Search
Duplicate

Code Convention

•
Entity에 Setter사용 금지
•
lombok annotation 을 위로 올리기
•
Controller단에 parameter 한 줄씩 띄워서 쓰기
@PostMapping("/boards/{boardId}/invite/{userId}") public ApiResponse<Void> invite( @PathVariable(name = "boardId") Long boardId, @PathVariable(name = "userId") Long userId, @AuthenticationPrincipal UserDetailsImpl userDetails ) { invitationService.createInvitation(boardId, userId, userDetails.getUser()); return new ApiResponse<>(HttpStatus.CREATED.value(), "보드에 사용자 초대 성공"); }
Java
복사
•
클래스 첫 줄 시작할 때 한 줄 띄우기
•
메서드 끝나고 한 줄 띄우기
•
Entity 생성자에 Builder 붙이기
@Builder public Invitation(User receiver, User sender, Board board) { this.id = new InvitationId(); id.setReceiver(receiver); id.setBoard(board); this.sender = sender; }
Java
복사
•
메서드 6줄 이하 지향
•
Dto record로 작성, 네이밍 Response or Request
•
parameter명은 Res, Req
@Builder public record CardCreateRequest( @Size(max = 500) String title ) { }
Java
복사
@PostMapping("/boards/{boardId}/sections/{sectionId}/cards") public ApiResponse<Void> createCard( @PathVariable Long boardId, @PathVariable Long sectionId, @RequestBody CardCreateRequest cardCreateReq, @AuthenticationPrincipal UserDetailsImpl userDetails) { cardService.createCard(cardCreateRequestDto, boardId, sectionId, userDetails.getUser()); return new ApiResponse<>(HttpStatus.CREATED.value(), "카드 생성"); }
Java
복사
•
테이블 명에 tb_ 붙이기 소문자로
◦
ex) @Table(name = "tb_menu")
•
GlobalException
◦
각자 extends 해서 쓰고 싶으면 본인 도메인의 exception에 extends한 exception class만들어서 쓰고 Global 쓰고싶으면 Global 쓰기
◦
ErrorCode implements는 반드시 해야함!