💻코드

https://github.com/JunHoPark93/google-java-styleguide를 참고

• 클래스 내부에서는 항상 한 줄씩 띄고 시작

• 모든 줄 바꿈은 한 줄씩만

• 상수

  • 상수 선언 위치
    • 클래스 내부의 맨위
  • 상수 이름
    • CONSTANT_CASE

• public 메서드와 private 메서드의 순서

  • public과 private을 각각 위, 아래로 분리

• 의존성 주입 방식 : @RequiredArgsConstructor

• 클래스에 적용하는 어노테이션 순서

  • 주요 어노테이션을 클래스에 가깝게 설정

  • 예시

    @Getter
    @NoArgsConstructor(access = AccessLevel.PROTECTED)
    @Entity
    public class User {
    				...
    }
    

    @RequiredArgsConstructor
    @RequestMapping("/api/users")
    @RestController
    public class UserController {
    						...
    }
    

• 엔터티 클래스내 필드

  • 순서
    1. 일반 필드
    2. 연관관계 필드
  • 줄 바꿈 양식
    • 어노테이션이 있는 필드는 줄 바꿈
  • 예시

  public class Review {
  
      @Id
      @GeneratedValue(strategy = GenerationType.IDENTITY)
      private Long id;
  
      private double grade;
      private String content;
  
      @ManyToOne(fetch = FetchType.LAZY)
      @JoinColumn(name = "user_id")
      private User user;
  
      @ManyToOne(fetch = FetchType.LAZY)
      @JoinColumn(name = "store_id")
      private Store store;
      
  		    ...
  }
  

• 매직 Number, String을 상수로 선언

• 주석 포맷

  • 한 줄 작성 : b. 방식
  • 여러 줄 작성 : a. 방식

  a.                  b.                  c.
  /*
   * This is          // And so           /* Or you can
   * okay.            // is this.          * even do this. */
   */
  

• JPA 생성자

  • 기본 생성자 (접근제어자는 protected)
  • 필드 생성자 (id, 단순 조회용 List(MappedBy) 등은 제외)
  • 필요 생성자가 여러개일 때 (엔터티 중요도에 따라 방식 선택)
    1. 생성자 오버로딩 ⇒ 중요도가 높은 엔터티라면 이 방식을 사용하여 매개변수들을 좀 더 명확하게 표현
    2. Builder 패턴

• 컨트롤러 응답 타입 : ResponseEntity

• 파라미터 인자가 많을 시, 줄 바꿈 포맷

  // 파라미터 인자 2개까지 (2개여도 길이가 길다면 줄 바꿈 가능)
  public void m(int a, int b) {
  
  }
  
  // 파라미터 인자 3개부터
  private void m(
          int a,
          int b,
          int c
  ) {
  
  }
  

• 메서드 호출 시, 줄 바꿈 포맷

  return reviewRepository.save(
          ReviewMapper.toEntity(
                  user,
                  store,
                  reviewSaveDto
          )
  ).getId();
  

• DTO 이름 설정 방식

  • 파일명 끝에 Dto 붙이기
    • ex) StoreSaveDto
  • 상황에 따라 Dto에 필요한 인자가 다를 때는 뒤에 For를 붙여서 구별
    • ex) ReviewDetailsForStoreDto

• 컨트롤러, 서비스 메서드명 설정 방식

  	컨트롤러	서비스
  생성	create{$entityName}	save
  단건 조회	show{$entityName}By{$condition}
  ex) showUserByUserId	findBy{$condition}
  ex) findByUserId
  업데이트	update	update
  삭제	deleteBy{$condition}
  ex) deleteById	deleteBy{$condition}
  ex) deleteById

• 컨트롤러 경로변수, 매개변수에 사용되는 id 이름 설정 방식

  • 앞에 도메인 이름 붙이기
    • ex) id (x) ⇒ userId (o)

• api 반환 타입 스펙

  	controller	service
  생성	ResponseEntity	Long id
  단건 조회	ResponseEntity	DTO
  업데이트	ResponseEntity	void
  삭제	ResponseEntity	void