[Spring] Pointcut, Advise, Advisor 기본 개념을 알아보자

• 포인트컷 (pointcut) : 필터링 할 위치를 지정하는 필터링 로직이다. 즉 어디에 부가 기능을 적용할지 초점을 둔다. 
• 어드바이드 (advice) : 프록시가 호출하는 부가 기능 이다. 단순히 프록시가 적용할 부가기능 로직이라 생각하면 된다. 
• 어드바이저 (advisor) : 단순하게 하나의 포인트컷과 하나의 어드바이스를 가지고 있는 것이다. 쉽게 생각해 포인트컷 1 : 어드바이스 1  인 것.

문장으로 정리하면, 부가 기능 로직을 적용할 때 , 어디에 적용할지 위치 지정은 pointcut 이 담당하고, 어떤 로직을 적용할지는 advice 가 담당한다. 그리하여 어디에, 어떤 부가 기능 로직을 지정할지 모두 알고 있는 것이 어드바이저(advisor)가 된다.

 

 

역할과 책임

• advice, pointcut 개념이 없을 때는, proxy 부가 기능 로직 내부에서 if 문으로 분기하여 Pattern 매칭으로 필터링 로직을 구현했다. 이는 SRP 를 위반하며 코드를 깔끔하게 나타내지도 못한다.
• 포인트컷은 대상 여부를 확인하는 필터 역할만 담당하게 되고, 
• 어드바이스는 부가 기능 로직만 담당하게 된다. 
• 둘을 합치면 어드바이저가 된다. 즉 스프링 Advisor 는 하나의 pointcut + 하나의 advice 로 구성된다. 
• 여기서 중요한 점은 하나의 어드바이스에 여러 부가기능 로직을 추가할 수 있다는 점이다. 이 부분을 아래에서 더 알아보자. 

 

 

 

중간 정리

우리가 advice, pointcut, advisor 같은 개념을 배우는 이유는 프록시를 적용하기 위함이다.

그럼 프록시는 왜 배우는가? 클라이언트가 애플리케이션 실행 시 의도대로 사용될 기능은 save() 와 find() 이다 (위 그림 참고).

이 때 save(), find() 는 정상적으로 실행시키되, 기획의도나 개발 이슈상 부가적으로 실행해야 할 기능이 존재할 수 있다. 그럴 경우 프록시를 삽입하여, target 인스턴스의 기능은 정상적으로 실행시키고, 중간에서 부가적으로 실행하고 싶은 기능도 추가할 수 있다. 이것이 프록시를 사용하는 의도 중 하나라 짚고 넘어가면 좋겠다.

 

 

 

어드바이저 - 예제 코드

@Slf4j
public class AdvisorTest {

    @Test
    void advisorTest1() {
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);

        // 이전과 달라진 부분 : DefaultPointcutAdvisor() 객체 생성.
        // Advisor 추가 -> 하나의 pointcut 과 하나의 advice 를 갖는다.
        DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor(Pointcut.TRUE, new TimeAdvice());

        proxyFactory.addAdvisor(advisor); // 기존 .addAdvise() -> .addAdvisor()
        // addAdvise 내부를 보면 편의상 addAdvisor 도 적용이 되어있다.

        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();

        proxy.save();
        proxy.find();
    }
}

• new DefaulPointcutAdvisor : Advisor 인터페이스 가장 일반적인 구현체. 생성자를 통해 하나의 포인트컷과 하나의 어드바이스를 넣어주면 된다. 첫번째 인자에는 pointcut, 두번째 인자에는 advice가 들어가면 된다.
• Pointcut.TRUE : 항상 true 를 반환하는 포인트컷으로, 어떠한 필터도 없음을 의미한다.
• proxyFactory.addAdvisor(advisor) : 프록시 팩토리에 적용할 어드바이저를 지정한다. 어드바이저는 내부에 포인트컷과 어드바이스를 모두 가지고 있기 때문에, 어디에 어떤 부가기능을 적용해야할지 어드바이저 하나로 알 수 있다.

 

 

직접 만든 포인트컷 - 예제 코드 

포인트컷을 커스텀하여 직접 생성할 수 있다 .물론 스프링에서 제공하는 간단한 방법도 존재한다. 하지만 직접 포인트 컷을 생성하면 좀 더 유연하게 로직 처리를 하거나 로그를 남길 수 있는 이점이 있다.

 

내부 정적 클래스로 MyPointcut 이라는 클래스를 생성하고 Pointcut 인터페이스를 구현한다. 

methodMatcher 추상 메서드를 오버라이드하여, 포인트컷을 적용할 로직을 삽입할 수 있다.

아래 코드는 "save" 라는 이름을 가진 메서드에 프록시를 적용하도록 matchName = "save" 로 지정하였다.

@Slf4j
public class AdvisorTest {

    @Test
    @DisplayName("직접 만든 포인트컷")
    void advisorTest2() {
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);

        // 기존 Pointcut.TRUE -> new MyPointcut()
        DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor(new MyPointcut(), new TimeAdvice());
        proxyFactory.addAdvisor(advisor);
        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();

        proxy.save();
        proxy.find();
    }

    static class MyPointcut implements Pointcut {

        @Override
        public ClassFilter getClassFilter() {
            return ClassFilter.TRUE;
        } // 항상 TRUE 반환

        @Override
        public MethodMatcher getMethodMatcher() {
            return new MyMethodMatcher();
        }
    }

    static class MyMethodMatcher implements MethodMatcher {

        private String matchName = "save";

        @Override
        public boolean matches(Method method, Class<?> targetClass) {
            boolean result = method.getName().equals(matchName);
            log.info("포인트컷 호출 method={} targetClass={}", method.getName(), targetClass);
            log.info("포인트컷 결과 result={}", result);
            return result;
        }

        @Override
        public boolean isRuntime() {
            return false;
        }

        @Override
        public boolean matches(Method method, Class<?> targetClass, Object... args) {
            return false;
        }
    }

}

 

MethodMatcher 인터페이스 

MethodMatcher 를 상속한 MyMethodMatcher 클래스는 2개의 matches 와  isRuntime 메서드를 오버라이드한다. 이 때 isRuntime이 false 를 리턴하면 첫번째 matches 가 호출되고, true 일 땐  아래의 matches(... args) 가 호출된다. 즉 동적으로 넘어오는 매개변수를 판단하는 로직으로 사용할 수 있다. 

isRuntime() 이 false 인 경우, 클래스의 정적 정보만 사용하기 때문에 (runtime = false) , 스프링이 내부에서 캐싱을 통해 성능 향상이 가능하지만, isRuntime() 이 true 인 경우 매개변수가 동적으로 변경된다고 가정하기 때문에 캐싱을 하지 않는다. 

 

결과 

실행 결과를 확인하면, save() 를 호출할 땐 TimeProxy 가 잘 적용되고, find() 를 호출할 땐 적용되지 않은것을 확인할 수 있다. 

 

 

 

스프링이 제공하는 포인트컷 - 예제 코드 

위에서는 우리가 직접 MethodMatcher 를 상속받아 포인트컷을 개발했지만, 스프링은 우리가 필요한 포인트컷을 이미 대부분 제공한다. 

pointcut.setMappedNames("save") 처럼 한줄의 코드로 포인트컷을 지정할 수 있다. 이처럼 NameMatchMethodPointcut 의 인스턴스로 setMappedNames() 메서드를 사용하면 간단하게 메서드 이름을 이용한 포인트컷을 만들 수 있다. 

@Slf4j
public class AdvisorTest {

    @Test
    @DisplayName("스프링이 제공하는 포인트컷")
    void advisorTest3() {
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);

        NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut();
        pointcut.setMappedNames("save"); // 메서드 이름이 save 인 경우에만 가능하도록.

        DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor(pointcut, new TimeAdvice());
        proxyFactory.addAdvisor(advisor);
        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();

        proxy.save();
        proxy.find();
    }

}

• NameMatchMethodPointcut : 메서드 이름을 기반으로 매칭한다. 내부에서는 PatternMatchUtils 를 사용한다. 예) *xxx* 허용
• JdkRegexpMethodPointcut : JDK 정규 표현식을 기반으로 포인트컷을 매칭한다.
• TruePointcut : 항상 참을 반환한다.
• AnnotationMatchingPointcut : 애노테이션으로 매칭한다.
• AspectJExpressionPointcut : aspectJ 표현식으로 매칭한다. 

가장 중요한 것은 aspectJ 표현식
위의 여러 pointcut 옵션 보다는 aspectJ 를 실무에서 가장 많이 사용한다. 편리하고 기능도 가장 많은 aspectJ 표현식을 기반으로 사용하는 AspectJExpressionPointcut 을 주로 사용하게 될 것이다. aspectJ 표현식과 사용 방법은 중요해서 이후 AOP를 설명할 때 자세히 설명하겠다.

 

 

여러 어드바이저와 함께 사용

어드바이저는 하나의 포인트컷과 하나의 어드바이스를 가진다고 했는데, 여러 어드바이스를 하나의 target 에 적용하는 경우는 가능할까? 프록시를 여러개 만들어 chaining 하는 방법을 적용해볼 수 있다.

 

기존

public class Before_MultiAdvisorTest {

    @Test
    @DisplayName("여러개의 프록시 사용")
    void multiAdvisorTest1() {
//        client -> proxy2(advisor2) -> proxy1(advisor1) -> target

//        프록시1 생성
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory1 = new ProxyFactory(target);
        DefaultPointcutAdvisor advisor1 = new DefaultPointcutAdvisor(Pointcut.TRUE, new Advice1());
        proxyFactory1.addAdvisor(advisor1);
        ServiceInterface proxy1 = (ServiceInterface) proxyFactory1.getProxy();

        //프록시2 생성, target -> proxy1 입력
        ProxyFactory proxyFactory2 = new ProxyFactory(proxy1); // target 이 아닌 proxy1 을 넣었다.
        DefaultPointcutAdvisor advisor2 = new DefaultPointcutAdvisor(Pointcut.TRUE, new Advice2());
        proxyFactory2.addAdvisor(advisor2);
        ServiceInterface proxy2 = (ServiceInterface) proxyFactory2.getProxy();

        //실행
        proxy2.save();
    }

    @Slf4j
    static class Advice1 implements MethodInterceptor {
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            log.info("advice1 호출");
            return invocation.proceed();
        }
    }

    @Slf4j
    static class Advice2 implements MethodInterceptor {
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            log.info("advice2 호출");
            return invocation.proceed();
        }
    }

}

 

변경 후 : 하나의 프록시에 여러 어드바이저 사용

위 방법은 proxyFactory 를 여러개 생성하는 문제가 있다. 사실 잘못된 것은 아니지만, 굳이 프록시 팩토리 객체를 여러개 생성할 필요가 없다는 점을 인지해야 한다. 어드바이스가 많아질 수록, 그만큼 프록시 팩토리도 늘어나기 때문이다.

 

아래 방법은 프록시 팩토리 하나에 여러개의 어드바이저를 적용한 형태다.

public class MultiAdvisorTest {

    @Test
    @DisplayName("하나의 프록시, 여러 어드바이저")
    void multiAdvisorTest2() {
        // 기존
        // client -> proxy2(advisor2) -> proxy1(advisor1) -> target
        // 변경 후
        // client -> proxy -> advisor2 -> advisor1 -> target

        DefaultPointcutAdvisor advisor1 = new DefaultPointcutAdvisor(Pointcut.TRUE, new Advice1());
        DefaultPointcutAdvisor advisor2 = new DefaultPointcutAdvisor(Pointcut.TRUE, new Advice2());

        //프록시1 생성
        ServiceInterface target = new ServiceImpl();
        ProxyFactory proxyFactory = new ProxyFactory(target);

        proxyFactory.addAdvisor(advisor2);
        proxyFactory.addAdvisor(advisor1);
        ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();

        //실행
        proxy.save();
        // 하나의 프록시에서 여러 어드바이저를 등록할 수 있다.
        // advisor2에서 먼저 포인트컷 적용하고, 그다음에 advisor1에서 포인트컷 적용한다.
        // 결과적으로 여러 프록시를 사용할 때와 비교하면, 결과는 같고 성능은 더 좋다. (하나의 프록시만 사용한 것)

    }

    @Slf4j
    static class Advice1 implements MethodInterceptor {
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            log.info("advice1 호출");
            return invocation.proceed();
        }
    }

    @Slf4j
    static class Advice2 implements MethodInterceptor {
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            log.info("advice2 호출");
            return invocation.proceed();
        }
    }

}

 

하나의 proxyFactory 에 addAdvisor() 를 두번 호출해 서로 다른 advisor 를 적용한 것을 확인할 수 있다. 중요한 점은 등록하는 순서대로 advisor 가 호출되기 때문에, 등록 순서도 유념하여 개발해야한다.

 

프록시 객체는 하나만 생성된다

많은 개발자들이 착각할 수 있는 지점이, AOP  적용 수 만큼 프록시가 생성된다고 오해한다. 스프링은 AOP 를 적용할 때, 최적화를 진행하여 지금처럼 프록시를 하나만 만들고, 하나의 프록시에 여러 어드바이저를 적용한다. 정리하면  하나의 target 에 여러 AOP 가 동시에 적용되어도, 스프링의 AOP 는 하나의 프록시만 생성한다.