<aside> 😎 백엔드의 코드 컨벤션을 기록해둔 페이지입니다.

</aside>

🍷 code convention

• Naver 컨벤션
• 적용법

🍷 custom code convention (24.01.17 최신화)

1. Domain Entity 선언

   // SelfValidationg은 필요한 경우에만 상속한다.
   public class MyDomain extend SelfValidationg<MyDomain> {
   	// 클래스 변수 맨위에 위치한다.
   	private static final String WE_ARE_NEW_BARAMS = "뉴바람스";
   
   	// 최대한 Value로 표현한다.
   	private DomainId domainId;
   	private Name name;
   	private Content content;
   
   	// SelfValidationg을 상속하지 않는다면 최대한 생성자는 Lombok을 사용한다.
   	// 단, 상속했다면 생성자에 검증 로직을 추가한다.
   	public MyDomain(DomainId domainId, ...) {
   		this.domainId = domainId;
   		...
   		this.validateSelf();
   	}
   
   	// Method ...
   }
   

2. Domain Value 선언

   • 기본적으로 Domain Entity와 비슷하다.

   public class Name extend SelfValidationg<Name> {
   	// 클래스 변수 맨위에 위치한다.
   	private static final String WE_ARE_NEW_BARAMS = "뉴바람스";
   
   	// 불변성을 유지한다.
   	// 검증 Annotation은 한 줄에 하나씩 작성한다.
   	@NotBlank
   	@Size(max = 20)
   	private final String name;
   
   	// Fixture Monkey에서 생성 오류가 발생할 때 @ConstructorProperties를 붙인다.
   	public Name(String name) {
   		this.name = name;
   		this.validateSelf();
   	}
   
   	// Method ...
   }
   

3. JPA Entity 선언

   @Entity
   @Table(name = "my_entities")
   @NoArgsConstructor(access = AccessLevel.PROTECTED)
   @AllArgsConstructor
   public class MyEntity extend BaseEntity {
   	// 필드는 위에 위치한다.
   	// 해당 레코드의 속성을 반드시 표현한다.
   	@Column(nullable = false, length = 20)
   	private String name;
   
   	@Column(nullable = false, length = 50, unique = true)
   	private String email;
   
   	// Embedded는 가운데 위치한다.
   	// 꼭 필요한 Embedded만 사용한다.
   	@Embedded
   	private Address address;
   
   	// 꼭 필요한 Enum 객체만 사용한다.
   	@Enumerated(value = EnumType.STRING)
   	private MyEnum enum;
   
   	// 연관관계는 맨밑에 위치한다.
   	@OneToMany
   	private List<MySubEntity> subEntities = new ArrayList<>();
   
   	// 생성자, 메서드 X
   }
   

   • @Table은 복수형으로 붙인다.

4. inner class

   • 작은 단위은 클래스 맨 위에 선언한다. (단순 데이터 혹은 열거형)
   • 큰 단위는 클래스 맨 아래에 선언 or 분리한다. (메서드를 가지는 등의 복잡한 클래스)

5. private 메서드 선언

   • 사용하는 public 메서드 뒤에 선언한다.
   • 여러 곳에서 사용하는 경우, 가장 마지막에 사용한 public 메서드 뒤에 선언한다.

6. parameter, 매개 변수

   • 가급적 매개 변수를 3개를 넘기지 않는다.
   • 넘어갈 경우 VO로 변환해서 줄여본다.

7. Lombok

   • @Getter :
     • 정말 필요한지 고려하고, 필요한 필드만 따로 선언해서 사용한다.
     • 만약 모두 필요하다고 판단되면 클래스에 작성한다.
   • @Setter, @EqualsAndHashCode, @ToString ❌
   • 생성자 어노테이션은 접근 제한자(AccessType)를 꼭 고려한다.

8. query 메소드 네이밍

   • Repository 계층 : findXXX, 쿼리가 예상갈 수 있도록 자세한 네이밍으로 작성한다.
   • Service 계층 : loadXXX, 필요한 파라미터를 명시하는 네이밍으로 작성한다.
   • Controller 계층 : getXXX, ****최대한 추상적인 네이밍으로 작성한다.

1. DTO (11.27 최신화)
   • Class + @Data + private fianl ~~sealed와 record의 조합을 사용한다.~~
   • 변환 로직을 가지지 않는다. 변환은 mapper가 담당한다.
   • Inner Class 구조로 사용한다.
   • 네이밍 : 도메인 + 요청/응답 . 행위 (ex. UserRequest.Create )
   • QueryDsl이 리턴하는 DTO는 @QueryProjection을 사용한다.
2. Service
   • 행위를 나타내는 네이밍을 한다.
   • 한 서비스는 하나의 책임만을 가진다.
   • ex. CreateUserService, SendMoneyService, ImageUploadService
3. 최대한 RESTful하게 URI를 작성한다.
   • 특정 end-point에만 도메인을 위치시키지 않는다.

1. Controller의 입력 인자가 줄이 넘어가면 나누어서 작성한다.

// bad..!
public AjajaResponse<Type> doSomething(Param param1, Param param2, Param param3, Param param4) {
	// logic...
}

// good..!
public AjajaResponse<Type> doSomething(
	Param param1,
	Param param2,
	Param param3,
	Param param4
) {
	// logic...
}