Spring AOP

이 문서에서는 Spring Legacy Project를 기준으로 Spring AOP 를 적용하는 방법에 대해서 다룬다.

Spring AOP

• AOP의 개념을 이해하고 설명할 수 있다.

• Spring Legacy Project에 AOP 설정을 수행할 수 있다.

• AOP에 사용하는 aspectj 표현식을 작성할 수 있다.

AOP란

AOP는 Aspect Oriented Programming 의 줄임말이다. 직역하면 측면(관점) 지향 프로그래밍이 되는데 이를 조금 더 풀어서 설명한다면 내가 바라보는 관점에서 필요한 대상에게만 수행하는 프로그래밍이라고 볼 수 있다. Java와 Spring에서는 AsjectJ가 표준으로 사용되며 따라서 적용하려면 AsjectJ 관련 라이브러리들이 필요하다.

다음 그림을 보면서 추가적으로 AOP에 대해 이해해본다.

요리 재료를 관점(Aspect)에 따라 분류

그림에 따르면 재료는 다음과 같이 필요하다.

• 요리재료 : 밥, 떡, 쫄면사리, 오징어, 돼지고기, 김치, 계란, 간장, 참기름, 물엿, 버터, 고추장

• 제육덮밥 : 밥, 돼지고기, 김치, 참기름, 고추장

• 오징어덮밥 : 밥, 오징어, 참기름, 고추장

• 버터밥 : 밥, 계란, 간장, 버터

• 떡볶이 : 떡, 계란, 물엿, 고추장

• 쫄볶이 : 떡, 쫄면사리, 계란, 물엿, 고추장

• 쫄면 : 쫄면사리, 계란, 참기름, 고추장

요리 재료가 맞는지보다 중요한 것은 요리에 따라 필요한 재료가 다르다는 것이다. 즉, 하고자 하는 요리가 결정되면 재료를 바라보는 관점(Aspect)이 달라진다는 것이다. 관점이 무엇이냐에 따라서 필요한 재료가 달라지는 것처럼, 원하는 작업에 따라 다양한 대상들을 선별하는 것이 Aspect의 핵심이다.

이는 웹 애플리케이션 역시 마찬가지이다.

웹 애플리케이션의 관점에 따른 분류

어느 시점으로 웹 애플리케이션을 바라보느냐에 따라서 필요한 컴포넌트가 달라지며, 이 관점에 알맞게 해당 컴포넌트를 간섭하여 특정 작업을 추가하는 것이 AOP의 최종 목표라고 볼 수 있다.

진행 절차

프로젝트 생성

Spring MVC Project를 생성한 뒤 다음과 같이 설정한다.

• project이름 : springaop

• base패키지 : com.hakademy.aop

의존성 추가

Spring-AOP를 위해서는 다음 의존성이 필요하다.

• org.aspectj.aspectjrt(Spring MVC Project 기본 내장)

• org.aspectj.aspectjweaver

• org.springframework.spring-aop

버전은 작성 시점에 따라 달라질 수 있으며, 이 문서를 작성하는 시점에서는 다음과 같은 버전을 사용하였다.

• aspectjrt, aspectjweaver : 1.9.5

• spring-aop : 4.3.25.RELEASE

AOP 설정

Spring MVC Project에서는 모든 component-scan이 DispatcherServlet의 설정파일인 servlet-context.xml에 설정되어 있다. 원하면 바꿀 수도 있지만, 설정파일을 최소한으로 변경하여 사용하기 위해 servlet-context.xml에 AOP 설정을 한다.

Spring-AOP 네임스페이스 추가

AspectJ Auto Proxy 설정 추가

Auto Proxy에 대해서는 하위 문서에서 설명한다.

Aspect 생성 및 설정

본격적으로 간섭을 시도하려면 먼저 다음 내용들을 정해야 한다.

1. 간섭하여 하고자 하는 내용을 작성

2. 간섭하고자 하는 시점을 지정

3. 간섭하고자 하는 대상을 수식으로 지정

수행할 내용은 다음과 같은 형태의 클래스로 정의한다.

@Aspect
@Component
public class TestAspect{

}

@Aspect 애노테이션을 이용하여 이 클래스는 간섭을 위한 것임을 명시한다. @Component 애노테이션을 이용하여 클래스를 스프링 컨테이너에 등록한다(@Service 등으로 등록해도 무방)

클래스 안에 내용은 다음과 같이 작성한다.

@Aspect
@Component
public class TestAspect{

    private static final Logger log = LoggerFactory.getLogger(TestAspect.class);
    
    public void before(){
        log.info("before 실행");
    }
    
}

Logger를 생략하고 싶다면 @Slf4j로 대체한다.

@Aspect
@Component
@Slf4j
public class TestAspect{

    public void before(){
        log.info("before 실행");
    }
    
}

다음은 간섭 시점을 설정해야 하는데, 간섭 시점은 크게 5가지로 구분된다.

• @Before : 간섭 대상 실행 전

• @After : 간섭 대상 실행 후

• @AfterReturning : 간섭 대상 실행 성공시

• @AfterThrowing : 간섭 대상 실행 오류시

• @Around : 간섭 대상의 실행 전체상황

사용법이 비교적 간단한 @Before와 @After를 사용하여 간섭 시점을 설정해본다.

@Before("target(com.hakademy.aop.HomeController)")
@After("target(com.hakademy.aop.HomeController)")

위의 두 애노테이션을 번갈아서 메소드에 작성해본 뒤 어떠한 효과가 발생하는지에 대해서 살펴보도록 한다. target은 대상 패키지나 클래스를 지정할 때 사용하는 명령이며, 자세한 종류는 하위 문서에서 다룬다.

@Before

@Aspect
@Component
@Slf4j
public class TestAspect{

    @Before("target(com.hakademy.aop.HomeController)")
    public void before(){
        log.info("before 실행");
    }
    
}

실행하면 다음과 같은 결과 화면이 나온다.

INFO : com.hakademy.aop.aspect.TestAspect - before 실행
INFO : com.hakademy.aop.HomeController - Welcome home! The client locale is ko_KR.

기본적으로 제공되는 HomeController를 간섭했기 때문에 HomeController의 모든 메소드가 실행될 때마다 @Before 시점에 우리가 추가한 간섭 객체 @Aspect의 메소드가 실행된다.

@After

@Aspect
@Component
@Slf4j
public class TestAspect{

    @After("target(com.hakademy.aop.HomeController)")
    public void after(){
        log.info("after 실행");
    }
    
}

실행하면 다음과 같은 결과 화면이 나온다.

INFO : com.hakademy.aop.HomeController - Welcome home! The client locale is ko_KR.
INFO : com.hakademy.aop.aspect.TestAspect - after 실행

HomeController의 모든 메소드가 실행될 때마다 @After 시점에 우리가 추가한 간섭 객체 @Aspect의 메소드가 실행된다.

이 외에도 @AfterReturning, @AfterThrowing을 테스트해보면 대략적인 시점을 알 수 있다. (단, @AfterThrowing은 대상 실행 중 예외 발생 시에만 확인이 가능하다)