GET 방식의 모든 API 요청에 대해서는 UserDetailsImpl 객체에서 userId의 null 값을 체크하여 비회원을 검증하기로 약속하였습니다.
클라이언트의 요청이 성공 혹은 실패했는지는 Response에 OkDto 활용해 ok=true/false로 전달하도록 합니다.
변수의 이름은 다른 사람들이 직관적으로 알아볼 수 있게 짓도록 합니다. 예를 들어, 한 객체 안에서 barterItemDtoList vs barterItemDtosList와 같은 멤버 변수를 활용하는 방식은 지양합니다.
생성자를 초기화 할 때 정적 팩토리 메소드와 빌더 패턴을 활용해 가독성을 높여 보도록 합니다. (선택사항)
a. 정적 팩토리 메소드 활용 : 객체 등을 활용해 일반적인 생성자를 만들 시에 활용 가능 new User(requestDto, password); → User.createOf(requestDto, password);
b. 빌더 패턴 활용 : 사용되는 인자가 많아 가독성이 떨어질 때 활용 가능 new User(userId, username, nickname, password, address, ...) → User.builder() .userId(id) .username(email) .nickname(nickname) .password(password) .address(address) .build();
주석은 가능한 활용합니다. 다만, 미완성 or 안 쓸 기능이지만 지우기 아까워서 주석으로 처리하겠어!! 보다는 주석의 목적을 다른 사람이 봐도 읽기 쉽도록 만든다는 개념으로 활용해야 합니다!
변수는 camelCase로, API URI는 dash-case로!
변수나 메소드의 네이밍을 할 때 가능한 20자가 넘지 않도록 합니다.