java spring aop

最新推荐文章于 2024-05-23 17:45:07 发布

SHAN_9W

最新推荐文章于 2024-05-23 17:45:07 发布

阅读量148

点赞数

文章标签： java spring aop

本文链接：https://blog.csdn.net/u014248032/article/details/94015111

版权

AOP简介

AOP(Aspect-Oriented Programming, 面向切面编程): 是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充.
AOP 的主要编程对象是切面(aspect), 而切面模块化横切关注点.
在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪里, 以什么方式应用, 并且不必修改受影响的类. 这样一来横切关注点就被模块化到特殊的对象(切面)里.
AOP 的好处:

每个事物逻辑位于一个位置, 代码不分散, 便于维护和升级
业务模块更简洁, 只包含核心业务代码.

AOP 术语

切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象
通知(Advice): 切面必须要完成的工作
目标(Target): 被通知的对象
代理(Proxy): 向目标对象应用通知之后创建的对象
连接点（Joinpoint）：程序执行的某个特定位置：如类某个方法调用前、调用后、方法抛出异常后等。连接点由两个信息确定：方法表示的程序执行点；相对点表示的方位。例如 ArithmethicCalculator#add() 方法执行前的连接点，执行点为 ArithmethicCalculator#add()；方位为该方法执行前的位置
切点（pointcut）：每个类都拥有多个连接点：例如 ArithmethicCalculator 的所有方法实际上都是连接点，即连接点是程序类中客观存在的事务。AOP 通过切点定位到特定的连接点。类比：连接点相当于数据库中的记录，切点相当于查询条件。切点和连接点不是一对一的关系，一个切点匹配多个连接点，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

AspectJ：

Java 社区里最完整最流行的 AOP 框架. 在 Spring2.0 以上版本中, 可以使用基于 AspectJ 注解或基于 XML 配置的 AOP

在 Spring 中启用 AspectJ 注解支持

要在 Spring 应用中使用 AspectJ 注解, 必须在 classpath 下包含 AspectJ 类库: aopalliance.jar、aspectj.weaver.jar 和 spring-aspects.jar
将 aop Schema 添加到 <beans> 根元素中.
要在 Spring IOC 容器中启用 AspectJ 注解支持, 只要在 Bean 配置文件中定义一个空的 XML 元素 <aop:aspectj-autoproxy>
当 Spring IOC 容器侦测到 Bean 配置文件中的 <aop:aspectj-autoproxy> 元素时, 会自动为与 AspectJ 切面匹配的 Bean 创建代理.

用 AspectJ 注解声明切面

要在 Spring 中声明 AspectJ 切面, 只需要在 IOC 容器中将切面声明为 Bean 实例. 当在 Spring IOC 容器中初始化 AspectJ 切面之后, Spring IOC 容器就会为那些与 AspectJ 切面相匹配的 Bean 创建代理.
在 AspectJ 注解中, 切面只是一个带有 @Aspect 注解的 Java 类.
通知是标注有某种注解的简单的 Java 方法.
AspectJ 支持 5 种类型的通知注解:

@Before: 前置通知, 在方法执行之前执行

@After: 后置通知, 在方法执行之后执行

@AfterRunning: 返回通知, 在方法返回结果之后执行

@AfterThrowing: 异常通知, 在方法抛出异常之后

@Around: 环绕通知, 围绕着方法执行

示例1

先创建接口AtithmeticCalculator

package beans.aop;
/**
*@author Danbro
*@version 创建时间:2019年6月28日下午3:45:44
*@funcition 
**/
public interface AtithmeticCalculator {
	int add(int i ,int j);
	
	int sub(int i ,int j);
	
	int div(int i ,int j);
	
	int mul(int i ,int j);
}

创建接口AtithmeticCalculator的实现AtithmeticCalculatorImpl

package beans.aop;

import org.springframework.stereotype.Component;

/**
*@author Danbro
*@version 创建时间:2019年6月28日下午3:50:05
*@funcition 
**/
@Component
public class AtithmeticCalculatorImpl implements AtithmeticCalculator {

	@Override
	public int add(int i, int j) {
		
		return  i + j;
	}

	@Override
	public int sub(int i, int j) {
		return i - j;
	}

	@Override
	public int div(int i, int j) {
		// TODO Auto-generated method stub
		return i / j;
	}

	@Override
	public int mul(int i, int j) {
		return i * j;
	}

}

前置通知:

在方法执行之前执行的通知前置通知使用 @Before 注解, 并将切入点表达式的值作为注解值.

package beans.aop;

import java.util.Arrays;
import java.util.List;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

/**
*@author Danbro
*@version 创建时间:2019年6月28日下午4:00:10
*@funcition 
**/
//把这个类声明为一个切面:需要把该类放入到IOC容器中,再申明为一个切面
@Component
@Aspect
public class LoggingAspect {
	
	@Before("execution(public int beans.aop.AtithmeticCalculatorImpl.*(int , int )) ")//*表示AtithmeticCalculatorImp的所有方法运行前时都执行beforeMethod方法
	public void beforeMethod(JoinPoint joinPoint) {
		//获取方法名
		String methodName = joinPoint.getSignature().getName();
		//获取方法要用到的参数
		List<Object> args = Arrays.asList(joinPoint.getArgs());
		System.out.println("the Method:" + methodName + "\tagrs:" + args);
	}
	
}

Bean配置文件

<?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: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-4.3.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">
	
	<!-- 自动扫描的包 -->
	<context:component-scan base-package="beans.aop"></context:component-scan>
	<!-- 使AspjectJ注解起作用:自动为匹配的类生成代理对象 -->
	<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

Main类调用

package beans.aop;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
*@author Danbro
*@version 创建时间:2019年6月28日下午3:54:30
*@funcition 
**/
public class Main {
	public static void main(String[] args) {
		//创建IOC容器
		ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
		//从容器中取bean的实例
		AtithmeticCalculator atithmeticCalculator = ctx.getBean(AtithmeticCalculator.class);
		//使用bean
		int result = atithmeticCalculator.add(2, 3);
		System.out.println(result);	
		int result2 = atithmeticCalculator.mul(2, 3);
		System.out.println(result2);
	}
}

结果

the Method:add	agrs:[2, 3]
5
the Method:mul	agrs:[2, 3]
6

后置通知

后置通知是在连接点完成之后执行的, 即连接点返回结果或者抛出异常的时候, 下面的后置通知记录了方法的终止.
一个切面可以包括一个或者多个通知.

package beans.aop;

import java.util.Arrays;
import java.util.List;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

/**
*@author Danbro
*@version 创建时间:2019年6月28日下午4:00:10
*@funcition 
**/
//把这个类声明为一个切面:需要把该类放入到IOC容器中,再申明为一个切面
@Component
@Aspect
public class LoggingAspect {
	
	@Before("execution(public int beans.aop.AtithmeticCalculatorImpl.*(int , int ))")
	public void beforeMethod(JoinPoint joinPoint) {
		//获取方法名
		String methodName = joinPoint.getSignature().getName();
		//获取方法要用到的参数
		List<Object> args = Arrays.asList(joinPoint.getArgs());
		System.out.println("the Method:" + methodName + "\tagrs:" + args);
	}
	//后置通知:在目标方法执行后(无论是否异常),执行的通知
	//在后置通知中还不能访问目标方法执行的结果
	@After("execution(public int beans.aop.AtithmeticCalculatorImpl.*(int , int ))")
	public void afterMethod(JoinPoint joinPoint) {
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the Method:" + methodName + "\tends");
	}
}

结果

the Method:add	agrs:[2, 3]
the Method:add	ends
5
the Method:mul	agrs:[2, 3]
the Method:mul	ends
6

返回通知

无论连接点是正常返回还是抛出异常, 后置通知都会执行. 如果只想在连接点返回的时候记录日志, 应使用返回通知代替后置通知.
在返回通知中, 只要将 returning 属性添加到 @AfterReturning 注解中, 就可以访问连接点的返回值. 该属性的值即为用来传入返回值的参数名称.
必须在通知方法的签名中添加一个同名参数. 在运行时, Spring AOP 会通过这个参数传递返回值.
原始的切点表达式需要出现在 pointcut 属性中

/**
	 * 在方法正常结束后执行的代码
	 * 返回通知是可以访问到方法的返回值的
	 * @param joinPoint
	 */
	@AfterReturning(value = "execution(public int beans.aop.AtithmeticCalculatorImpl.*(..))",
			returning = "result")
	public void returnMehtod(JoinPoint joinPoint,Object result) {
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the Method:" + methodName + "\tends with:" + result);
	}

异常通知

只在连接点抛出异常时才执行异常通知
将 throwing 属性添加到 @AfterThrowing 注解中, 也可以访问连接点抛出的异常. Throwable 是所有错误和异常类的超类. 所以在异常通知方法可以捕获到任何错误和异常.
如果只对某种特殊的异常类型感兴趣, 可以将参数声明为其他异常的参数类型. 然后通知就只在抛出这个类型及其子类的异常时才被执行.

/**
	 * 	在目标方法出现异常时会执行的代码
	 * 	可以访问到异常对象,且可以指定在出现特定异常时在执行通知代码
	 * @param joinPoint
	 * @param ex
	 */
	@AfterThrowing(value = "execution(public int beans.aop.AtithmeticCalculatorImpl.*(..))",
			throwing = "ex")
	public void afterThrowing(JoinPoint joinPoint,Exception ex) {//Expection可以指定异常
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the Method:" + methodName + "\toccurs expection:" + ex);
	}

环绕通知

环绕通知是所有通知类型中功能最为强大的, 能够全面地控制连接点. 甚至可以控制是否执行连接点.
对于环绕通知来说, 连接点的参数类型必须是 ProceedingJoinPoint . 它是 JoinPoint 的子接口, 允许控制何时执行, 是否执行连接点.
在环绕通知中需要明确调用 ProceedingJoinPoint 的 proceed() 方法来执行被代理的方法. 如果忘记这样做就会导致通知被执行了, 但目标方法没有被执行.
注意: 环绕通知的方法需要返回目标方法执行之后的结果, 即调用 joinPoint.proceed(); 的返回值, 否则会出现空指针异常

	/**
	 * 	环绕通知需要携带ProceedingJoinPoint类型的参数
	 * 	环绕通知类似于动态代理的全过程 ProceedingJoinPoint类型参数可以决定是否执行目标方法
	 * 	且环绕通知必须有返回值 返回值既为目标方法的返回值
	 * @param pjd
	 */
	@Around("execution(public int beans.aop.AtithmeticCalculatorImpl.*(..))")
	public Object aroundMethod(ProceedingJoinPoint pjd) {
		Object result = null;
		String methodName = pjd.getSignature().getName();
		try {
			//前置通知
			System.out.println("the Method:" + methodName + " begins with " + Arrays.asList(pjd.getArgs()));
			result = pjd.proceed();
			//返回通知
			System.out.println("the Method:" + methodName + " ends with ");
		} catch (Throwable e) {
			//异常通知
			System.out.println("the Method:" + methodName + "\toccurs expection:" + e);
			throw new RuntimeException();
		}
		//返回通知
		System.out.println("the Method:" + methodName + " ends " + result);
		return result;
	}

指定切面的优先级

在同一个连接点上应用不止一个切面时, 除非明确指定, 否则它们的优先级是不确定的.
切面的优先级可以通过实现 Ordered 接口或利用 @Order 注解指定.
实现 Ordered 接口, getOrder() 方法的返回值越小, 优先级越高.
若使用 @Order 注解, 序号出现在注解中

重用切入点定义

在编写 AspectJ 切面时, 可以直接在通知注解中书写切入点表达式. 但同一个切点表达式可能会在多个通知中重复出现.
在 AspectJ 切面中, 可以通过 @Pointcut 注解将一个切入点声明成简单的方法. 切入点的方法体通常是空的, 因为将切入点定义与应用程序逻辑混在一起是不合理的.
切入点方法的访问控制符同时也控制着这个切入点的可见性. 如果切入点要在多个切面中共用, 最好将它们集中在一个公共的类中. 在这种情况下, 它们必须被声明为 public. 在引入这个切入点时, 必须将类名也包括在内. 如果类没有与这个切面放在同一个包中, 还必须包含包名.
其他通知可以通过方法名称引入该切入点.

	@Pointcut("execution(public int beans.aop.AtithmeticCalculatorImpl.*(int , int ))")
	public void declareJoinPointExpression() {}

	public void afterMethod(JoinPoint joinPoint) {
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the Method:" + methodName + "\tends");
	}

用基于 XML 的配置声明切面

除了使用 AspectJ 注解声明切面, Spring 也支持在 Bean 配置文件中声明切面. 这种声明是通过 aop schema 中的 XML 元素完成的.
正常情况下, 基于注解的声明要优先于基于 XML 的声明. 通过 AspectJ 注解, 切面可以与 AspectJ 兼容, 而基于 XML 的配置则是 Spring 专有的. 由于 AspectJ 得到越来越多的 AOP 框架支持, 所以以注解风格编写的切面将会有更多重用的机会.

<?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">
	<!-- 配置bean -->
	<bean id = "atithmeticCalculator" class="beans.aop.xml.AtithmeticCalculatorImpl"></bean>
	<!-- 配置切面的bean -->
	<bean id = "loggingAspect" class="beans.aop.xml.LoggingAspect"></bean>
	<!-- 配置AOP -->
	<aop:config>
		<!-- 配置表达式 -->
		<aop:pointcut expression="execution(* beans.aop.AtithmeticCalculatorImpl.*(int , int ))" id="pointcut"/>
		<!-- 配置切面及通知 -->
		<aop:aspect ref="loggingAspect" order="1">
			<!-- 前置通知 -->
			<aop:before method="beforeMethod" pointcut-ref="pointcut"/>
		</aop:aspect>
	</aop:config>
</beans>

SHAN_9W

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
java spring aop

AOP简介 AOP(Aspect-Oriented Programming, 面向切面编程): 是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充. AOP 的主要编程对象是切面(aspect), 而切面模块化横切关注点. 在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪...
复制链接

扫一扫