엔티티, 공통 응답 정의

[kim-kiwon]

작업내용

엔티티 정의

• BaseTimeEntity
  • 모든 엔티티가 공동 상속함.
  • createAt과 updatedAt 가짐
  • JpaAuditing 을 통해 해당 객체가 생성 / 수정되면 JPA가 createdAt / updatedAt 필드를 자동으로 갱신하도록 설정
• 일반 엔티티
  • DB 설계에 맞춰 Dish/DishIngerdient 등 Entity들 정의
• 특이사항
  • 엔티티에는 wrapper 타입을 써야함.
  • DB는 null이 가능한데, 기본 타입은 null이 들어올 수 없기 때문

JPA 설정 추가

• local
  • ddl-auto
  • 테이블을 JPA 설정으로 자동 생성하도록 함
  • show-sql / format_sql
  • 실행되는 sql을 포맷화하여 출력하도록 함
• real
  • ddl-auto
  • 직접 DB에 생성해두었으므로 DDL 사용X

공통 응답/예외 정의

• ApiResult
  • ApiResponse 는 SpringDoc 의 어노테이션 명과 중첩됨
  • success, businessCode, result, errorMsg 가짐
• ResponseType
  • 비즈니스적으로 정의해둔 응답 enum
  • status 와 businessCode 를 가짐
• 비즈니스 예외처리
  • 의도한 비즈니스 예외의 경우 예외마다 ResponseType 을 부여한다.
  • ex) 중복 데이터 삽입 / 검증 실패 등
  • ResponseType 을 활용해 status와 businessCode 를 추출해 응답을 생성한다.
• 응답 null 필드 제외
  • 응답에 null 필드를 제외시킨다.
  • Jackson <-> Object 변환을 담당하는 Jackson2ObjectMapper 빈을 커스텀하여. 모든 응답에 대해 Include.NON_NULL 을 추가하였다.

Plugin DSL

• gradle 에서 plugin 을 import 할때 쉽게 사용하게 해주는 문법
• Plugin DSL 사용하도록 수정

  pluings {
  id 'org.springframework.boot' version '3.0.6'
  }

Swagger 설정

• SpringFox vs SpringDocs
  • SpringFox 는 마지막 개발이 3년전.
  • 현재 스프링 버전 호환을 위해서는 추가설정이 필요함.
• 지속해서 유지보수 되고있는 SpringDocs 선택