📌 브랜치 이름

예시) feature / #이슈번호 제목

📌 네이밍 규칙<Google Code Style Guide>

네이밍 규칙 (2)

<aside> 💡

검증 메서드는 긍정문 사용

예시)

• 권장: isValidUser(), hasPermission(), existsInDatabase()
• 비권장: isNotInvalidUser(), checkUserValidity() </aside>

<aside> 💡

getter가 아닌 메서드에서 get-을 사용하지 않는다.

예시)

• 권장: calculateTotalPrice(), fetchUserData()
• 비권장: getTotalPrice(), getUserData() (이 경우 데이터 가공이나 처리 과정이 있는 메서드라면 적합하지 않음) </aside>

<aside> 💡

DTO 네이밍 구체화

DTO는 데이터 전송용 객체(Data Transfer Object)의 약자로, 그 용도에 따라 request, response, clientRequest, clientResponse와 같이 명확히 구분

예시)

• UserRequest: 클라이언트가 서버로 전송하는 요청 데이터.
• UserResponse: 서버가 클라이언트로 응답할 때 보내는 데이터.
• UserClientRequest: 서버가 외부 API에 보낼 요청 데이터.
• UserClientResponse: 서버가 외부 API로부터 받은 응답 데이터. </aside>

📌 코드 및 패키지 구조

<aside> 💡

패키지 구조는 도메인 기준으로 한다.

예시)

- com.example.project
    - user
        - UserController
        - UserService
        - UserRepository
    - product
        - ProductController
        - ProductService
        - ProductRepository

</aside>

<aside> 💡

클래스와 선언부 필드 사이의 개행

예시)

public class UserService {

    private final UserRepository userRepository;
    private final UserValidator userValidator;

    // 메서드 선언부
    public void createUser(User user) {
        // 메서드 로직
    }
}

</aside>

<aside> 💡

@Valid를 통한 입력값 검증

예시)

@PostMapping("/users")
public ResponseEntity<UserResponse> createUser(@Valid @RequestBody UserRequest userRequest) {
    User user = userService.createUser(userRequest);
    return ResponseEntity.ok(new UserResponse(user));
}

</aside>

<aside> 💡

Enum 정의 시 후행 쉼표 사용

예시)

public enum OrderStatus {
    PENDING,
    SHIPPED,
    DELIVERED,
}

</aside>

<aside> 💡

Lombok 라이브러리를 사용하되, 그 범위를 제한한다.

@Getter, @NoArgsConstructor, @RequiredArgsConstructor

</aside>

<aside> 💡

어노테이션의 배치 순서

• 여러 어노테이션을 사용할 때는 중요한 어노테이션을 가장 위에 배치
• Lombok 관련 어노테이션은 코드에서 가장 아래에 배치하여 시각적 일관성을 유지

예시)

• @NoArgsConstructor 사용시 AccessLevel.PROTECTED 로 설정

  → 생성자를 통해서 값 변경 목적으로 접근하는 메시지들 차단

@Entity
@Table(name = "users")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class User {
    // 필드와 메서드 정의
}

</aside>

📌 변수 및 메서드 관리

<aside> 💡

메서드 순서

• Public 메서드는 클래스 상단에 배치한다.
• Private 메서드는 호출되는 위치 바로 아래에 둔다. </aside>

<aside> 💡

필드 변수 정의 순서

• static final 변수 → final 변수 → 인스턴스 변수 순서로 정의한다.

• 예시)

  public class ExampleClass {
      private static final String CONSTANT = "ConstantValue";
      private final String immutableField;
      private String mutableField;
  
      public ExampleClass(String value) {
          this.immutableField = value;
      }
  }
  

</aside>