Spring集成AOP

Spring AOP 面向切面编程

一、环境搭建

依赖包管理（pom.xml）

<!-- Spring AOP -->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aop</artifactId>
	<version>4.3.8.RELEASE</version>
</dependency>

<dependency>
	<groupId>org.aspectj</groupId>
	<artifactId>aspectjweaver</artifactId>
	<version>1.8.2</version>
</dependency>

Spring配置文件

<?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:context="http://www.springframework.org/schema/context"
    xmlns:util="http://www.springframework.org/schema/util"
    xmlns:jee="http://www.springframework.org/schema/jee"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:jpa="http://www.springframework.org/schema/data/jpa"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    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/context http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
        http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!-- 开启注解 -->
    <context:annotation-config />

    <!-- 配置组件扫描 -->
    <context:component-scan base-package="com.info.*"></context:component-scan>

	<!-- 打开AOP注解支持,用于支持 @Aspect 等注解 -->
	<aop:aspectj-autoproxy /> 
    
</beans>

二、实现AOP切面编程

package com.info.aop;

import java.util.Arrays;

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.springframework.stereotype.Component;

@Component
@Aspect // 配合 <aop:aspectj-autoproxy/>
public class AopDemo {
	
	/*
	 * @Before: 在调用方法之前时候执行
	 * within(): 按照包和类型切入，这个包和类的全部实例都被 "切" 到
	 * within(com.info.service.*): 切入到包下所有的类
	 * 
	 * execution(修饰词  返回值  方法全限定名(参数类型) 异常类型): 切入到具体的方法
	 * execution(* com.info.service.AlarmBordService.query()): 切入一个具体方法
	 * execution(* quer*(..)): 切入以quer开头的方法
	 * execution(* com.info.service.AlarmBordService.*(..)): 切入类下所有的方法
	 * execution(* com.info.service.*.*(..)): 切入包下所有的方法
	 * execution(execution(* com.info..*.*(..)): 切入包和子包下所有的方法
	 */
	@Before("within(com.info.service.AlarmBordService)")
	public void beforeMethod(JoinPoint jp) {
		String methodName = jp.getSignature().getName();
		System.out.println("前置通知: 被切的方法是 " + methodName);
	}
	
	/*
	 * @AfterReturning: 用在方法正常结束后执行切入方法
	 */
	@AfterReturning(value = "execution(* com.info.service.AlarmBordService.*(..))", returning = "result")
	public void afterReturningMethod(JoinPoint jp, Object result) {
		String methodName = jp.getSignature().getName();
		System.out.println("返回通知: 被切的方法是 " + methodName + " 返回的值是 " + result);
	}

    /*
     * @After: 目标方法执行之后执行以下方法体的内容，不管是否发生异常。
     */
	@After(value = "within(com.info.service.AlarmBordService)")
	public void afterMethod(JoinPoint jp) {
		System.out.println("后置通知.....");
	}

    /*
     * @AfterThrowing: 异常通知，目标方法发生异常的时候执行以下代码
     */
	@AfterThrowing(value = "execution(* com.info.service.AlarmBordService.*(..))", throwing = "e")
    public void afterThorwingMethod(JoinPoint jp, NullPointerException e){
        String methodName = jp.getSignature().getName();
        System.out.println("异常通知: 被切的方法是 " + methodName + " Exception: " + e);
    }

	/*
	 * 环绕通知：目标方法执行前后分别执行一些代码，发生异常的时候执行另外一些代码
	 */
	@Around(value = "execution(* com.info.service.AlarmBordService.*(..))")
	public Object aroundMethod(ProceedingJoinPoint jp) {
		String methodName = jp.getSignature().getName();
		Object result = null;
		try {
			System.out.println("【环绕通知中的--->前置通知】：the method 【" + methodName + "】 begins with " + Arrays.asList(jp.getArgs()));
			// 执行目标方法：返回对象是 null 时终止方法，要想执行返回 jp.proceed()
//			result = jp.proceed();
			System.out.println("【环绕通知中的--->返回通知】：the method 【" + methodName + "】 ends with " + result);
		} catch (Throwable e) {
			System.out.println("【环绕通知中的--->异常通知】：the method 【" + methodName + "】 occurs exception " + e);
		}

		System.out.println("【环绕通知中的--->后置通知】：-----------------end.----------------------");
		
		// 获取注解的方法
		Signature sig = jp.getSignature();
		MethodSignature msig = null;
		if (!(sig instanceof MethodSignature)) {
			throw new IllegalArgumentException("该注解只能用于方法");
		}
		msig = (MethodSignature) sig;
		Object target = jp.getTarget();
		Method currentMethod = target.getClass().getMethod(msig.getName(), msig.getParameterTypes());
		
		return result;
	}
}

说明： AOP切入的是方法，不是某个控制器请求，所以不能直接返回视图来中断该方法的请求，但可以通过抛异常的方式达到中断方法执行的目的，所以在before通知中，如果通过验证直接return返回继续执行连接点方法，否则抛出一个自定义异常AccessDeniedException来中断连接点方法的执行。

测试类

package com.info.service;

import org.springframework.stereotype.Service;

import com.info.model.AlarmBord;

@Service
public class AlarmBordService {
	
	public String query() {
		AlarmBord alarmBord = null;
		System.out.println(alarmBord.getAlarmId());
		return "Hello";
	}
}

三、SpringBoot 集成 APO

引入依赖包：

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

引入依赖包后即可使用 APO 切面编程（参考上面），不需要做其他的配置修改

四、自定义注解切面

自定义注解切面不能使用上面的 within 等方式切入，需要使用 @annotation 来指定注解的位置

自定义注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Validate {

}

切入：

@Around("@annotation(com.info.tCloud3.controller.kubt.Validate)")