빈 후처리기

[cme10575]

빈 후처리기 (BeanPostProcessor)

• 빈 저장소에 등록하기 직전에 조작
• 스프링이 제공하는 인터페이스, 구현해서 빈으로 등록시키면 됨
• 빈 객체를 프록시로 교체 가능 (컴포넌트 스캔 포함)
• 스프링은 프록시를 생성하기 위한 빈 후처리기를 이미 만들어서 제공함 > 이거 사용

엄청 많은 빈이 등록되기 때문에 패키지로 프록시로 감쌀 빈을 제한해야한다. 포인트컷을 사용하면 더 효율적일 것 스프링 AOP는 포인트컷을 사용해 프록시 대상 여부 체크

스프링이 제공하는 빈 후처리기

• implementation 'org.springframework.boot:spring-boot-starter-aop'

AutoProxyCreator (AnnotationAwareAspectJAutoProxyCreator)

• 프록시를 자동으로 생성해주는 빈 후처리기
• 스프링 빈에 등록된 Advisor를 자동으로 찾아 필요한 곳에 프록시 자동 적용해줌
• 어드바이저만 빈으로 등록하면 끝!

포인트컷의 사용처

1. 프록시 적용 어부 판단 - 생성 단계
2. 어드바이스 적용 여부 판단 - 사용 단계

AspectJExpressionPointcut

• 패키지에 메서드 이름까지 지정할 수 있는 정밀한 포인트컷
• '반환타입/패키지/메서드 이름과 파라미터'로 지정

[LeeeeDain]

세션 8. 빈 후처리기

빈 후처리기

• BeanPostProcessor
• 빈 저장소에 등록하기 직전에 빈을 조작하기 위해 사용
• 빈 후처리기를 사용해 실제 객체 대신 프록시를 스프링 빈으로 등록하면 수동으로 등록한 빈은 물론이고, 컴포넌트 스캔을 사용하는 빈까찌 모두 프록시를 적용할 수 있다.
• 빈 후처리기를 사용하면 프록시를 생성하는 코드가 설정 파일에는 필요 없어지고 빈 후처리기 하나에 집중되어 빈이 추가되어도 프록시와 관련된 코드는 전혀 변경하지 않아도 된다.
• 프록시 적용 대상은 basePackage 와 pointcut을 이용해 제한하는 것이 좋다.
• 스프링은 이미 프록시를 생성하기 위한 빈 후처리기를 제공 중이기 때문에 실제로는 이걸 그냥 가져다 쓰면 된다.

빈 후처리기 사용방법

• BeanPostProcessor 인터페이스를 구현하고, 스프링 빈으로 등록하면 됨

• public interface BeanPostProcessor {
  // 객채 생성 이후에 @PostConstruct 같은 초기화가 발생하기 전에 호출되는 포스트 프로세서
  Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException
  // 객채 생성 이후에 @PostConstruct 같은 초기화가 발생한 다음에 호출되는 포스트 프로세서
  Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException
  }

• 예시 - beanA를 A객체 대신에 B객체로 변경하는 빈 후처리기

  @Slf4j
  static class AToBPostProcessor implements BeanPostProcessor {
  
      @Override
      public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
          log.info("beanName={} bean={}", beanName, bean);
          if (bean instanceof A) {
              return new B();
          }
          return bean;
      }
  }

로그 찍는 빈 후처리기 예제

• 빈 후처리기 클래스

  @Slf4j
  public class PackageLogTracePostProcessor implements BeanPostProcessor {
  
  private final String basePackage;
  private final Advisor advisor;
  
  public PackageLogTracePostProcessor(String basePackage, Advisor advisor) {
      this.basePackage = basePackage;
      this.advisor = advisor;
  }
  
  @Override
  public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
      log.info("param beanNAme={] bean={}", beanName, bean.getClass());
  
      // 프록시 적용 대상 여부 체크
      // 프록시 적용 대상이 아니면 원본을 그대로 진행
      String packageName = bean.getClass().getPackageName();
      if (!packageName.startsWith(basePackage)) {
          return bean;
      }
  
      // 프록시 대상이면 프록시를 만들어서 반환
      ProxyFactory proxyFactory = new ProxyFactory(bean);
      proxyFactory.addAdvisor(advisor);
  
      Object proxy = proxyFactory.getProxy();
      log.info("create proxy: target={} proxy={}", bean.getClass(), proxy.getClass());
      return proxy;
  }
  }

• 빈 후처리기 빈으로 등록하는 config 클래스

  @Slf4j
  @Configuration
  @Import({AppV1Config.class, AppV2Config.class})
  public class BeanPostProcessorConfig {
  
  @Bean
  public PackageLogTracePostProcessor logTracePostProcessor(LogTrace logTrace) {
      return new PackageLogTracePostProcessor("hello.proxy.app", getAdvisor(logTrace));
  }
  
  private Advisor getAdvisor(LogTrace logTrace) {
      // pointcut
      NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut();
      pointcut.setMappedNames("request*", "order*", "save*");
      // advice
      LogTraceAdvice advice = new LogTraceAdvice(logTrace);
      return new DefaultPointcutAdvisor(pointcut, advice);
  }
  }

• 이제 로그 찍는 프록시를 생성하는 코드가 설정 파일에는 필요 없다. 프록시를 생성하고 프록시를 스프링 빈으로 등록하는 것은 빈 후처리기가 모두 처리해준다.

스프링이 제공하는 빈 후처리기

• 스프링이 제공하는 빈 후처리기를 사용하려면 다음을 꼭 추가해주어야 한다.

  • implementation 'org.springframework.boot:spring-boot-starter-aop'

• AnnotationAwareAspectJAutoProxyCreator 라는 자동으로 프록시를 생성해주는 빈 후처리기가 스프링 빈에 자동 등록된다.

  • 이 빈 후처리기는 스프링 빈으로 등록된 Advisor를 찾아 자동으로 프록시를 적용한다. 왜냐면 Advisor 안에 pointcut(적용 범위)와 advice(프록시 기능)이 모두 포함되어 있기 때문에 자동으로 적용할 수 있다.

  • 여러 Advisor의 포인트컷을 모두 만족하면 프록시를 한 개 생성하고, 프록시에 만족하는 Advisor를 모두 포함시킨다.

  • @AspectJ 와 관련된 AOP 기능도 자동으로 찾아서 처리해준다. (뒤에서 설명)

• 예제

  @Slf4j
  @Import({AppV1Config.class, AppV2Config.class})
  public class AutoProxyConfig {
  
  @Bean
  public Advisor advisor2(LogTrace logTrace) {
      // pointcut
      AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut();
      pointcut.setExpression("execution(* hello.proxy.app..*(..))");
  
      // advice
      LogTraceAdvice advice = new LogTraceAdvice(logTrace);
      return new DefaultPointcutAdvisor(pointcut, advice);
  }
  }

포인트컷 사용처

1. 프록시 적용 여부를 판단할 때 - 생성 단계
   • 클래스 + 메서드 조건을 모두 비교한다. 이 때 메서드 하나라도 맞는게 있으면 프록시를 생성한다.
     • ex) AController에는 request(), noLog() 메서드가 있는데 여기서 reqeust()가 포인트컷 조건에 만족하므로 `AController는 프록시를 생성한다.
2. 어드바이스 적용 여부를 판단할 때 - 사용 단계
   • 프록시가 호출되었을 때 프록시 내부에서 부가 기능인 어드바이스를 적용할지 포인트컷을 보고 판단한다.
     • ex) AController에서 request() 메서드는 포인트컷 조건에 만족하므로 프록시는 어드바이스를 먼저 호출하고, target을 호출한다. AController에서 noLog() 메서드는 포인트컷 조건에 만족하지 않으므로 프록시는 어드바이스를 호출하지 않고, target만 호출한다.

AspectJExpressionPointcut

• AspectJ라는 AOP에 특화된 포인트컷 표현식을 이용한 스프링이 제공하는 매우 정밀한 포인트컷

• 실무에서 실제로 이것만 사용

• As-is

  • NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut();
    pointcut.setMappedNames("request*", "order*", "save*");

• To-be

  • AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut();
    pointcut.setExpression("execution(* hello.proxy.app..*(..)) && !execution(* hello.proxy.app..noLog(..))");

[LeeeeDain]

스프링에서도(스프링부트x) aspectj를 사용해 aop를 어노테이션으로 설정 가능하다. 참고: https://heidi-mood.com/80