AOP가 필요한 이유
- 핵심기능 (Core Concerns): 업무 로직을 포함하는 기능
- 부가기능 (Cross-cutting Concerns): 핵심 기능을 도와주는 부가적인 기능
- 로킹, 보안, 트랙잭션 등
- Aspect: 부가 기능을 정의한 코드인 어드바이스(Advice)와 어드바이스를 어디에 적용할지 결정하는 포인트컷(PointCut)을 합친 개념
(Advice + PointCut = Aspect)
객체지향프로그래밍 (Oject Oriented Programming: OOP)
이전과 현재에 많은 프로젝트는 OOP 패러다임을 지향하며 프로그래밍함. 정의된 기능을 재사용하기 위해 동작보다는 객체를 중심으로 프로그래밍하는 OOP가 등장함.
- OOP의 핵심은 공통된 목적을 띈 데이터와 동작을 묶어 하나의 객체로 정의하는 것임
- 객체를 적극적으로 활용함으로써 기능을 재사용할 수 있는 것이 큰 장점임
- 객체를 잘 활용하기 위해선 관심사 분리 (Separation of Concerns, SoC)의 디자인 원칙을 준수해야 함
주요 개념
- Spring MVC 구조는
@Controller
, @Service
, @Repository
와 같이 관심사 별로 계층을 나눠 객체를 관리하게 됨
- 관심사 분리는 모듈와의 핵심임
문제점
- 특정 관심사 업무 코드에 트랜잭션, 보안, 로깅 등의 코드가 존재하게 됨
- 트랜잭션, 보안, 로깅 코드는 업무와는 관련이 없지만 애플리케이션에 필수적인 부가 긴으임
- 트랜잭션, 보안, 로깅 기능은 불특정 다수의 클래스에서 존재하게 됨
- 관심사 관점에서는 트랜잭션, 보안, 로깅 코드를 횡단 관심사(Cross-cutting Concerns: 부가 기능)라고 함
- 업무 관련 코드는 핵심 관심사(Core Concerns: 핵심 기능)라고 함
- 비즈니스 클래스에 횡단 관심사와 핵심 관심사가 공존하게 됨
- 메소드 복잡도 증가 -> 비즈니스 코드 파악이 어려움
- 부가 기능의 불특정 다수 메소드가 반복적으로 구현 -> 횡단 관심사의 모듈화가 어려움
AOP의 등장
OOP만 사용해선 횡단 관심사 코드를 깔끔하게 분리하고 비즈니스 코드에 적용하기 어려움. 이러한 OOP의 관심사 분리에 대한 한계적인 부분을 해결하고자 AOP가 등장함
AOP란?
AOP(Aspect-Oriented Programming)은 기존과 다른 프로그램 구조 사고 방식을 제공함으로써 객체 지향 프로그래밍(OOP)의 부족한 부분을 보완함. OOP의 모듈화의 핵심 단위는 클래스이고, AOP의 모듈화의 핵심 단위는 관점임. Aspect는 여러 유형과 객체 간에 발생하는 문제 (예. 트랜잭션)의 모듈화를 가능하게 함.
AOP의 핵심 기능과 부가 기능
- 핵심 기능 (Core Concern): 객제가 제공하는 고유의 기능(업무 로직 등을 포함)임
- 부가 기능(Cross-curring Concern)
- 핵심 기능을 보조하기 위해 제공되는 기능
- 로그 추족 로직, 보안, 트랜잭션 기능 등이 있음
- 단독으로 사용되지 않고 핵심 기능과 함께 사용됨
- 핵심 기능인 OO 로직과 부가기능인 로그 추적 로직이 하나의 객체로 들어감
- 부가 기능이 필요한 경우엔 아래와 같은 형태로 합쳐져서 하나의 로직을 완성하게 됨
- 서비스를 실행하면 핵심 기능과 부가 기능이 함께 실행됨
여러 곳에서 공통으로 사용하는 부가 기능
부가 기능은 보통 여러 클래스에 걸쳐서 함께 사용됨. 이러한 부가 기능은 횡단 관심사가 됨
- 부가 기능을 여러 곳에 적용하려면 번거롭고 중복 코드가 생기게 됨
- 부가 기능에 수정이 필요하게 되면 사용되는 클래스에 모두 하나씩 찾아가면서 수정해야함
AOP가 필요한 이유
소프트웨어 개발에서 변경 지점은 하나가 될 수 있도록 잘 모듈화해야 함. 부가 기능처럼 특정 로직을 애플리케이션 전반에 적용하는 문제는 일반적인 OOP 방식으로는 해결이 어렵기 때문에 핵심 기능과 부가 기능을 분리하는 AOP 방식이 필요함
핵심 포인트
- 객체 지향 프로그래밍(OOP)
- OOP 방식의 프로그래밍을 했을 때 여러 곳에서 공통적으로 사용되는 부가 기능의 중복 코드가 발생하게 됨
- 중복되는 부가 기능에 수정 및 삭제가 필요하게 되면 사용되는 모든 곳에 수정 및 동작을 해줘야함
- 관심 지향 프로그래밍(AOP)은 OOP 방식의 불필요한 반복을 해결하기 위한 방법임
AOP 용어
AOP의 용어 및 개념들
애스펙트(Aspect)
- 여러 객체에 공통으로 적용되는 기능을 말함 (공통 기능)
- 어드바이스 + 포인트컷을 모듈화하여 애플리케이션에 포함되는 횡단 기능임
- 여러 어드바이스와 포인트컷이 함께 존재함
조인 포인트(join point)
- 클래스 초기화, 객체 인스턴스화, 메소드 호출, 필드 접근, 예외 발생과 같은 애플리케이션 실행 흐름에서의 특정 포인트를 의미함
- 애플리케이션에 새로운 동작을 추가하기 위해 조인 포인트에 관심 코드(aspect code)를 추가할 수 있음
- 횡단 관심은 조인포인트 전,후에 AOP에 의해 자동으로 추가됨
- 추상적인 개념이고 AOP를 적용할 수 있는 모든 지점이라고 생각하면 됨
- 스프링 AOP는 프록시 방식을 사용하므로 조인 포인트는 항상 메소드 실행 지점으로 제한됨
- 어드바이스 적용이 필요한 곳은 애플리케이션 내에 메서드를 가짐
어드바이스(Advice)
- 조인포인트에서 수행되는 코드를 의미
- Aspect를 언제 핵심 코드에 적용할지 정의
- 시스템 전체 애스펙트에 API 호출을 제공함
- 메소드를 호출하기 전에 각 상세 정보와 모든 메소드를 로그로 남기기 위해 메소드 시작 전의 포인트인 조인포인트 S를 선택함
- 부가 기능에 해당됨
포인트컷(Pointcut)
- 조인 포은트 중에서 어드바이스가 적용될 위치를 선별하는 기능임
- AspectJ 표현식을 사용해서 지정함
- 프록시를 사용하는 스프링 AOP는 메서드 실행 지점만 포인트컷으로 선별 가능함
위빙(Weaving)
- 포인트컷으로 결정한 타겟의 조인 포인트에 어드바이스를 적용하는 것
- Advice를 핵심 코드에 적용하는 것
- 핵심 기능 코드에 영향을 주지 않고 부가 기능을 추가할 수 있음
- AOP 적용을 위해 애스펙트 객체에 연결한 상태임
- 컴파일 타임(AspectJ complier)
- 로드타임
- 런타임, 스프링 AOP는 런타임, 프록시 방식임
AOP 프록시(proxy)
- AOP 기능을 구현하기 위한 프록시 객체임
- 스프링에서 AOP 프록시는 JDK 동적 프록시 또는 CGLIB 프록시임
타겟(Target)
- 핵심 기능을 담고 있는 모듈로 타겟은 부가기능을 부여할 대상이 됨
- Advice를 받는 객체이고 포인트컷으로 결정됨
어드바이저(Advisor)
- 하나의 어드바이스와 하나의 포인트컷으로 구성됨
- 스프링 AOP에서만 사용되는 특별한 용어
타입별 Advice
어드바이스(Advice)
- Aspect를 언제 핵심 코드에 적용할지를 정의함
- 부가 기능에 해당됨
- 특정 조인 포인트에서 애스팩트에 의해 취해지는 조치
Adivce 순서
어드바이스는 기본적으로 순서를 보장하지 않음
- 순서를 지정하고 싶으면
@Aspect
적용 단위로 org.springframework.core.annotation.@Order
애너테이션을 적용해야함.
- 어드바이스 단위가 아니라 클래스 단위로 적용할 수 있음
- 하나의 애프팩트에 여러 어드바이스가 존재하면 순서를 보장받을 수 없음
- 애스팩트를 별도의 클래스로 분리해야 함
Advice 종류
Beofre
- 조인 포인트 실행 이전에 실행 함
- 타겟 메서드가 실행되기 전에 처리해야할 필요가 있는 부가 기능을 메서드 호출 전에 실행함
- Before Advice 구현한 메서드는 일반적으로 리턴타입이 void임
- 리턴 값을 갖더라도 실제 advice 적용 과정에 아무 영향이 없음
- 주의점으로 메서드에서 예외를 발생시킬 경우 대상 객체의 메서드가 호출되지 않게 된다는 점이 있음
- 예제
- 작업 흐름을 변경할 수 없음
- 메서드 종료 시 자동으로 다음 타겟이 호출됨 (예외가 발생하면 다음 코드는 호출되지 않음)
@Beofre("hello.aop.order.aop.Pointcuts.orderAndService()")
public void doBefore(JoinPoint joinPoint) {
log.info("[before] {}", joingPoint.getSignature());
}
After retunrning
- 조인 포인트가 정상 완료 후 실행됨
- 메서드가 예외 없이 실행된 이후에 공통 기능을 실행함
- 예제
- 메서드 실행이 정상적으로 반환될 때 실행함
- returning 속성에 사용된 이름은 어드바이스 메서드의 매개변수 이름과 일치해야 함
- returning 절에 지정된 타입의 값을 반환하는 메서드만 대상을 실행함
@AfterRetuning(value = "hello.aop.order.aop.Pointcuts.orderAndService()", returning = "result")
public void doReturn(JoinPoint joinPoint, Object result) {
log.info("[return] {} return={}", joinPoint.getSignature(), result);
}
After throwing
- 메서드가 예외를 던지는 경우에 실행
- 메서드가 실행하는 도중 예외가 발생하는 경우 공통 기능을 실행함
- 예제
- 메서드 실행이 예외를 던져서 종료될 때 실행
- throwing 속성에 사용된 이름은 어드바이스 메서드의 매개변수 이름과 일치해야 함
- throwing절에 지정된 타입과 맞는 예외를 대상으로 실행함
@AfterThrowing(value = "hello.aop.order.aop.Pointcuts.orderAndService()", throwing="ex")
public void doThrowing(JoinPoint joinPoint, Exception ex) {
log.info("[ex] {} message={}", joinPoint.getSignature(), ex.getMessage());
}
After (finally)
- 조인 포인트의 동작(정상 또는 예외)과는 성관없이 실행함. (예외 동작의 finally와 비슷한 기능)
- 메서드 실행 후 공통 기능을 실행함
- 일반적으로 리소스를 해제하는데 사용함
Around
- 메서드 호출 전후에 수행하며 가장 강력한 어드바잇
- 조인 포인트 실행 여부 선택, 반환 값 변환, 예외 변환 등이 가능함
- 조인 포인트 실행 여부 선택 - joinPoint.proceed()
- 전달 값 변환 - joinPoint.proceed(args[])
- 반환 값 변환
- 예외 변환
- try ~ catch ~ finally
가 들어가는 구문 처리 가능
- 메서드 실행 전, 후, 예외 발생 시점에 공통 기능을 실행함
- 어드바이스의 첫 번째 파라미터는
ProceedingJoinPoint
를 사용해야함
proceed()
를 통해 대상을 실행함
proceed()
를 여러 번 실행 할 수 있음
@Around만 있어도 모든 기능 수행이 가능함
가장 강력한 어드바이스이며 대부분의 기능을 제공하지만 타겟 등 고려해야할 사항이 있을 때 정상적으로 작동이 되지 않는 경우가 있음
- @Before, @After와 같은 어드바이스는 기능은 적지만 원하는대로 작동되고 코드도 단순함
- 각 애너테이션만 봐도 타겟 실행 전에 어떤 일을 하는지 명확하게 알 수 있음
- 좋은 설계는 @Around만 사용해서 해결하는 것보다는 제약을 가지더라도 실수를 미연에 방지하는 것
- 제약을 두면 문제 자체가 발생하지 않게 하며, 역할이 명확해짐
Pointcut 표현식
포인트 컷과 표현식 & 지시자
포인트컷은 관심 조인 포인트를 결정하므로 어드바이스가 실행되는 시기를 제어할 수 있음. AspectJ는 포인트컷을 편리하기 위해 특별한 표현식을 제공함
@Pointcut("execution(* transfer(..))"
private void anyOldTransfer(){}
포인트컷 표현식은 AspectJ poincut expression ⇒ AspectJ가 제공하는 포인트컷 표현식을 줄여서 표현하는 것
포인트컷 지시자
포인트컷 표현식은 execution같은 포인트컷 지시자 (Pointcut Designator, PCD)로 시작함
포인트컷 지시자 종류
종류 | 설명 |
---|
execution | 메서드 실행 조인 포인트를 매칭함. 스프링 AOP에서 가장 많이 사용하며 기능도 복잡함 |
within | 특정 타입 내의 조인 포인트를 매칭함 |
args | 인자가 주어진 타입의 인스턴스의 조인 포인트 |
this | 스프링 빈 객체(스프링 AOP 프록시)를 대상으로 하는 조인 포인트 |
target | Target 객체(스프링 AOP 프록시가 가르키는 실제 대상)를 대상으로 하는 조인 포인트 |
@target | 실행 객체의 클래스에 주어진 타입의 애너테이션이 있는 조인 포인트 |
@within | 주어진 애너테이션이 있는 타입 내 조인 포인트 |
@annotation | 메서드가 주어진 애너테이션을 가지고 잇는 조인 포인트를 매칭 |
@args | 전달된 실제 인수의 런타임 타입이 주어진 타입의 애너테이션을 갖는 조인 포인트 |
bean | 스프링 전용 포인트컷 지시자에고 빈의 이름으로 포인트컷을 지정함 |
execution
을 가장 많이 사용하고 나머지는 자주 사용하지 않음.
Pointcut 표현식 결합
포인트컷 표현식은 &&
, ||
, !
를 사용하여 결합할 수 있음. 이름으로 pointcut 표현식을 참조할 수도 있음.
@Pointcut("execution(public * *(..))")
private void anyPublicOperation() {}
@Pointcut("within(com.xyz.myapp.trading..*)")
private void inTrading() {}
@Pointcut("anyPublicOperation() && inTrading()")
private void tradingOperation() {}
(1) anyPublicOperation
은 메서드 실행 조인 포인트가 공용 메서드으이 실행을 나타내는 경우 일치함
(2) inTrading
메서드 실행이 거래 모듈에 있는 경우에 일치함
(3) tradingOperation
은 메서드 실행이 거래 모듈의 공개 메서드를 나타내는 경우 일치함
일반적인 pointcut 표현식들
- 모든 공개 메서드 실행
- execution(public * *(..))
set
다음 이름으로 시작하는 모든 메서드 실행
- execution(* set*(..))
AccountService
인터페이스에 의해 정의된 모든 메소드의 실행
- execution(* com.xyz.service.AccountService.*(..))
service
패키지에 정의된 메서드 실행
- execution(* com.xyz.service*.*(..))
- 서비스 패키지 또는 해당 하위 패키지 중 하나에 정의된 메서드 실행
- execution(* com.xyz.service..*.*(..))
- 서비스 패키지 내의 모든 조인 포인스 (Spring AOP에서만 메서드 실행)
- within(com.xyz.service.*)
- 서비스 패키지 또는 하위 패키지 중 하나 내의 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- within(com.xyz.service..*)
AccountService
프록시가 인터페이스를 구현하는 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- this(com.xyz.service.AccountService)
AccountService
대상 객체가 인터페이스를 구현하는 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- target(com.xyz.service.AccountService)
- 단일 매개변수를 사용하고 런타임에 전달된 인수가
Serializable
과 같은 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- args(java.io.Serializable)
- 대상 객체
@Transactional
애너테이션이 있는 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- @target(org.springframework.transaction.annotation.Transactional
- 실행 메서드에 @Transactional 애너테이션이 있는 조인 포인트 (Spring AOP에서만 메서드 실행)
- @annotation(org.springframework.transaction.annotation.Transactional)
- 단일 매개 변수를 사용하고 전달된 인수의 런타임 유형이 @Classified 애너테이션을 갖는 조인 포인트 (Spring AOP에서만 메서드 실행)
- @args(com.xyz.security.Classified)
tradeService
라는 이름을 가진 스프링 빈의 모든 조인 포인트 (Spring AOP에서만 메서드 실행)
- bean(tradeService)
- 와일드 표현식
*Service
라는 이름을 가진 스프링 빈의 모든 조인 포인트
- bean(*Service)
JoinPoint
AOP 적용 위치
- AOP는 지금까지 학습한 메서드 실행 위치 뿐만 아니라 다양한 위치에 적용할 수 있음
- 적용 가능 지점(조인 포인트): 생성자, 필드 값 접근, static 메서드 접근, 메서드 실행
- AOP를 수행하는 메서드는 이 joinPoint 인스턴스를 인자로 받게 됨
- JoinPoint 인스턴스에서 조인 포인트 지점의 정보를 얻어내야 함
Join Pint
조인 포인트는 추상 개념이고, AOP를 적용할 수 있는 지점을 의미함
- 어드바이스가 적용될 수 있는 위치, 메소드 실행, 생성자 호출, 필드 값 접근, static 메서드 접근 같은 프로그램 실행 중 지점을 나타냄
- AspectJ를 사용해서 컴파일 시점과 클래스 로딩 시점에 적용하는 AOP는 바이트코드를 실제 조작하기 때문에 해당 기능을 모든 지점에 다 적용할 수 있음
- 프록시 방식을 사용하는 스프링 AOP는 메서드 실행 지점에만 AOP를 적용할 수 있음
- 프록시는 메서드 오버라이딩 개념으로 동작함
- 생성자나 static 메서드, 필드 값 접근에는 프록시 개념이 적용될 수 없음
- 프록시를 사용하는 스프링 AOP의 조인 포인트는 메서드 실행으로 제한됨
- 프록시 방식을 사용하는 스프링 AOP는 스프링 컨테이너가 관리할 수 있는 스프링 빈에만 AOP를 적용할 수 있음
- JoinPoint 메소드는 어드바이스의 종류에 따라 사용방법이 다소 다르지만 기본적으로 어드바이스 메소드에 매개변수로 선언만 하면 됨
JoinPoint 인터페이스의 주요 기능
JoinPint.getArgs()
: JoinPoint에 전달된 인자를 배열로 반환함
JoinPoint.getThis()
: AOP 프록시 객체를 반환함
JoinPoint.getTarget()
: AOP가 적용된 대상 객체를 반환함
- 클라이언트가 호출한 비즈니스 메소드를 포함하는 비즈니스 객체를 반환함
JoinPoint.getSignature()
: 조언되는 메서드에 대한 설명을 반환함
- 클라이언트가 호출한 메소드의 시그니처(리턴타입, 이름, 매개변수) 정보가 저장된 Signature 객체를 반환함
- Signature
: 객체가 선언하는 모든 메서드에서 메서드의 이름, 매개변수를 담고 있는 객체들을 시그니처라고 함
- Signature가 제공하는 메서드
String getName()
: 클라이언트가 호출한 메서드의 이름을 반환함
String toLongString()
: 클라이언트가 호출한 메소드의 리턴타입, 이름, 매개변수를 패키지 경로까지 포함해서 반환함
String toShortString()
: 클라이언트가 호출한 메소드 시그니처를 축약한 문자열로 반환함
JoinPoint.toString()
: 조언되는 방법에 대한 유용한 설명을 인쇄함
ProceedingJoinPoint 인터페이스의 주요 기능
proceed()
: 다음 어드바이스나 타겟을 호출함
애너테이션(Annotation)을 이용한 AOP
Spring에서의 AOP
AOP는 스프링 IoC를 보완하여 매우 강력한 미들웨어 솔루션을 제공함
Spring AOP 지원
- @AspectJ 애너테이션 스타일
- 스키마 기반 접근
AspectJ 지원
@AspectJ는 애너테이션이 있는 일반 Java 클래스로 관점을 선언하는 스타일을 말함
- @AspectJ 스타일은 AspjectJ 5 릴리스의 일부로, AspectJ 프로젝트에 의해 도입됨
- 스프링은 pointcut 구문 분석 및 일치를 위해 AspectJ가 제공하는 라이브러리를 사용하여 AspectJ 5와 동일한 애너테이션을 해석함
- AOP 런타임은 여전히 순수한 스프링 AOP이며, AspectJ 컴파일러나 위버에 의존하지 않음
AspectJ 지원 활성화
- Spring 설정에서 @AspectJ aspect를 사용하기 위해서는 @AspectJ aspect에 기반한 Spring AOP 설정과 이러한 aspect에 의해 조언되는 자동 프록시 빈에 대한 Spring 지원을 활성화해야 함
- @AspectJ 지원은 XML 또는 Java 스타일 설정으로 활성화할 수 있음
- Java 설정으로 @AspectJ 지원 활성화 방법
@configuration
@EnableAspectJAutoProxy
public class AppConfig {
}
Apsect 선언
@AspectJ 지원이 활성화되면 @AspectJ 관점(@Aspect 애너테이션이 있음) 이 있는 클래스로 애플리케이션 컨텍스트에 정의된 모든 빈이 Spring에서 자동으로 감지되고 Spring AOP를 구성하는 데 사용됨
import org.aspectj.lang.annotation.Aspect;
@Aspect
public class NotVeryUsefulAspect {
}
포인트컷 선언
- 포인트컷은 관심 조인 포인트를 결정하므로 어드바이스가 실행되는 시기를 제어할 수 있음
- Spring AOP는 Spring Bean에 대한 메소드 실행 조인 포인트만 지원하므로 Pointcut은 Spring Bean의 메소드 실행과 일치하는 것으로 볼 수 있음
- Pointcut 선언은 이름과 매개변수를 포함하는 서명과 우리가 관심 있는 메소드 실행을 정확히 결정하는 pointcut 표현식의 두 부분으로 구성
- Pointcut 표현식은
@Pointcut
애노테이션을 사용하여 표시됨
어드바이스 선언
- 어드바이스는 포인트컷 표현식과 연관되며 포인트컷과 일치하는 메서드 실행 전 또는 메서드 실행 이후에 실행됨
- Pointcut 푷현식은 명명된 pointcut에 대한 단순 참조이거나 제자리에 선언된 pointcut 표현식일 수 있음