AOP

이용만·2023년 4월 5일

https://jiwondev.tistory.com/152
AOP에 대한 설명이 잘 나와 있다.

핵심 포인트

객체 지향 프로그래밍(OOP)는 객체 지향 프로그래밍이다.

OOP 방식의 프로그래밍을 했을 때 여러 곳에서 공통적으로 사용되는 부가 기능의 중복 코드가 발생하게 된다.

중복되는 부가 기능에 수정 및 삭제가 필요하게 되면 사용되는 모든 곳에 수정 및 삭제 동작을 해줘야한다.

관심 지향 프로그래밍(AOP)은 OOP 방식의 불필요한 반복을 해결하기 위한 방법이다.

AOP 용어입니다.

애스팩트(Aspect)

여러 객체에 공통으로 적용되는 기능을 말합니다. (공통 기능)

어드바이스 + 포인트컷을 모듈화하여 애플리케이션에 포함되는 횡단 기능입니다.

여러 어드바이스와 포인트컷이 함께 존재합니다.

조인 포인트(join point)
클래스 초기화, 객체 인스턴스화, 메소드 호출, 필드 접근, 예외 발생과 같은 애플리케이션 실행 흐름에서의 특정 포인트를 의미합니다.
애플리케이션에 새로운 동작을 추가하기 위해 조인포인트에 관심 코드(aspect code)를 추가할 수 있습니다.
횡단 관심은 조인포인트 전/후에 AOP에 의해 자동으로 추가됩니다.
추성적인 개념이고 AOP를 적용할 수 있는 모든 지점이라 생각하면 됩니다.
스프링 AOP는 프록시 방식을 사용하므로 조인 포인트는 항상 메소드 실행 지점으로 제한됩니다.
어드바이스 적용이 필요한 곳은 애플리케이션 내에 메서드를 갖습니다.

어드바이스(Advice)

조인포인트에서 수행되는 코드를 의미합니다.

Aspect를 언제 핵심 코드에 적용할 지를 정의합니다.

시스템 전체 애스펙트에 API 호출을 제공합니다.

위 그림처럼 메소드를 호출하기 전에 각 상세 정보와 모든 메소드를 로그로 남기기 위해 메소드 시작 전의 포인트인 조인포인트 S를 선택합니다.

부가 기능에 해당됩니다.

위빙(Weaving)

포인트컷으로 결정한 타겟의 조인 포인트에 어드바이스를 적용하는 것입니다.

Advice를 핵심 코드에 적용하는 것을 의미합니다.

핵심 기능 코드에 영향을 주지 않고 부가 기능을 추가 할 수 있습니다.

AOP 적용을 위해 애스펙트 객체에 연결한 상태입니다.

컴파일 타임(AspectJ compoiler)

로드 타임

런타임, 스프링 AOP는 런타임, 프록시 방식입니다.

AOP 프록시(proxy)

AOP 기능을 구현하기 위해 만든 프록시 객체입니다.

스프링에서 AOP 프록시는 JDK 동적 프록시 또는 CGLIB 프록시입니다.

타겟 (Target)

핵심 기능을 담고 있는 모듈로 타겟은 부가기능을 부여할 대상이 됩니다.

Adivce를 받는 객체이고 포인트컷으로 결정됩니다.

어드바이저(Advisor)

하나의 어드바이스와 하나의 포인트 컷으로 구성됩니다.

스프링 AOP에서만 사용되는 특별한 용어입니다.

타입별 Advice

어드바이스(Advice)

Aspect를 언제 핵심 코드에 적용할지를 정의합니다.

부가 기능에 해당됩니다.

특정 조인 포인트에서 애스팩트에 의해 취해지는 조치입니다.

Advice 순서
어드바이스는 기본적으로 순서를 보장하지 않습니다.

순서를 지정하고 싶으면 @Aspect 적용 단위로 애너테이션을 적용해야 합니다.
org.springframework.core.annotation.@Order
어드바이스 단위가 아니라 클래스 단위로 적용할 수 있습니다.

하나의 애스펙트에 여러 어드바이스가 존재하면 순서를 보장 받을 수 없습니다.

애스펙트를 별도의 클래스로 분리해야 합니다.

Advice 종류

Before

조인 포인트 실행 이전에 실행합니다.
타겟 메서드가 실행되기 전에 처리해야할 필요가 있는 부가 기능을 메서드 호출 전에 실행합니다.
Before Advice 구현한 메서드는 일반적으로 리턴타입이 void입니다.
- 리턴 값을 갖더라도 실제 Advice 적용 과정에 아무 영향이 없습니다.
주의점으로 메서드에서 예외를 발생시킬 경우 대상 객체의 메서드가 호출되지 않게 된다는 점이 있습니다.

@Before("hello.aop.order.aop.Pointcuts.orderAndService()")
public void doBefore(JoinPoint joinPoint) {
    log.info("[before] {}", joinPoint.getSignature());
}

작업 흐름을 변경할 수 없습니다.
메서드 종료 시 자동으로 다음 타겟이 호출됩니다. (예외가 발생하면 다음 코드는 호출되지 않는다.)

After returning

조인 포인트가 정상 완료 후 실행합니다.
메서드가 예외 없이 실행된 이후에 공통 기능을 실행합니다.

@AfterReturning(value = "hello.aop.order.aop.Pointcuts.orderAndService()", returning = "result")
public void doReturn(JoinPoint joinPoint, Object result) {
    log.info("[return] {} return={}", joinPoint.getSignature(), result);
}

메서드 실행이 정상적으로 반환될 때 실행됩니다.
returning 속성에 사용된 이름은 어드바이스 메서드의 매개변수 이름과 일치해야 합니다.
returning 절에 지정된 타입의 값을 반환하는 메서드만 대상을 실행합니다.

After 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());
}

메서드 실행이 예외를 던져서 종료될 때 실행합니다.
throwing 속성에 사용된 이름은 어드바이스 메서드의 매개변수 이름과 일치해야 합니다.
throwing 절에 지정된 타입과 맞은 예외를 대상으로 실행합니다.

After (finally)

조인 포인트의 동작(정상 또는 예외)과는 상관없이 실행합니다.
- 예외 동작의 finally를 생각하면 됩니다.
메서드 실행 후 공통 기능을 실행합니다.
일반적으로 리소스를 해제하는데 사용합니다.

Around

서드 호출 전후에 수행하며 가장 강력한 어드바이스입니다.
- 조인 포인트 실행 여부 선택, 반환 값 변환, 예외 변환 등이 가능합니다.
메서드 실행 전 & 후, 예외 발생 시점에 공통 기능을 실행합니다.
가장 강력한 어드바이스입니다.
- 조인 포인트 실행 여부 선택 - joinPoint.proceed()
- 전달 값 변환 - joinPoint.proceed(args[])
- 반환 값 변환
- 예외 변환
- try ~ catch ~ finally 가 들어가는 구문 처리 가능합니다.
어드바이스의 첫 번째 파라미터는 ProceedingJoinPoint를 사용해야 합니다.
proceed()를 통해 대상을 실행합니다.
proceed()를 여러번 실행할 수 있습니다.

포인트컷과 표현식 & 지시자

포인트컷은 관심 조인 포인트를 결정하므로 어드바이스가 실행되는 시기를 제어할 수 있습니다.
AspectJ는 포인트컷을 편리하게 표현하기 위한 특별한 표현식을 제공합니다.
ex) @Pointcut("execution(* hello.aop.order..*(..))")
포인트컷 표현식은 AspectJ pointcut expression ⇒ AspectJ가 제공하는 포인트컷 표현식을 줄여서 표현하는 것

포인트컷 지시자

포인트컷 표현식은 execution 같은 포인트컷 지시자(Pointcut Designator, PCD)로 시작합니다.
execution

메서드 실행 조인트 포인트를 매칭한다.

스프링 AOP에서 가장 많이 사용하며, 기능도 복잡하다.

Pointcut 표현식 결합

포인트컷 표현식은 &&, ||, ! 를 사용하여 결합할 수 있습니다.
이름으로 pointcut 표현식을 참조할 수도 있습니다.

@Pointcut("execution(public * *(..))")
private void anyPublicOperation() {} // (1)

@Pointcut("within(com.xyz.myapp.trading..*)")
private void inTrading() {} // (2)

@Pointcut("anyPublicOperation() && inTrading()")
private void tradingOperation() {} // (3)

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 Point
조인 포인트는 추상적인 개념이고, AOP를 적용할 수 있는 지점을 의미합니다.

어드바이스가 적용될 수 있는 위치, 메소드 실행, 생성자 호출, 필드 값 접근, static 메서드 접근 같은 프로그램 실행 중 지점을 나타냅니다.
AspectJ를 사용해서 컴파일 시점과 클래스 로딩 시점에 적용하는 AOP는 바이트코드를 실제 조작하기 때문에 해당 기능을 모든 지점에 다 적용할 수 있습니다.
프록시 방식을 사용하는 스프링 AOP는 메서드 실행 지점에만 AOP를 적용할 수 있습니다.
프록시는 메서드 오버라이딩 개념으로 동작합니다.
생성자나 static 메서드, 필드 값 접근에는 프록시 개념이 적용될 수 없습니다.
프록시를 사용하는 스프링 AOP의 조인 포인트는 메서드 실행으로 제한됩니다.
프록시 방식을 사용하는 스프링 AOP는 스프링 컨테이너가 관리할 수 있는 스프링 빈에만 AOP를 적용할수 있습니다.
JoinPoint 메소드는 어드바이스의 종류에 따라 사용방법이 다소 다르지만 기본적으로 어드바이스 메소드에 매개변수로 선언만 하면 됩니다.

JoinPoint 인터페이스의 주요 기능

JoinPoint.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

@AspectJ 지원

@AspectJ는 애너테이션이 있는 일반 Java 클래스로 관점을 선언하는 스타일을 말합니다.

@AspectJ 스타일은 AspectJ 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으로 @AspectJ 지원을 활성화하려면 @EnableAspectJAutoProxy 애너테이션을 추가합니다.
```
@Configuration
@EnableAspectJAutoProxy
public class AppConfig {
}
	```
```

Aspect 선언

@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 표현식일 수 있습니다.

이용만

성장하는 개발자가 되고자 합니다.

이전 포스트

Bean 등록 및 의존 관계 설정방법

다음 포스트

AOP