Code Convention

☑️ 코드 컨벤션

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 다음 네이밍 컨벤션에 맞춰 작성합니다

대상	네이밍 컨벤션	예시
메서드	camelCase	`deleteData()`
변수	camelCase	`userName`
클래스(객체)	PascalCase	`UserSession`
디렉토리(패키지)명	kebab-case	`images/, api-service/`
파일명	camelCase	`useDragOn.ts`
상수	UPPER_SNAKE_CASE	`MAX_RETRY_COUNT`

메서드명 → 동사로 시작
변수명 → 명사로 시작 </aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 주석은 설명하려는 구문에 맞춰 들여쓰기 합니다.

// Good
function someFunction() {
  ...

  // statement에 관한 주석
  statements
}

</aside>

Builder를 통한 초기화 OR 코드컨벤션 맞춰서 도메인 클래스 내부에 메서드 추가
- 외부에서 로직 실행 후 저장 하는게 아닌 로직의 책임 자체를 해당 클래스가 지도록
메서드명은 set~~ 이 아닌 의도와 목적을 포함하도록 작성
- ex) increaseQuantity(int quantity), updateUsername(String username), …
일단 ReqDto에는 @Getter, @Setter를 사용합니다.
- 추후 테스트 과정에서 @Setter 제거 + @Builder,@Jacksonized 로 바꿔서 테스트 해보고 그래도 문제 없으면 변경 가능 </aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> Entity / DAO / DTO의 경우 Wrapper 클래스로 통일합니다

</aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 객체 생성 시 new 키워드 사용은 지양합니다

Builder 나 Static Factory Method 사용 지향
- 컨버팅 메서드만 팩토리 메서드, 새로 인스턴스 생성 시 빌더 패턴 사용
  - 기본 생성자는 막거나(private) 제거
ex)

@Getter
@Builder
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class Cart {    
		private Long cartId;
    private Long userId;
    private Long productId;
    private Integer quantity;

    
    ~~// 정적 팩토리 메서드
    public static Cart userProductQuantityOf(Users user, Product product, Integer quantity) {
        return new Cart(user, product, quantity);
    }~~
}

참고
- https://ydydydyc.github.io/java/what-is-static-factory-method/
- https://velog.io/@cjh8746/정적-팩토리-메서드Static-Factory-Method </aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> .ENV 파일의 경우 레포지토리에 올리지 않고 카카오톡을 통해 공유

</aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> Dto 클래스 네이밍 컨벤션은 다음과 같음

DTO 용도에 따라 다음 접미사 중 선택
- ReqDto / ResDto / Dto
- ex - NotiSendReqDto </aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 실패 응답의 경우 전역 예외 처리 모듈에서 일괄 처리

비즈니스 로직 상에선 예외만 던져주기 </aside>

<aside> <img src="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" alt="https://cdn-icons-png.flaticon.com/512/3602/3602241.png" width="40px" /> 본인 userId 조회 시

user 가 본인 userId를 파라미터로 받을 일이 있다면 @AuthenticationPrincipal로 세션 값을 통해 가져오도록 한다. </aside>