[Spring] AOP

AOP (Aspect Oriented Programming) 

• 관점 지향 프로그램
• 어떤 로직을 핵심적인 관점, 부가적인 관점으로 나누고, 그 관점을 기준으로 각각 모듈화 하여 비즈니스 로직을 헤치지 않고 재사용하는 프로그래밍 기법
  • 핵심적인 관점: 개발자가 적용하고자 하는 비즈니스 로직.
  • 부가적인 관점: 핵심 로직을 수행하기 위해 필요한 DB 연결(JDBC), 로깅, 파일 입출력 등

 

AOP의 장점 또는 사용하는 이유

• 공통 관심 사항을 핵심 관심사항으로부터 분리시켜 핵심 로직을 깔끔하게 유지할 수 있다.
• 그에 따라 코드의 중복 제거, 가독성, 유지보수성 등을 높일 수 있다.
• 각각의 모듈에 수정이 필요하면 다른 모듈의 수정 없이 해당 로직만 변경하면 된다.

 

AOP 주요 키워드

• Aspect
  • 흩어진 관심사(Crosscutting Concerns)를 묶어서 모듈화 한 것. 하나의 모듈. Advice와 Point Cut이 들어간다.
• Target
  • Aspect가 가지고 있는 Advice가 적용되는 대상(클래스, 메서드 등등)을 말한다.
•  Advice
  • 어떤 일을 해야 할 지에 대한 것. 해야 할 일들에 대한 정보를 가지고 있다.
• Join Point
  • Around Advice에서 사용할 공통 기능 매서드는 대부분 파라미터로 전달받은 ProceedingJoinPoint의 proceed() 매서드만 호출하면 된다. ProceedingJoinPoint 인터페이스안의 proceed()라는 메서드를 사용하면 어드바이스 혹은 대상 메서드를 실행한다.
    
•  Point Cut
  • Join Point의 상세한 스펙을 정의한 것. 어디에 적용해야 하는지에 대한 정보를 가지고 있다. 
     @Pointcut("execution(위치)") = “해당 위치에 있는 메서드에 aop를 적용한다”와 같은 구체적인 정보를 준다.

 

 

주요 Annotation

 

주요 키워드와 어노테이션을 배웠으니 간단한 예제를 통해 AOP를 직접 구현해보겠습니다. 해당 예제는 실행 시간을 출력하는 것인데요. 실행 시간을 출력하는 예제를 보면서 AOP 특징에 대해서 알아보겠습니다.

 

스프링 AOP 구현

 

먼저 aop를 사용하기위해서는 dependency를 추가를 해야 합니다. build.gradle 에 밑의 코드를 추가하고 gradle 새로고침을 해서 build 해줍니다. 해당 작업을 완료해야 @Aspect Annotation이 인식이 됩니다.

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

 

우선 aop를 사용하지않고 해당 작업을 구현해보도록 하겠습니다.

Custom annotation을 통해서 해당 annotation이 설정된 메서드만 실행시간을 측정할 수 있도록 @Timer을 생성하였습니다.

 

@Timer

 

 

@Target 은 Java compiler 가 annotation 이 어디에 적용될지 결정하기 위해 사용합니다. 예를 들어 위에서 사용한 Timer클래스 위에 선언한 ElementType.TYPE, ElementType.METHOD은 타입 선언과 메서드 선언할 때 해당 Annotation을 사용하겠다는 의미입니다.
@Retention 은 어느 시점까지 어노테이션의 메모리를 가져갈지 설정하는 어노테이션입니다.  RetentionPolicy.RUNTIME은 런타임 동안에 유지되고, 런타임을 종료할 때까지 메모리는 살아있다는 메타 정보입니다.

주로 custom annotation을 설정할때 @Retention과 @Target annotation을 사용합니다. 

 

 

그다음, @GetMapping, @PostMapping, @DeleteMapping 컨트롤 메서드를 가지고 있는 RestApiController 클래스를 생성하겠습니다.

 

RestApiController 

시간을 측정하기 위해 스프링 프레임워크에서 제공하는 유틸 중 하나인 StopWatch를 사용합니다. aop를 사용하지 않고 시간을 측정하게 된다면 각 메서드마다

StopWatch stopWatch = new StopWatch();
stopWatch.start();
stopWatch.stop();

위와 같은 동일한 코드를 중복으로 적어줘야 합니다.

비즈니스 로직과 상관없고 실제 로직이 아닌 부가적인 코드가 모든 메서드에 반복적으로 들어가 있습니다. 이 클래스는 서비스 로직인 핵심 코드로만 유지할 수 있게 부가적인 코드는  TimerAop 클래스를 만들어 빼주도록 하겠습니다.

 

TimerAop

 

Aop로 동작하기위해 @Aspect 어노테이션을 붙여주고 Spring에서 관리될 수 있게 @Component 어노테이션을 붙여줍니다.

@Pointcut 에는 aop를 적용시킬 path를 적어줍니다.  proceedingJoinPoint.proceed()는  aop가 적용된 메소드 전체를 실행합니다. 만약 반환되는 값이 있다면 상위 클래스인 Object 타입으로 받습니다.

시간을 측정하기위해서 전후 시간이 필요한데 @before, @After은 시간을 공유할 수 없기 때문에 @Around annotaion을 사용합니다.  @Around 어노테이션은 대상 객체의 메서드 실행 전, 후 시점에 공통기능을 실행합니다. 공통 기능을 구현한 매서드, cut() 메서드와 enableTImer() 메서드를 제어한다고 설정합니다.

즉, @Around 어노테이션을 통해 cut(), enableTimer()에서 설정한 aop 적용 위치의 메서드 실행 전후로 around() 메서드가 실행되며 기록을 저장합니다. 

 

RestApiController 

aop를 구현한후 RestApiController 클래스에는 서비스 로직만 남아 코드가 간결하고 깔끔해진 것을 볼 수 있습니다.

이런 식으로 aop를 구현하면 핵심 로직을 깔끔하게 유지할 수 있게 됩니다.