[배성준] sprint6

[seongjuun]

기본 요구사항

데이터베이스

• 아래와 같이 데이터베이스 환경을 설정하세요.
  • 데이터베이스: discodeit
  • 유저: discodeit_user
  • 패스워드: discodeit1234
• ERD를 참고하여 DDL을 작성하고, 테이블을 생성하세요.

Spring Data JPA 적용하기

• Spring Data JPA와 PostgreSQL을 위한 의존성을 추가하세요.
• 앞서 구성한 데이터베이스에 연결하기 위한 설정값을 application.yaml 파일에 작성하세요.
• 디버깅을 위해 SQL 로그와 관련된 설정값을 application.yaml 파일에 작성하세요.

엔티티 정의하기

• 클래스 다이어그램을 참고해 도메인 모델의 공통 속성을 추상 클래스로 정의하고 상속 관계를 구현하세요.
• JPA의 어노테이션을 활용해 createdAt, updatedAt 속성이 자동으로 설정되도록 구현하세요.
  • @CreatedDate, @LastModifiedDate
• 클래스 다이어그램을 참고해 클래스 참조 관계를 수정하세요. 필요한 경우 생성자, update 메소드를 수정할 수 있습니다. 단, 아직 JPA Entity와 관련된 어노테이션은 작성하지 마세요.
  • 화살표의 방향과 화살표 유무에 유의하세요.
• ERD와 클래스 다이어그램을 토대로 연관관계 매핑 정보를 표로 정리해보세요.(이 내용은 PR에 첨부해주세요.)

엔티티 관계	다중성	방향성	부모-자식 관계	연관관계의 주인
User:ReadStatus	1:N	User→ReadStatus 단방향	부모: User, 자식: ReadStatus	User
User:UserStatus	1:1	User↔UserStatus 단방향	부모: User, 자식: USerStatus	User
User:Message	1:N	User→Message 단방향	부모: User, 자식: Message	User
User:BinaryContent	1:0,1	User→BinaryContent 단방향	부모: User, 자식: BinaryContent	User
Channel:ReadStatus	1:N	Channel→ReadStatus 단방향	부모: Channel, 자식: ReadStatus	Channel
Channel:Message	1:N	Channel→Message 단방향	부모: Channel, 자식: Message	Channel
Message:BinaryContent	1:N	Message→BinaryContent 단방향	부모: Message, 자식: BinaryContent	Message

• JPA 주요 어노테이션을 활용해 ERD, 연관관계 매핑 정보를 도메인 모델에 반영해보세요.
  • @Entity, @Table
  • @Column, @Enumerated
  • @OneToMany, @OneToOne, @ManyToOne
  • @JoinColumn, @JoinTable
• ERD의 외래키 제약 조건과 연관관계 매핑 정보의 부모-자식 관계를 고려해 영속성 전이와 고아 객체를 정의하세요.
  • cascade, orphanRemoval

레포지토리와 서비스에 JPA 도입하기

• 기존의 Repository 인터페이스를 JPARepository로 정의하고 쿼리메소드로 대체하세요.
  • FileRepository와 JCFRepository 구현체는 삭제합니다.
• 영속성 컨텍스트의 특징에 맞추어 서비스 레이어를 수정해보세요.
  • 힌트: 트랜잭션, 영속성 전이, 변경 감지, 지연로딩

DTO 적극 도입하기

• Entity를 Controller 까지 그대로 노출했을 때 발생할 수 있는 문제점에 대해 정리해보세요. DTO를 적극 도입했을 때 보일러플레이트 코드가 많아지지만, 그럼에도 불구하고 어떤 이점이 있는지 알 수 있을거에요.(이 내용은 PR에 첨부해주세요.)
  • 힌트
    • Entity와 API의 결합
    • 프로덕션 환경에서는 성능을 고려해 OSIV를 false로 설정하는 경우가 대부분
    • 양방향 연관관계 시 순환 참조
    • 민감한 데이터
• 다음의 클래스 다이어그램을 참고하여 DTO를 정의하세요.
• Entity를 DTO로 매핑하는 로직을 책임지는 Mapper 컴포넌트를 정의해 반복되는 코드를 줄여보세요.

BinaryContent 저장 로직 고도화

• BinaryContent 엔티티는 파일의 메타 정보(fileName, size, contentType)만 표현하도록 bytes 속성을 제거하세요.
• BinaryContent의 byte[] 데이터 저장을 담당하는 인터페이스를 설계하세요.
  • BinaryContentStorage
    • 바이너리 데이터의 저장/로드를 담당하는 컴포넌트입니다.
    • UUID put(UUID, byte[])
      • UUID 키 정보를 바탕으로 byte[] 데이터를 저장합니다.
      • UUID는 BinaryContent의 Id 입니다.
    • InputStream get(UUID)
      • 키 정보를 바탕으로 byte[] 데이터를 읽어 InputStream 타입으로 반환합니다.
      • UUID는 BinaryContent의 Id 입니다.
    • ResponseEntity<?> download(BinaryContentDto)
      • HTTP API로 다운로드 기능을 제공합니다.
      • BinaryContentDto 정보를 바탕으로 파일을 다운로드할 수 있는 응답을 반환합니다.
• 서비스 레이어에서 기존에 BinaryContent를 저장하던 로직을 BinaryContentStorage를 활용하도록 리팩토링하세요.
• BinaryContentController에 파일을 다운로드하는 API를 추가하고, BinaryContentStorage에 로직을 위임하세요.
• 로컬 디스크 저장 방식으로 BinaryContentStorage 구현체를 구현하세요.
  • 클래스 다이어그램
• discodeit.storage.type 값이 local 인 경우에만 Bean으로 등록되어야 합니다.

페이징과 정렬

• 메시지 목록을 조회할 때 다음의 조건에 따라 페이지네이션 처리를 해보세요.
  • 50개씩 최근 메시지 순으로 조회합니다.
  • 총 메시지가 몇개인지 알 필요는 없습니다.
• 일관된 페이지네이션 응답을 위해 제네릭을 활용해 DTO로 구현하세요.
• Slice 또는 Page 객체로부터 DTO를 생성하는 Mapper를 구현하세요.
  • 확장성을 위해 제네릭 메소드로 구현하세요.

심화 요구사항

N+1 문제

• N+1 문제가 발생하는 쿼리를 찾고 해결해보세요.

읽기전용 트랜잭션 활용

• 프로덕션 환경에서는 OSIV를 비활성화하는 경우가 많아요.
  이때 서비스 레이어의 조회 메소드에서 발생할 수 있는 문제를 식별하고,
  읽기 전용 트랜잭션을 활용해 문제를 해결해보세요.

OSIV 비활성화하기

spring:
  jpa:
    open-in-view: false

페이지네이션 최적화

• 오프셋 페이지네이션과 커서 페이지네이션 방식의 차이에 대해 정리해보세요.

오프셋 페이지네이션
- 오프셋 페이지네이션은 LIMIT과 OFFSET을 사용해 데이터를 건너뛰고 원하는 부분만 가져오는 방식입니다. 데이터가 많아질수록 성능이 낮아집니다.

커서 페이지네이션
- 커서 페이지네이션은 마지막으로 받은 데이터의 커서를 기준으로 그 다음 데이터를 가져오는 방식입니다. 순차적으로 데이터를 가져오기때문에 특정 부분만 가져오기 힘듭니다.

• 기존에 구현한 오프셋 페이지네이션을 커서 페이지네이션으로 리팩토링하세요.
• Entity와 DTO를 매핑하는 보일러플레이트 코드를 MapStruct 라이브러리를 활용해 간소화해보세요.