[Spring] ProxyFactory

 

이전 포스팅에서 동적 프록시를 적용할 때의 문제점을 짚어봤다.

 

1. 인터페이스가 없는 경우에는 CGLIB를, 있는 경우에는 JDK 동적 프록시를 적용해야한다.
2. 두 기술을 모두 사용하려면, JDK 동적 프록시의 InvocationHandler 와 CGLIB의 MethodInterceptor를 중복해서 만들어 관리해야할까?
3. 특정 조건에서(필터) 프록시 로직을 적용하는 기능을 공통으로 적용할 수 있어야 한다. 

 

스프링에서 제공하는 추상화된 프록시 기술 : ProxyFactory 

스프링은 동적 프록시를 통합하여 생성해 주는 프록시 팩토리(Proxy Factory) 라는 기능을 제공한다. 이전에는 인터페이스의 유무에 따라 JDK 동적 프록시나 CGLIB 을 선택해야 했다면, 이제는 Proxy Factory 하나로  편리하게 동적 프록시를 생성할 수 있다. Proxy Factory 의 의존 관계와 사용 흐름은 아래 그림과 같다. 

 

Advice , Pointcut 도입

스프링은 Advice 라는 새로운 개념을 도입하면서, 상황에 따라 JDK 동적프록시나 CGLIB 를 따로 생성해야하는 문제를 해결했다. 개발자는 InvocationHandler 나 MethodInterceptor 를 신경쓰지 않고, Advice 만 생성하면 된다. ( Advice 는 개발자가 적용하고 싶은 부가 기능 로직이라 생각하자 )

프록시 팩토리를 사용하면, 내부에서 Advice 를 호출하는 전용 InvocationHandler, MethodInterceptor 를 내부에서 사용한다.

이전에 FilterHandler 를 만들어, 특정 조건에 맞는 메서드에만 프록시를 적용한 적이 있다. 프록시 팩토리에서는 Pointcut 이라는 개념을 도입하여 이 문제를 일관성 있게 해결한다. 예제 코드를 보면서 Advice 와 Pointcut 을 더 이해해보자. 

 

 

 

Advice, Pointcut 예제 코드

Advice 는 부가기능 로직을 담당한다고 했다. 여기서 TimeAdvice 는 메소드의 실행 시간을 체크하여 로그를 남기는 부가기능을 담당한다. Advice 는 MethodInterceptor 를 상속받아 invoke(MethodInvocation invocation) 메서드를 오버라이드 하는데, 이 때 invocation.proceed() 를 호출하면 targe 클래스를 호출하고 그 결과를 리턴받는다. 그런데 이전 포스팅과 달리 target 의 정보가 보이지 않는다. 이전에는 생성자로 target 을 주입받았지만, MethodInterceptor 를 사용하면, MethodInvocation invocation 내부에 target 의 클래스 정보가 모두 포함돼 있다.

import lombok.extern.slf4j.Slf4j;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;

@Slf4j
public class TimeAdvice implements MethodInterceptor {
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        log.info("TimeProxy 실행");
        long startTime = System.currentTimeMillis();
        
        // 기존
        //Object result = method.invoke(target, args); 

        // 변경 : MethodInterceptor 상속 후 
        Object result = invocation.proceed(); 
        // target 을 자동으로 찾고 인자를 넘긴다. -> 실제 타겟을 호출한다.

        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("TimeProxy 종료 resultTime={}", resultTime);
        return result;
    }
}

주의할 점은, TimeAdvice 가 상속받는 MethodInterceptor 가 CGLIB의 MethodInterceptor 와 이름이 같으므로 패키지 이름에 주의해야한다. Advice 를 적용하기 위해서는 org.aopalliance.intercept 스프링 AOP 모듈 내부에 있는 것을 사용한다.

이제 우리가 만든 Advice 를 ProxyFactory 에 전달하면 proxy 가 반환되고 적용되는 것을 확인할 수 있다.

 

Advice - ProxyFactory 적용  (1) : 인터페이스를 상속받는 target 의 proxy 생성

• 우선 Proxy 를 적용할 대상 (target) 객체를 불러와야한다. 여기서는 ServiceInterface 타입의 ServiceImpl 의 인스턴스를 target 으로 지정했다. 해당 인스턴스는 인터페이스를 상속받고 있음을 인지하자
• 그 다음 ProxyFactory() 인스턴스를 생성할 때 인자로 target 객체를 넘겨준다. 프록시 팩토리는 이 인스턴스 정보를 기반으로 내부에서 프록시를 생성한다. 
• 우리가 넘겨준 인스턴스는 인터페이스를 상속받았다고 언급했다. 즉 target 인스턴스에 인터페이스가 있다면 ProxyFactory 내부에서 JDK 동적 프록시를 기본으로 사용하고, 그렇지 않다면 CGLIB 를 통해 동적 프록시를 생성한다. 
• proxyFactory.addAdvice() : 이제 프록시가 사용할 부가기능 로직을 addAdvice() 의 인자로 넘겨준다. 우리가 만든 TimeAdvice 의 인스턴스를 넘겨주자.  ( JDK 동적 프록시가 제공하는 InvocationHandler 와 CGLIB가 제공하는 MethodInterceptor의 개념과 유사)
• 부가기능 까지 설정을 마친 proxyFactory 는 proxyFactory.getProxy() 로 프록시 객체를 생성하고 결과를 받는다. 

@Slf4j
public class ProxyFactoryTest {

    @Test
    @DisplayName("인터페이스가 있으면 JDK 동적 프록시 사용")
    void interfaceProxy() {
    
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);  
        // target 을 넣으면서 프록시 팩토리를 만든다. 즉 프록시 팩토리는 이미 타겟의 정보를 알고있다.
        // 프록시의 호출대상(target)을 프록시 팩토리를 생성할 때 인자로 넘기는 것.

        proxyFactory.addAdvice(new TimeAdvice());  // advice 추가 -> 프록시가 사용할 부가 로직을 설정한다. (advice : 조언을 해준다.)
        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();
        log.info("targetClass={}", target.getClass());
        log.info("proxyClass={}", proxy.getClass());
        
        proxy.save(); // 프록시 객체의 자체 메서드를 호출하면, advice 로 추가된 (로그) 로직이 수행된다.
        // save() 에 정의된 "save 호출" 이란 로그가 바로 찍히는 것이 아니라, TimeAdvice() 내부에서 invocation.proceed() 할 때 save()의 로그가 찍힌다,.
        
        assertThat(AopUtils.isAopProxy(proxy)).isTrue();
        assertThat(AopUtils.isJdkDynamicProxy(proxy)).isTrue();  // 인터페이스가 존재하므로 JDK dynamic proxy
        assertThat(AopUtils.isCglibProxy(proxy)).isFalse();

    }
}

 

실행 결과

 

 

Advice - ProxyFactory 적용  (2) : 구체 클래스를 사용하는 프록시 생성

(1) 예제 코드와 크게 달라진 것은 없다. 차이점이라면 인터페이스가 없는 구체클래스를 사용했다는 점이다. 똑같이 프록시 팩토리를 사용해 프록시를 생성한 후 , 테스트코드를 통해 어떤 결과가 나오는지 확인해보자. 

@Slf4j
public class ProxyFactoryTest {

    @Test
    @DisplayName("구체 클래스만 있으면 CGLIB 사용")
    void concreteProxy() {
        ConcreteService target = new ConcreteService();
        ProxyFactory proxyFactory = new ProxyFactory(target);
        proxyFactory.addAdvice(new TimeAdvice());
        ConcreteService proxy = (ConcreteService) proxyFactory.getProxy();
        log.info("targetClass={}", target.getClass());
        log.info("proxyClass={}", proxy.getClass());

        proxy.call();

        assertThat(AopUtils.isAopProxy(proxy)).isTrue();
        assertThat(AopUtils.isJdkDynamicProxy(proxy)).isFalse();
        assertThat(AopUtils.isCglibProxy(proxy)).isTrue();
    }

}

assertThat(AopUtils.isCglibProxy(proxy)).isTrue() 가 통과하는 것을 보아 CGLIB 를 활용해 프록시가 생성됐음을 확인할 수 있다.

 

 

Advice - ProxyFactory 적용  (3) : ProxyTargetClass 옵션 사용

target 인스턴스는 인터페이스를 상속받지만, setProxyTargetClass(true) 옵션을 사용하면 JDK 동적 프록시 대신 강제로 CGLIB 를 사용해 프록시를 생성할 수 있다.

 

@Slf4j
public class ProxyFactoryTest {

    @Test
    @DisplayName("ProxyTargetClass 옵션을 사용하면 인터페이스가 있어도 CGLIB를 사용하고, 클래스 기반 프록시 사용")
    void proxyTargetClass() {
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);
        
        proxyFactory.setProxyTargetClass(true); 
        // proxy 를 만드는데 target 클래스를 기반으로 만들꺼야! 라고 설정
        
        proxyFactory.addAdvice(new TimeAdvice());
        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();
        log.info("targetClass={}", target.getClass());
        log.info("proxyClass={}", proxy.getClass());

        proxy.save();

        assertThat(AopUtils.isAopProxy(proxy)).isTrue();
        assertThat(AopUtils.isJdkDynamicProxy(proxy)).isFalse();
        assertThat(AopUtils.isCglibProxy(proxy)).isTrue();
    }

}

 

정리

프록시 팩토리의 추상화 덕분에 구체적인 CGLIB, JDK 동적 프록시 기술에 의존하지 않고 편리하게 동적 프록시를 생성할 수 있게 됐다. 또한 프록시의 부가기능 로직도 특정 기술에 종속되지 않고, Advice 하나로 편리하게 사용할 수 있었다. 이것은 프록시 팩토리 내부에서 JDK 동적 프록시인 경우 InvocationHandler 가  Advice 를 호출하고, CGLIB 인 경우 MethodInterceptor 가 Advice 를 호출하도록 개발되었기 때문이다 .

 

 

코드 및 자료 출처

스프링 핵심 원리 - 고급편 - 인프런 | 강의