🚚 백엔드 컨벤션

🧑‍💻 개발 컨벤션

---

1. 메서드 순서

• a() 메서드가 내부에서 사용하는 b(), c() 메서드를 바로 아래에 위치한다.
• static 메서드를 상단에 작성한다.

class Example { 
    public static void hello() {
        // ...
    }
    
    private static void hi() {
        // ...
    }
    
    public void a() {
        b();
        c();
    }
    
    private void b() {
        // ...
    }
    
    private void c() {
        // ...
    }
    
    public void d() {
        // ..
    }
}

• d() 메서드도 b() , c() 메서드를 이용하지만 a() 가 먼저 메서드를 사용하니 a() 메서드 아래에 위치한다.

class Example {

    public void a() {
        b();
        c();
    }
    
    private void b() {
        // ...
    }
    
    private void c() {
        // ...
    }
    
    public void d() {
        b();
        c();
    }
}

2. import문 단락

import문 단락은 아래의 순서로 선언한다. 블럭 사이에는 줄바꿈을 한다. java, javax, jakarta, org, net, com, 그 외

사용 예시

package roomescape.reservation.service;

import java.time.LocalDate;
import java.util.List;
import java.util.stream.Collectors;

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import roomescape.member.domain.Member;
import roomescape.member.dto.LoginMemberInToken;
import roomescape.member.repository.MemberRepository;
import roomescape.reservation.domain.FreeReservations;
import roomescape.reservation.domain.Payment;

3. static import 사용

• Test 프레임워크는 static import 사용한다. (ex: JUnuit & AssertJ Assertions)

4. final 선언

• 재할당되지 않는 로컬변수, 매개변수, 멤버변수에 final 선언을 한다.
• catch 블록에서 final 선언을 한다.
• for-each 블록에서 final 선언을 한다.
• 클래스 선언, 메서드 선언시에는 final 선언을 하지 않는다.

public int sum(final int x, final int y) {
    return x + y;
}

try {
    // 로직
} catch (final NullPointerException e) {

}

for (final int num : nums) {
    System.out.println(num);
}

5. 타입 추론 사용 유무

• 타입 추론(var)은 사용하지 않고 변수 타입을 명시적으로 선언한다.

6. 커밋 컨벤션

• 클래스명 없이 아래의 커밋 태그에 맞게 작성한다.

feat	신규 기능 개발
refactor	리펙터링
docs	문서 작업
chore	의존성 추가, 기타 작업
test	테스트 관련 작업
fix	버그 픽스
style	코드 변경 없는 포맷팅, 주석 제거와 같은 작업

// 예시
feat: 사용자 도메인 추가

7. 테스트 메서드 이름과 DisplayName 설정

• DisplayName은 행위에 대한 서술을 한다.
• 메서드의 명은 DisplayName을 영어로 작성한다.
• 구체적인 메서드명은 들어가지 않는다.

@DisplayName("인사를 한다.")
@Test
void sayHello() {
    Member member = new Member();
    
    assertThat(member.sayHello()).isEqualTo("Hello World");
}

8. 클래스 선언 후 줄바꿈

• 클래스 선언 후 줄바꿈을 넣어준다.

public class Main {
    
    private int foo;
}

9. 어노테이션이 붙은 필드의 줄바꿈

• 어노테이션이 붙은 필드는 줄바꿈을 넣어주고, 아닌 필드는 기존 방식처럼 줄바꿈 없이 선언한다.

class Member {
    
    private static final int MAX_VALUE = 3;
    private static final int MIN_VALUE = 1;

    @Id
    @Column(name = "id", nullable = false)
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(name = "email", nullable = false)
    private String email;
    
    @Column(name = "name", nullable = false)
    private String name;
    
    @Column(name = "password", nullable = false)
    private String password;
    
    @Column(name = "profile_photo", nullable = false)
    private String profilePhoto;
    
    @Enumerated(EnumType.STRING)
    @Column(name = "role", nullable = false)
    private Role role;
    
    private int num1;
    private int num2;

}

10. 클래스 & 메서드 레벨 어노테이션 배치 순서

• 클래스 & 메서드 레벨에 사용되는 어노테이션들은 클래스 & 메서드 관련도가 높을수록 아래에 배치한다.

Entity

@Getter
@NoArgs
@Table
@Entity
public class Member {
}

Service

@Getter
@Required
@Service
public class Member {
}

Test Code

@DisplayName()
@Test
void test {
}

11. Lombok

기본적으로 Lombok을 사용하되 아래 명시된 것들만 사용할 수 있다.

• getter
• noargs
• builder
• required
• slf4j

12. 객체 생성자

• 필드의 개수가 3개 이하라면 new 연산자를 사용해 생성하고, 4개 이상이면 Builder를 사용해 객체를 생성한다.

필드가 3개 이하일 경우

public class Main {
    
    private int a;
    private int b;
    private int c;
    
    private Main(int a, int b, int c) {
        this.a = a;
        this.b = b;
        this.c = c;
    }
}

필드가 4개 이상일 경우

public class Main {
    
    private int a;
    private int b;
    private int c;
    private int d;
    
    @Builder 
    private Main(int a, int b, int c, int d) {
        this.a = a;
        this.b = b;
        this.c = c;
        this.d = d;
    }
}

13. 데이터베이스 관련 문자열

테이블, 컬럼명 대문자로 통일한다.

@Entity
@Table(name = "MEMBER")
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Member {

    public static final String DEFAULT_PROFILE_IMAGE_URL = "";

    @Id
    @Column(name = "ID", nullable = false)
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(name = "EMAIL", nullable = false)
    private String email;
    
    @Column(name = "NAME", nullable = false)
    private String name;
    
    @Column(name = "PASSWORD", nullable = false)
    private String password;
    
    @Column(name = "PROFILE_PHOTO", nullable = false)
    private String profilePhoto;
    
    @Enumerated(EnumType.STRING)
    @Column(name = "ROLE", nullable = false)
    private Role role;
  
}

네이브 쿼리, JPQL 사용시에도 대문자로 쿼리를 작성한다

@Query("""
        SELECT m
        FROM Member m
        WHERE m.id = :id
        """)
Optional<Member> findById(@Param("id") long id);

14. 레코드 줄바꿈

@Schema(description = "레퍼런스 링크 생성 요청 바디")
public record ReferenceLinkCreateRequest(
        @Schema(description = "레퍼런스 링크 값", example = "<https://www.naver.com>")
        @NotBlank(message = "빈 url은 허용하지 않습니다.")
        String url,
        
        @Schema(description = "레퍼런스 링크 값", example = "<https://www.naver.com>")
        @NotBlank(message = "빈 url은 허용하지 않습니다.")
        String name
) {
}

@Schema(description = "레퍼런스 링크 생성 요청 바디")
public record ReferenceLinkCreateRequest(@Schema(description = "레퍼런스 링크 값", example = "<https://www.naver.com>") 
                                         @NotBlank(message = "빈 url은 허용하지 않습니다.") 
                                         String url) {
}

애노테이션 없이 필드 갯수가 2개 이하라면 줄바꿈하지 않는다.

애노테이션이 붙은 경우 줄바꿈을 한다. 필드마다도 줄바꿈을 해준다.

단, 필드에 에노테이션이 1개라면 예외 적으로 첫줄을 제외하고 줄바꿈을 하지 않는다.

public record PairRoomRequest(
        @Schema(description = "페어룸 접근 코드", example = "abcdef") String accessCode, 
        @Schema(description = "페어룸 접근 토큰", example = "abcdef") String accessToken
) {
}

15. 컨트롤러 메서드 네이밍

예시) Member 컨트롤러

16. CURD

• C → createMember
• R → getMember, getMembers
• U → updateMember
• D → deleteMember

17. 컨트롤러 DTO에서는 Wrapper class 사용

• Spring validation message 출력 용이성을 위함.
• 그 외 하위 개층에서는 primitive type을 사용한다. (long, int, byte, double, float 등등)
  • 불변 객체 변환 용이성
  • NPE 발생 방지
  • 조금의 성능 개선
  • 예외) 프레임워크 강제 사항일 시 제외 (e.g, hibernate)

18. DTO는 서비스에 둔다.(To be update...)