Spring Framework에서 사용되는 AOP 구현방식을 소개하려고 한다.
AOP를 다루고자 하는 사람들은 조금 방법이 다양하게 있으니, 원하는 방식 하나 택해서 사용하면 될듯 싶다.
[배경 입문 지식]
1. [Spring-Framework] 30. AOP(Aspect-Oriented-Programming) 관점지향 프로그래밍 (Java셋팅) (1), 2020-10-04
- https://yyman.tistory.com/1447
2. [Spring-Framework] 30. AOP(Aspect-Oriented-Programming) 관점지향 프로그래밍 (Java셋팅) (2), 2020-10-04
셋팅 방법에서 다르다.
동일하게 생각하고 작성하면, 오류를 경험할 수 있다.
AOP를 다루는 건 큰 틀에서는 같은 일인데 불구하고, Service 어노테이션 정의부터 다소 셋팅이 달라져버릴 수가 있어서 신중하게 사용하는 것을 권장한다. 셋팅을 먼저 한 경우라면, 거기에 맞춰서 흐름을 타주는 방식으로 가야 하겠다.
XML, 순수한 Java 방식, Context.xml 및 Java 방식(어노테이션) 크게 3가지 방법으로 AOP를 설정할 수 있다.
이론적으로는 같으나 실질적인 구현에서는 호환이 안 되니 주의하여 사용할 것을 권한다.
3가지 방법 중 하나를 택해서 AOP 대상을 두었으면 그 방법을 따라가는 형태로 진행하는 것을 권장한다.
(구현 관점에서보면, 표준화가 진행이 덜된 느낌이 있다.) 시간이 나면, 소개해주겠다.
[태스트 환경]
* IDE: Eclipse 2020-06 (Spring Tools 3 Addon.....)
* Spring Framework Version: 4.2.4.RELEASE
* JUnit 5(태스트 실행)
1. 프로젝트 생성
-> Spring Legacy Project -> Spring MVC Project로 진행하였음.
프로젝트 생성 및 셋팅 방법에 대해서는 "이전 글들"을 참고하면 된다. (동일하게 진행함.)
2. pom.xml 설정
매우 중요한 부분이다. 노란색 불은 들어오는데 빌드하면 오류가 생긴 경우도 있을 수도 있다.
셋팅을 잘해야 한다.
-> Spring Tool-Suites 4.7로 작업하면 14버전을 사용해도 무방하다. 다만, 이전 버전의 Eclipse 등에서 프로젝트 구성에서 오류가 생길 수도 있다.
지금 pom 셋팅은 공통적인 작업이다.
(중략)
<properties>
<java-version>1.8</java-version>
<org.springframework-version>4.2.4.RELEASE</org.springframework-version>
<org.aspectj-version>1.6.10</org.aspectj-version>
<org.slf4j-version>1.6.6</org.slf4j-version>
</properties>
(중략)
<!-- AspectJ -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${org.aspectj-version}</version>
</dependency>
<!-- AspectJWeaver -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.8</version>
</dependency>
<!-- Spring AOP 추가(Java) -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${org.springframework-version}</version>
</dependency>
(중략)
3. 미리 살펴보는 프로젝트 구성도
이번 작업에서는 JUnit5로 TDD 방식으로 구동한 프로젝트이다.
그림 1. 프로젝트 구성도
작업할 프로젝트 구성이다.
4. 프로젝트 환경설정(Build Path, Java Compiler, Project Factes)
Build Path의 Libraries에 들어가서 버전을 1.8로 설정한다.
JUnit 5도 추가해준다.
참고로 JUnit 5은 자바 1.8버전에서부터 지원한다.
그림 2. 프로젝트 구성도
Build Path를 설정해준다. "Add Library"를 클릭해서 JUnit 5을 추가할 수 있다.
그림 3. 자바 컴파일러 환경설정
JDK를 잘 설치하였음에도 1.8버전 등으로 변경하였을 때 이클립스에서 오류로 간주해버리는 경우가 있다.
오류가 생기는 이유는 Project Factes 옵션을 조작할 때 발생한다.
JDK Compliance의 Compiler compliance level 버전을 맞춰주면 오류가 사라지는 것을 확인할 수 있다.
그림 4. Project Factes
Java의 버전을 1.8으로 변경한다.
5. applicationJavaAOP.xml (src/main/resources/applicationJavaAOP.xml)
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.2.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.2.xsd">
<aop:aspectj-autoproxy />
<context:component-scan base-package="com.website.example" />
<bean id="loggingAspect" class="com.website.example.aop.LogAdvisorJava" />
</beans>
AOP 스키마 정의는 servlet-context.xml에서 간단한 조작으로 추가하였다.
그림 5. aop 환경설정해주기 - 네임스페이스 정의
양식 틀은 /src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml에서 복사 붙여넣기하였다.
작성한 코드는 <aop>.....</bean> 이 정도이다.
* 파일명: applicationJavaAOP.xml
[첨부(Attachments)]
applicationJavaAOP.zip6. ResultAOPJava.java (com.website.example.text)
package com.website.example.test;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Service;
@Service
public class ResultAOPJava {
@Pointcut("execution(* com.website.example.test.*(..))")
public void method1() {
System.out.println("결과: 메서드");
}
}
* 파일명: ResultAOPJava.java
[첨부(Attachments)]
7. LogAdvisor.java (com.website.example.aop)
관점에 대한 인터페이스이다.
객체의 다형성을 생각하면 좋을 것으로 보인다.
package com.website.example.aop;
import org.aspectj.lang.annotation.Aspect;
@Aspect
public interface LogAdvisor {
public void beforeAdvice();
public void afterAdvice();
public void aroundAdvice();
}
* 파일명: LogAdvisor.java
[첨부(Attachments)]
8. LogAdvisorJava.java (com.website.example.aop)
클래스명을 Impl로 해도 되었을 법한데 태스트용이니 생략하도록 하자.
package com.website.example.aop;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Service;
// 어노테이션 방식
@Aspect
public class LogAdvisorJava implements LogAdvisor{
@Before("execution(* com.website.example.test.ResultAOPJava.*(..))")
public void beforeAdvice() {
System.out.println("전 단계");
}
@After("execution(* com.website.example.test.ResultAOPJava.*(..))")
public void afterAdvice() {
System.out.println("후 단계");
}
public void aroundAdvice() {
}
}
* 파일명: LogAdvisorJava.java
[첨부(Attachments)]
9. TestMain.java (com.website.example.test)
JUnit 태스트 도구로 실행 영역을 구현하였다.
package com.website.example.test;
import org.junit.Test;
import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;
public class TestMain {
@Test
public void test() {
// 방법 1
@SuppressWarnings("resource")
AbstractApplicationContext factory = new GenericXmlApplicationContext("applicationJavaAOP.xml");
ResultAOPJava cal = factory.getBean(ResultAOPJava.class);
cal.method1();
}
}
* 파일명: TestMain.java
[첨부(Attachments)]
10. 출력 결과
아래의 그림처럼 AOP가 잘 출력되는 것을 확인할 수 있다.
그림 6. AOP 화면 출력 결과
정상적으로 AOP 환경설정이 이뤄진 것을 확인할 수 있다.
* 참고자료(References)
1. Spring AOP – AspectJ Annotation Config Example - HowToDoInJava, https://howtodoinjava.com/spring-aop/spring-aop-aspectj-example-tutorial-using-annotation-config/, Accessed by 2020-10-09, Last Modified 2015-02.
-> 추천(25점): 구현에 대해서 많은 도움을 주었다.
2. 스프링 부트(Spring Boot) - AOP와 트랜잭션(Transaction) 설정하기 [개발을 시작해봐요!], https://congsong.tistory.com/25, Accessed by 2020-10-09, Last Modified 2020-04-28.
-> 추천(25점): 스프링 부트로 작성되었지만, AOP 개발 방법의 흐름을 살펴볼 수 있었음.