Code Convention | Backend

Dto

• 📂 위치
  • dto.request / dto.response 패키지 내 클래스 생성
  • 1 dto 1 class
  • ex) package com.graphy.backend.domain.comment.dto.request;
• 🏷️ Naming
  • 행위+도메인+request/response
  • ex) CreateCommentRequest, GetAllProjectsResponse
• 🔁 Entity, DTO 변환 Format
  • Request

  @Getter
  @Builder
  @NoArgsConstructor
  @AllArgsConstructor
  public class {행위}{도메인}Request {
  
  
      public {도메인} toEntity() {
          return Comment.builder()
                  ...
                  .build();
      }
  }

  • Response

  @Getter
  @Builder
  @NoArgsConstructor
  @AllArgsConstructor
  public class {행위}{도메인}Response {
  
  
      public static {행위}{도메인}Response {from OR of}() {
              return Comment.builder()
                      ...
                      .build();
              }
          }

Mapper

• 📂 위치
  • dto 클래스 내에 함수로 생성
• 🏷️ Naming
  • Entity → Dto
    • from (인자 값 1개일 경우)
    • of (인자 값 2개 이상일 경우)
  • Dto → Entity
    • toEntity

Annotation

Entity

@Entity
@Getter
@Builder
@NoArgsConstructor
@AllArgsConstructor

Dto

@Getter
@Builder
@NoArgsConstructor
@AllArgsConstructor

Naming

변수

• 특정 클래스 내의 변수
  • 변수 Type의 첫 번째 문자만 소문자로 변환
  • ex) private final MemberRepository memberRepository;
• 보통의 임시 변수
  • 그 변수의 사용 의도를 알아낼 수 있도록 명명
  • 되도록이면 한 문자로 이루어진 변수 이름 피하기

Controller 내의 Method

만약 이 네이밍 규칙을 따를 경우에 가독성이 떨어지는 경우가 발생한다면, 가독성이 더 좋은 네이밍을 가져가는 것을 권장합니다.

• 도메인 OR 목적어 + 접미사
  • 도메인+List() – 목록 조회 유형
  • 도메인+Details() – 단일 상세 조회 유형
  • 도메인+Save() – 등록/수정/삭제 가 동시에 일어나는 유형
  • 도메인+Add() – 등록만 하는 유형
  • 도메인+Modify() – 수정만 하는 유형
  • 도메인+Remove() – 삭제만 하는 유형

Service 내의 Method

• 접두사 + 도메인 OR 목적어

  • find+도메인() - 조회 유형
  • find+도메인+List() - 목록 조회 유형
  • add+도메인() - 등록 유형
  • modify+도메인() - 변경 유형
  • remove+도메인() - 삭제 유형
  • save+도메인() – 등록/수정/삭제 가 동시에 일어나는 유형

• 유효성 검사 Method

  • 중복 데이터인지 등을 확인하는 Method
  • check[목적어][검사하려는 행위]
    ex) checkMemberDuplicated

QueryDSL

QueryDSL return type: DTO

QueryDSL의 반환 DTO 생성자

@QueryProjection
public MemberDto(String username, int age) {
    this.username = username;
    this.age = age;
}

QueryDSL의 반환 DTO 어노테이션

@Getter
@Builder
@NoArgsConstructor

return type 예시

queryFactory
    .select(new QMemberDto(member.username, member.age))
    .from(member)
    .fetch();

ETC

쿼리 작성 시

• 복잡한 join이 필요한 경우 or 가독성이 떨어지는 쿼리 -> QueryDSL 사용
• 그 외의 경우 -> @Query 어노테이션 또는 JPARepository 사용

다른 도메인의 기능이 필요한 경우

Service 내에서 다른 도메인의 Service 참조

@Configuration

@EnableJpaAuditing, @EnableWebMvc 등 Configuration 관련 어노테이션은 메인 어플리케이션이 아닌 따로 Configuration 파일을 생성해 관리

example

@Configuration
@EnableJpaAuditing
public class JpaConfig {
}

REST Docs

기본

• {도메인}/{메서드}/{성공 OR 실패}/{실패 원인} 형식 사용
• camelCase 적용

{도메인}/{메서드}/{성공 OR 실패}/{실패 원인}

ex)
auth/#/success
auth/#/fail/emptyEmail (회원가입 시 이메일이 공백인 경우)

메서드명

Controller 내의 Method를 따름

• 회원가입 : signIn
• 로그인 : #
• 목록 조회 유형 : list
• 단일 상세 조회 : detail
• 등록/수정/삭제 가 동시에 일어나는 유형 : save
• 등록만 하는 유형 : add
• 수정 : modify
• 삭제 : remove

실패 원인

• 없는 값 : emptyXxx
• 잘못된 값 : invalidXxx
• 인증 실패 : unauthorizedMember
• 자격 없음 : forbiddenMember

도메인명으로 설명이 부족한 경우 (ex. 마이페이지, 답글)

• 도메인에서 한 단계 더 추가
• ex) member/mypage/detail/success
• ex) comment/reComment/add/success