본문 바로가기
🖥Web/🔥SpringBoot

[SpringBoot] AOP AspectJ @Aspect 적용하기 @Pointcut, @Around, @Before, @AfterReturning, @After, @AfterThrowing, example code

by 후누스 토르발즈 2021. 1. 14.
반응형

 

 

 

AOP 주요 개념

 

AOP는 Aspect Oriented Programming의 약자로 관점 지향 프로그래밍이라고 불린다.

관점지향은 쉽게말해 어떤 로직을 기준으로 핵심적인 관점, 부가적인 관점으로 나누어서 보고 그 관점을 기준으로 각각 모듈화 하겠다는 것이다.

 

여기서 모듈화란 어떤 공통된 로직이나 기능을 하나의 단위로 묶는것을 말한다.

 

예로들어 핵심적인 관점은 결국 우리가 적용하고자 하는 핵심 비즈니스 로직이 된다.

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

 

AOP에서 각 관점을 기준으로 로직을 모듈화한다는 것은 코드들을 부분적으로 나누어서 모듈화하겠다는 의미다.

이때, 소스 코드 상에서 다른 부분에 계속 반복해서 쓰는 코드들을 발견할 수 있는 데 이것을 흩어진 관심사(Crosscutting Concerns)라 부른다.

 

위와 같이 흩어진 관심사를 Aspect로 모듈화하고 핵심적인 비즈니스 로직에서 분리하여 재사용하겠다는 것이 AOP의 취지다.

 

 

 

Aspect : 위에서 설명한 흩어진 관심사를 모듈화 한 것. 주로 부가기능을 모듈화함.

Target : Aspect를 적용하는 곳 (클래스, 메서드 .. )

Advice : 실질적으로 어떤 일을 해야 할 지에 대한 것, 실질적인 부가기능을 담은 구현체

JointPoint : Advice가 적용될 위치, 끼어들 수 있는 지점. 메서드 진입 지점, 생성자 호출 시점, 필드에서 값을 꺼내올 때 다양한 시점에 적용 가능

PointCut : JointPoint의 상세한 스펙을 정의한 것. ‘A란 메서드의 진입 시점과 호출할 것’과 같이 더욱 구체적으로 Advice가 실행될 지점을 정할 수 있음

 

 

스프링 AOP 특징

 

프록시 패턴 기반의 AOP 구현체, 프록시 객체를 쓰는 이유는 접근 제어 및 부가기능을 추가하기 위해서임

스프링 빈에만 AOP르 적용 가능

모든 AOP 기능을 제공하는 것이 아닌 스프링 loC와 연동하여 엔터프라이즈 애플리케이션에서 가장 흔한 문제(중복코드, 프록시 클래스 작성의 번거로움, 객체들 간 관계 복잡도 증가 …)에 대한 해결책을 지원하는 것이 목적

 

 

 

Aspect : 위에서 설명한 흩어진 관심사를 모듈화 한 것. 주로 부가기능을 모듈화함.

Target : Aspect를 적용하는 곳(클래스, 메서드 .. )

Advice : 실질적으로 어떤 일을 해야할 지에 대한 것, 실질적인 부가기능을 담은 구현체

JoinPoint : Advice가 적용될 위치, 끼어들 수 있는 지점. 메소드 진입 지점, 생성자 호출 시점, 필드에서 값을 꺼내올 때 등 다양한 시점에 적용가능

PointCut : JoinPoint의 상세한 스펙을 정의한 것. ‘A란 메서드의 진입 시점에 호출할 것’과 같이 더욱 구체적으로 Advice가 실행될 지점을 정할 수 있음.

 

 

@Before (이전) : 어드바이스 타겟 메소드가 호출되기 전에 어드바이스 기능을 수행

 

@After (이후) : 타겟 메소드의 결과에 관계없이(즉 성공, 예외 관계없이) 타겟 메소드가 완료되면 어드바이스 기능을 수행

 

@AfterReturning( 정상적 반환 이후) 타겟 메소드가 성공적으로 결과값을 반환 후에 어드바이스 기능을 수행

 

@Around( 메소드 실행 전 후) : 어드바이스가 타겟 메소드를 감싸서 타겟 메소드 호출 전과 후에 어드바이스 기능을 수행

 

 

AspectConfig.java

package com.example.base.arearch;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

import com.example.base.common.ResponseProtocolCode;
import com.example.base.common.vo.ResponseVO;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
@Aspect
public class AspectConfig {

    @Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
    public void getMapping(){}    

    @Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping)")
    public void postMapping(){}

    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
    public void requestMapping(){}

    @Pointcut("execution(* com.example.base..*.*Service.*(..))")
    public void serviceExcution(){}
    
	@Around(value = "serviceExcution()")
	public Object around(ProceedingJoinPoint pjp) throws Throwable {
		log.debug("==========Around Logging START==========");
		log.debug("==========Around proceed START==========");
		Object returnValue = null;
		try {
			returnValue = pjp.proceed(); // 메서드 호출 자체를 감쌈					
		} catch (Throwable e) {
			log.debug("asdasdasdasd");
			returnValue = new ResponseVO<>(ResponseProtocolCode.RESPONSE_SERVER_ERROR);
		}
		log.debug("==========Around proceed END==========");
		log.debug("returnValue.toString() : " + returnValue);
		log.debug("==========Around Logging END==========");	
		return pjp;
	}

	@Before(value = "serviceExcution()")
	public void before(JoinPoint joinPoint) throws Throwable {				
		log.debug("==========Before Logging START==========");
		log.debug("==========Before Logging END==========");
	}

	@AfterReturning(pointcut = "serviceExcution()", returning = "result")
	public void afterReturning(JoinPoint joinPoint, Object result) {			
		log.debug("==========AfterReturning Logging START==========");
		log.debug("result : " + result);
		log.debug("==========AfterReturning Logging END==========");
	}

	@After(value = "serviceExcution()")
	public void after(JoinPoint joinPoint) {			
		log.debug("==========After Logging START==========");
		log.debug("==========After Logging END==========");
	}

	@AfterThrowing(pointcut = "serviceExcution()", throwing = "ex")
	public void afterThrowing(JoinPoint joinPoint, Throwable ex) throws Throwable {
		log.debug("==========AfterThrowing Logging START==========");
		log.debug("Throwable : " + ex);
		log.debug("==========AfterThrowing Logging END==========");
	}
}

 

 

SampleController.java

package com.example.base.sample.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.example.base.common.vo.ResponseVO;
import com.example.base.sample.service.SampleService;
import com.example.base.sample.vo.SamplePVO;
import com.example.base.sample.vo.SampleRVO;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "SAMPLE", description = "샘플 API")
@RestController
@RequestMapping("/base/sample")
public class SampleController {
	
	@Autowired
	private SampleService sampleService;
	
	@Operation(summary = "샘플 조회", description = "샘플 조회")
	@GetMapping("/currentDate")
	public ResponseVO<SampleRVO> currentDate(@Parameter(description = "SamplePVO") SamplePVO samplePVO, @Parameter(description = "SampleRVO")SampleRVO sampleRVO, @Parameter(description = "ResponseVO") ResponseVO<SampleRVO> rVO) throws Throwable {
		return sampleService.currentDate(samplePVO, sampleRVO, rVO);
	}

	@Operation(summary = "샘플 조회", description = "샘플 조회")
	@GetMapping("/currentDate2")
	public ResponseVO<SampleRVO> currentDate2(@Parameter(description = "SamplePVO") SamplePVO samplePVO, @Parameter(description = "SampleRVO")SampleRVO sampleRVO, @Parameter(description = "ResponseVO") ResponseVO<SampleRVO> rVO) {
		return sampleService.currentDate2(samplePVO, sampleRVO, rVO);
	}
}

 

SampleService.java

package com.example.base.sample.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.example.base.common.ResponseProtocolCode;
import com.example.base.common.vo.ResponseVO;
import com.example.base.sample.mapper.SampleMapper;
import com.example.base.sample.vo.SamplePVO;
import com.example.base.sample.vo.SampleRVO;

import io.swagger.v3.oas.annotations.Parameter;

@Service
public class SampleService {

	@Autowired
	SampleMapper sampleMapper;

	public ResponseVO<SampleRVO> currentDate(@Parameter(description = "SamplePVO") SamplePVO samplePVO, @Parameter(description = "SampleRVO") SampleRVO sampleRVO, @Parameter(description = "ResponseVO") ResponseVO<SampleRVO> rVO) {
		try {
			rVO.setResponse(sampleMapper.currentDate(samplePVO));
			if (rVO.getResponse() != null) {
				rVO.setCode(ResponseProtocolCode.RESPONSE_SUCCESS);
				rVO.setMessage("정상 적으로 날짜가 조회되었습니다.");
			} else {
				rVO.setCode(ResponseProtocolCode.RESPONSE_FAILED);
				rVO.setMessage("날짜 조회에 실패하였습니다.");
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		return rVO;
	}

	public ResponseVO<SampleRVO> currentDate2(@Parameter(description = "SamplePVO") SamplePVO samplePVO, @Parameter(description = "SampleRVO") SampleRVO sampleRVO, @Parameter(description = "ResponseVO") ResponseVO<SampleRVO> rVO) throws Throwable {
		try {
			rVO.setResponse(sampleMapper.currentDate(samplePVO));
			if (rVO.getResponse() != null) {
				rVO.setCode(ResponseProtocolCode.RESPONSE_SUCCESS);
				rVO.setMessage("정상 적으로 날짜가 조회되었습니다.");
			} else {
				rVO.setCode(ResponseProtocolCode.RESPONSE_FAILED);
				rVO.setMessage("날짜 조회에 실패하였습니다.");
			}
			throw new Throwable(ResponseProtocolCode.RESPONSE_SERVER_ERROR);
		} catch (Exception e) {
			e.printStackTrace();
		}
		return rVO;
	}
}

 

 

currentDate

 

 

 

currentDate2

 

 

 

두 프로세스의 차이는

예외를 발생시킨것인데 예외가 발생되면 Response를 만든다.

사용자가 에러코드를 그냥 맞게하지 않고 의도적으로 다른 Response를 만든다.

 

 

 

 

 

 

 

 

 

Reference Link :

https://engkimbs.tistory.com/746

 

https://vmpo.tistory.com/100

 

반응형