4. 확장 기능

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

---

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

그렇다고 스프링 데이터 JPA가 제공하는 인터페이스를 모두 구현하는 것은 불가능에 가깝다.

 

다양한 이유로 인터페이스의 메서드를 직접 구현하고 싶다면 어떻게 해야할까?

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

 

 

사용자 정의 인터페이스

public interface MemberRepositoryCustom {
	List<Member> findMemberCustom();
}

 

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

@RequiredArgsConstructor
public class MemberRepositoryImpl implements MemberRepositoryCustom {

    private final EntityManager em;

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

 

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

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

 

사용자 정의 구현 클래스

• (중요!) 규칙: 리포지토리 인터페이스 이름 + Impl
• 이렇게 해야 스프링 데이터 JPA가 인식해서 스프링 빈으로 등록해준다.

※ 참고

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

※ 중요

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

 

 

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

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

예를 들어서 위 예제의 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 사용

우선 등록일, 수정일 적용

@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
    public void preUpdate() {
        updatedDate = LocalDateTime.now();
    }
}

 

테스트

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

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

    em.flush(); // @PreUpdate
    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 java.time.LocalDateTime;
import javax.persistence.Column;
import javax.persistence.EntityListeners;
import javax.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;

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

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

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;
}

 

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

 

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

/* 등록자 수정자가 config 클래스의 Bean에서 주입된다. */
@Bean
public AuditorAware<String> auditorAware(){
    return () -> Optional.of(UUID.randomUUID().toString());
}

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

 

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

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

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;

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

    @LastModifiedBy
    private String lastModifiedBy;
}

 

 

등록일과 수정일, 등록자와 수정자를 분리해서 쓰고싶다면?

• 실무에서는 엔티티마다 특성이 다르기 때문에 어떤 엔티티는 등록일,수정일만 쓰고싶은 경우가있고, 등록자와 수정자까지 쓰고싶은 경우도 있다.
• 이럴 경우 두 속성을 분리해서 상속받아 쓰게끔하면 해결된다.

public class BaseTimeEntity {

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

public class BaseEntity extends BaseTimeEntity {

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

※ 참고

저장시점에 등록일, 등록자는 물론이고, 수정일, 수정자도 같은 데이터가 저장된다. 데이터가 중복 저장되는 것 같지만, 이렇게 해두면 변경 컬럼만 확인해도 마지막에 업데이트한 유저를 확인 할 수 있으므로 유지보수 관점에서 편리하다. 이렇게 하지 않으면 변경 컬럼이 null 일때 등록 컬럼을 또 찾아야 한다.
참고로 저장시점에 저장데이터만 입력하고 싶으면 @EnableJpaAuditing(modifyOnCreate = false) 옵션을 사용하면 된다.

 

 

 

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();
    }
}

• 기존에는 파라미터로 아이디를 받으면 해당 아이디를 리포지토리를 이용해 DB에서 엔티티를 조회했다.

 

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

@RestController
@RequiredArgsConstructor
public class MemberController {

    private final MemberRepository memberRepository;

    @GetMapping("/members2/{id}")
    public String findMember2(@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 객체를 스프링 데이터 JPA가 생성하여 주입해준다.

 

요청 파라미터

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

 

기본값

글로벌 설정: 스프링 부트

spring.data.web.pageable.default-page-size=20 /# 기본 페이지 사이즈/
spring.data.web.pageable.max-page-size=2000 /# 최대 페이지 사이즈/

 

개별 설정

• @PageableDefault 사용

@RequestMapping(value = "/members_page", method = RequestMethod.GET) 
public String list(@PageableDefault(size = 12, sort = “username”,direction = Sort.Direction.DESC) Pageable pageable) {
  ...
}

 

 

접두사

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

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

 

 

Page 내용을 DTO로 변환하기

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

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

 

 

Page를 1부터 시작하기

스프링 데이터는 Page를 0부터 시작한다.

만약 1부터 시작하려면?

 

1부터 시작하는 방법은 크게 2가지가 있다.

1. Pageable, Page를 파라미터와 응답 값으로 사용하지 않고, 직접 클래스를 만들어서 처리한다. 그리고 직접 PageRequest(Pageable 구현체)를 생성해서 리포지토리에 넘긴다.
   물론 응답값도 Page 대신 직접 만들어서 제공해야 한다.
   
   
2. spring.data.web.pageable.one-indexed-parameters 를 true 로 설정한다.
   → 이 방법은 web에서 page 파라미터를 -1 처리 할 뿐이다. 그래서 응답값인 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
}

※ 참고

가급적이면 Page는 0부터 시작하도록 하는게 제일 깔끔하다.
그러나 1부터 시작해달라고 요청을 받는다면 위의 1번 방법이 차선책일 것이다.