[스프링 핵심 원리 - 고급편] #07. 스프링이 지원하는 프록시(2)

[YuDeokRin]

3️⃣ 포인트컷, 어드바이스, 어드바이저 - 소개

✅ 포인트컷(Pointcut)이란?

• 어디에 부가 기능을 적용할지, 어디에 부가 기능을 적용하지 않을지 판단하는 필터링 로직이다.
• 주로 클래스와 메서드 이름으로 필터링 한다.
• 이름 그대로 어떤 포인트(Point)에 기능을 적용할지 말지 잘라서(cut) 구분하는 것이다.

✅ 어드바이스(Advice)이란?

• 이전에 본 것 처럼 프록시가 호출하는 부가 기능이다. 단순하게 프록시 로직이라 생각하면 된다.

✅ 어드바이저(Advisor)이란?

• 단순하게 하나의 포인트컷과 하나의 어드바이스를 가지고 있다는 것이다. 간단히 말해 포인트컷1 + 어드바이스1이다.

➡️ 정리

• 부가 기능 로직을 적용해야 한다면 포인트컷으로 어디에? 적용할지 선택하고, 어드바이스로 어떤 로직을 적용할지 선택하는 것이다.

🗒️ 쉽게 기억하기

• 조언(Advice)을 어디(Pointcut)에 할 것인가?
• 조언자(Advisor)는 어디(Pointcut)에 조언(Advice)을 해야할지 알고 있다.

➡️ 역할과 책임

• 포인트컷은 대상 여부를 확인하는 필터 역할만 담당한다.
• 어드바이스는 깔끔하게 부가 기능 로직만 담당한다.
• 둘을 합치면 어드바이저가 된다. 스프링의 어드바이저는 하나의 포인트컷 + 하나의 어드바이스로 구성된다.

4️⃣ 예제 코드1 - 어드바이저

@Slf4j
public class AdvisorTest {

		@Test
		void advisorTest1() {
				ServiceInterface target = new ServiceImpl();
				ProxyFactory proxyFactory = new ProxyFactory(target);
				DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor(Pointcut.TRUE, new TimeAdvice());
				
				proxyFactory.addAdvisor(advisor);
				ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();
				
				proxy.save();
				proxy.find();
		}
}

• new DefaultPointcutAdvisor : Advisor 인터페이스의 가장 일반적인 구현체이다. 생성자를 통해 하나의 포인트컷과 하나의 어드바이스를 넣어주면 된다. 어드바이저는 하나의 포인트컷과 하나의 어드바이스로 구성된다.
• Pointcut.TRUE : 항상 true 를 반환하는 포인트컷이다. 이후에 직접 포인트컷을 구현해볼 것이다.
• new TimeAdvice() : 앞서 개발한 TimeAdvice 어드바이스를 제공한다.
• proxyFactory.addAdvisor(advisor) : 프록시 팩토리에 적용할 어드바이저를 지정한다. 어드바이저는
  내부에 포인트컷과 어드바이스를 모두 가지고 있다. 따라서 어디에 어떤 부가 기능을 적용해야 할지 어드바이저 하나로 알 수 있다. 프록시 팩토리를 사용할 때 어드바이저는 필수이다.
• 그런데 생각해보면 이전에 분명히 proxyFactory.addAdvice(new TimeAdvice()) 이렇게 어드바이저가 아니라 어드바이스를 바로 적용했다. 이것은 단순히 편의 메서드이고 결과적으로 해당 메서드 내부에서 지금 코드와 똑같은 다음 어드바이저가 생성된다. DefaultPointcutAdvisor(Pointcut.TRUE, new TimeAdvice())

#save() 호출
TimeAdvice - TimeProxy 실행
ServiceImpl - save 호출
TimeAdvice - TimeProxy 종료 resultTime=0ms
#find() 호출
TimeAdvice - TimeProxy 실행
ServiceImpl - find 호출
TimeAdvice - TimeProxy 종료 resultTime=1ms

5️⃣ 예제 코드2 - 직접 만든 포인트컷

• 이번에는 save() 메서드에는 어드바이스 로직을 적용하지만, find() 메서드에는 어드바이스 로직을 적용하지 않도록 해보자.
• 물론 과거에 했던 코드와 유사하게 어드바이스에 로직을 추가해서 메서드 이름을 보고 코드를 실행할지 말지 분기를 타도 된다. 하지만 이런 기능에 특화되어서 제공되는 것이 바로 포인트컷이다.

public interface Pointcut {
		ClassFilter getClassFilter();
		MethodMatcher getMethodMatcher();
}

public interface ClassFilter {
		boolean matches(Class<?> clazz);
}

public interface MethodMatcher {
		boolean matches(Method method, Class<?> targetClass);
		//..
}

• 포인트컷은 크게 ClassFilter 와 MethodMatcher 둘로 이루어진다. 이름 그대로 하나는 클래스가 맞는지, 하나는 메서드가 맞는지 확인할 때 사용한다. 둘다 true로 반환해야 어드바이스를 적용할 수 있다.

➡️AdvisorTest - advisorTest2() 추가

@Test
@DisplayName("직접 만든 포인트컷")
void advisorTest2() {
		ServiceImpl target = new ServiceImpl();
		ProxyFactory proxyFactory = new ProxyFactory(target);
		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;
		}
		
		@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){
			throw new UnsupportedOperationException();
		}
}

• MyPointcut

  • 직접 구현한 포인트컷이다. Pointcut 인터페이스를 구현한다.
  • 현재 메서드 기준으로 로직을 적용하면 된다. 클래스 필터는 항상 true 를 반환하도록 했고, 메서드 비교 기능은MyMethodMatcher 를 사용한다.

• MyMethodMatcher

  • 직접 구현한 MethodMatcher 이다. MethodMatcher 인터페이스를 구현한다.
  • matches() : 이 메서드에 method , targetClass 정보가 넘어온다. 이 정보로 어드바이스를 적용할지 적용하지 않을지 판단할 수 있다.

• 여기서는 메서드 이름이 "save" 인 경우에 true 를 반환하도록 판단 로직을 적용했다.

• isRuntime() , matches(... args) : isRuntime() 이 값이 참이면 matches(... args) 메서드가 대신 호출된다. 동적으로 넘어오는 매개변수를 판단 로직으로 사용할 수 있다.

  • isRuntime() 이 false 인 경우 클래스의 정적 정보만 사용하기 때문에 스프링이 내부에서 캐싱을 통해 성능 향상이 가능하지만, isRuntime() 이 true 인 경우 매개변수가 동적으로 변경된다고 가정하기 때문에 캐싱을 하지 않는다.
  • 크게 중요한 부분은 아니니 참고만 하고 넘어가자

• new DefaultPointcutAdvisor(new MyPointcut(), new TimeAdvice())

  • 어드바이저에 직접 구현한 포인트컷을 사용한다.

• 실행 결과

#save() 호출
AdvisorTest - 포인트컷 호출 method=save targetClass=class
hello.proxy.common.service.ServiceImpl
AdvisorTest - 포인트컷 결과 result=true
TimeAdvice - TimeProxy 실행
ServiceImpl - save 호출
TimeAdvice - TimeProxy 종료 resultTime=1ms
#find() 호출
AdvisorTest - 포인트컷 호출 method=find targetClass=class
hello.proxy.common.service.ServiceImpl
AdvisorTest - 포인트컷 결과 result=false
ServiceImpl - find 호출

• 실행 결과를 보면 기대한 것과 같이 save() 를 호출할 때는 어드바이스가 적용되지만, find() 를 호출할 때는 어드바이스가 적용되지 않는다.

• save() 호출

• find() 호출
  • 포인트컷이 적용되지 않는 경우

1. 클라이언트가 프록시의 find() 를 호출한다.
2. 포인트컷에 Service 클래스의 find() 메서드에 어드바이스를 적용해도 될지 물어본다.
3. 포인트컷이 false 를 반환한다. 따라서 어드바이스를 호출하지 않고, 부가 기능도 적용되지 않는다.
4. 실제 인스턴스를 호출한다.

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

• AdvisorTest - advisorTeset3() 추가

@Test
@DisplayName("스프링이 제공하는 포인트컷")
void advisorTest3() {
		ServiceImpl target = new ServiceImpl();
		ProxyFactory proxyFactory = new ProxyFactory(target);
		NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut();
		pointcut.setMappedNames("save");
		DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor(pointcut, new TimeAdvice());
		proxyFactory.addAdvisor(advisor);
		ServiceInterface proxy = (ServiceInterface) proxyFactory.getProxy();

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

• NameMatchMethodPointcut 사용 코드

NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut();
pointcut.setMappedNames("save");

• NameMatchMethodPointcut을 생성하고setMappedNames(...)성된다. 으로 메서드 이름을 지정하면 포인트컷이 완성된다.

#save() 호출
TimeAdvice - TimeProxy 실행
ServiceImpl - save 호출
TimeAdvice - TimeProxy 종료 resultTime=1ms
#find() 호출
ServiceImpl - find 호출

• 실행 결과를 보면 save() 를 호출할 때는 어드바이스가 적용되지만, find() 를 호출할 때는 어드바이스가 적용되지 않는다.

✅ 스프링이 제공하는 포인트컷

• 스프링은 무수히 많은 포인트컷을 제공한다.

• 대표적인 몇가지만 알아보자.

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

✅ 가장 중요한 것은 aspectJ 표현식

• 여기에서 사실 다른 것은 중요하지 않다. 실무에서는 사용하기도 편리하고 기능도 가장 많은 aspectJ 표현식을 기반으로 사용하는 AspectJExpressionPointcut 을 사용하게 된다.
• aspectJ 표현식과 사용방법은 중요해서 이후 AOP를 설명할 때 자세히 설명하겠다.
• 지금은 Pointcut 의 동작 방식과 전체 구조에 집중하자.

7️⃣ 예제 코드4 - 여러 어드바이저 함께 적용

✅ 의문점

• 어드바이저는 하나의 포인트컷과 하나의 어드바이스를 가지고 있다.
• 만약 여러 어드바이저를 하나의 target 에 적용하려면 어떻게 해야할까?
• 쉽게 이야기해서 하나의 target 에 여러 어드바이스를 적용하려면 어떻게 해야할까?

여러 프록시

• MultiAdvisorTest

package hello.proxy.advisor;

import hello.proxy.common.service.ServiceInterface;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.aop.framework.ProxyFactory;
import org.springframework.aop.support.DefaultPointcutAdvisor;
import org.springframework.cglib.proxy.MethodInterceptor;

public class MultAdvisorTest {

    @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);
        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();
        }
    }
}

• 위 코드는 런타임에 다음과 같이 동작한다.

• 실행결과

MultiAdvisorTest$Advice2 - advice2 호출
MultiAdvisorTest$Advice1 - advice1 호출
ServiceImpl - save 호출

• 포인트컷은 advisor1 , advisor2 모두 항상 true 를 반환하도록 설정했다. 따라서 둘다 어드바이스가 적용된다.

✅ 여러 프록시의 문제

• 이 방법이 잘못된 것은 아니지만, 프록시를 2번 생성해야 한다는 문제가 있다. 만약 적용해야 하는 어드바이저가 10개라면 10개의 프록시를 생성해야한다.

• 하나의 프록시

• MutlAdvisorTest - multiAdvisorTest2() 추가

@Test
@DisplayName("하나의 프록시, 여러 어드바이저")
void multiAdvisorTest2() {
		//proxy -> advisor2 -> advisor1 -> target
		DefaultPointcutAdvisor advisor2 = new DefaultPointcutAdvisor(Pointcut.TRUE,new Advice2());
		DefaultPointcutAdvisor advisor1 = new DefaultPointcutAdvisor(Pointcut.TRUE,new Advice1());

		ServiceInterface target = new ServiceImpl();
		ProxyFactory proxyFactory1 = new ProxyFactory(target);
		proxyFactory1.addAdvisor(advisor2);
		proxyFactory1.addAdvisor(advisor1);
		ServiceInterface proxy = (ServiceInterface) proxyFactory1.getProxy();

		//실행
		proxy.save();
}

• 프록시 팩토리에 원하는 만큼 addAdvisor() 를 통해서 어드바이저를 등록하면 된다.
• 등록하는 순서대로 advisor 가 호출된다. 여기서는 advisor2 , advisor1 순서로 등록했다.

• 실행 결과

MultiAdvisorTest$Advice2 - advice2 호출
MultiAdvisorTest$Advice1 - advice1 호출
ServiceImpl - save 호출

• 실행 결과를 보면 advice2 , advice1 순서대로 호출된 것을 알 수 있다.

✅ 정리

• 결과적으로 여러 프록시를 사용할 때와 비교해서 결과는 같고, 성능은 더 좋다.