[스프링 데이터 JPA] 5. 확장 기능

 

1️⃣ 사용자 정의 리포지토리 구현 

스프링 데이터 JPA  리포지토리는 인터페이스만 정의하고 구현체는 스프링이 자동 생성한다. 

따라서 이제 스프링 데이터 JPA가 제공하는 인터페이스를 직접 구현하려고 하면 구현해야 하는 기능들이 너무 많아 다 구현하기가 힘들다. 

 

다양한 이유로 인터페이스의 메서드를 직접 구현하고 싶다면..??

- JPA 직접 사용(EntityManager)
- 스프링 JDBC Template 사용 
- MyBatis 사용 
- 데이터베이스 커넥션 직접 사용 등등..
- Querydsl 사용 

 

사용자 정의 인터페이스

MemberRepositoryCustom

 

사용자 정의 인터페이스 구현 클래스 

MemberRepositoryImpl

 

사용자 정의 인터페이스 상속

MemberRepository

그리고 이제 MemberRepository에서 사용자 정의 인터페이스인 MemberRepositoryCustom을 상속 받아서 사용하면 된다. 

 

 

사용자 정의 메서드 호출 코드

MemberRepositoryTest

 

 

❗ 사용자 정의 구현 클래스 

규칙: 리포지토리 인터페이스 이름 + Impl

-> 스프링 데이터 JPA가 인식해서 스프링 빈으로 등록 

 

😎 사용자 정의 리포지토리 구현 최신 방식 

스프링 데이터 2.X 부터는 사용자 정의 구현 클래스에 리포지토리 인터페이스 이름 + Impl 을 적용하는 대신에 

사용자 정의 인터페이스명 + Impl방식도 지원한다. 

예를 들어서 MemberRepositoryImpl 대신에 MemberRepositoryCustomImpl 로 같이 구현해도 된다. 

 

-> 기존 방식보다 이 방식이 사용자 정의 인터페이스 이름과 구현 클래스 이름이 비슷하므로 더 직관적인 편이다.

추가로 여러 인터페이스를 분리해서 구현하는 것도 가능하기 때문에 새롭게 변경된 사용자 정의 인터페이스명 + Impl 방식을 사용할 것을 더 권장한다. 

 

 

⭐ 참고

실무에서는 주로 QueryDSL이나 SpringJdbcTemplate을 함께 사용할 때 사용자 정의 리포지토리 기능을 자주 사용한다. 

 

 

❗ 참고: 항상 사용자 정의 리포지토리가 필요한 것은 아니다. 

그냥 임의의 리포지토리를 만들어도 된다. 예를 들어 MemberQueryRepository를 인터페이스가 아닌 클래스를 만들고 스프링 빈으로 등록해서 그냥 직접 사용해도 된다. 물론 이런 경우에는 스프링 데이터 JPA와는 아무런 관계 없이 별도로 동작한다. 

 

 

 

2️⃣ Auditing

 

❓ 엔티티를 생성하고 변경할 때 변경한 사람과 시간을 추적하고 싶다면? 

- 등록일 

- 수정일 

- 등록자

- 수정자 

 

 

순수 JPA 사용 

: 등록일, 수정일 적용 

JpaBaseEntity

등록일이나 수정일 같은 경우에는 보통 대부분 테이블에 들어가는 것이 유지보수성에도 훨씬 좋다.

왜냐하면 누가 언제 변경했거나 등록했는지를 알아야지 문제 파악도 되기 때문이다. 

 

그러므로 공통 데이터를 따로 클래스로 생성해서 @MappedSuperclass를 하고 이 클래스를 상속받으면 해당 엔티티에 이 데이터들을 포함해서 테이블을 생성한다. 

즉, BaseEntity는 테이블이 아니라 그냥 공통 데이터이다. 

 

 

Member

-> Member 엔티티에 BaseEntity를 추가해줬다. 

 

MemberTest

JPA 주요 이벤트 어노테이션 

@PrePersist, @PostPersist 

@PreUpdate, @PostUpdate 

 

 

스프링 데이터 JPA 사용

-설정

스프링 부트 설정 클래스에 @EnableJpaAuditng을 설정해줘야 한다. 

-> 그리고 엔티티에 @EntityListeners(AuditingEntityListener.class)를 추가해준다. 

 

 

사용 어노테이션

@CreatedDate

@LastModifiedDate

@CreatedBy

@LastModifiedBy

-> 스프링 데이터 Auditing 적용 : 등록일, 수정일, 등록자, 수정자 

이때 등록일과 등록자는 최초 등록일이랑 등록자니까 혹시 수정될 것을 방지해서 @Column(updatable = false)로 지정해준다. 

 

그리고 지금 등록자와 수정자는 아이디가 없기 때문에 UUID로 랜덤값으로 등록자와 수정자를 처리해주는 AuditorAware 스프링 빈으로 등록해준다.

 

❗ 실무에서는 세션 정보나, 스프링 시큐리티 로그인 정보에서 id 를 받아서 넣어주면 된다. 

 

MemberTest

 

⭐ 참고

실무에서 대부분의 엔티티는 등록시간, 수정시간이 필요하지만, 등록자, 수정자는 없을 수도 있다. 

그래서 다음과 같이 Base 타입을 분리하고, 원하는 타입을 선택해서 상속한다. 

-> 이렇게 따로 분리해둔 다음에 수정자, 등록자가 필요한 경우에만 이걸 상속해서 사용해주면 된다. 

 

 

❗ 참고 

저장 시점에 등록일, 등록자는 물론이고, 수정일, 수정자도 같은 데이터가 저장된다. 

데이터가 중복 저장되는 것 같지만, 이렇게 해두면 변경 컬럼만 확인해도 마지막에 업데이트한 유저를 확인할 수 있으므로 유지보수 관점에서 편리하다. 

이렇게 안하면 변경 컬럼이 null 일 때 등록 컬럼을 또 찾아야 한다. 

참고로 저장 시점에 그냥 저장 데이터만 입력하고 싶으면 @EnableAuditing(modifyOnCreate = false) 옵션을 사용하면 된다. 

 

 

 

3️⃣ Web 확장 - 도메인 클래스 컨버터

: HTTP 파라미터로 넘어온 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩 

 

도메인 클래스 컨버터 사용 전

MemberController

 

도메인 클래스 컨버터 사용 전

MemberController

HTTP 요청은 회원 id를 받지만, 도메인 컨버터가 중간에 동작해서 회원 엔티티 객체를 반환한다. 

memberRepository.find(Member.class, id) 이런 거 없어도 알아서 동작한다..!!

도메인 클래스 컨버터도 리파지토리를 사용해서 엔티티를 찾기는 한다. 

 

❗ 주의 

도메인 클래스 컨버터로 엔티티를 파라미터로 받으면, 이 엔티티는 단순 조회용으로만 사용해야 한다~!!!!!!

(트랜잭션이 없는 범위로 엔티티를 조회했기 때문에 엔티티를 변경해도 DB에 변경되지 않기 때문이다.) 

그리고 이거 사용 권장 안함 

 

 

4️⃣ Web 확장 - 페이징과 정렬 

: 스프링 데이터가 제공하는 페이징과 정렬 기능을 스프링 MVC에서 편리하게 사용할 수 있다. 

 

페이징과 정렬 예제 

MemberController

파라미터로 Pageable을 받을 수 있다. 

Pageable 은 인터페이스로 실제는 org.springframework.data.domain.PageRequest 객체 생성 

 

요청 파라미터 

예) /members?page=0&size=3&sort=username,desc 

page : 현재 페이지, 0부터 시작 

size: 한 페이지에 노출할 데이터 건수

sort: 정렬 조건을 정의한다. 예) 정렬 속성 asc , 정렬 방향을 변경하고 싶으면 sort 파라미터 추가 

Pageable이 기본 제공하는 것

 

기본 값 설정하는 방법

- 글로벌 설정 : 스프링부트

default-page-size : 기본 페이지 사이즈 

max-page-size : 최대 페이지 사이즈 

 

- 개별 설정 : @PageableDefault 어노테이션 사용 

 

 

Page 내용을 DTO로 변환하기

엔티티를 API로 직접 노출하는 건 좋지 않다. 

왜냐하면 엔티티가 변경되면 API 스펙이 변경되는 것이기도 하고, 전략이 노출되는 것?이기 때문에 엔티티를 직접 노출하는 것은 하지 않는 것이 좋다. 

-> 그래서 엔티티를 꼭 DTO로 변환해서 반환해야 한다. 

Page는 map()을 지원해서 내부 데이터를 다른 것으로 변경할 수 있다. 

 

 

MemberDto

 

 

⭐ Page 사용할 때 주의할 점으로는 우선 스프링 데이터는 Page를 0부터 시작한다!! 

만약 Page를 1부터 시작하고 싶다면..?

 

1. Pageable, Page를 파라미터와 응답값으로 사용하지 않고, 직접 클래스를 만들어서 처리한다. 

그리고 직접 PageRequest(Pageable 구현체)를 생성해서 리포지토리에 넘긴다. 

물론 응답값도 Page 대신에 직접 만들어서 제공해야 한다. 

 

2. spring.data.web.pageable.one-indexed-parameters 를 true로 설정해주면 된다. 

근데 이 방법은 web에서 page 파라미터를 -1할 뿐으로, 따라서 응답값인 Page에 모두 0 페이지 인덱스를 사용하는 한계가 있다. 

 

그냥 제일 좋은 방법은 있는대로 사용하는게...