21.04.16 TIL(D+67 Spring AOP ,Tiles)

AOP ( Aspect Oriented Programming ) : 관점 지향 프로그래밍

- 핵심 기능과 공통 기능을 분리 시켜놓고, 공통 기능을 필요로 하는 핵심 기능들에서 사용하는 방식

- 공통 기능과 핵심 기능이 직접적으로 접촉하지 않고 Proxy를 통해서 수행

 

 

- 용어 정리

 

타겟 (Target)
부가기능을 부여할 대상

 

애스펙트 (Aspect)

부가기능 모듈 (부가될 기능을 정의한 어드바이스와 어드바이스를 어디에 적용할지를 결정하는 포인트컷을 함께 가지고 있다.)

 

어드바이스 (Advice)

부가기능을 담은 구현체

 

포인트컷 (PointCut)

어드바이스를 적용할 조인포인트를 선별하는 기능을 정의

 

조인포인트 (JoinPoint)

어드바이스가 적용될 수 있는 위치 (Spring에서는 프록시를 이용하여 구현하기 때문에 메소드 조인포인트만 제공)

 

프록시 (Proxy)

타겟을 감싸서 타겟의 요청을 대신 받아주는 랩핑(Wrapping) 오브젝트

 

 

- AOP 구현 방법

 

공통 : MVNRepostory에서 spring aop, aspectj weaver, aspectjrt 를 검색하여 Maven 태그를 pom.xml에 넣기(귀찮다면 아래 태그 붙여넣기)

 

AspectJRT : aspectj 런타임 프로그램. AspectJ의 기능을 사용토록 한다.

AspectJ Weaver : aspect의 정보를 바탕으로 aspect를 구성한 코드를 생성하는데 필요한 프로그램

위 두개는 세트.

 

		<!-- https://mvnrepository.com/artifact/org.springframework/spring-aop -->
		<dependency>
		    <groupId>org.springframework</groupId>
		    <artifactId>spring-aop</artifactId>
		    <version>5.3.3</version>
		</dependency>
		
		<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
		<dependency>
		    <groupId>org.aspectj</groupId>
		    <artifactId>aspectjweaver</artifactId>
		    <version>1.9.4</version>
		</dependency>
		
		<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjrt -->
		<dependency>
		    <groupId>org.aspectj</groupId>
		    <artifactId>aspectjrt</artifactId>
		    <version>1.9.4</version>
		</dependency>

 

 

1. xml 스키마 기반 구현

       1. src안에 bean.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:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">
		
	<!--  
		객체 생성
		java
		LogAOP logAop = new LogAOP();
		
		xml:
		<bean id="logAop" class="com.aop.LogAOP"/>
		
		jsp tag
		<jsp:useBean id="logAop" class="com.aop.LogAOP"/>
		
	-->	
	
	<!-- AOP Objcet 생성 -->
	
	<bean id="logAop" class="com.aop.LogAOP"/>
	
	<!-- AOP 설정(자동 호출) - callback  -->
	<aop:config>
		<aop:aspect id="logger" ref="logAop">
			<aop:pointcut expression="within(com.dto.*)" id="publicM"/> <!-- dto 패키지 안에있는 클래스가 실행될 때마다 -->
			<aop:around method="loggerAop" pointcut-ref="publicM"/>
		</aop:aspect>
	</aop:config>
	
	<!-- xml Cat Object New -->
	<bean id="myCat" class="com.dto.Cat">
		<property name="name" value="야옹이"/>
		<property name="age" value="3"/>
		<property name="color" value="노랑"/>
	</bean>

</beans>

 

 

       2. Main 클래스

package com.main;

import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

import com.dto.Cat;

public class MainClass {

	public static void main(String[] args) {
		
		// Java에서 xml 실행 시
		AbstractApplicationContext ctx = new GenericXmlApplicationContext("bean.xml");
		
		// xml에서 생성된 Object를 읽어 온다
		Cat myCat = ctx.getBean("myCat", Cat.class);
		myCat.info();
		
		myCat.setAge(5);

	}

}

 

 

       3. log를 작성해줄 LogAOP 클래스

package com.aop;

import org.aspectj.lang.ProceedingJoinPoint;

public class LogAOP {
	
	public Object loggerAop(ProceedingJoinPoint joinpoint) throws Throwable {
		
		String signatureStr = joinpoint.getSignature().toShortString();
		System.out.println(signatureStr + " 시작");
		
		try {
			Object obj = joinpoint.proceed();	// 실행 시
			
			return obj;
			
		}finally {
			System.out.println("실행 후 : "+System.currentTimeMillis());
			System.out.println(signatureStr + " 종료");	//실행 후
		}
		
	}

}

 

       4. 고양이 DTO

package com.dto;

public class Cat {
	
	private String name;
	private int age;
	private String color;
	
	public Cat() {
		// TODO Auto-generated constructor stub
	}

	public Cat(String name, int age, String color) {
		super();
		this.name = name;
		this.age = age;
		this.color = color;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getColor() {
		return color;
	}

	public void setColor(String color) {
		this.color = color;
	}
	
	
	public void info() {
		System.out.println("이름 : "+name);
		System.out.println("나이 : "+age);
		System.out.println("색 : "+color);
	}

}

       

 

 

2. @Aspect 어노테이션 기반 구현 (1번보다 간편하다.)

       1. src안에 bean.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:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">		

	<!-- AOP Objcet 생성 -->
	
	<bean id="logAop" class="com.aop.LogAOP"/>
	
	<!-- AOP Annotation (XML과 차이나는 곳) -->
	<aop:aspectj-autoproxy/>
		
	
	<!-- xml Cat Object New -->
	<bean id="myCat" class="com.dto.Cat">
		<property name="name" value="고양이"/>
		<property name="age" value="2"/>
		<property name="color" value="흰색"/>
	</bean>
	
</beans>

 

       2. LogAOP.java

package com.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;


/*어노테이션 추가*/
@Aspect
public class LogAOP {
	
	/* com.dto안의 클래스와 연결 */
	@Around("within(com.dto.*)")
	public Object loggerAop(ProceedingJoinPoint joinpoint) throws Throwable {
		
		String signatureStr = joinpoint.getSignature().toShortString();
		System.out.println(signatureStr + " 시작");
		
		try {
			Object obj = joinpoint.proceed();	// 실행 시
			
			return obj;
			
		}finally {
			System.out.println("실행 후 : "+System.currentTimeMillis());
			System.out.println(signatureStr + " 종료");	//실행 후
		}
		
	}

}

 

 

MainClass와 CatDTO는 XML방식과 똑같다.

 

 

@Before (이전)

• 어드바이스 타겟 메소드가 호출되기 전에 어드바이스 기능을 수행

@After (이후)

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

 

@Around (메소드 실행 전후)

• 어드바이스가 타겟 메소드를 감싸서 타겟 메소드 호출전과 후에 어드바이스 기능을 수행

 

within() : 클래스 혹은 인터페이스 단위까지만 범위 지정이 가능

• ex) within(com.dto.*) : dto 패키지 아래의 클래스와 인터페이스가 가진 모든 메소드
• ex) within(com.dto..) : dto 아래의 모든 하위 패키지까지 포함한 클래스와 인터페이스가 가진 메소드

 

 

 

※ AOP를 웹과 연동시에는 WEB-IMF/spring 폴더에 aop-context.xml을 추가하고,

web-xml의 dispatcher 'param-value'에 xml의 위치를 추가해준다.

 

aop-context.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:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">
		
	<aop:aspectj-autoproxy/>
	
	<!-- AOP 해당 클래스를 생성 -->
	<bean id="myAspect" class="bit.com.a.aop.LogAOP"/>

</beans>

 

web.xml

  <servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>
	      /WEB-INF/spring/servlet-context.xml
	      /WEB-INF/spring/aop-context.xml <!-- 이부분 추가 -->
      </param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

 

 

 

 

 

---

 

Tiles

 - 뷰페이지의 jsp들을 상단, 사이드, 메인, 하단 등을 페이지 include 방식으로 나누어 반복되는 부분을 설정파일로

관리가 가능

 

 

1 .pom.xml tiles 추가

	<!-- tiles -->
	<dependency>
	    <groupId>org.apache.tiles</groupId>
	    <artifactId>tiles-api</artifactId>
	    <version>3.0.7</version>
	</dependency>
	
	<dependency>
	    <groupId>org.apache.tiles</groupId>
	    <artifactId>tiles-core</artifactId>
	    <version>3.0.7</version>
	</dependency>
	
	<dependency>
	    <groupId>org.apache.tiles</groupId>
	    <artifactId>tiles-jsp</artifactId>
	    <version>3.0.7</version>
	</dependency>
	
	<dependency>
	    <groupId>org.apache.tiles</groupId>
	    <artifactId>tiles-servlet</artifactId>
	    <version>3.0.7</version>
	</dependency>
	
	<dependency>
	    <groupId>org.apache.tiles</groupId>
	    <artifactId>tiles-template</artifactId>
	    <version>3.0.7</version>
	</dependency>
	
	<dependency>
  		<groupId>org.apache.tiles</groupId>
  		<artifactId>tiles-autotag-core-runtime</artifactId>
  		<version>1.1.0</version>
  	</dependency>

	<dependency>
  		<groupId>org.apache.tiles</groupId>
  		<artifactId>tiles-request-api</artifactId>
  		<version>1.0.6</version>
  	</dependency>
  	
  	<dependency>
  		<groupId>org.apache.tiles</groupId>
  		<artifactId>tiles-request-jsp</artifactId>
  		<version>1.0.6</version>
  	</dependency>
  	
  	<dependency>
  		<groupId>org.apache.tiles</groupId>
  		<artifactId>tiles-request-servlet</artifactId>
  		<version>1.0.6</version>
  	</dependency> 

 

 

2. WEB-INF/spring/servlet-context.xml 수정

 

기존의 viewResolver를 지우고 하단과 같이 설정한다.

<!-- tiles 설정 -->
<bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles3.TilesConfigurer">
	<property name="definitions">
		<list>
			<value>/WEB-INF/views/layouts.xml</value>	<!-- jsp의 집합체 -->
		</list>
	</property>
</bean>
	
<bean id="viewResolver" class="org.springframework.web.servlet.view.UrlBasedViewResolver">
	<property name="requestContextAttribute" value="requestContext"/>
	<property name="viewClass" value="org.springframework.web.servlet.view.tiles3.TilesView"/>
</bean>

 

3. WEB-INF/views/layouts.xml 생성

 

definition태그의 name은 컨트롤러 이동 시에 사용

template에는 테이블 형식을 갖춘 jsp의 위치를 작성한다.

extends를 통하여 해당 태그의 attribute를 상속 받을 수 있다.

아래의 예시는 bbslist.tiles로 이동할 경우 header, menu, empty, footer만 상속받고 content는 새로운 페이지를 불러온다.

 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tiles-definitions PUBLIC
       "-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN"
       "http://tiles.apache.org/dtds/tiles-config_3_0.dtd">


<tiles-definitions>
	<definition name="login.tiles" template="/WEB-INF/views/layouts-tiles.jsp">
		<put-attribute name="header" value="/WEB-INF/views/header.jsp"/>
		<put-attribute name="menu" value="/WEB-INF/views/login/menu.jsp"/>
		<put-attribute name="content" value="/WEB-INF/views/login/content.jsp"/>
		<put-attribute name="empty" value="/WEB-INF/views/empty.jsp"/>
		<put-attribute name="footer" value="/WEB-INF/views/footer.jsp"/>
	</definition>
	
	
	<definition name="bbslist.tiles" extends="login.tiles">
		<put-attribute name="content" value="/WEB-INF/views/bbs/content.jsp"/>
	</definition>
	
</tiles-definitions>

 

template

 

테이블 형식으로 구성

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib prefix="tiles" uri="http://tiles.apache.org/tags-tiles"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>

<!-- 기본 layout -->
<table style="width:100%; height:100%; border-color:gray">

	<!-- header -->
	<tr align="center" style="background-color:black; color:white;">
		<td style="height:10%;" colspan="3">
			<tiles:insertAttribute name="header"/>
		</td>
	</tr>
	
	<!-- menu, main -->
	<tr>
		<td style="width: 20%; background-color: rgb(204,204,204)" align="left" valign="top">
			<tiles:insertAttribute name="menu"/>
		</td>
		<td>
			<tiles:insertAttribute name="content"/>
		</td>
		<td width="15%" align="center">
			<tiles:insertAttribute name="empty"/>
		</td>
	</tr>
	
	<!-- footer -->
	<tr align="center" style="background-color: black; color: white;">
		<td height="10%" colspan="3">
			<tiles:insertAttribute name="footer"/>
		</td>
	</tr>
	
	
</table>


</body>
</html>

 

 

출력 예시