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

📌 사용자 정의 리포지토리 구현

• 스프링 데이터 JPA 리포지토리는 인터페이스만 정의하고 구현체는 스프링이 자동 생성
• 스프링 데이터 JPA가 제공하는 인터페이스를 직접 구현하면 구현해야 하는 기능이 너무 많음
• 다양한 이유로 인터페이스의 메서드를 직접 구현하고 싶다면?
  • JPA 직접 사용( EntityManager )
  • 스프링 JDBC Template 사용
  • MyBatis 사용
  • 데이터베이스 커넥션 직접 사용 등등...
  • Querydsl 사용

 

 

📌 사용자 정의 인터페이스

public interface MemberRepositoryCustom {

    List<Member> findMemberCustom();
}

 

 

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

package study.datajpa.repository;

import jakarta.persistence.EntityManager;
import lombok.RequiredArgsConstructor;

import java.lang.reflect.Member;
import java.util.List;

@RequiredArgsConstructor
public class MemberRepositoryCustomImpl implements MemberRepositoryCustom{

    private final EntityManager em;

    @Override
    public List<Member> findMemberCustom(){
        return em.createQuery("select m from Member m").getResultList();
    }
}

 

 

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

public interface MemberRepository extends JpaRepository<Member, Long>, MemberRepositoryCustom {}

 

 

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

List<Member> result = memberRepository.findMemberCustom();

 

 

⚡ 사용자 정의 구현 클래스

• 규칙: 리포지토리 인터페이스 이름 + Impl
  • Impl 대신 다른 이름으로 변경하고 싶으면?
• 스프링 데이터 JPA가 인식해서 스프링 빈으로 등록

 

 

XML 설정

<repositories base-package="study.datajpa.repository" repository-impl-postfix="Impl" />

 

 

JavaConfig 설정

@EnableJpaRepositories(basePackages = "study.datajpa.repository", repositoryImplementationPostfix = "Impl")

 

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

 

cf) 항상 사용자 정의 리포지토리가 필요한 것은 아님
➡ 그냥 임의의 리포지토리를 만들어도 됨 !
ex) MemberQueryRepository를 인터페이스가 아닌 클래스로 만들고 스프링 빈으로 등록해서 그냥 직접 사용해도 됨
➡ 스프링 데이터 JPA와는 아무런 관계 없이 별도로 동작

 

 

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

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

 

ex) MemberRepositoryImpl 대신에 MemberRepositoryCustomImpl 같이 구현해도 됨

 

최신 사용자 정의 인터페이스 구현 클래스 예제

@RequiredArgsConstructor
public class MemberRepositoryCustomImpl implements MemberRepositoryCustom {

    private final EntityManager em;

    @Override
    public List<Member> findMemberCustom() {
        return em.createQuery("select m from Member m")
                .getResultList();
    } 
}

• 기존 방식보다 이 방식이 사용자 정의 인터페이스 이름과 구현 클래스 이름이 비슷하므로 더 직관적
• 여러 인터페이스를 분리해서 구현하는 것도 가능하기 때문에 새롭게 변경된 이 방식을 사용하는 것을 더 권장

 

 

📌 Auditing

• 엔티티를 생성, 변경할 때 변경한 사람과 시간을 추적하고 싶다면
  • 등록일
  • 수정일
  • 등록자
  • 수정자

 

⚡ 순수 JPA 사용

package study.datajpa.entity;

import jakarta.persistence.Column;
import jakarta.persistence.MappedSuperclass;
import jakarta.persistence.PrePersist;
import jakarta.persistence.PreUpdate;
import lombok.Getter;

import java.time.LocalDateTime;

@MappedSuperclass
@Getter
public class JpaBaseEntity {

    @Column(updatable = false)
    private LocalDateTime createdDate;
    private LocalDateTime updatedDate;

    @PrePersist
    public void prePersist(){
        LocalDateTime now = LocalDateTime.now();
        createdDate = now;
        updatedDate = now;
    }

    @PreUpdate
    private void preUpdate(){
        updatedDate = LocalDateTime.now();
    }
}

public class Member extends JpaBaseEntity {}

 

확인 코드

    @Test
    public void jpaEventBaseEntity() throws Exception{
        //given
        Member member = new Member("member1");
        memberRepository.save(member); //@PrePersist

        Thread.sleep(100);
        member.setUsername("member2");

        em.flush();
        em.clear();

        //when
        Member findMember = memberRepository.findById(member.getId()).get();

        //then

        System.out.println("findMember.createdDate = " + findMember.getCreatedDate());
        System.out.println("findMember.updatedDate = " + findMember.getUpdatedDate());

    }

 

JPA 주요 이벤트 어노테이션

• @PrePersist, @PostPersist
• @PreUpdate, @PostUpdate

 

 

⚡ 스프링 데이터 JPA 사용

설정

• @EnableJpaAuditing -> 스프링 부트 설정 클래스에 적용해야함
• @EntityListeners(AuditingEntityListener.class) -> 엔티티에 적용

사용 어노테이션

• @CreatedDate
• @LastModifiedDate
• @CreatedBy
• @LastModifiedBy

 

 

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

package study.datajpa.entity;

import jakarta.persistence.Column;
import jakarta.persistence.EntityListeners;
import jakarta.persistence.MappedSuperclass;
import lombok.Getter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

import java.time.LocalDateTime;

@EntityListeners(AuditingEntityListener.class)
@MappedSuperclass
@Getter
public class BaseEntity {

    @CreatedDate
    @Column(updatable = false)
    private LocalDateTime createdDate;

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;
}

• 등록자, 수정자를 처리해주는 AuditorAware 스프링 빈 등록

@CreatedBy
@Column(updatable = false)
private String createdBy;

@LastModifiedBy
private String lastModifiedBy;

❗주의 :  DataJpaApplication 에 @EnableJpaAuditing 도 함께 등록해야 함

• 실무에서는 세션 정보나, 스프링 시큐리티 로그인 정보에서 ID를 받음

cf) 실무에서 대부분의 엔티티는 등록시간, 수정시간이 필요하지만, 등록자, 수정자는 없을 수도 있음
➡ Base 타입을 분리하고, 원하는 타입을 선택해서 상속

 

 

package study.datajpa;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.domain.AuditorAware;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

import java.util.Optional;
import java.util.UUID;

@EnableJpaAuditing
@SpringBootApplication
public class DataJpaApplication {

    public static void main(String[] args) {
        SpringApplication.run(DataJpaApplication.class, args);
    }

    @Bean 
    public AuditorAware<String> autitorProvider(){
        return ()-> Optional.of(UUID.randomUUID().toString());
    }
}

cf) 저장시점에 등록일, 등록자는 물론이고, 수정일, 수정자도 같은 데이터가 저장
➡ 데이터가 중복 저장되는 것 같지만, 이렇게 해두면 변경 컬럼만 확인해도 마지막에 업데이트한 유저를 확인 할 수 있으므로 유지보수 관점 에서 편리
➡ 이렇게 하지 않으면 변경 컬럼이 null 일때 등록 컬럼을 또 찾아야 함

• 참고로 저장시점에 저장데이터만 입력하고 싶으면 @EnableJpaAuditing(modifyOnCreate = false) 옵션을 사용

 

 

⚡ 전체 적용

• @EntityListeners(AuditingEntityListener.class) 를 생략하고 스프링 데이터 JPA 가 제공하는 이벤트를 엔티티 전체에 적용하려면 orm.xml에 다음과 같이 등록

<?xml version="1.0" encoding="UTF-8"?>
<entity-mappings xmlns="http://xmlns.jcp.org/xml/ns/persistence/orm"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence/orm
 http://xmlns.jcp.org/xml/ns/persistence/orm_2_2.xsd" version="2.2">
     <persistence-unit-metadata>
         <persistence-unit-defaults>
             <entity-listeners>
                 <entity-listener class="org.springframework.data.jpa.domain.support.AuditingEntityListener"/>
            </entity-listeners>
        </persistence-unit-defaults>
    </persistence-unit-metadata>
</entity-mappings>

반응형

 

 

📌 Web 확장 - 도메인 클래스 컨버터

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

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

@RestController
@RequiredArgsConstructor
public class MemberController {
    private final MemberRepository memberRepository;
    @GetMapping("/members/{id}")
    public String findMember(@PathVariable("id") Long id) {
        Member member = memberRepository.findById(id).get();
        return member.getUsername();
    }
}

 

 

⚡ 도메인 클래스 컨버터 사용 후

@RestController
@RequiredArgsConstructor
public class MemberController {
    private final MemberRepository memberRepository;
    @GetMapping("/members/{id}")
    public String findMember(@PathVariable("id") Member member) {
        return member.getUsername();
    }
}

• HTTP 요청은 회원 id 를 받지만 도메인 클래스 컨버터가 중간에 동작해서 회원 엔티티 객체를 반환
• 도메인 클래스 컨버터도 리파지토리를 사용해서 엔티티를 찾음

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

➡ 트랜잭션이 없는 범위에서 엔티티를 조회했으므로, 엔티티를 변경해도 DB에 반영되지 않음

 

 

📌 Web 확장 - 페이징과 정렬

• 스프링 데이터가 제공하는 페이징과 정렬 기능을 스프링 MVC에서 편리하게 사용 가능

페이징과 정렬 예제

    @GetMapping("/members")
    public Page<Member> list(Pageable pageable){
        Page<Member> page = memberRepository.findAll(pageable);
        return page;
    }

• 파라미터로 Pageable 을 받을 수 있음
• Pageable 은 인터페이스, 실제는 org.springframework.data.domain.PageRequest 객체 생성

 

 

⚡ 요청 파라미터

• ex) /members?page=0&size=3&sort=id,desc&sort=username,desc
• page: 현재 페이지, 0부터 시작
• size: 한 페이지에 노출할 데이터 건수
• sort: 정렬 조건을 정의
  • ex) 정렬 속성,정렬 속성...(ASC | DESC), 정렬 방향을 변경하고 싶으면 sort 파라 미터 추가 ( asc 생략 가능)

 

 

기본값

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

```yml
spring:
  data:
    web:
      pageable:
        default-page-size: 20 # 기본 페이지 사이즈
        max-page-size: 20000 # 최대 페이지 사이즈

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

 

 @GetMapping("/members")
    public Page<Member> list(@PageableDefault(size = 12, sort = "username", direction = Sort.Direction.DESC) Pageable pageable){
        Page<Member> page = memberRepository.findAll(pageable);
        return page;
    }

접두사

• 페이징 정보가 둘 이상이면 접두사로 구분
• @Qualifier 에 접두사명 추가 "{접두사명}_xxx"
• ex) /members?member_page=0&order_page=1

 public String list(
    @Qualifier("member") Pageable memberPageable,
    @Qualifier("order") Pageable orderPageable, ...

 

 

⚡ Page 내용을 DTO로 변환

• 엔티티를 API로 노출하면 다양한 문제가 발생
  • 엔티티를 꼭 DTO로 변환해서 반환
• Page는 map() 을 지원해서 내부 데이터를 다른 것으로 변경 가능

 

MemberDTO

 @Data
 public class MemberDto {
     private Long id;
     private String username;
     public MemberDto(Member m) {
         this.id = m.getId();
         this.username = m.getUsername();
    }
}

 

 

Page.map() 사용

    @GetMapping("/members")
    public Page<MemberDto> list(Pageable pageable){
        Page<Member> page = memberRepository.findAll(pageable);
        Page<MemberDto> pageDto = page.map(MemberDto::new);
        return pageDto;
    }

 

 

Page.map() 코드 최적화

    @GetMapping("/members")
    public Page<MemberDto> list(Pageable pageable){
        return memberRepository.findAll(pageable).map(MemberDto::new);
    }

 

 

⚡ Page를 1부터 시작하기

• 스프링 데이터는 Page를 0부터 시작
• 만약 1부터 시작하려면?
  • 1. Pageable, Page를 파리미터와 응답 값으로 사용히지 않고, 직접 클래스를 만들어서 처리
       • 직접 PageRequest(Pageable 구현체)를 생성해서 리포지토리에 넘김
       • 물론 응답값도 Page 대신에 직접 만들어서 제공해야 함 (ex. MyPage 같은걸 만들어서 사용)
       • PageRequest.of(1,2)
  • 2. spring.data.web.pageable.one-indexed-parameters 를 true 로 설정
       • 이 방법은 web에서 page 파라미터를 -1 처리 할 뿐
    3. 응답값인 Page 에 모두 0 페이지 인덱스를 사용하는 한계가 있음

one-indexed-parameters Page 1요청 ( http://localhost:8080/members?page=1 )

 

{
    "content": [
    ...
    ],
    "pageable": {
        "offset": 0,
        "pageSize": 10, 
          "pageNumber": 0 //0 인덱스
    },
    "number": 0, //0 인덱스 
    "empty": false
}

➡ 한계 발생
➡ 권장은 0부터 사용

 

 

 

김영한님의 <실전! 스프링 데이터 JPA>을 수강하고 작성한 글입니다

 

 

 

 

---

PREV

[스프링 데이터 JPA] 4. 쿼리 메소드 기능

NEXT

[스프링 데이터 JPA] 6. 스프링 데이터 JPA 분석