[Spring Boot] AOP 사용 방법과 예시코드

 

의존성 추가

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-aop'
}

 

 

사용 방식

1. Aspect 정의 : @Aspect 애너테이션을 사용해서 Aspect 클래스를 정의한다
2. Advice 적용 : @Before, @After, @Around 등 다양한 Advice를 메서드에 적용한다. 특정 시점에 어떤 실행 로직을 실행할지 정의한다.
3. Pointcut 설정 : execution 표현식 등을 통해 특정 메서드, 패키지 등에만 Aspect가 적용되도록 설정한다
4. AOP 활성화 : @EnableAspectJAuotProxy 애너테이션을 Spring Boot 애플리케이션 클래스에 추가해 AOP를 활성화 한다

 

@EnableAspectJAutoProxy

• 스프링 컨텍스트 내에서 AspectJ AOP 프레임워크를 사용할 수 있도록 하는 애너테이션
• AOP 프록시 빈을 자동으로 등록하고 AOP를 사용할 수 있게 됨
• 해당 애너테이션을 사용하지 않아도 AspectJ AOP 프레임워크를 사용할 수 있음

 

동작과정

• AOP가 적용된 메서드 호출 시 Spring은 자동으로 설정된 Advice를 실행 
• 예를 들어 @Around Advice가 설정된 메서드는 AOP 프록시가 해당 메서드 호출을 가로챈 후 메서드 실행 전후 지정된 로직을 수행

 

시간 측정 Aspect 예제

 

• com.youable.aop_example.service.BankService의 메소드가 실행될 때 로깅 메서드를 호출하는 예제

package com.youable.aop_example.service;

@Service
@RequiredArgsConstructor
public class BankService {
    private final AccountRepository accountRepository;
    private final TransactionRepository transactionRepository;

    public String registAccount(
            RegistAccountRequest request
    ) {
        String accountNumber = UniqueValueGenerator.getAccountNumber();
        Account account = request.of(accountNumber, request);
        accountRepository.save(account);
        return accountNumber;
    }

    public Transaction deposit(TransactionRequest request) {
        Account account = accountRepository.findByAccountNumber(request.getAccountNumber())
                .orElseThrow(() -> new RuntimeException("account not found"));
		// 생략
        return transaction;
    }

    public Transaction withdrawal(TransactionRequest request) {
        Account account = accountRepository.findByAccountNumber(request.getAccountNumber())
                .orElseThrow(() -> new RuntimeException("account not found"));
		// 생략
        return transaction;
    }
}

• registAccount, deposit, withdrawal 메서드를 가지고 있음

@Aspect
@Component
@Slf4j
public class LoggingAspect {
    @Around("execution(* com.youable.aop_example.service.BankService.*(..))")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();

        Object result = joinPoint.proceed();

        long executionTime = System.currentTimeMillis() - start;
        log.info("실행 된 메소드 명 : {},  실행 시간 :  {} ms",
                joinPoint.getSignature().getName(), executionTime);

        return result;
    }
}

• ProceedingJoinPoint로 메서드 이름을 얻을 수 있음
• BankService의 메서드를 호출하면 AOP 설정에 따라 @Around Advice가 실행됨
• ProceedingJoinPoint의 proceed() 메서드를 호출하면 실제 메서드가 실행됨
• proceed에 의해 실제 메서드가 완료되면 메서드 후속 작업으로 돌아와 이후 로직을 수행

실행 된 메소드 명 : registAccount,  실행 시간 :  30 ms

• 실행 결과

메서드의 파라미터 가져오기

@Aspect
@Component
@RequiredArgsConstructor
@Slf4j
public class SecurityAspect {
    private final AccountRepository accountRepository;
    @Before("execution(* com.youable.aop_example.service.BankService.withdrawal(..))")
    public void checkSecurity(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        TransactionRequest transaction = (TransactionRequest) args[0];
       log.warn("Large amount withdrawal detected!");
       Account account = accountRepository.findByAccountNumberAndOwnerNameAndPassword(transaction.getAccountNumber(), transaction.getOwnerName(), transaction.getPassword())
               .orElseThrow(() -> new RuntimeException("fail authorization"));

    }
}

• Advice실행시 메서드의 파라미터를 JoinPoint로 부터 얻을 수 있음