[Spring]Spring AOP 개념 및 활용 방법

🤔Spring AOP(Aspect Oriented Programming - 관점 지향 프로그래밍) 란?

: AspectJ 컴파일러에 의해 프로그램 실행시 핵심관심코드와 횡단관심코드가 결합(Weaving)되어 실행되는 기능 제공

1) OOP보다 AOP가 좋은 점?

OOP의 경우 모듈화(캡슐화)가 너무 강력해서 핵심관심코드와 횡단관심코드를 분리하여 프로그램을 작성하기 어려움
=> 코드의 중복성이 높아 프로그램의 생산성 및 유지보수의 효율성 감소

이러한 부분을 AOP는 핵심관심코드와 횡단관심코드를 분리한 후, 결합이 필요한 부분에서만 결합하여 실행될 수 있도록하여 해결해줌!

2) Spring AOP 기능을 사용하기 위해 2개의 라이브러리 빌드 처리 필요

서는 aspectjrt 라이브러리와 aspectjweaver 라이브러리가 프로젝트에 빌드 처리 - 메이븐 사용

=> 아래 사이트에서 위 두개의 라이브러리 파일 찾아서 pom.xml 파일에 빌드처리하면 됨

https://mvnrepository.com/ 

그런데 aspectjrt는 이미 빌드처리 되어 있음. Spring이 자체적으로 사용한다고 함. aspectjweaver 라이브러리만 검색! 

pom.xml 파일에 아래 코드 붙여 넣으면 그것이 바로 빌드 처리! 

<!--이건 이미 빌드 처리 되어 있었음 -->		
        <!-- AspectJ - Spring AOP 기능을 제공하기 위한 라이브러리 -->
		<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjrt -->
		<!-- => AspectJ 컴파일러에 의해 생성된 Proxy 클래스의 실행 관리 기능을 제공하기 위한 라이브러리 -->
		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjrt</artifactId>
			<version>${org.aspectj-version}</version>
		</dependency>
		
<!--이거만 하면 됨 -->	        
		<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
		<!-- => AspectJ 컴파일러로 핵심관심코드와 횡단관심코드가 결합된 클래스(Proxy 클래스)를
		생성하는 Weaving 기능을 제공하기 위한 라이브러리 -->
		<dependency>
		    <groupId>org.aspectj</groupId>
		    <artifactId>aspectjweaver</artifactId>
		    <version>${org.aspectj-version}</version>
		    <scope>runtime</scope>
		</dependency>

 

3) Spring AOP을 구현(2가지 방법 있음)

- Spring Bean Configuration File(XML) 파일의 엘리먼트를 사용하여 환경 설정

or

- AOP 관련 어노테이션을 사용하여 설정

 

⚫위 두 가지 방법은 아래 블로그 참고 ! 

  https://kgvovc.tistory.com/53

[Spring Core] AOP(Aspect Oriented Programming) - 2편(Advice 정의, @Before, @AfterReturning, @AfterThrowing, @After, @Around)

 

 

cf)

*핵심관심코드: 프로그램 실행에 핵심적인 기능을 제공하는 명령 - 데이타 처리 명령

*횡단관심코드: 프로그램 실행에 보조적인 기능을 제공하는 명령 - 로그 처리, 권한 처리, 트렌젝션 처리, 예외 처리 등

 

 

---

 

 

👩‍💻실습 코드

1) 핵심관심코드(데이터 처리를 명령하는 메소드)를 작성한 JoinPointBean 클래스

package xyz.itwill06.aop;

//핵심관심모듈
public class JoinPointBean {
	public void add() {
		System.out.println("*** JoinPointBean 클래스의 add() 메소드 호출 ***");
	}
	
	public void modify(int num, String name) {
		System.out.println("*** JoinPointBean 클래스의 modify(int num, String name) 메소드 호출 ***");
	}
	
	public void remove(int num) {
		System.out.println("*** JoinPointBean 클래스의 remove(int num) 메소드 호출 ***");
	}
	
	public String getName() {
		System.out.println("*** JoinPointBean 클래스의 getName() 메소드 호출 ***");
		return "홍길동";
	}
	
	public void calc(int num1, int num2) {
		System.out.println("*** JoinPointBean 클래스의 calc(int num1, int num2) 메소드 호출 ***");
		System.out.println("몫 = "+(num1/num2));
	}
}

 

2) 횡단관심코드(데이터 처리 명령을 제외한 보조적인 기능을 명령하는 메소드)를 작성한 JoinPointAdvice 클래스

=> 횡단관심코드를 작성한 클래스를 Advice 클래스라고 부른다

 

<주요 키워드 확인하고 아래 실습코드 확인하기 ! > 

 

• 타겟 메소드(Target Method) : 핵심관심모듈(=위의 1번 클래스)의 메소드 중 PointCut 언어로 지정되어 횡단관심코드가 삽입돼 실행될 메소드

=> PointCut 언어 : 핵심관심모듈의 메소드 중 특정 메소드만을 지정하기 위한 언어

 

• Before Advice Method : 타겟 메소드의 명령 실행전에 삽입되어 실행될 명령을 작성한 메소드 

=> JoinPoint : 핵심관심코드를 기준으로 횡단관심코드가 삽입되어 실행될 위치

=> Around Advice Method를 제외한 나머지 Advice Method는 일반적으로 반환형을 [void]로 작성하고 매개변수를 작성하지 않거나 JoinPoint 인터페이스를 자료형으로 사용하는 매개변수 작성 가능
=> Advice 클래스의 메소드를 규칙에 맞지 않게 작성한 경우 IllegalArgumentException 발생

 

• JoinPoint 객체 : 타겟메소드 관련 정보가 저장된 객체
=> AspectJ 컴파일러에 의해 Advice 클래스의 메소드가 호출될 때 타겟메소드 관련 정보를 저장한 JoinPoint 객체를 매개변수에 전달하여 저장
=> Advice 클래스의 메소드에서 타겟메소드 관련 정보가 필요한 경우 매개변수를 선언하여 JoinPoint 객체를 전달받아 JoinPoint 객체의 메소드를 호출하여 사용 가능

 

• JoinPoint.getTarget() : 타겟메소드를 호출한 객체(핵심관심모듈 - Spring Bean)를 반환하는 메소드
=> Object 타입의 객체 반환
• Object.getClass() : 객체를 생성한 클래스의 Class 객체를 반환하는 메소드
• Class.getName() : Class 객체의 클래스(패키지 포함)를 문자열로 반환하는 메소드 
System.out.println(joinPoint.getTarget().getClass().getName());
• Class.getSimpleName() : Class 객체의 클래스(패키지 미포함)를 문자열로 반환하는 메소드 
System.out.println(joinPoint.getTarget().getClass().getSimpleName());
• JoinPoint.getSignature() : 타겟메소드의 정보가 저장된 Signature 객체를 반환하는 메소드
• Signature.getName() : 타겟메소드의 이름을 반환하는 메소드
System.out.println(joinPoint.getSignature().getName());
• JoinPoint.getArgs() : 타겟메소드의 매개변수에 저장된 모든 값(객체)을 Object 배열로 반환하는 메소드
System.out.println(joinPoint.getArgs());

 

 

<스프링.AOP에서 활용 가능한 5가지 종류의 Adivce 클래스>

 

1) Before Advice Method

package xyz.itwill06.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;

//횡단관심모듈
public class JoinPointAdvice {
	
	public void beforeDisplay(JoinPoint joinPoint) {
		//System.out.println("### [before]핵심관심코드 실행 전에 삽입되어 실행될 횡단관심코드 ###");
		
		String className=joinPoint.getTarget().getClass().getSimpleName();
		String methodName=joinPoint.getSignature().getName();
		Object[] params=joinPoint.getArgs();
		
		System.out.print("### [before]"+className+" 클래스의 "+methodName+"(");
		for(int i=0;i<params.length;i++) {
			System.out.print(params[i]);
			if(i < params.length-1) {
				System.out.print(", ");
			}
		}
		System.out.println(") 메소드 호출 ###");
	}
	
//아래 이어서

 

 

2) After Advice Mehtod

public void displayMessage(JoinPoint joinPoint) {
		//System.out.println("### [after]핵심관심코드 실행 후에 무조건 삽입되어 실행될 횡단관심코드 ###");
		
		Object[] params=joinPoint.getArgs();
		System.out.println("### [after]사원번호가 "+params[0]+"인 사원정보를 삭제 하였습니다.");
	}
    
//아래 이어서

 

 

3) After Returning Advice Mehtod

After Returning Advice Mehtod에는 JoinPoint 인터페이스의 매개변수 외에 Object 클래스의 매개변수 작성 가능
 => AspectJ 컴파일러는 Object 클래스의 매개변수에 타겟메소드의 반환값을 제공받아 저장
 => 타겟메소드에서 반환되는 값(객체)의 자료형이 고정되어 있는 경우 Object 클래스 대신 반환되는 값(객체)의 자료형으로 매개변수 작성 가능
 => After Returning Advice Mehtod에 Object 클래스의 매개변수가 작성된 경우 Spring Bean Configuration File의 AOP 설정에서 after-returning 엘리먼트에 returning 속성을 반드시 작성하야 타겟메소드의 반환값을 저장할 매개변수를 지정 
 => after-returning 엘리먼트에 returning 속성이 없거나 속성값이 잘못 설정되면 IllegalArgumentException 발생

    public void displayName(JoinPoint joinPoint, Object object) {
		//System.out.println("### [after-returning]핵심관심코드가 정상적으로 실행된 후에 삽입되어 실행될 횡단관심코드 ###");

		String methodName=joinPoint.getSignature().getName();
		String userName=(String)object;
		System.out.println("### [after-returning]"+methodName+" 메소드의 반환값 = "+userName);
	}
	
//아래 이어서

 

 

4) After Throwing Advice Mehtod

After Throwing Advice Mehtod에는 JoinPoint 인터페이스의 매개변수외에 Exception 클래스의 매개변수 작성 가능
 => AspectJ 컴파일러는 Exception 클래스의 매개변수에 타겟메소드에서 발생된 예외(Exception 객체)를 제공받아 저장
 => 타겟메소드에서 발생되는 예외가 고정되어 있는 경우 Exception 클래스 대신 필요한
예외 클래스로 매개변수 작성 가능
 => After Throwing Advice Mehtod에 Exception 클래스의 매개변수가 작성된 경우 Spring Bean
Configuration File의 AOP 설정에서 after-throwing 엘리먼트에 throwing 속성을 반드시
작성해야 타겟메소드에서 발생된 예외가 저장될 매개변수를 지정 
 => after-throwing 엘리먼트에 throwing 속성이 없거나 속성값이 잘못 설정되면 IllegalArgumentException 발생

	public void exceptionHandle(JoinPoint joinPoint, Exception exception) {
		//System.out.println("### [after-throwing]핵심관심코드에서 예외가 발생된 후에 삽입되어 실행될 횡단관심코드 ###");
		
		String methodName=joinPoint.getSignature().getName();
		System.out.println("### [after-throwing]"+methodName+" 메소드에서 발생된 예외 = "
				+exception.getMessage());
	}
	
//아래 이어서

 

 

5) Around Advice Method

Around Advice Method는 Object 클래스로 반환형을 작성하고 ProceedingJoinPoint 인터페이스로 매개변수를 작성하여 선언
타겟메소드의 반환값을 제공받아 Around Advice Method에서 반환하기 위해 반환형 작성
 => 타겟메소드의 반환값이 없는 경우 void 자료형으로 반환형을 작성할 수 있지만 타겟메소드의 반환값이 있는 경우 void 자료형으로 반환형을 작성하면 에러 발생
타겟메소드 관련 정보를 ProceedingJoinPoint 인터페이스의 매개변수로 제공받아 사용
 => ProceedingJoinPoint 객체 : 타겟메소드 관련 정보를 저장하기 위한 객체
 => JoinPoint 객체와 다른점은 ProceedingJoinPoint 객체로 타겟메소드를 직접 호출 가능

	public Object display(ProceedingJoinPoint joinPoint) throws Throwable {
		System.out.println("### [around]핵심관심코드 실행 전에 삽입되어 실행될 횡단관심코드 ###");
		//ProceedingJoinPoint.proceed() : ProceedingJoinPoint 객체로 타겟메소드를 호출하는 메소드
		// => 타겟메소드를 호출하여 반환되는 결과값을 변수에 저장
		// => Throwable(Error 클래스와 Exception 클래스의 부모클래스) 객체가 발생되므로 반드시
		//예외 처리하거나 예외 전달
		Object result=joinPoint.proceed();
		System.out.println("### [around]핵심관심코드 실행 후에 삽입되어 실행될 횡단관심코드 ###");
		return result;//타겟메소드의 반환값을 반환 처리
	}
}