JPA Proxy

임준영·2021년 4월 20일

JPA

목록 보기

11/12

JPA Proxy

얼마전에 AOP 관련된 글들을 살펴보다가 프록시를 알게되어서 스프링 AOP에서 프록시가 어떻게 동작하는지에 대해서도 간단히 살펴보았습니다. 하지만 역시 이 프록시라는 녀석은 JPA에서 지연로딩을 할때도 사용하는 아주... 용도가 다양한 녀석이였습니다. 그래서 지연로딩을 공부하면서 다시한번 프록시에 대해서 살펴보았습니다.

JPA에서 프록시는 연관된 객체들을 데이터베이스에서 조회하기 위해서 사용합니다.
프록시를 사용하면 연관된 객체들을 처음부터 데이터베이스에서 조회하는 것이 아니라 실제 사용하는 시점에 데이터베이스에서 조회할 수 있습니다.

하지만 자주 함께 사용되는 객체들은 조인을 사용해서 함께 조회하는 것이 더 효과적입니다. JPA는 즉시로딩과 지연로딩이라는 방법으로 둘을 모두 지원하고 있습니다.

    @Test
    @Transactional
    @Rollback(false)
    public void printUser() throws Exception {

        Team team = new Team();
        team.setId("team1");
        team.setName("팀1");

        teamRepository.save(team);

        Member member = new Member();
        member.setId("member1");
        member.setName("임준영");
        member.setAge(28);

        member.setTeam(team);
        memberRepository.save(member);
        
     }


     @Test
     @Transactional
     public void printUserAndTeam() throws Exception {

         Member member = memberRepository.findById("member1").get();
         Team team = member.getTeam();

         System.out.println("소속 팀: " + team.getName());
         System.out.println("회원이름: " + member.getName());
      }

위의 코드는 Team 엔티티와 Member 엔티티와 연관관계를 매핑하고 global fetch 전략을 EAGER로 설정한 상태입니다.

즉시로딩(fetch = FetchType.EAGER)

스크린샷 2019-11-21 오전 2 52 39

위의 코드에서 printUserAndTeam() 메소드는 member1 로 회원 엔티티를 찾아서 회원은 물론이고 회원과 연관된 팀의 이름도 출력합니다.

만약 아래와 같은 코드에서 소속팀을 출력하지 않는다고 했을때 회원과 연관된 팀 엔티티까지 데이터베이스에서 함께 조화하는 것은 효율적이지 않아 보입니다.

   @Test
     @Transactional
     public void printUserAndTeam() throws Exception {

         Member member = memberRepository.findById("member1").get();
         System.out.println("회원이름: " + member.getName());
      }

JPA는 이런 문제를 해결하려고 엔티티가 실제 사용될 때까지 데이터베이스 조회를 지연하는 방법을 제공하는데 이것을 지연 로딩이라고 합니다. team.getName()처럼 팀 엔티티의 값을 실제 사용하는 시점에 데이터베이스에서 팀 엔티티에 필요한 데이터를 조회하는 것입니다.

1. Proxy 기초

엔티티를 실제 사용하는 시점까지 데이터베이스 조회를 미루고 싶으면 EntityManager.getReference() 메소드를 사용하면 됩니다.

이 메소드를 호출할 때 JPA는 데이터베이스를 조회하지 않고 실제 엔티티 객체도 생성하지 않습니다. 대신에 데이터베이스 접근을 위임한 프록시 객체를 반환합니다.

스크린샷 2019-11-21 오후 11 13 56

아래 그림을 보면 프록시 클래스는 실제 클래스를 상속 받아서 만들어지므로 실제 클래스와 겉 모양이 같습니다. 따라서 사용자 입장에서는 이것이 진짜 객체인지 프록시 객체인지 구분하지 않고 사용하면 됩니다.

스크린샷 2019-11-21 오후 10 47 53

프록시 객체는 실제 객체에 대한 참조(target)를 보관합니다. 그리고 프록시 객체의 메소드를 호출하면 프록시 객체는 실제 객체의 메소드를 호출합니다.

스크린샷 2019-11-21 오후 11 17 41

2. Proxy 객체의 초기화

프록시 객체는 member.getName()처럼 실제 사용될 때 데이터베이스를 조회해서 실제 엔티티 객체를 생성하는데 이것을 프록시 객체의 초기화라고 합니다.

Proxy 초기화 예제 코드

Member member = em.getReference(Member.class, "id1");
member.getName(); //1. getName();

// 프록시 클래스 예상 코드
class MemberProxy extends Member{

    Object target = null;

    public String getName(){
        
        if(target == null){

            //2. 초기화 요청
            //3. DB 조회
            //4. 실제 엔티티 생성 및 참조 보관
            this.target = .....;
        }

        return target.getName();
    }
}

3. Proxy 초기화 과정

스크린샷 2019-11-21 오후 11 34 05

초기화 순서

프록시 객체에 member.getName() 호출해서 실제 데이터를 조회합니다.

프록시 객체는 실제 엔티티가 생성되어 있지 않으면 영속성 컨텍스트에서 실제 엔티티 생성을 요청하는데 이것을 초기화라고 합니다.

영속성 컨텍스트는 데이터베이스를 조회해서 실제 엔티티 객체를 생성합니다.

프록시 객체는 생성된 실제 엔티티 객체의 참조를 Member target 맴버 변수에 보관합니다.

프록시 객체는 실제 엔티티 객체의 getName()을 호출해서 결과를 반환합니다.

4. 프록시의 특징

프록시 객체는 처음 사용할 때 한 번만 초기화 됩니다.

프록시 객체를 초기화한다고 프록시 객체가 실제 엔티티로 바뀌는 것은 아닙니다. 프록시 객체가 초기화되면 프록시 객체를 통해서 실제 엔티티에 접근할 수 있습니다.

프록시 객체는 원본 엔티티를 상속받은 객체이므로 타입 체크 시에 주의해서 사용해야 합니다.

영속성 컨텍스트에서 찾는 엔티티가 이미 있으면 데이터베이스를 조회할 필요가 없으므로 em.getReference()를 호출해도 프록시가 아닌 실제 엔티티를 반환합니다.

초기화는 영속성 컨텍스트의 도움을 받아야 가능합니다. 따라서 영속성 컨텍스트의 도움을 받을 수 없는 준영속 상태의 프록시를 초기화하면 문제가 발생합니다. 하이버네이트는 org.hibernate.LazyInitializationException 예외를 발생시킵니다.

준영속 상태와 초기화에 관련된 코드는 아래같이 발생 할 수 있습니다.

Member member = em.getReference(Member.class, "id1");

transaction.comit();
// 준영속 상태 초기화 시도
//org.hibernate.LazyInitializationException 예외 발생!
member.getName();

em.close() 메소드로 영속성 컨텍스트를 종료해서 member는 준영속 상태입니다. member.getName()을 호출하면 프록시를 초기화해야 하는데 영속성 컨텍스트가 없으므로 실제 엔티티를 조회할 수 없습니다. 따라서 LazyInitializationException 예외가 발생합니다.

5. 프록시와 식별자

엔티티를 프록시로 조회 할 때 식별자(PK) 값을 파라미터로 전달하는데 프록시 객체는 이 식별자 값을 보관합니다.

Team team = em.getReference(Team.class, "team1"); //식별자 보관
team.getId(); // 초기화 되지 않습니다.

프록시 객체는 식별자 값을 가지고 있으므로 식별자 값을 조회하는 team.getId()를 호출해도 프록시를 초기화하지 않습니다. 단 엔티티의 접근 방식을 프로퍼티(@Access(AccessType.PROPERTY))로 설정한 경우에만 초기화되지 않습니다.

엔티티 접근 방식을 필드 (@Access(AccessType.FIELD))로 설정하면 JPA는 getId() 메소드가 id만 조회하는 메소드인지 다른 필드까지 활용해서 어떤일을 하는 메소드인지 알지 못하므로 프록시 객체를 초기화 합니다.

연관관계 설정시에 데이터베이스의 접근 횟수를 줄일 수 있습니다.

Member member = em.getReference(Member.class, "member1");
Team team = em.getReference(Team.class, "team1"); //식별자 보관
member.setTeam(team);

실제로 회원 엔티티가 팀 엔티티와 연관관계를 설정할때 팀 엔티티를 데이터베이스에서 영속성 컨텍스트로 가져오지 않고 팀 엔티티의 식별자 값만 가지고 있는 프록시를 사용하면 데이터베이스 접근 횟수를 줄일 수 있습니다. 참고로 연관관계를 설정해도 프록시를 초기화하지 않습니다.

6. 프록시 확인

JPA가 제공하는 PersistenceUtil.isLoaded(Object entity) 메소드를 사용하면 프록시 인스턴스의 초기화 여부를 확인 할 수 있습니다. 아직 초기화되지 않는 프록시 인스턴스는 false를 반환합니다. 이미 초기화되었거나 프록시 인스턴스가 아니면 true를 반환합니다.

// member1 식별자 값을 가지고 있는 프록시를 반환합니다.
Member member = entityManager.getReference(Member.class, "member1");
   
//현재 JPA에서 엔티티 데이터에 접근하는 방식은 필드이기 때문에 프록시가 초기화됩니다. 프로퍼티 방식이면 초기화가 되지 않습니다.
System.out.println("회원이름: " + member.getName());

        
boolean isLoad = entityManager.getEntityManagerFactory()
                 .getPersistenceUnitUtil().isLoaded(member);

System.out.println("isLoad: " + isLoad);
System.out.println("memberProxy = " + member.getClass().getName());