프록시

Member와 Team이 연관 관계가 맺어져 있을 때 Member를 조회하면 Team도 매번 함께 조회해야 할까?

public class App {
    public void printUserAndTeam(String memberId) {
        ...

        Member member = em.find(Member.class, memberId);
        Team team = member.getTeam();

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

public class App {
    public void printUser(String memberId) {
        ...

        Member member = em.find(Member.class, memberId);
        Team team = member.getTeam();

        System.out.println("회원 이름: " + member.getUsername());
    }
}

• 첫 번째처럼 소속 팀이 필요하다면 한 방에 가져오는 게 좋다.

• 두 번째처럼 회원 정보만 필요하다면 team을 가져올 필요도 없다.

  • 이 경우 team을 매번 가져오면 리소스를 낭비하게 된다.

• 이 문제를 해결하려면 프록시를 이해해야 한다.

프록시 기초

em.find()

• 데이터베이스를 통해서 실제 Entity 객체를 조회한다.

public class App {
    public class App {
        public void printUserAndTeam(String memberId) {
            ...

            Member member = em.find(Member.class, memberId);
            // 출력 등 사용하는 로직 없음
        }
    }
}

• 데이터를 사용하지 않고 find()만 했을 때도 select 쿼리를 실행한다.

em.getReference()

• 데이터베이스 조회를 미루는 가짜(프록시) Entity 객체를 조회한다.

• DB에 쿼리가 안 날아가는데 객체가 조회된다.

public class App {
    public void printUserAndTeam(String memberId) {
      ...

        Member member = em.getReference(Member.class, memberId);
        // 출력 등 사용하는 로직 없음
    }
}

• select 쿼리가 나가지 않았다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member = em.getReference(Member.class, memberId);
        // 데이터 사용
        System.out.println("회원 이름: " + member.getUsername());
    }
}

• member 데이터를 실제 호출하는 순간에 select 쿼리가 출력된다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member = em.getReference(Member.class, memberId);
        // 클래스 정보 조회
        System.out.println("회원 이름: " + member.getClass());
    }
}

• 클래스를 출력해보면 Proxy라는 글자가 보인다.

• 하이버네이트가 강제로 만든 가짜 클래스라는 뜻이다.

• em.getReference()는 프록시를 사용한다.

  • 진짜 객체를 주는 게 아니라 프록시라는 가짜 객체를 준다.

  • 껍데기만 있고 안은 텅텅 빈 상태다.

프록시의 특징

• 실제 클래스를 상속 받아서 만들어진다.

  • 따라서 실제 클래스와 겉모습이 같다.

  • 내가 직접 상속하는 게 아니라 하이버네이트가 내부적으로 라이브러리를 사용해 상속한다.

• 사용하는 입장에서는 진짜 객체인지 프록시 객체인지 구분하지 않고 사용한다.

• 프록시 객체는 실제 객체의 참조(target)을 보관한다.

• 프록시 객체에 있는 메서드를 호출하면, 프록시 객체는 실제 객체의 메서드를 호출한다.

  • getId()를 호출하면 프록시는 target에 있는 getId()를 대신 호출한다.

  • 하지만 맨 처음에는 DB 조회가 되지 않은 상태이므로 target이 비어있을 것이다. 이때는 어떻게 될까?

프록시 객체의 초기화

public class App {
    public void getMemberName() {
        // 실제 객체가 아닌 프록시 객체를 가져온다.
        Member member = em.getReference(Member.class, "id");
        // 처음에 getName()을 호출하면 target에 값이 없는 상태다.
        // 그럼 영속성 컨텍스트에 데이터를 요청해 그 값을 반환한다.
        member.getName();
    }
}

1. 데이터를 요청했는데 Member의 target에 데이터가 없다.

2. JPA가 진짜 Member 객체를 가져오라고 영속성 컨텍스트에 요청한다.

3. 영속성 컨텍스트는 DB를 조회해서 실제 Entity 객체를 생성해 보내준다.

4. target과 진짜 객체인 Entity를 연결한다.

5. target의 진짜 getName()을 통해서 값을 반환한다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member = em.getReference(Member.class, memberId);
        // 실제 레퍼런스 조회
        System.out.println("회원 이름: " + member.getUsername());
    }
}

• userName을 실제 가져다 쓰는 시점에 영속성 컨텍스트로 Member를 요청해서 실제 레퍼런스를 가지게 된다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member = em.getReference(Member.class, memberId);
        // 실제 레퍼런스 조회
        System.out.println("회원 이름: " + member.getUsername());
        // 다시 하면 프록시에서 조회
        System.out.println("회원 이름: " + member.getUsername());
    }
}

• 이제 target에 값이 있기 때문에 다음에 다시 조회해도 DB에 쿼리를 다시 날리지 않는다.

주의 사항

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

  • 한 번 초기화하면 그 내용을 그대로 사용한다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member = em.getReference(Member.class, memberId);

        System.out.println("before: " + member.getClass());
        System.out.println("회원 이름: " + member.getUsername());
        System.out.println("after: " + member.getClass());  // before와 같은 값 출력
    }
}

• 프록시 객체를 초기화 할 때, 프록시 객체가 실제 Entity로 바뀌는 것은 아니다.

  • 초기화 되면 프록시 객체를 통해 실제 엔티티에 접근할 수 있을 뿐이다.

  • 그래서 프록시를 통해 데이터를 가져온 뒤에도 getClass()의 값은 $Proxy...로 동일하다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

        Member member2 = new Member();
        member2.setUsername("member2");
        em.persist(member2);

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

        Member m1 = em.find(Member.class, member1.getId());
        Member m2 = em.find(Member.class, member2.getId());

        // find()로 가져왔고 타입을 정확하게 비교하는 것이므로 true를 출력한다.
        System.out.println("m1 == m2: " + (m1.getClass() == m2.getClass()));

        Member m3 = em.getReference(Member.class, member1.getId());
        Member m4 = em.find(Member.class, member2.getId());

        // m3는 getReference()이므로 false를 출력한다.
        System.out.println("m1 == m2: " + (m1.getClass() == m2.getClass()));

        tx.commit();
    }
}

public class App {
    public static void main(String[] args) {
        Member m1 = em.find(Member.class, member1.getId());
        Member m2 = em.find(Member.class, member2.getId());
        // true
        System.out.println("m1 == Member: " + (m1.getClass() == m2.getClass()));

        Member m1 = em.find(Member.class, member1.getId());
        Member m2 = em.getReference(Member.class, member2.getId());
        // false
        System.out.println("m1 == Member: " + (m1.getClass() == m2.getClass()));
    }

    public void logic(Member m1, Member m2) {
        // 실제 로직 상에서는 실제 인티티가 넘어올지 프록시가 넘어올지 모르기 때문에
        // 비교할 때는 instance of를 사용해야 한다.
        // false
        System.out.println("m1 == m2: " + (m1 == m2));
        // true
        System.out.println("m1 == m2: " + (m1 instanceof m2));
        System.out.println("m2 == m2: " + (m2 instanceof m2));

    }
}

• 프록시 객체는 원본 Entity를 상속받는다.

  • 즉, 프록시인 멤버와 아닌 멤버가 타입이 맞지 않을 수 있어 주의해야 한다.

    • 타입 비교 시 ==를 쓰면 실패하고, instance of를 사용해야 한다.

    • 프록시를 쓸지 안 쓸지 모르므로 JPA에서는 웬만하면 instance of를 사용하는 것이 좋다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        Member m1 = em.find(Member.class, member1.getId());
        // find()로 진짜 객체를 가져오기 때문에 'Member'라고 출력된다.
        System.out.println("m1 = " + m1.getClass());

        // find()한 뒤에 getReference()로 가져오게 되면
        Member m2 = em.getReference(Member.class, member1.getId());
        // 'Proxy'가 아니라 'Member'로 출력된다.
        System.out.println("m2 = " + m2.getClass());

        // 프록시든 아니면 한 영속성 컨텍스트에서 가져오고 PK가 같다면 항상 true가 된다.
        System.out.println("m1 == reference = " + (m1 == reference));

        tx.commit();
    }
}

• find() 후 getReference()를 호출하면 실제 Entity를 반환한다.

  • 이미 멤버를 영속성 컨텍스트 1차 캐시에 넣어뒀기 때문에 굳이 프록시로 가져올 필요가 없다.

    • getReference()로 수행할 수 있는 성능 최적화에 대한 이점이 없다.

• 실제 객체와 레퍼런스로 가져온 객체를 같다고 취급한다.

  • JPA는 한 트랜잭션 안에서 PK가 같다면 같은 객체임을 보장한다.

  • 원본과 레퍼런스를 == 비교 시 항상 true가 나온다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        Member m1 = em.getReference(Member.class, member1.getId());
        System.out.println("m1 = " + m1.getClass());

        Member reference = em.getReference(Member.class, member1.getId());
        System.out.println("reference = " + reference.getClass());

        // true
        System.out.println("a == a: " + (m1 == reference));

        tx.commit();
    }
}

• 둘 다 레퍼런스로 받을 때도 같은 프록시로 출력된다.

• 하나의 영속성 컨텍스트에 있을 때 같다는 걸 보장해줘야 하기 때문이다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        // 프록시로 불러온 다음
        Member refMember = em.getReference(Member.class, member1.getId());
        // 출력을 위해 실제 값으로 초기화 한다.
        // 클래스 값은 프록시로 출력된다.
        System.out.println("refMember = " + refMember.getClass());

        Member findMember = em.find(Member.class, member1.getId());
        // 프록시가 초기화 되었으니 당연히 Member 타입이 출력되어야 하는 것 아닌가? 할 수 있지만
        // JPA는 PK가 같으면 무조건 같음을 보장해줘야 하기 때문에 프록시로 나온다.
        System.out.println("findMember = " + findMember.getClass());

        // JPA에서는 무조건 이게 참이 되도록 맞춘다!
        System.out.println("a == a: " + (refMember == findMember));

        tx.commit();
    }
}

• 프록시가 초기화 된 상태에서 find()를 하면 어떻게 될까?

• JPA는 기본적으로 refMember == findMember의 값이 true임을 보장해야 한다.

• 따라서 refMember, findMember 모두 프록시로 출력된다.

• find()를 했기 때문에 실제 DB를 조회하면서 select 쿼리는 찍힌다.

• 하지만 프록시를 한 번 조회한 뒤에는 find()를 한 객체에도 프록시로 반환한다.

  • 그래야 JPA의 룰을 보장할 수 있기 때문이다.

  • 처음에 엔티티로 반환하면 엔티티로, 프록시로 반환하면 계속 프록시로 반환한다.

• 중요한 건 프록시든 아니든 개발에 문제가 없도록 짜는 것이다. instance of를 기억하자.

준영속 상태의 프록시

• 영속성 컨텍스트의 도움을 받을 수 없는 준영속 상태이면, 프록시를 초기화할 때 문제가 발생한다.

  • 하이버네이트는 org.hibernate.LazyInitializationException 예외를 터뜨린다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        // 프록시 생성
        Member refMember = em.getReference(Member.class, member1.getId());
        // 프록시로 출력한다.
        System.out.println("refMember = " + refMember.getClass());

        // 실제 DB를 조회하면서 쿼리를 날리고 프록시를 초기화 한다.
        refMember.getUsername();
        // 타입은 여전히 프록시로 출력된다.
        System.out.println("refMember = " + refMember.getClass());

        tx.commit();
    }
}

• 같은 영속성 컨텍스트 안에서는 같은 프록시를 출력한다.

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        // 프록시 생성
        Member refMember = em.getReference(Member.class, member1.getId());
        // 프록시로 출력
        System.out.println("refMember = " + refMember.getClass());

        // detach(), clear(), close()로 영속성 컨텍스트를 준영속으로 만든다.
        em.close();

        // 실제 데이터로 초기화 하면서 데이터를 가져와야 하지만
        // 영속성 컨텍스트로 관리하지 않게 되면서 exception이 떨어진다.
        refMember.getUsername();
        System.out.println("refMember = " + refMember.getClass());

        tx.commit();
    }
}

• detach(), clear(), close()로 준영속 상태가 되면 LazyInitializationException을 던진다.

• 프록시를 초기화 할 때 영속성 컨텍스트를 통하기 때문이다.

• 트랜잭션이 끝났는데 조회 하려고 할 때 많이 만나는 에러이므로 기억해두도록 하자.

프록시 유틸리티 메서드

프록시 인스턴스의 초기화 여부 확인

public class App {
    public static void main(String[] args) {
        EntityManagerFactory emf = Persistence.createEntityManagerFactory();
        ...
        // 앞에서 초기화 했다면 true, 아니라면 false
        System.out.println("isLoaded: " + emf.getPersistenceUnitUtil().isLoaded(refMember));
    }
}

• PersistenceUnitUtil.isLoaded(Object entity)

  • 해당 프록시가 초기화 됐는지 확인하는 메서드

프록시 클래스 확인

• entity.getClass().getName()

프록시 강제 초기화

public class App {
    public void printUserAndTeam(String memberId) {
        Member member1 = new Member();
        member1.setUsername("member1");
        em.persist(member1);

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

        Member refMember = em.getReference(Member.class, member1.getId());
        System.out.println("refMember = " + refMember.getClass());

        // 이런 방식으로 강제 호출하는 것 보다는
        refMember.getUsername();
        // 이 방식을 더 권유한다.
        Hibernate.initialize(refMember);

        tx.commit();
    }
}

• org.hibernate.Hibernate.initialize(entity)

  • Hibernate에서 제공하는 것이며, JPA 표준은 강제 초기화가 없다.

    • member.getName()처럼 강제 호출 해야 한다.