-
Notifications
You must be signed in to change notification settings - Fork 2
BE 코딩 컨벤션
5win edited this page Sep 20, 2024
·
1 revision
- Google Java Style Guide 에 맞춰서 작성.
- 단, 들여쓰기는 ‘2 spaces’가 아닌 ‘4 spaces’ 사용.
- https://google.github.io/styleguide/javaguide.html
- 인텔리제이 스타일 자동 완성 기능 사용 추천.
- else 지양하기.
- indent depth가 가능한 3을 넘어가지 않도록 주의.
- find
- 반환 값이 존재하지 않을 수 있는 경우.
- 반환 타입으로 Optional 또는 List.
- ex)
findByName
- get
- 반환 값이 null이 아님이 보장되는 경우.
- 반환 타입으로 DTO 또는 Entity 객체가 가능.
- ex)
getByName
서로 다른 레이어 간에는 Entity 객체를 통한 전달을 지양하고 DTO를 사용할 것. 요청과 응답에 대한 정보를 가지는 DTO의 경우 request & response 붙일 것.
-
reqeust
- 유저 생성 요청 →
UserCreateRequest
- 유저 정보 수정 요청 →
UserUpdateRequest
- 유저 생성 요청 →
-
response
- 유저 정보 조회 요청에 대한 응답 →
UserInfoResponse
- 유저 리스트 조회에 대한 응답 →
UserListResponse
- 유저 정보 조회 요청에 대한 응답 →