[Spring boot] AOP (관점 지향 프로그래밍) 이해 및 활용

스프링 AOP ( Aspect Oriented Programming )

 

AOP는 Aspect Oriented Programming의 약자로 관점 지향 프로그래밍이라고 불린다. 관점 지향은 쉽게 말해 어떤 로직을 기준으로 핵심적인 관점, 부가적인 관점으로 나누어서 보고 그 관점을 기준으로 각각 모듈화하겠다는 것이다. 여기서 모듈화란 어떤 공통된 로직이나 기능을 하나의 단위로 묶는 것을 말한다. 

 

예로들어 핵심적인 관점은 결국 우리가 적용하고자 하는 핵심 비즈니스 로직이 된다. 또한 부가적인 관점은 핵심 로직을 실행하기 위해서 행해지는 데이터베이스 연결, 로깅, 파일 입출력 등을 예로 들 수 있다.

 

AOP에서 각 관점을 기준으로 로직을 모듈화한다는 것은 코드들을 부분적으로 나누어서 모듈화하겠다는 의미다. 이때, 소스 코드상에서 다른 부분에 계속 반복해서 쓰는 코드들을 발견할 수 있는 데 이것을 흩어진 관심사 (Crosscutting Concerns)라 부른다. 

 

흩어진 관심사들을 모아서 공용화 한다.

 

 

AOP를 위한 주요 개념

AOP 주요 개념

• Aspect : 위에서 설명한 흩어진 관심사를 모듈화 한 것. 주로 부가기능을 모듈화함.
• Target : Aspect를 적용하는 곳 (클래스, 메서드 .. )
• Advice : 실질적으로 어떤 일을 해야할 지에 대한 것, 실질적인 부가기능을 담은 구현체
• JointPoint : Advice가 적용될 위치, 끼어들 수 있는 지점. 메서드 진입 지점, 생성자 호출 시점, 필드에서 값을 꺼내올 때 등 다양한 시점에 적용가능
• PointCut : JointPoint의 상세한 스펙을 정의한 것. 'A란 메서드의 진입 시점에 호출할 것'과 같이 더욱 구체적으로 Advice가 실행될 지점을 정할 수 있음

@Around 어노테이션은 타겟 메서드를 감싸서 특정 Advice를 실행한다는 의미이다. 위 코드의 Advice는 타겟 메서드가 실행된 시간을 측정하기 위한 로직을 구현하였다. 추가적으로 execution(* com.saelobi..*.EventService.*(..))가 의미하는 바는 com.saelobi 아래의 패키지 경로의 EventService 객체의 모든 메서드에 이 Aspect를 적용하겠다는 의미다.

 

@Around("execution(* com.saelobi..*.EventService.*(..))")
public Object logPerf(ProceedingJoinPoint pjp) throws Throwable{
    long begin = System.currentTimeMillis();
    Object retVal = pjp.proceed(); // 메서드 호출 자체를 감쌈
    System.out.println(System.currentTimeMillis() - begin);
    return retVal;
}

 

이 밖에도 @Around 외에 타겟 메서드의 Aspect 실행 시점을 지정할 수 있는 어노테이션이 있다.

• @Before (이전) : 어드바이스 타겟 메소드가 호출되기 전에 어드바이스 기능을 수행
• @After (이후) : 타겟 메소드의 결과에 관계없이(즉 성공, 예외 관계없이) 타겟 메소드가 완료 되면 어드바이스 기능을 수행
• @AfterReturning (정상적 반환 이후)타겟 메소드가 성공적으로 결과값을 반환 후에 어드바이스 기능을 수행
• @AfterThrowing (예외 발생 이후) : 타겟 메소드가 수행 중 예외를 던지게 되면 어드바이스 기능을 수행
• @Around (메소드 실행 전후) : 어드바이스가 타겟 메소드를 감싸서 타겟 메소드 호출전과 후에 어드바이스 기능을 수행

 

위 @Around에 Url 기반 트리거 외에도 특정 Annotation이 붙은 메소드에 대해서 AOP가 실행되게 할수도 있다.

 

우선 아래와 같이 메소드에 붙일 사용자 Annotation을 생성한다.

package com.sdp.common.util;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Documented
@Target(ElementType.METHOD)
public @interface UrlLogging {

}

 

그리고 아래와 같이 @Aspect config 에

 

아래와 같이 포인트컷에 어노테이션을 지정해주면 해당 어노테이션이 붙은 메소드가 실행될때를 감지한다.

@Pointcut("@annotation(com.sdp.common.util.UrlLogging)")

 

보통 AOP를 적용시 포인트컷에 해당하는 메소드가 실행될때 인자를 가지고 활용을 하는경우가 많다. 예를 들어 해당 메소드를 호출한 장비의 디바이스 아이디가 필요하다... 는 경우 등이다.

 

이럴 경우 위 포인트 컷 다음에 @Before 등으로 트리거를 추가해주면 해당 메소드에 JoinPoint인자로 PointCut에 의해 호출한 메소드의 인자가 넘어온다.

@Aspect
@Component
public class RestAopConfig {

   private static final Logger logger = LoggerFactory.getLogger(RestAopConfig.class);

   @Autowired
   RestAopMapper restAopMapper;

   @Pointcut("@annotation(com.sdp.common.util.UrlLogging)")
   public void triggerUrlLogging() {
   }

   @Before("triggerUrlLogging()")
   public void before(JoinPoint jointPoint) {
      Object[] args = jointPoint.getArgs();

   }
}

 

 

아래는 AOP 를 수행할 원본 메소드이고  @UrlLogging 어노테이션을 걸어둔 모습이다.

@UrlLogging
@RequestMapping(value = "/renewal/pms/branchForm")
public String branchForm(HttpServletRequest request, HttpServletResponse response, String macAddr, BranchVO branchVO, RedirectAttributes redirectAttributes, AccWallVO accWallVO)
    throws Exception {
    String returnUrl = "";

    logger.error("branchVO : {}", branchVO.toString());
    logger.error("accWallVO : {}", accWallVO.toString());

 

위 API가 실행 될때 Aopconfig에 설정한 @Before 메소드에 브레이크를 걸어둔 모습이다. JoinPoint.getArgs()를 해보면 API실행 시 넘어온 인자들이 넘어오게 된다. AOP처리시 해당 인자들을 활용해서 로직 구현을 할 수 있다.