Spring AOP (Aspect Oriented Programming)

Spring AOP(Aspect Oriented Programming)

개요

관점 지향 프로그래밍(AOP)은 문제를 바라보는 관점을 기준으로 프로그래밍 하는 기법이다. 공통된 관심사항을 모듈화하여 여러 코드에 쉽게 적용할 수 있도록 도와준다. 이를 구현하기 위해 기존의 OOP 방식으로는 한계가 있어 (상속, 위임 등으로 해결하려 하지만 코중복된 코드 등의 한계 발생) AOP개념이 도입되었다. 그렇기 때문에 OOP와는 반대되는 개념이 아닌 보완을 해주는 개념이라고 볼 수 있다.

Spring IoC 컨테이너에 의존하지 않기 때문에 필요하지 않으면 사용하지 않아도 무방하다. 이러한 특성 때문에 핵심 비즈니스 로직을 변경하지 않고도 공통 관심 기능을 추가, 적용할 수 있다.

공통 관심 기능은 주로 로깅, 트랜잭션, 인증 등이 있다.

용어

• JoinPoint : Advice 적용 가능한 지점(메서드 호출, 값 변경 등)
• PointCut : 실제 Advice가 적용되는 지점(JoinPoint 부분집합)
• Advice : 언제 로직에 적용할지 등의 정의(before, after, around,…)
• Weaving : Advice를 실제 로직에 적용하는 것을 의미
• Aspect : 공통으로 적용되는 기능을 의미(로깅, 트랜잭션 등)

3가지 Weaving 방식

• 컴파일 시 : AspectJ에서 사용하는 방식. 컴파일 할 때 알맞은 위치에 공통 코드를 삽입하면 컴파일 결과 AOP가 적용된 클래스파일이 생성 -> 원본 변경됨
• 클래스 로딩 시 : 로딩한 클래스의 바이너리 정보를 변경하여 공통 코드를 삽입한 새로운 클래스 바이너리 코드로 사용하도록 함. -> 원본 변경 X
• 런타임 시 : 프록시를 이용하여 AOP적용. 소스, 클래스 정보 변경하지 않는다.

스프링에서 AOP

• 스프링은 자체적으로 프록시 기반의 AOP를 지원한다.
• 메서드 호출 JoinPoint만 지원.
• 필드 값 변경 등을 이용하려면 AspectJ와 같은 도구를 이용해야 한다.

구현 방법

• XML스키마 기반의 POJO클래스를 이용한 방법
• AspectJ에서 정의한 애노테이션 기반
• Spring API를 이용한 구현(많이 사용되진 않는다)

기본적으로 프록시 방식으로 적용된다.

Advice 종류

Aspect에 적용가능한 Advice의 종류는 다음과 같다.

• Before : 메서드 호출 전
• After Returning : 메서드가 예외없이 실행된 이 후
• After Throwing : 메서드 예외가 발생했을 때 이 후
• After : 예외 여부 상관없이 메서드 호출 후
• Around : 메서드의 실행 전과 후, 예외 발생 시점 전부 (가장 범용적)

XML스키마 기반으로 구현하기

구현하는 방법은 아래 순서대로 이루어진다.

1. Dependency 추가
2. 공통 기능 제공할 클래스 정의
3. XML설정으로 Aspect를 정의

1. Dependency 추가

AOP를 적용하기 위해 Spring-AOP, AspectJ 두 가지 의존을 추가해야 한다.

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aop</artifactId>
	<version>4.3.6.RELEASE</version>
</dependency>
<dependency>
	<groupId>org.aspectj</groupId>
	<artifactId>aspectjweaver</artifactId>
	<version>1.7.4</version>
</dependency>

spring-aop대신 context로 추가해도 무방하다. (aop를 이미 의존하고 있기 때문)

2. 공통 기능 제공할 클래스 정의

Advice구현 클래스 정의.

package com.navercorp.test.aop;

import org.aspectj.lang.ProceedingJoinPoint;

public class Profiler {
	
	public Object trace(ProceedingJoinPoint joinPoint) throws Throwable {
		long start = System.currentTimeMillis();
		System.out.println("시작");
		try {
			return joinPoint.proceed();
		} finally {
			System.out.println("종료");
			long finish = System.currentTimeMillis();
			System.out.println("실행시간 : " + (finish - start) + "ms");
		}
	}
}

언제 실행될지 어떤 모듈에 정할지 등의 정보는 없고 오로지 공통 수행 기능에 대한 부분만 명시되어 있다.

3. XML설정으로 Aspect를 정의

XML설정 파일에 Aspect관련 설정을 추가한다.

<bean id="profiler" class="com.xxxx.Profiler" />

<aop:config>
   	<aop:aspect id="traceAspect" ref="profiler">
   		<aop:pointcut expression="execution(public * com.navercorp.test..*())" id="publicMethod"/>
   		<aop:around method="trace" pointcut-ref="publicMethod"/>
	</aop:aspect>
</aop:config>

aspect ref는 Profiler 클래스를 정의한 빈의 id.
pointcut을 정할 때 expression을 활용해서 다양하게 적용할 수 있다.
around의 method는 실제 적용될 메서드 (Profiler에서는 trace) 명을 지정하고 pointcut-ref는 pointcut의 id 입력

Advice 타입 별 클래스 작성

1. Before : pointcut-ref, method="before", before() 메서드 정의, 파라메터는 JoinPoint, 리턴타입은 void
2. After Returning : pointcut, method, 리턴받을 파라메터 지정 returning="ret", void afterReturing(Object ret), Object 대신 특정 타입 지정 가능, 정보 필요하면 JoinPoint 매개변수로 지정
3. After Throwing : throwing="ex"
4. After : 리턴값은 void
5. Around : 메서드 첫 파라미터는 반드시 ProceedingJoinPoint 선언

호출되는 메서드에 대한 정보나 파라미터에 대한 정보가 필요하면 JoinPoint 를 파라미터로 명시한다.

애노테이션 기반으로 구현하기

1. @Aspect 애노테이션으로 Aspect클래스 구현
2. XML설정이나 @Configuration 기반 설정에서 autoproxy 설정을 해줘야 한다

1. 애노테이션으로 Aspect클래스 구현

위의 Profiler 클래스를 애노테이션 기반으로 구현한다.

@Aspect
public class Profiler {
	
	@Pointcut("execution(public * com.navercorp.test..*())")
	private void profileTarget() {}
	
	@Around("profileTarget()")
	public Object trace(ProceedingJoinPoint joinPoint) throws Throwable {
		long start = System.currentTimeMillis();
		System.out.println("시작");
		try {
			return joinPoint.proceed();
		} finally {
			System.out.println("종료");
			long finish = System.currentTimeMillis();
			System.out.println("실행시간 : " + (finish - start) + "ms");
		}
	}
}

2. autoproxy설정

빈이 하나 이상의 관점으로 Advice가 되는지 스프링이 결정한다. 빈의 메서드 호출을 가로채고 필요할 때 Advice를 수행할 수 있도록 자동으로 프록시를 설정해야 한다.

• XML기반

  
  <aop:aspectj-autoproxy />
  

• Java Config기반

  
  @EnableAspectJAutoProxy
  

@Pointcut 이용한 Pointcut설정

@Pointcut("execution(public * com..*(..))")
private void pointcut() {}

• value로 pointcut 표현식을 사용
• 적용된 메서드의 리턴타입은 void
• 메서드 내 코드는 없다. 있어도 무의미.
• Advice의 pointcut-ref나 value에 정의된Pointcut메서드명이 포함된다.

Pointcut Expression

• execution(수식어패턴? 리턴타입패턴 클래스이름패턴?메서드이름패턴(파라미터패턴))
• within : 특정 타입에 속하는 메서드. ex)within(com.navercorp..*)
• bean : 빈 이름을 이용한 정의, ex) bean(readArticle), bean(*Article)

and, or로 expression의 조합이 가능하다

@AfterThrowing(pointcut="execution(public * get*()) and execution(public * set*())")

Advice 적용 순서

하나 이상의 Advice가 적용된 경우 순서를 명시할 수 있다. 방법은 2가지가 존재한다.

• @Order
• Ordered 인터페이스 구현

@Order

Aspect 클래스를 지정하기 위해 @Aspect를 적용하는데, 이 때 Order 애노테이션을 적용한다.

@Aspect
@Order(2)
public class LogginAspect {
	...
}

Order에 들어간 숫자는 순서 값. 낮을 수록 우선순위가 높다. (1이 2보다 먼저)

XML 에서도 적용 가능.
<aop:aspect id='xx' ... order="2">

Ordered 인터페이스 구현

getOrder 메서드를 재정의하는데 메서드의 리턴값을 정의.