[The JAVA, 코드 조작] 4부. 다이나믹 프록시

[tonykang22]

4부. 다이나믹 프록시

(다이나믹 프록시 또한 리플렉션의 일부이다.)

1. 스프링 데이터 JPA는 어떻게 동작하나?

• 스프링 데이터 JPA에서 인터페이스 타입의 인스턴스는 누가 만들어 주는것인가?
  • Spring AOP를 기반으로 동작하며 RespositoryFactorySupport에서 프록시를 생성한다.
  • 생성된 프록시가 bean으로 등록되어 주입되는 것.

2. 프록시 패턴

• Proxy와 Real Subject가 공유하는 인터페이스가 있고, Client는 해당 인터페이스 타입으로 Proxy를 사용한다.
• Client는 Proxy를 거쳐서 Real Subject를 사용하기 때문에 Proxy는 Real Subject에 대한 접근 관리, 부가기능 제공, 리턴값 변경을 할 수 있다.
• Real Subject는 자신이 해야할 일만 하면서(단일 책임 원칙) Proxy를 사용해서 부가적인 기능(접근 제한, 로깅, 트랜잭션 등)을 제공할 때 이런 패턴을 주로 사용한다.

예시

차례대로 Subject(Interface), Real Subject, 그리고Proxy에 해당하는 예시 코드이다.

public interface CarService {

    void startEngine(CarModel model);
}

public class RealCarService implements CarService {

    @Override
    public void startEngine(CarModel model) {
        System.out.println(model.getModel() + " engine starts...");
    }
}

public class ProxyCarService implements CarService {

    private final CarService carService;

    public ProxyCarService(CarService carService) {
        this.carService = carService;
    }

    @Override
    public void startEngine(CarModel model) {
        System.out.println("Proxy has taken over.");
        carService.startEngine(model);
        System.out.println("Now we are letting you go.");
    }
}

먼저 Real Subject의 코드를 실행해보면

class CarServiceTest {

    private CarService carService = new RealCarService();

    @Test
    void startEngine() {
        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
    }
}

이제 Proxy를 사용해 코드를 실행해보자.

class CarServiceTest {

    private CarService carService = new ProxyCarService(new RealCarService());

    @Test
    void startEngine() {
        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
    }
}

이번엔 프록시에서라도 차 모델을 G90으로 변경해보자.

public class ProxyCarService implements CarService {

    private final CarService carService;

    public ProxyCarService(CarService carService) {
        this.carService = carService;
    }

    @Override
    public void startEngine(CarModel model) {
        System.out.println("G90 engine starts...");
    }
}

기존의 메소드를 사용하는 것 뿐만 아니라 아예 다른 작업도 가능하는 것을 잊지 말자.

3. 다이나믹 프록시 실습

• 다이나믹 프록시란, 런타임에 특정 인터페이스들을 구현하는 클래스 또는 인스턴스를 만드는 기술이다.
  • 위의 예시에서는 컴파일 타임에 프록시 패턴을 적용해본 것이다. 차이를 구분해야한다.
• https://docs.oracle.com/javase/8/docs/technotes/guides/reflection/proxy.html

  “an application can use a dynamic proxy class to create an object that implements multiple arbitrary event listener interfaces”

• 프록시 인스턴스 만들기
  • Object Proxy.newProxyInstance(ClassLoader, Interfaces, InvocationHandler)
  • ClassLoader : 원하는 class 타입의 classLoader
  • Interfaces : 어떤 interface 타입의 프록시인지
  • InvocationHandler : 메소드가 호출될 때 메소드 처리를 어떻게 할 것인지 정의
    • Object로 반환되지만, Interfaces를 넘겼듯, 바로 캐스팅하면 된다.

예시

리플렉션에서 봤듯, invoke()의 proxy는 우리가 원하는 proxy 이고, Object[] args는 arguments로, Real Subject에 arguments를 넘겨주고 실행한다면 메소드가 하는 일을 그대로 실행한다.

class CarServiceTest {

    private CarService carService = (CarService) Proxy.newProxyInstance(CarService.class.getClassLoader(), new Class[]{CarService.class},
        new InvocationHandler() {
            CarService carService = new RealCarService();

            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                return method.invoke(carService, args);
            }
        });

    @Test
    void startEngine() {
        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

이제 Proxy의 역할을 하도록 코드를 변경해보자. 출력을 하면 무슨 값이 나올까?

class CarServiceTest {

    private CarService carService = (CarService) Proxy.newProxyInstance(CarService.class.getClassLoader(), new Class[]{CarService.class},
        new InvocationHandler() {
            CarService carService = new RealCarService();

            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                System.out.println("Proxy Starts");
                Object invoke = method.invoke(carService, args);
                System.out.println("Hahaha");
                return invoke;
            }
        });

    @Test
    void startEngine() {
        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

모든 메소드에 위의 로직이 실행되게 된다...

• 다이나믹 프록시는 유연한 구조가 아니다. 그래서 스프링 AOP가 등장한 것이다.
  • 즉, 특정 메소드에서만 추가적으로 제어된 로직을 실행하도록 하기가 쉽지 않다는 의미다.
  • 자바의 다이나믹 프록시로는 클래스 기반의 프록시를 만들 수 없다. (인터페이스 기반)

굳이 바꾼다면 다음과 같겠으나, 프록시 패턴을 각각이 사용할 매소드가 많아지고 구조가 복잡해질 수록 사용이 어려워질 것이다.

class CarServiceTest {

    private CarService carService = (CarService) Proxy.newProxyInstance(CarService.class.getClassLoader(), new Class[]{CarService.class},
        new InvocationHandler() {
            CarService carService = new RealCarService();

            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                if (method.getName().equals("startEngine")) {
                    System.out.println("Proxy Starts");
                    Object invoke = method.invoke(carService, args);
                    System.out.println("Hahaha");
                    return invoke;
                }
                return method.invoke(carService, args);
            }
        });

    @Test
    void startEngine() {
        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

4. 클래스의 프록시가 필요하다면?

• 서브 클래스를 만들 수 있는 라이브러리를 사용하여 프록시를 만들 수 있다.
• CGlib
  • https://github.com/cglib/cglib/wiki
  • 스프링, 하이버네이트가 사용하는 라이브러리
    • Enhancer가 핵심적인 클래스 -> Enhancer.create(Class, Handler)
    • Handler : MethodInterceptor 로 만들어줄 수 있다.
  • 버전 호환성이 좋치 않아서 서로 다른 라이브러리 내부에 내장된 형태로 제공되기도 한다.

예시

마찬가지로 앞뒤로 로직을 추가할 수 있다.

class CarServiceTest {

    @Test
    void startEngine() {
        MethodInterceptor handler = new MethodInterceptor() {
            RealCarService carService = new RealCarService();
            @Override
            public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
                return method.invoke(carService, args);
            }
        };
        RealCarService carService = (RealCarService) Enhancer.create(RealCarService.class, handler);

        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

• ByteBuddy
  • https://bytebuddy.net/#/
  • 스프링에서 버전관리를 해주기는 하지만 버전확인은 언제나 옳다.
  • 바이트 코드 조작 뿐 아니라 런타임(다이나믹) 프록시를 만들 때도 사용할 수 있다.
  • Class<? extends BookService> proxyClass = new ByteBuddy().subclass(BookService.class). make().load(BookService.class.getClassLoader()).getLoaded();
  • Class<? extends BookService> proxyClass = new ByteBuddy().subclass(BookService.class). method(named("run")).intercept(InvocationHandlerAdapter.of( ) }).make().load(BookService.class.getClassLoader()).getLoaded();
• 서브 클래스를 만드는 방법의 단점
  • 상속을 사용하지 못하는 경우, 프록시를 만들 수 없다.
    • Private 생성자만 있는 경우 (하위 클래스에서는 항상 부모 클래스의 생성자를 호출한다.)
    • Final 클래스인 경우
  • 인터페이스가 있을 때는 인터페이스의 프록시를 만들어 사용할 것.

예시

변경된게 없는 RealCarService를 하위클래스를 만들어서 실행하는 방법.

class CarServiceTest {

    @Test
    void startEngine() throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {

        Class<? extends RealCarService> proxyClass = new ByteBuddy().subclass(RealCarService.class)
            .make().load(RealCarService.class.getClassLoader()).getLoaded();
        RealCarService carService = proxyClass.getConstructor(null).newInstance();

        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

이와 같이 클래스 기반의 프록시도 사용이 가능하다.

class CarServiceTest {

    @Test
    void startEngine() throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {

        Class<? extends RealCarService> proxyClass = new ByteBuddy().subclass(RealCarService.class)
            .method(named("startEngine")).intercept(InvocationHandlerAdapter.of(new InvocationHandler() {
                RealCarService realCarService = new RealCarService();
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    System.out.println("Method startEngine start");
                    Object invoke = method.invoke(realCarService, args);
                    System.out.println("Method startEngine end");
                    return invoke;
                }
            }))
            .make().load(RealCarService.class.getClassLoader()).getLoaded();
        RealCarService carService = proxyClass.getConstructor(null).newInstance();

        CarModel model = new CarModel("Avante");
        carService.startEngine(model);
        carService.stopEngine(model);
    }
}

5. 다이나믹 프록시 정리

• 다이나믹 프록시
  • 런타임에 인터페이스 또는 클래스의 프록시 인스턴스 또는 클래스를 만들어 사용하는 프로그래밍 기법
• 다이나믹 프록시 사용처
  • 스프링 데이터 JPA
  • 스프링 AOP
  • Mockito
  • 하이버네이트 lazy initialzation
    • 가령 @OneToMany 등의 Many로 끝났을 때는 lazy.
    • 프록시 객체를 가지고 있다가 직접 그 필드를 조회할 때 쿼리가 발생하는 것이다.
  • ...