📚 코드 컨벤션

KOIN API V2에서 사용하는 코드 컨벤션 설정에 대한 문서입니다.

해당 컨벤션은

• 캠퍼스 핵데이 Java 코딩 컨벤션
• Google Java Style Guide 을 참고하여 작성되었습니다.

Java

v1.0

아래 컨벤션을 IntelliJ에 적용한다.

자세한 적용 방식은 💡 코드컨벤션 적용하기 문서를 참고하여 적용한다.

파일 내용 보기

<code_scheme name="BCSDLab-Backend-coding-convention-v1.0">
<!-- Referenced by Naver coding convention for Java (version 1.2) -->
<!-- https://naver.github.io/hackday-conventions-java/ -->
  <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
  <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="3" />
  <option name="IMPORT_LAYOUT_TABLE">
    <value>
      <emptyLine />
      <package name="" withSubpackages="true" static="true" />
      <emptyLine />
      <package name="java" withSubpackages="true" static="false" />
      <emptyLine />
      <package name="javax" withSubpackages="true" static="false" />
      <emptyLine />
      <package name="org" withSubpackages="true" static="false" />
      <emptyLine />
      <package name="net" withSubpackages="true" static="false" />
      <emptyLine />
      <package name="com" withSubpackages="true" static="false" />
      <emptyLine />
      <package name="" withSubpackages="true" static="false" />
      <emptyLine />
    </value>
  </option>
  <option name="RIGHT_MARGIN" value="120" />
  <option name="ENABLE_JAVADOC_FORMATTING" value="false" />
  <option name="JD_KEEP_EMPTY_LINES" value="false" />
  <option name="FORMATTER_TAGS_ENABLED" value="true" />
  <XML>
    <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" />
  </XML>
  <codeStyleSettings language="JAVA">
    <option name="LINE_COMMENT_AT_FIRST_COLUMN" value="false" />
    <option name="LINE_COMMENT_ADD_SPACE" value="true" />
    <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" />
    <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
    <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" />
    <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
    <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" />
    <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
    <option name="SPACE_AFTER_TYPE_CAST" value="false" />
    <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" />
    <option name="CALL_PARAMETERS_WRAP" value="1" />
    <option name="METHOD_PARAMETERS_WRAP" value="1" />
    <option name="EXTENDS_LIST_WRAP" value="1" />
    <option name="METHOD_CALL_CHAIN_WRAP" value="5" />
    <option name="THROWS_LIST_WRAP" value="5" />
    <option name="EXTENDS_KEYWORD_WRAP" value="1" />
    <option name="BINARY_OPERATION_WRAP" value="1" />
    <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true" />
    <option name="TERNARY_OPERATION_WRAP" value="1" />
    <option name="ARRAY_INITIALIZER_WRAP" value="1" />
    <indentOptions>
      <option name="CONTINUATION_INDENT_SIZE" value="4" />
      <option name="USE_TAB_CHARACTER" value="false" />
    </indentOptions>
  </codeStyleSettings>
</code_scheme>

static import

static import는 와일드카드(*) 사용을 허용한다. 단, 3개부터 허용한다.

줄 최대 너비

네이버는 120, 구글은 100자 기준으로 줄 최대 너비를 잡는다.

빈 줄

• 메서드 사이에 빈 줄을 추가한다.
• 클래스의 마지막 메서드에는 빈 줄을 추가하지 않는다. (메서드를 포함하여 클래스 내부의 마지막 괄호에 빈 줄을 추가하지 않는다.)

Application

Package Architecture

구조 보기

└── koin
    ├── KoinApplication.java
    ├── domain
    │   ├── shop
    │   │   ├── controller
    │   │   │   └── ShopController.java
    │   │   ├── domain
    │   │   │   ├── Menu.java
    │   │   │   ├── MenuCategory.java
    │   │   │   ├── MenuCategoryMap.java
    │   │   │   ├── MenuImage.java
    │   │   │   └── MenuOption.java
    │   │   ├── dto
    │   │   │   └── ShopMenuResponse.java
    │   │   ├── repository
    │   │   │   └── MenuRepository.java
    │   │   └── service
    │   │       └── ShopService.java
    └── global
        ├── common
        │   └── BaseEntity.java
        ├── config
        │   └── JpaConfiguration.java
        └── exception
            └── GlobalExceptionHandler.java

위와 같은 패키지 구조를 사용한다.

메서드 이름

• Service Layer에서는 비즈니스 로직을 나타내는 용어를 사용한다.
  • 조회: getXXX
• Repository Layer에서는 데이터베이스 접근을 나타내는 용어를 사용한다.
  • Repository에서 단순 조회로직을 호출할 경우 Entity getByXXX() 메소드를 호출한다.
  • 별도의 예외 핸들링이 필요한 경우 Optinal<Entity> findByXXX() 메소드를 호출한다.
  • JPA를 사용하여 Repository interface를 정의할 때 Repository를 상속받아 구현한다.

DTO

• record를 사용한다.
• Java Code에서는 camelCase를 통해 작성하고 결과물로 snake_case를 요구할 경우 @JsonNaming(value = SnakeCaseStrategy.class)등을 통해 snake_case로 응답되도록한다.
• 기존 코인에 없던 새로운 기능을 만드는 경우 결과물로는 snake_case로 응답되도록 한다.
  • 클라이언트의 혼란을 덜기 위해 기존 코인의 DTO 컨벤션을 따라간다
  • 

Test

인수테스트

해당 컨벤션은 마이그레이션 과정에서 필수로 적용되는 컨벤션입니다.

기능을 작성할 때 인수테스트를 반드시 작성해야한다. 인수테스트는 RestAssured를 사용하여 작성한다.

자세한 내용은 코드를 참고한다.