Spring AOP

Spring AOP 란?

• 스프링 프레임워크에서 제공하는 기능
• 관점 지향 프로그래밍을 지원하는 기술입니다.
• 로깅, 보안, 트랜잭션 관리 등과 같은 공통적인 관심사를 모듈화 하여 코드 중복을 줄이고 유지 보수성을 향상

 

1. @Aspect
   • Spring 빈(Bean) 클래스에만 적용 가능합니다.
2. 어드바이스 종류
   • @Around: '핵심기능' 수행 전과 후 (@Before + @After)
   • @Before: '핵심기능' 호출 전 (ex. Client 의 입력값 Validation 수행)
   • @After: '핵심기능' 수행 성공/실패 여부와 상관없이 언제나 동작 (try, catch 의 finally() 처럼 동작)
   • @AfterReturning: '핵심기능' 호출 성공 시 (함수의 Return 값 사용 가능)
   • @AfterThrowing: '핵심기능' 호출 실패 시. 즉, 예외 (Exception) 가 발생한 경우만 동작

(ex. 예외가 발생했을 때 개발자에게 email 이나 SMS 보냄)

 

3. 포인트컷 Expression Language

(AOP에서 어떤 메서드가 어드바이스를 적용받을지를 결정하는 일종의 필터 역할)

포인트컷 Expression 형태:

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

 

( ? 는 생략 가능 )

예제:

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

 

• 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개 (타입 상관없음)

• @Pointcut
  • 포인트컷 재사용 가능
  • 포인트컷 결합 (combine) 가능

@Component
@Aspect
public class Aspect {
    @Pointcut("execution(* com.sparta.myselectshop.controller.*.*(..))")
    private void forAllController() {}

    @Pointcut("execution(String com.sparta.myselectshop.controller.*.*())")
    private void forAllViewController() {}

    @Around("forAllContorller() && !forAllViewController()")
    public void saveRestApiLog() {
       ...
    }

    @Around("forAllContorller()")
    public void saveAllApiLog() {
       ...
    }
}

 

Spring AOP 적용

 

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

    private final ApiUseTimeRepository apiUseTimeRepository;

    public UseTimeAop(ApiUseTimeRepository apiUseTimeRepository) {
        this.apiUseTimeRepository = apiUseTimeRepository;
    }

    @Pointcut("execution(* com.sparta.myselectshop.controller.ProductController.*(..))")
    private void product() {}
    @Pointcut("execution(* com.sparta.myselectshop.controller.FolderController.*(..))")
    private void folder() {}
    @Pointcut("execution(* com.sparta.myselectshop.naver.controller.NaverApiController.*(..))")
    private void naver() {}

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

        try {
            // 핵심기능 수행
            Object output = joinPoint.proceed();
            return output;
        } finally {
            // 측정 종료 시간
            long endTime = System.currentTimeMillis();
            // 수행시간 = 종료 시간 - 시작 시간
            long runTime = endTime - startTime;

            // 로그인 회원이 없는 경우, 수행시간 기록하지 않음
            Authentication auth = SecurityContextHolder.getContext().getAuthentication();
            if (auth != null && auth.getPrincipal().getClass() == UserDetailsImpl.class) {
                // 로그인 회원 정보
                UserDetailsImpl userDetails = (UserDetailsImpl) auth.getPrincipal();
                User loginUser = userDetails.getUser();

                // API 사용시간 및 DB 에 기록
                ApiUseTime apiUseTime = apiUseTimeRepository.findByUser(loginUser).orElse(null);
                if (apiUseTime == null) {
                    // 로그인 회원의 기록이 없으면
                    apiUseTime = new ApiUseTime(loginUser, runTime);
                } else {
                    // 로그인 회원의 기록이 이미 있으면
                    apiUseTime.addUseTime(runTime);
                }

                log.info("[API Use Time] Username: " + loginUser.getUsername() + ", Total Time: " + apiUseTime.getTotalTime() + " ms");
                apiUseTimeRepository.save(apiUseTime);
            }
        }
    }
}

 

 

 

 

Spring이 프록시(가짜 혹은 대리) 객체를 중간에 삽입해줍니다.

DispatcherServlet 과 ProductController 입장에서는 변화가 전혀 없습니다.

호출되는 함수의 input, output 이 완전 동일합니다."

 

joinPoint.proceed()" 에 의해서 원래 호출하려고 했던 함수, 인수(argument) 가 전달됩니다. 

-> createProduct(requestDto);