Spring AOP

출처 : 내일배움캠프

 

Aspect Oriented Programming : 관점지향 프로그래밍

1. AOP 개념 이해
2. '나만의 셀렉샵' 에 스프링 AOP 적용
   1. Top5 회원 찾기
   2. 중복 폴더명 저장 시 에러 처리
   3. 스프링 예외 처리

서버를 사용한 시간 ~ 모든 API에 요청, 응답한 시간의 합을 기준으로 상위 5인 선발

스크래치 파일을 이용한 서버 사용시간 측정

+ 스크래치 파일은 별도로 저장되는 임시파일, 프로젝트와 관련없는 코드를 다룰 때 유용하다

스크래치 파일 경로

class Scratch {
    public static void main(String[] args) {
        // 측정 시작 시간
        long startTime = System.currentTimeMillis();

        // 함수 수행
        long output = sumFromOneTo(1_000_000_000);

        // 측정 종료 시간
        long endTime = System.currentTimeMillis();

        long runTime = endTime - startTime;
        System.out.println("소요시간: " + runTime);
    }

    private static long sumFromOneTo(long input) {
        long output = 0;

        for (int i = 1; i < input; ++i) {
            output = output + i;
        }

        return output;
    }
}

output의 값을 초기값 1초로 설정한 후, 사용시간만큼 값을 증가시키는 반복문을 통해 시간의 합을 구한다

TOP 5 회원 찾기 설계 및 구현

컬럼명	타입	중복허용	설명
id	Long	X	테이블 ID(PK)
userId	Long	X	회원 ID(FK)
totalTime	Long	O	API 총 사용시간

ApiUseTime 생성

ApiUseTimeRepository 생성

ProductController 사용시간 기록 추가

(관리자) 회원별 API 총 사용시간 조회 API 설계 및 구현

기능	메서드	URL	설명
API 총 사용시간 조회	GET	/api/use/time	회원별 API 총 사용시간 조회 (관리자용)

ApiUseTimeController 생성

 

AOP란?

각 API 별 수행해야 하는 주요 비즈니스 로직을 제외한 부가기능을 모듈화하여 부가기능 중심으로 설계 구현하는 것

~ 스프링이 제공하는 AOP

AOP를 사용해 모든 컨트롤러에 부가기능 추가

package com.sparta.myselectshop.aop;

import com.sparta.myselectshop.entity.ApiUseTime;
import com.sparta.myselectshop.entity.User;
import com.sparta.myselectshop.repository.ApiUseTimeRepository;
import com.sparta.myselectshop.security.UserDetailsImpl;
import lombok.RequiredArgsConstructor;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Component;

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

    private final ApiUseTimeRepository apiUseTimeRepository;

    @Around("execution(public * com.sparta.myselectshop.controller..*(..))")
    public synchronized 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);

            }
        }
    }
}

AOP 적용 전

AOP 적용 후

스프링 AOP 어노테이션의 종류

1. @Aspect

스프링 빈 클래스에 적용가능

2. 어드바이스의 종류 ~ AOP 코드가 실행되는 시점을 지정해준다

- @Around : '핵심기능' 수행 전과 후(@Before + @After)

- @Before : '핵심기능' 수행 전(ex : Client의 입력값 Vaildation 수행)

- @After : '핵심기능' 수행 성공/실패 여부와 관계없이 언제나 동작 (try, catch의 finally()와 같은 동작 방식)

- @AfterReturning : '핵심기능' 호출 성공시 동작하여 함수의 Return값 사용가능

- @AfterThrowing : '핵심기능' 호출 실패시, 예외가 발생한 경우에만 동작 (ex : 예외발생시 개발자에게 통지기능)

3. 포인트컷 ~ AOP 코드가 실행되는 장소를 정해준다

예제 -> @어드바이스(포인트컷)의 형태

execution(

modifiers-pattern? 

return-type-pattern declaring-type-pattern? 

method-name-pattern(param-pattern) throws-pattern?)​

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

modifiers-pattern : pubilc, private, *

return-type-pattern : void, String, List<String>, *

declaring-type-pattern : 클래스명(패키지명 필요)

~ com.sparta.springcore.controller.* : controller 패키지의 모든 클래스에 적용

~ com.sparta.springcore.controller.. : controller 패키지 및 하위 패키지의 모든 클래스까지 적용

method-name-pattern(param-pattern)

함수명

addFolders : addFolders() 함수에만 적용

add* : add로 시작하는 모든 함수에 적용

파라미터 패턴

(com.sparta.springcore.dto.FolderRequestDto) - FolderRequestDto 인수에만 적용

() - 인수 없음

(*) - 타입 상관없이 인수 1개

(..) - 타입 상관없이 인수 1~N개