[내일배움캠프_Spring Boot 심화주차] Spring AOP

My 셀렉샵 Top5 회원 찾기 설계 및 구현

요구사항

• 2주간 'My 셀렉샵'을 가장 많이 사용하는 Top5 회원들에게 선물 증정을 위해, 회원별 'My 셀렉샵' 사용시간 저장
• 'My 셀렉샵' 서버 사용 시간을 기준으로 설정
  • 서버 사용 시간: 'My 셀렉샵'의 상품 및 폴더와 관련된 API 사용시간의 총 합
    1. 상품 조회 API("GET /api/search") 수행시간
    2. 관심상품 등록 API("POST /api/products") 수행시간
    3. 폴더 저장 API("POST /api/folders") 수행시간
    4. ...
• API 사용 시간 = Controller에 요청이 들어온 시간 - 응답이 나간 시간

스크래치 파일(Scratch File)

스크래치 파일은 프로젝트와 상관없이 어떤 특정한 method 혹은 코드를 수행시켜보고 싶을 때 사용하는 파일

스크래치 파일 위치

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;
    }
}

My 셀렉 샵 프로젝트에 서버 사용 시간 추가하기

ApiUseTime Entity와 Repository 생성

package com.sparta.myselectshop.entity;

import jakarta.persistence.*;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Entity
@Getter
@Setter
@NoArgsConstructor
@Table(name = "api_use_time")
public class ApiUseTime {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @OneToOne
    @JoinColumn(name = "user_id", nullable = false)
    private User user;

    @Column(nullable = false)
    private Long totalTime;

    public ApiUseTime(User user, Long totalTime) {
        this.user = user;
        this.totalTime = totalTime;
    }

    public void addUseTime(long useTime) {
        this.totalTime += useTime;
    }
}

package com.sparta.myselectshop.repository;

import com.sparta.myselectshop.entity.ApiUseTime;
import com.sparta.myselectshop.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface ApiUseTimeRepository extends JpaRepository<ApiUseTime, Long> {
    Optional<ApiUseTime> findByUser(User user);
}

 

관심상품 저장 부분에 적용

@RestController
@RequiredArgsConstructor
@RequestMapping("/api")
public class ProductController {

    private final ProductService productService;
    private final ApiUseTimeRepository apiUseTimeRepository;

    @PostMapping("/products")
    public ProductResponseDto createProduct(@RequestBody ProductRequestDto requestDto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
        // 측정 시작 시간
        long startTime = System.currentTimeMillis();

        try {
            // 응답 보내기
            return productService.createProduct(requestDto, userDetails.getUser());
        } finally {
            // 측정 종료 시간
            long endTime = System.currentTimeMillis();
            // 수행시간 = 종료 시간 - 시작 시간
            long runTime = endTime - startTime;

            // 로그인 회원 정보
            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);
            }

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

	...
}

사용 시간 수행 결과

부가 기능 모듈화의 필요성

• 'Top5 회원 찾기' 기능이 추가된 것을 'My 셀렉샵' 회원들은 알 수도 없고 알 필요도 없음
• 핵심 기능: 각 API 별 수행해야 할 비즈니스 로직
  ex) 상품 키워드 검색, 관심상품 등록, 회원 가입, 관심상품에 폴더 추가, ...

핵심 기능

• 부가 기능: 핵심기능을 보조하는 기능
  ex) 회원 패턴 분석을 위한 로그 기록, API 수행시간 저장, ...

보조 기능

문제점

• 모든 '핵심 기능'의 Controller에 '부가 기능' 코드를 추가했을 때
  • '핵심 기능'이 100개라면, 100개의 '핵심 기능' 모두에 동일한 내용의 코드 추가 필요
  • '핵심 기능'이 나중에 추가된다면, 항상 '부가 기능' 추가를 신경써야함
• '핵심 기능' 수정 시
  • 같은 함수 내에 '핵심 기능'과 '부가 기능'이 섞여 있음
  • '핵심 기능'이해를 위해 '부가 기능'까지 이해 필요함

부가 기능 모듈화

AOP(Aspect Oriented Programming)를 통해 부가 기능 모듈화

• 부가 기능은 핵심 기능과는 관점(Aspect), 관심이 다름
• 따라서 핵심 기능과 분리해 부가 기능 중심으로 설계 및 구현 가능

부가 기능 모듈화

---

Spring AOP

Spring AOP

1. 어드바이스: 부가 기능을 핵심 기능에 언제 수행할 건지 정하는 것

• 핵심 기능이 수행되기 전
• 핵심 기능이 수행된 후
• 핵심 기능이 수행되기 전과 후
• 핵심 기능이 잘 수행돼서 반환된 값 사용여부
• 핵심 기능 오류 발생 시 수행여부

2. 포인트컷: 적용 위치(지점)

Spring AOP 애너테이션

@Aspect

• Spring Bean(빈) 클래스에만 적용 가능
• 즉, AOP 설정하려는 클래스에 설정

어드바이스 종류

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

포인트컷

 

[포인트 컷 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
  • 클래스명 (패키지명 필요)
  • ex) com.sparta.myselectshop.controller.* - controller 패키지의 모든 클래스에 적용
  • ex) com.sparta.myselectshop.controller.. - controller 패키지 및 하위 패키지의 모든 클래스에 적용
• method-name-pattern(param-pattern)
  • 함수명
    - ex) addFolders - addFolders() 메서드에만 적용
    - ex) add* - add로 시작하는 모든 메서드에 적용
  • 파라미터 패턴(param-pattern)
    - ex) 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("forAllController() && !forAllViewController()")
    public void saveRestApiLog() {
    	...
    }
    
    @Around("forAllController()")
    public void saveAllApiLog() {
    	...
    }
}

 

프로젝트에 적용하기

• aop > UseTimeAop 클래스 생성

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.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Component;

@Slf4j(topic = "UseTimeAop")
@Aspect
@Component // Bean 클래스에 적용
@RequiredArgsConstructor // Bean 주입
public class UseTimeAop {

    private final ApiUseTimeRepository apiUseTimeRepository;

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

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

        try {
            // 핵심기능 수행
            Object output = joinPoint.proceed(); // controller 메서드 수행
            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 적용 후]

AOP 적용 후 흐름

• Spring이 프록시(가짜 혹은 대리) 객체를 중간에 삽입해줌
• DispatcherServlet과 ProductController 입장에서는 변화가 전혀 없음
• 호출되는 함수의 input, ouput이 완전 동일
• "joinPoing.proceed()"에 의해서 원래 호출하려고 했던 함수, 인수(argument)가 전달됨