[Spring] AOP 개념 및 적용하기

1. AOP란?

- 관점 지향 프로그래밍 (Aspect Oriented Programming)

- 프로젝트 구조를 바라보는 관점을 바꿔보자는 의미

- 횡단 관심사(Cross-Cutting Concern)의 분리를 허용함으로써 모듈성을 증가시키는 것이 목적인 프로그래밍 패러다임

- 여러 객체에 공통으로 적용할 수 있는 기능을 분리해서 개발자는 반복 작업을 줄이고 핵심 기능 개발에만 집중할 수 있음

 

간단하게 한줄로 AOP를 정리해보자면, AOP는 공통된 기능을 재사용하는 기법이다.

 

왜 사용해야할까??

 

 

위 사진은 우아한 테크 10분 테크톡 유튜브 영상에서 캡쳐한 사진이다. 

만약 3개의 메소드의 실행 시간을 측정해달라는 요청이 들어오면 메소드 시작 지점과 끝나는 지점의 시간을 측정해 이의 차이를 출력할 것이다. 

이러면 부가기능과 비즈니스 로직이 함께 있게 되고, 유지보수 뿐만 아니라 가독성도 떨어지게된다. 

 

위 사진에서  부가기능은 실행시간 측정, 로깅이고 이들을 묶은 것이 횡단 관심사이다. 

이런 상황에서 AOP를 사용한다면 다음과 같은 장점이 있다.

• 공통 관심 사항을 핵심 관심사항으로부터 분리시켜 핵심 로직을 깔끔하게 유지할 수 있다.
• 그에 따라 코드의 가독성, 유지보수성 등을 높일 수 있다.
• 각각의 모듈에 수정이 필요하면 다른 모듈의 수정 없이 해당 로직만 변경하면 된다.
• 공통 로직을 적용할 대상을 선택할 수 있다

 

 

2. AOP의 주요 개념

 

Target

부가기능을 부여할 대상(클래스)을 의미한다. 바로 아래서 설명하는 Aspect가 적용되는 대상을 의미한다.

 

 

Aspect

객체지향 모듈을 오브젝트라 부르는 것과 비슷하게 부가기능 모듈을 Aspect라고 부르며, 핵심 기능에 부가되어 의미를 갖는 특별한 모듈 이다.

Aspect = Advice + PointCut
Aspect 안에는 부가기능을 정의하는 Advice,

Advice를 어디에 적용할지 결정하는 PointCut이 있다.
참고로 AOP라는 뜻 자체가 애플리케이션의 핵심적인 기능에서 부가적인 기능을 분리해서 Aspect라는 모듈을 만들어 설계하고 개발하는 방법을 뜻한다.

 

 

Advice

Aspect에서 실질적으로 어떤 일을 해야할지에 대한 부가기능을 담은 구현체를 의미한다.
Advice는 Target Object에 종속되지 않기 때문에 순수하게 부가기능에만 집중할 수 있다. Advice는 Aspect가 ‘무엇’을 ‘언제’할지를 정의하고 있다.

 

 

JoinPoint

Advice가 적용될 위치를 의미한다.

Spring 프레임워크에서 JoinPoint라면 Advice가 적용되는 메서드라고 생각하면 된다.

 

 

PoinCut

부가기능이 적용될 대상(메서드)를 선정하는 방법을 의미한다.
Advice를 적용할 JoinPoint를 선별하는 기능을 정의한 모듈이다. JoinPoint의 상세한 기능을 정의하는 것이라고 생각하면 됩니다.

 

 

Proxy

Target을 감싸서 Target에 들어오는 요청을 대신 받아주는 Warpping 오브젝트이다.
Client에서 Target을 호출하게 되면 Target이 아닌 Target을 감싸고 있는 Proxy가 호출되어, Target 메서드 실행 전에 전처리, Target 메서드 실행 후 후처리를 실행시킬 수 있도록 구성되어 있다.

 

 

 

3. 사용법

@Aspect
@Component
public class TestAop {
    @Around("execution(* com.gjgs.modules.users.services.interfaces.UserService.getUser(..))")
    public void adviceMethod(ProceedingJoinPoint joinPoint){    
        Object result = null;
            try {
                System.out.println("AOP 시작");
                result = proceedingJoinPoint.proceed();
                System.out.println("AOP 종료");
            } catch (){
                ...
            }
    }
}

 

@Around는 Advice로서 Aspect가 ‘무엇을’, 언제’ 할지를 정의하는 부분에서 ‘언제’ 라는 시점을 정의한 것이다. 아래와 같이 5가지 타입이 존재한다.

 

• @Before
  • Advice 타겟 메서드가 호출되기 전에 Advice 기능을 수행
• @After
  • Target 메서드의 결과와 관계없이(성공,예외와 관계없이) Target 메서드가 완료되면 Advice 기능을 수행
• @AfterReturning(정상적 반환 이후)
  • Target 메서드가 성공적으로 결과값을 반환 후에 Advice 기능을 수행
• @AfterThrowing (예외 발생 이후)
  • Target 메서드가 수행 중 예외를 던지게 되면 Advice 기능을 수행
• @Around(메서드 실행 전후)
  • Target 메서드를 감싸서 Target 메서드 호출 전과 호출 후에 Advice 기능을 수행
  • Around의 경우, 인자로 ProceedingJoinPoint를 받아서 proceed 메서드를 실행시켜야만 합니다. proceed는 실제 Target 메서드를 실행하는 것이라고 보면 되고 앞 뒤에 메서드 실행 전, 후에 진행할 작업을 코딩면 된다.

 

 

execution(* com.gjgs.modules.users.services.impl.UserService.getUser(..))

 

Advice의 Value로 들어간 문자열을 PointCut 표현식 이라고 한다.
PointCut의 구성은 2가지로 분류되는데 execution을 지정자 라고 부르며 이외의 뒤쪽 부분은 Target 명세 라고 한다.
지정자는 총 9가지 타입이 있지만 자주 쓰는 execution과 @annotation 정도만 알아보자.

 

• execution()
  • 접근제한자, 리턴타입, 인자타입, 클래스/인터페이스, 메소드명, 파라미터타입, 예외타입 등을 전부 조합가능한 가장 세심한 지정자
  • ex) execution(* com.blogcode.service.AccountService.*(..)
    • AccountService 인터페이스의 모든 메소드
• @annotation()
  • Target 메서드에 특정 애노테이션이 지정된 경우
  • @annotation(org.springframework.transaction.annotation.Transactional)
    • Transactional 애노테이션이 지정된 모든 메서드

 

execution 표현식에 대해 자세히 알아보면

execution([수식어] 리턴타입 [클래스이름].메서드이름(파라미터))

 

• 수식어
  • public, private 등 수식어를 명시하지만 스프링 AOP에서는 private만 가능 (생략 가능)
• 리턴타입
  • 리턴 타입을 명시
• 클래스이름 및 메서드이름
  • 클래스이름과 메서드 이름을 명시 (클래스 이름은 패키지명까지 함께 명시)
• 파라미터
  • 메서드의 파라미터를 명시
• 표현식
  • * : 모든 값을 표현
  • .. : 0개 이상을 의미
  • execution(void set*(..))
    • 리턴 타입이 void이고 메서드 이름이 set으로 시작하며, 파라미터가 0개 이상인 메서드
  • execution(* sp.aop.service..())
    • sp.aop.service 패키지의 파라미터가 없는 모든 메서드
  • execution(* sp.aop.service...(..))
    • sp.aop.service 패키지 및 하위 패키지에 있는 파라미터가 0개 이상인 모든 메서드
  • execution(* get())
    • get으로 시작하고 1개의 파라미터를 갖는 메서드
  • execution(Integer read*(Integer, ..))
    • 리던값이 Integer이고 메서드 이름이 read로 시작하며 첫번째 파라미터 타입이 Integer이고, 1개 이상의 파라미터를 갖는 메서드

 

이제 프로젝트에 적용해보자.

 

당장에 적용해볼만한 게 파라미터 로그찍기와 실행시간 정도였다. 

그 중 Service레이어의 메소드 실행 시간을 측정하여 출력해주었다. 추후에 공통관심사가 생긴다면 그때 추가로 분리하기로 했다.

 

@Component
@RequiredArgsConstructor
@Aspect
@Slf4j
public class TimingAdvisor {

    private final SlackService slackService;

    @Pointcut("execution(public * jikgong.domain..*Service.*(..))")
    public void pointcut() {}

    @Around("pointcut()") // 어드바이스 + 포인트컷 설정
    public Object advice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        String methodName = proceedingJoinPoint.getSignature().getName();

        long start = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();// 타깃 메소드 호출

        long end = System.currentTimeMillis();
        long runningTime = end - start;

        if (runningTime <= 1000) {
            log.info("[정상 실행] method = {}, 실행시간 = {} ms", methodName, runningTime);
        } else {
            String message = "[!경고] [기준 실행 시간을 초과하였습니다] method = " + methodName + ", 실행시간 = " + runningTime + "ms";
            log.error(message);
            // Slack 메시지 전송
            HashMap<String, String> data = new HashMap<>();
            data.put("경고 내용", message);
            slackService.sendMessage("경고: 실행 시간 초과", data);
        }
        return result;
    }
}

 

 

 

 

어떤 메소드에 실행 시간이 얼마 걸렸다를 출력해주다.

기준 시간 (1000ms) 보다 오래 걸리는 경우 경고 log 및 slack으로 메시지를 보내주었고, 기준 시간 보다 적게 걸리는 경우는 정상 실행 log를 찍어주어 비정상적으로 오래 걸리는 메소드에 대해 확인할 수 있도록 세팅했다.

 

 

 

(참고)

slack 호출 코드

@Service
@Slf4j
public class SlackService {
    @Value("${webhook.slack.url}")
    private String SLACK_WEBHOOK_URL;

    private final Slack slackClient = Slack.getInstance();

    /**
     * 슬랙 메시지 전송
     **/
    public void sendMessage(String title, HashMap<String, String> data) {
        try {
            slackClient.send(SLACK_WEBHOOK_URL, payload(p -> p
                    .text(title) // 메시지 제목
                    .attachments(List.of(
                            Attachment.builder().color(Color.GREEN.toString()) // 메시지 색상
                                    .fields( // 메시지 본문 내용
                                            data.keySet().stream().map(key -> generateSlackField(key, data.get(key))).collect(Collectors.toList())
                                    ).build())))
            );
            log.info("slack 알림 전송");
        } catch (IOException e) {
            log.error("slack 알림 전송 실패");
            e.printStackTrace();
        }
    }

    /**
     * Slack Field 생성
     **/
    private Field generateSlackField(String title, String value) {
        return Field.builder()
                .title(title)
                .value(value)
                .valueShortEnough(false)
                .build();
    }
}