Code convention

코드 컨벤션

Java Google Style Guide

코드 스타일의 경우 Java Google Style Guide를 사용하되 일부를 수정하여 사용하였다.

추가 사항

1. Tab Size

• Tab size는 4로 사용한다. (구글 스타일 : 2)

2. 메소드 최대 길이

• 메소드의 최대 길이는 권장 10줄 이내, 최대 15줄 이내로 한다.

3. Get vs Find

• 객체를 조회하는 메소드를 만들 시 명명하는 방법, get과 find를 같이 사용하되 예외 처리에 따라 다르게 작성한다.
  • get ← 객체를 직접 반환, 객체가 없다면 예외를 던짐
  • find ← Optional로 객체를 감싸서 반환

4. 클래스, 인터페이스 네이밍

• 인터페이스 → 형용사나 명사로 이름을 짓는다.
• 클래스 → 명사로 이름을 짓는다.

5. DTO 네이밍

• 요청 : Request를 접미사로 가진다. 예) LoginRequest
• 응답 : Response를 접미사로 가진다. 예) LoginResponse

6. Validation 전략

• Controller -> DTO에 @Valid 활용하여 Notnull, NotBlank, Size 등 사전조건을 검증한다.
• Service -> Repository에서 반환한 Optional.empty 등 비즈니스 플로우 상 문제가 발생하는지 검증한다.
• Domain -> 도메인의 비즈니스 로직을 검증한다. 예) 판매 시작 시간이 판매 종료 시간보다 앞서야 한다. 등
• Repository, Entity -> 데이터베이스 테이블에 제약 조건을 명시하되 추가적인 검증은 하지 않는다.

7. 어노테이션 순서

• Annotation의 순서는 짧은 것이 위로, 긴 것이 아래로 간다.
• 예시

  @Service
  @RequiredArgsConstructor
  @Transactional(readOnly = true)
  public class OrderService implements OrderUseCase {

8. 불변 객체 final

• 불변 객체의 경우 선언시 final을 붙인다.
• 예시

  @Override
  @Transactional
  public OrderIdResponse orderCartByCartIdAndUserId(final long cartId, final long userId) {
      final Cart cart = cartConnector.findByCartIdAndUserId(cartId, userId)
          .orElseThrow(() -> new DoesNotFindCartException(cartId, userId));
      final Order order = OrderMapper.toDomain(idGenerator, userId, cart, timeUtil.now());
      orderRepository.persist(order);
      return new OrderIdResponse(order.getId());
  }

9. Code Smell with SonarLint

• SonarLint를 사용하여 코드 스멜이 발생할 수 있는 부분을 없앤다.
• 

테스트 컨벤션

1. 테스트

• 단위 : 클래스단위, 같은 레이어에서 다른 레이어의 참조가 필요없는 것을 테스트한다.
• 통합 : 클래스단위, 다른 layer는 의존성의 방향에따라 선택적으로 Mocking 하여 테스트한다.
• 인수 : API부터 전체를 테스트한다. 클래스 mocking은 없다. Tomcat과 DB는 테스트용 Mocking을 사용한다.

2. 테스트 적용 범위

• Controller → 인수테스트로 대체한다.
• Service → 통합테스트로 작성하면서 비즈니스 플로우를 검증한다.
• Domain → 단위 테스트로 작성하면서 최대한꼼꼼히, 동작, 예외, 반례같은거 생각하면서 테스트한다.
• Repository → 통합테스트로 작성한다.

3. Nested Test

• 테스트 코드를 작성하면서 @Nested를 활용한 계층 구조로 테스트를 작성한다.
• 예시

  @DisplayName("OrderService 클래스")
  @ExtendWith(SpringExtension.class)
  @ContextConfiguration(classes = OrderService.class)
  class OrderServiceTest {
  
      @Nested
      @DisplayName("orderCartByCartIdAndUserId 메소드는")
      class orderCartByCartIdAndUserIdMethod {
  
          @Test
          @DisplayName("cartId와 userId를 받아, 주문에 성공하면, cartId를 반환한다.")
          void returnCartIdWhenOrderSuccess() {
              // given, when, then ... 
    
          }
      }
  }

4. Test Coverage

• 테스트 커버리지의 목표는 70%로 한다.
• 단 DTO, Lombok 등 자동생성되거나 테스트가 필요없는 경우 테스트 커버리지에서 제외한다.
•