📚 TIL 34일차

Spring AOP

AOP는 'Aspect Oriented Programming'의 약자로, 관점 지향 프로그래밍이라고도 한다. 관점 지향은 어떤 로직을 핵심적인 관점과 부가적인 관점으로 나누어서 보고, 그 관점을 기준으로 모듈화하는 것을 말한다.

*모듈화 : 어떤 공통된 로직이나 기능을 하나의 단위로 묶는 것

Advice

부가기능을 '언제 수행할건지' 결정한다. 예를 들면 핵심기능이 실행된 전이나 후가 될 수 있고, 전·후 전부가 될 수 있다. 또, 핵심기능 수행 성공 여부에 따라 동작할지도 결정할 수 있고, 핵심기능 수행의 결과로 반환된 결과물을 사용할지를 결정할 수도 있다.

1. @Around: '핵심기능' 수행 전과 후 (@Before + @After)
2. @Before: '핵심기능' 호출 전
   • ex. Client 의 입력값 Validation 수행
3. @After: '핵심기능' 수행 성공/실패 여부와 상관없이 언제나 동작
   • try, catch 의 finally() 처럼 동작
4. @AfterReturning: '핵심기능' 호출 성공 시 (함수의 Return 값 사용 가능)
5. @AfterThrowing: '핵심기능' 호출 실패 시. 즉, 예외 (Exception) 가 발생한 경우만 동작
   • ex. 예외가 발생했을 때 개발자에게 email 이나 SMS 보냄)

Pointcut

pointcut = 지점. 부가기능을 만든 후, 핵심기능의 어디에 붙일지(수행할지) 결정한다.

- 포인트컷 Expression 형태

? 는 생략 가능하다.

execution(modifiers-pattern? return-type-pattern declaring-type-pattern? method-name-pattern(param-pattern) throws-pattern?)

• modifiers-pattern
  • public, private, *
• return-type-pattern
  • void, String, List＜String＞, *
• declaring-type-pattern
  • 클래스명 (패키지명 필요)
  • com.sparta.myselectshop.controller.* - controller 패키지의 모든 클래스에 적용
  • com.sparta.myselectshop.controller.. - controller 패키지 및 하위 패키지의 모든 클래스에 적용
• method-name-pattern(param-pattern)
  • 함수명
    • addFolders : addFolders() 함수에만 적용
    • add* : add 로 시작하는 모든 함수에 적용
  • 파라미터 패턴 (param-pattern)
    • (com.sparta.myselectshop.dto.FolderRequestDto) - FolderRequestDto 인수 (arguments) 만 적용
    • () = 인수 없음
    • (*) = 인수 1개 (타입 상관없음)
    • (..) = 인수 0~N개 (타입 상관없음)

→ 포인트컷 Expression 예제

@Around("execution(public * com.sparta.myselectshop.controller..*(..))")
public Object execute(ProceedingJoinPoint joinPoint) throws Throwable { ... }

@Pointcut 사용 예제 1

@Component
@Aspect
public class Aspect {

	// 패키지의 모든 클래스에 적용 + 인수가 몇 개인지 상관없음
	@Pointcut("execution(* com.sparta.myselectshop.controller.*.*(..))")
	private void forAllController() {}

	// 반환 타입 String인 + 모든 클래스 + 인수 없음
	@Pointcut("execution(String com.sparta.myselectshop.controller.*.*())")
	private void forAllViewController() {}

	/* @Pointcut을 호출할 때는 메서드 명으로 */
    
    // 모든 컨트롤러이면서 && view 컨트롤러는 아닌(!)
	@Around("forAllContorller() && !forAllViewController()")
	public void saveRestApiLog() {
		...
	}

	// 모든 컨트롤러를 호출
	@Around("forAllContorller()")
	public void saveAllApiLog() {
		...
	}	
}

@Pointcut 사용 예제 2

@Slf4j(topic = "UseTimeAop")
@Aspect
@Component
@RequiredArgsConstructor
public class UseTimeAop {

    /* 생성자 주입 생략 */

	// ProductController + 인수 상관 없음
    @Pointcut("execution(* com.sparta.myselectshop.controller.ProductController.*(..))")
    private void product() {}
    
    // FolderController + 인수 상관 없음
    @Pointcut("execution(* com.sparta.myselectshop.controller.FolderController.*(..))")
    private void folder() {}
    
    // NaverApiController + 인수 상관 없음
    @Pointcut("execution(* com.sparta.myselectshop.naver.controller.NaverApiController.*(..))")
    private void naver() {}


	// product 혹은 folder 혹은 naver api 컨트롤러의
    // 앞 뒤로(@Around) execute() 실행
    @Around("product() || folder() || naver()")
    public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {
        // 측정 시작 시간
        // ...
        

execute() 내부에서는 핵심기능을 실행 후 → 부가기능을 실행한다.

@Around("product() || folder() || naver()")
public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {
	// 측정 시작 시간
	long startTime = System.currentTimeMillis();

	try {
		// 핵심기능 수행
		Object output = joinPoint.proceed();
		return output;
        
	} finally {
    	// ....
        

Spring AOP 동작 이해

시퀀스 다이어그램 (Sequence Diagram)

• AOP 적용 전
• AOP 적용 후

1. Spring이 프록시(가짜 혹은 대리) 객체를 중간에 삽입해준다.
2. DispatcherServlet 과 ProductController 입장에서는 변화가 전혀없다.
   • 호출되는 함수의 input, output 이 완전 동일하다.
   • joinPoint.proceed() 에 의해서 원래 호출하려고 했던 함수, 인수(argument) 가 전달된다.
     → createProduct(requestDto);