Skip to content

BE 코딩 컨벤션

5win edited this page Sep 20, 2024 · 1 revision

1. 코드 컨벤션

  • Google Java Style Guide 에 맞춰서 작성.
  • else 지양하기.
  • indent depth가 가능한 3을 넘어가지 않도록 주의.

2. 메서드 명

find & get

  • find
    • 반환 값이 존재하지 않을 수 있는 경우.
    • 반환 타입으로 Optional 또는 List.
    • ex) findByName
  • get
    • 반환 값이 null이 아님이 보장되는 경우.
    • 반환 타입으로 DTO 또는 Entity 객체가 가능.
    • ex) getByName

DTO

서로 다른 레이어 간에는 Entity 객체를 통한 전달을 지양하고 DTO를 사용할 것. 요청과 응답에 대한 정보를 가지는 DTO의 경우 request & response 붙일 것.

  • reqeust
    • 유저 생성 요청 → UserCreateRequest
    • 유저 정보 수정 요청 → UserUpdateRequest
  • response
    • 유저 정보 조회 요청에 대한 응답 → UserInfoResponse
    • 유저 리스트 조회에 대한 응답 → UserListResponse
Clone this wiki locally