IntelliJ Code Style

Naver_coding_convention_v1_2.xml

컨벤션

naver code style

• • 와일드 카드 임포트 지양한다.

[No 확정]Repo, Service, Controller 메서드명

<aside> 🚨 기본적인 권장사항 입니다! (필수는 아님)

</aside>

• 조회 메서드의 경우

  • Repository, Service - find{메서드명}

  • Controller - get{메서드명}

    

  • 예외인 경우

    • 아래와 같이 Get이 명확하게 더 잘 어울리는 경우에는 사용해주세요!

      

@validation 전략

<aside> ➡️ Entity & Controller 에서 Validation 처리하기로 결정되었습니다.

</aside>

• Controller Dto

• Entity

DTO 전략

• 편의상 Controller - Service 간의 DTO는 공용으로 사용합니다.

• 필요 시 Controller - Service 분리가 필요한 경우 별도의 DTO를 만들어 분리합니다.

• 기본적으로 inner record 형식을 따릅니다.

  • example

    public record XXRequest() {
    	public record CreateRequest(String name) {
    
    	}
    
    	public record UpdateRequest(String name, String description) {
    	
    	}
    } 
    
    public record XXResponse(String id, String name, String description) {
    	public record CreateResponse(String id) {
    
    	}
    	
    	public record UpdateResponse(String name, String description) {
    
    	}
    }