[Spring] AOP(Aspect Oriented Programming)란? 스프링 AOP란?

intro

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술을 듣고 나서 개인적으로 AOP에 대해 추가로 정리해 보았다.
해당 강의에 나온 코드 분석 외에도 추가적인 기능도 살펴보았다.

AOP (Aspect Oriented Programming)란?

AOP는 Aspect Oriented Programming의 약자로 관점 지향 프로그래밍이라고 불린다. 관점 지향은 어떤 로직을 기준으로 핵심적인 관점, 부가적인 관점으로 나누어서 보고 그 관점을 기준으로 모듈화 하겠다는 것이다.

• 모듈화 : 어떤 공통된 로직이나 기능을 하나의 단위로 묶는 것

예를 들어 핵심적인 관점은 비즈니스 로직이 될 수 있고, 부가적인 관점은 핵심 로직을 실행하기 위해 행해지는 데이터베이스 연결, 로깅, 파일 입출력 등이 될 수 있다.

AOP는 흩어진 관심사(Crosscutting Concerns)를 모듈화 할 수 있는 프로그래밍 기법이다

[그림 1] AOP 예시

[그림 1]과 같이 클래스 A, B, C에서 공통적으로 나타나는 색깔 블록은 중복되는 메서드, 필드, 코드 등이다. 이때 예를 들어 클래스 A의 주황색 블록 부분을 수정해야 한다면 클래스 B, C의 주황색 부분도 일일이 찾아 수정해야 한다. 이는 SOLID원칙을 위배하며 유지보수를 어렵게 만든다. 이런 식으로 소스 코드상에서 계속 반복해서 사용되는 부분들을 **흩어진 관심사(Crosscutting Concerns)**라고 한다.

결국 AOP에서 각 관점을 기준으로 로직을 모듈화한다는 것은 흩어진 관심사를 모듈화하겠다는 의미다. [그림 1]과 같이 주황색, 파란색, 빨간색 블록처럼 모듈화 시켜놓고 어디에 적용시킬지만 정의해주면 되는 것이다. 이때 모듈화 시켜놓은 블럭을 Aspect라고 한다.

 

공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern) 분리

AOP 관련 용어

• Aspect : 흩어진 관심사를 모듈화 한 것.
• Target : Aspect를 적용하는 곳. 클래스, 메서드 등..
• Advice : 실질적으로 어떤 일을 해야 할 지에 대한 것, 실질적인 부가기능을 담은 구현체
• Join Point : Advice가 적용될 위치 혹은 끼어들 수 있는 시점. 메서드 진입 시점, 생성자 호줄 시점, 필드에서 꺼내올 시점 등 끼어들 시점을 의미. 참고로 스프링에서 Join Point는 언제나 메서드 실행 시점을 의미 한다.
• Point Cut : Join Point의 상세한 스펙을 정의한 것. "A란 메서드의 진입 시점에 호출할 것"처럼 구체적으로 Advice가 실행될 시점을 정함.

AOP 적용 방법

1. 컴파일 타임 적용

• 컴파일 시점에 바이트 코드를 조작하여 AOP가 적용된 바이트 코드를 생성하는 방법.

1. 로드 타임 적용

• 순수하게 컴파일한 뒤, 클래스를 로딩하는 시점에 클래스 정보를 변경하는 방법

1. 런타임 적용

• 스프링 AOP가 주로 사용하는 방법. A라는 클래스 타입의 Bean을 만들 때 A 타입의 Proxy Bean을 만들어 Proxy Bean이 Aspect 코드를 추가하여 동작하는 방법.

스프링 AOP

• 스프링에서 제공하는 스프링 AOP는 프록시 기반의 AOP 구현체이다.
• 프록시 객체를 사용하는 것은 접근 제어 및 부가 기능을 추가하기 위해서이다.
• 스프링 AOP는 스프링 Bean에만 적용할 수 있다.
• 모든 AOP 기능을 제공하는 것이 목적이 아닌, 중복 코드, 프록시 클래스 작성의 번거로움 등 흔한 문제를 해결하기 위한 솔루션을 제공하는 것이 목적이다.
• 스프링 AOP는 순수 자바로 구현되었기 때문에 특별한 컴파일 과정이 필요하지 않다.
• 프록시 패턴

[그림 2] Proxy 패턴

프록시 패턴에서는 interface가 존재하고 Client는 이 interface 타입으로 Proxy 객체를 사용한다. Proxy 객체는 기존의 타겟 객체(Real Subject)를 참조한다. Proxy 객체와 기존의 타겟 객체의 타입은 같고, Proxy는 원래 할 일을 가지고 있는 Real Subject를 감싸서 Client의 요청을 처리한다.

스프링 AOP 구현

maven

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

gradle

implementation 'org.springframework.boot:spring-boot-starter-aop'

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술에 나온 코드로 AOP를 먼저 분석해본다.

1. 시간 측정 AOP 등록

package hello.hellospring.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

// AOP 적용, 스프링 빈 등록
@Aspect
@Component
public class TimeTraceAop {
    // 공통관심사항을 적용할 곳(hello.hellospring 패키지 하위 모두) 타겟팅
    @Around("execution(* hello.hellospring..*(..))")
    public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {

        long start = System.currentTimeMillis();    // 시작 시각

        System.out.println("START: " + joinPoint.toString());

        try {
            return joinPoint.proceed();
        } finally {
            long finish = System.currentTimeMillis();   // 종료 시각
            long timeMs = finish - start;   // 호출 시간

            System.out.println("END: " + joinPoint.toString() + " " + timeMs + "ms");
        }
    }
}

스프링 빈을 등록하는 방법은 컴포넌트 스캔 방식과 SpringConfig에 직접 등록해주는 방식 2가지가 있다.

여기서는 간단한게 컴포넌트 스캔 방식인 @Component 어노테이션을 사용하여 스프링 빈으로 등록했다. 하지만 TimeTraceAop 같은 경우는 공통 관심 사항이기 때문에 SpringConfig 파일에 직접 빈으로 등록해주는 것을 추천한다.

메서드 호출할 때마다 인터셉트가 걸려서 동작하는 방식임

2. 실행 결과

1) localhost:8080 실행

2) 회원 목록 클릭

3) 회원 가입 클릭

4) id 입력 후 등록

3. 해결

• 회원가입, 회원 조회등 핵심 관심사항과 시간을 측정하는 공통 관심 사항을 분리한다.
• 시간을 측정하는 로직을 별도의 공통 로직으로 만들었다.
• 핵심 관심 사항을 깔끔하게 유지할 수 있다.
• 변경이 필요하면 이 로직만 변경하면 된다.
• 원하는 적용 대상을 선택할 수 있다.(타겟팅)

2. 스프링의 AOP 동작 방식 설명

AOP는 Proxy를 호출한다!

1. AOP 적용 전 의존관계

2. AOP 적용 후 의존관계

1) AOP를 적용하면 Proxy(가짜 memberService)를 만들어낸다.

2) 실제로는 memberController가 memberService라는 Proxy(가짜 memberService)를 호출한다.

3) joinPoint.proceed()가 호출되면 실제 memberService가 호출된다.

<Proxy 주입 콘솔에서 출력해서 확인하기>

@Controller
public class MemberController {
    // private final MemberService memberService = new MemberService();
    // 스프링 컨테이너에 스프링 빈으로 등록을 해두고 가져다 쓰는 방식(같은 MemberService를 공유하도록)
    private final MemberService memberService;

    // 회원 컨트롤러 & 회원 서비스 연결
    @Autowired
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
        // memberController가 Proxy(가짜 memberService)를 호출함을 확인
        System.out.println("memberService = " + memberService.getClass());
        ...
    }

아래와 같이 실제 MemberService가 아닌 뒤에 무엇인가 붙은 Proxy가 주입되는 것을 확인할 수 있다.

3. AOP 적용 전 전체 그림

4. AOP 적용 후 전체 그림

Spring AOP를 사용하기 위해서는 위와 같이 의존성을 추가해줘야 한다.

이제 다른 코드로 AOP를 분석해 본다.

지금부터 구현할 기능은 타겟 메서드의 실행 시간을 측정해주는 로직이다.

@Component
@Aspect
public class PerfAspect {

    @Around("execution(* com.example..*.EventService.*(..))")
    public Object logPerf(ProceedingJoinPoint pjp) throws Throwable {
        long begin = System.currentTimeMillis();
        Object reVal = pjp.proceed();
        System.out.println(System.currentTimeMillis() - begin);
        return reVal;
    }
}

스프링 AOP는 Bean에서만 동작한다고 했다. 따라서 @Component 어노테이션 등을 통해 스프링 Bean으로 등록해준 뒤 사용해야 한다. @Aspect 어노테이션을 붙이면 해당 클래스가 Aspect라는 것을 명시해준다.

logPerf() 메서드는 @Around 어노테이션의 execution을 통해 Advice를 적용할 범위를 지정해줄 수 있다. 위의 코드를 예시로 들자면 com.example 밑의 모든 클래스에 적용하고, EventService 밑의 모든 메서드에 적용하라는 뜻이다.

위와 같은 경로 지정 방식이 아닌 특정 어노테이션이 붙은 포인트에 해당 Aspect를 실행할 수도 있다.

@Component
@Aspect
public class PerfAspect {

  @Around("@annotation(PerfLogging)")
  public Object logPerf(ProceedingJoinPoint pjp) throws Throwable {
    long begin = System.currentTimeMillis();
    Object retVal = pjp.proceed();
    System.out.println(System.currentTimeMillis() - begin);
    return retVal;
  }
}

위와 같이 @Around 어노테이션에 @annotation(PerfLogging)처럼 적용될 어노테이션을 명시할 수 있다. 그럼 해당 메서드를 적용시킬 특정 메서드에 @PerfLogging 어노테이션을 붙여주기만 하면 logPerf() 기능이 동작한다.

혹은 특정 Bean 전체에 해당 기능을 적용시킬 수도 있다.

// Aspect 정의@Component
@Aspect
public class PerfAspect {

// 빈이 가지고있는 모든 퍼블릭 메쏘드@Around("bean(simpleServiceEvent)")
  public Object logPerf(ProceedingJoinPoint pjp) throws Throwable {
    long begin = System.currentTimeMillis();
    Object retVal = pjp.proceed();
    System.out.println(System.currentTimeMillis() - begin);
    return retVal;
  }
}

위와 같이 @Around 어노테이션에 bean(simpleServcieEvent)처럼 적용될 빈을 명시할 수 있다. 그럼 해당 빈이 가지고 있는 모든 public 메서드에 해당 기능이 적용된다.

@Around 외에 타겟 메서드의 Aspect 실행 시점을 지정할 수 있는 어노테이션은 다음과 같은 것들이 있다.

• @Before : Advice 타겟 메서드가 호출되기 전에 Advice 기능 수행
• @After : 타겟 메서드의 결과에 관계없이 타겟 메서드과 완료되면 Advice 기능 수행
• @AfterRunning : 타겟 메서드가 성공적으로 결과값을 반환 한 후에 Advice 기능 수행
• @AfterThrowing : 타겟 메서드가 수행 중 예외를 던지면 Advice 기능 수행
• @Around : Advice가 타겟 메서드를 감싸 타겟 메서드 호출 전, 후에 Advice 기능 수행