[JPA] Spring Data JPA - 확장 기능

쿼리 메소드 기능에 이어 추가적인 확장 기능(사용자 정의 리포지토리 구현, Auditing)에 대해 알아봅시다.

---

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

스프링 데이터 JPA로 리포지토리 개발 시 인터페이스만 정의하고, 구현체는 만들지 않습니다.

하지만 여러가지 이유로 메소드를 직접 구현해야 할 때가 있습니다.

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

그렇다고 직접 리포지토리 구현체를 만들자니 인터페이스가 제공하는 기능까지 모두 구현해야 하는데, 이런 문제를 우회해서 필요한 메소드만 구현할 수 있는 방법을 제공합니다.

 

1. 구현하고 싶은 메소드를 인터페이스 레벨에 선언

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

2. 구현체에 선언 메소드 Override

@RequiredArgsConstructor
public class MemberRepositoryCustomImpl implements MemberRepositoryCustom{

    private final EntityManager em;

    @Override
    public List<Member> findMemberCustom(String name) {
        return em.createQuery("select m from Member m where m.name like CONCAT('%',:name,'%')")
                .setParameter("name",name)
                .getResultList();
    }
}

 

규칙. 이 때 반드시 구현체 이름은 사용자 지정 인터페이스 이름 + "Impl" 로 지정해야 합니다.

(스프링 데이터 JPA Impl을 인식해서 스프링 빈으로 구현체를 등록하기 때문에)

 

3. Spring Data JPA 인터페이스에 추가로 1에서 선언한 인터페이스 상속 

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

 

 

TestCode 

@Test
void customTest()
{
    memberRepository.save(new Member("KIM",10));
    memberRepository.save(new Member("KIM",15));
    List<Member> members = memberRepository.findMemberCustom("KIM");
    for (Member member : members) {
        System.out.println("member.getAge() = " + member.getAge());
    }
}

이렇게 하면 사용자가 직접 구현한 쿼리를 포함한 리포지토리  + Spring Data JPA을 사용한 리포지토리를 하나의 접근 계층으로 만들어 사용할 수 있습니다.

---

Auditing

엔티티를 생성, 변경할 때 변경한 사람과 시간을 추적해주는 기능입니다. 

+ 이 기능은 순수 JPA를 사용했을 때도 적용할 수 있습니다.

순수 JPA 사용

[JPA] 고급 매핑 : 매핑 정보만 제공하기 using @MappedSuperClass

BaseEntity 정의 

@MappedSuperclass
@Getter
public class JpaBaseEntity {
    @Column(updatable = false)
    private LocalDateTime createdDate;
    private LocalDateTime updatedDate;

    @PrePersist // persist 전 실행되는 메소드
    public void prePersist() {
        LocalDateTime now = LocalDateTime.now();
        createdDate = now;
        updatedDate = now;
    }

    @PreUpdate // merge 전 실행되는 메소드
    public void preUpdate() {
        updatedDate = LocalDateTime.now();
    }
}

• JPA 주요 이벤트 어노테이션
  • @PrePersist,  @PostPersist : 엔티티 persist 전,후에 실행됩니다.
  • @PreUpdate, @PostUpdate : 엔티티 업데이터 전, 후에 실행됩니다.
• 이벤트 어노테이션을 통해 persist, update 전 createdDate, updatedDate를 now() 로 초기화 해줍니다.

적용

public class Member extends JpaBaseEntity {

TestCode

@Test
@Transactional
@DisplayName("Base Entity 적용")
public void jpaBaseEntity() throws InterruptedException {
    //given
    Member member = new Member("member1");
    memberRepository.save(member); //@PrePersist

    Thread.sleep(100);

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

결과

findMember.createdDate = 2023-05-19T20:11:41.359666
findMember.updatedDate = 2023-05-19T20:11:41.498849

---

Spring Data JPA 사용

Spring Data JPA를 사용해서 Auditing을 하려면 추가적인 설정이 필요합니다.

 

설정

• @EnableJpaAuditing : 스프링 부트 설정 클래스에 적용
• @EntityListeners(AuditingEntityListener.class) : Base 엔티티에 적용

등록일 및 수정일, 등록자 및 수정자 BaseEntity

@EntityListeners(AuditingEntityListener.class)
@MappedSuperclass
public class BaseTimeEntity {

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

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

• @CreatedDate : 등록일
• @LastModifiedDate : 수정일 
• @CreatedBy : 등록자 
• @LastModifiedBy : 수정자

스프링 부트 설정 클래스에 빈 등록 및 @EnableAuditing 어노테이션 설정

@SpringBootApplication
@EnableJpaAuditing
public class DataJpaApplication {

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

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

 

마찬가지로 적용할 도메인에 상속

public class Member extends BaseEntity {

스프링 데이터 JPA를 사용하면 순수 JPA를 사용하는 것 보다 좀 더 유연하게 어노테이션으로 Auditing을 처리할 수 있습니다.

---

<참고 자료>

• 자바 ORM 표준 JPA 프로그래밍, 김영한