Spring框架学习与实践（十一）

最新推荐文章于 2024-11-10 21:05:45 发布
最新推荐文章于 2024-11-10 21:05:45 发布
阅读量187 收藏
点赞数
分类专栏： Spring框架 文章标签： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jiuyuefenglove/article/details/104519170
版权

Spring 使用 AspectJ 开发 AOP：基于 XML 和基于 Annotation

AspectJ 是一个基于 Java 语言的 AOP 框架，它扩展了 Java 语言。Spring2.0 以后，新增了对 AspectJ 方式的支持，新版本的 Spring 框架，建议使用 AspectJ 方式开发 AOP。

使用 AspectJ 开发 AOP 通常有两种方式：

1）基于 XML 的声明式

2）基于 Annotation 的声明式

接下来将对这两种 AOP 的开发方式进行演练。

 

基于XML的声明式

基于 XML 的声明式是指通过 Spring 配置文件的方式定义切面、切入点及声明通知，而所有的切面和通知都必须定义在 <aop:config> 元素中。下面通过案例演示 Spring 中如何使用基于 XML 的声明式实现 AOP 的开发。

1. 导入 JAR 包

使用 AspectJ 除了需要导入 Spring AOP 的 JAR 包以外，还需要导入与 AspectJ 相关的 JAR 包，具体如下：

1）spring-aspects-3.2.13.RELEASE.jar：Spring 为 AspectJ 提供的实现，在 Spring 的包中已经提供

2）om.springsource.org.aspectj.weaver-1.6.8.RELEASE.jar：是 AspectJ 提供的规范，可以在官方网址https://repo.spring.io/webapp/#/search/quick/中搜索并下载：

 2. 创建切面类 MyAspect

在 src 目录下创建一个名为 com.mengma.aspectj.xml 的包，在该包下创建切面类 MyAspect，编辑后如下所示：

package com.mengma.aspectj.xml;

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

public class MyAspect {
	// 前置通知
	public void myBefore(JoinPoint joinPoint) {
		System.out.print("前置通知，目标：");
		System.out.print(joinPoint.getTarget() + "方法名称：");
		System.out.println(joinPoint.getSignature().getName());
	}
	
	// 后置通知
	public void myAfterReturning(JoinPoint joinPoint) {
		System.out.print("后置通知，方法名称：" + joinPoint.getSignature().getName());
	}
	
	// 环绕通知
	public Object myAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
		System.out.println("环绕开始"); // 开始
		Object obj = proceedingJoinPoint.proceed(); // 执行当前目标方法
		System.out.println("环绕结束"); // 结束
		return obj;
	}
	
	// 异常通知
	public void myAfterThrowing(JoinPoint joinPoint, Throwable e) {
		System.out.println("异常通知" + "出错了" + e.getMessage());
	}
	
	// 最终通知
	public void myAfter() {
		System.out.println("最终通知");
	}

}

上述代码中，分别定义了几种不同的通知类型方法，在这些方法中，通过 JoinPoint 参数可以获得目标对象的类名、目标方法名和目标方法参数等。需要注意的是，环绕通知必须接收一个类型为 ProceedingJoinPoint 的参数，返回值必须是 Object 类型，且必须抛出异常。异常通知中可以传入 Throwable 类型的参数，用于输出异常信息。

3. 创建 Spring 配置文件

在 com.mengma.aspectj.xml 包下创建 applicationContext.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-2.5.xsd  
            http://www.springframework.org/schema/aop
            http://www.springframework.org/schema/aop/spring-aop-2.5.xsd">
    
    <!--目标类 -->
    <bean id="customerDao" class="com.mengma.dao.CustomerDaoImpl" />
    <!--切面类 -->
    <bean id="myAspect" class="com.mengma.aspectj.xml.MyAspect"></bean>
    <!--AOP 编程 -->
    <aop:config>
        <aop:aspect ref="myAspect">
            <!-- 配置切入点，通知最后增强哪些方法 -->
            <aop:pointcut expression="execution ( * com.mengma.dao.*.* (..))"
                id="myPointCut" />
            <!--前置通知，关联通知 Advice和切入点PointCut -->
            <aop:before method="myBefore" pointcut-ref="myPointCut" />
            <!--后置通知，在方法返回之后执行，就可以获得返回值returning 属性 -->
            <aop:after-returning method="myAfterReturning"
                pointcut-ref="myPointCut" returning="returnVal" />
            <!--环绕通知 -->
            <aop:around method="myAround" pointcut-ref="myPointCut" />
            <!--抛出通知：用于处理程序发生异常，可以接收当前方法产生的异常 -->
            <!-- *注意：如果程序没有异常，则不会执行增强 -->
            <!-- * throwing属性：用于设置通知第二个参数的名称，类型Throwable -->
            <aop:after-throwing method="myAfterThrowing"
                pointcut-ref="myPointCut" throwing="e" />
            <!--最终通知：无论程序发生任何事情，都将执行 -->
            <aop:after method="myAfter" pointcut-ref="myPointCut" />
        </aop:aspect>
    </aop:config>
</beans>

上述代码中，首先在第 4、7、8 行代码中分别导入了 AOP 的命名空间。第 12 行代码指定了切面类。

第 17、18 行代码配置了切入点，通知需要增强哪些方法，expression="execution（*com.mengma.dao.*.*（..））的意思是增强 com.mengma.dao 包下所有的方法。

第 20～32 行代码用于关联通知（Advice）和切入点（PointCut）。以第 20 行代码前置通知为例，<aop:before> 标签的 method 属性用于指定通知，pointcut-ref 属性用于指定切入点，也就是要增强的方法，其他几种通知的配置可以参考代码注释。

4. 创建测试类

在 com.mengma.aspectj.xml 包下创建测试类 XMLTest，如下所示：

package com.mengma.aspectj.xml;

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

import com.mengma.dao.CustomerDao;

public class XMLTest {
	@Test
	public void test() {
		String xmlPath = "com/mengma/aspectj/xml/applicationContext.xml";
		ApplicationContext applicationContext = new ClassPathXmlApplicationContext(xmlPath);
		// 从Spring容器获取实例
		CustomerDao customerDao = (CustomerDao) applicationContext.getBean("customerDao");
		// 执行方法
		customerDao.add();
	}

}

5. 运行项目并查看结果

使用 JUnit 测试运行 XMLTest，运行成功后，控制台的输出结果如图：

为了更好地演示异常通知，接下来在 CustomerDaoImpl 类的 add() 方法中添加一行会抛出异常的代码，如“int i=1/0；”，重新运行 XMLTest 测试类，可以看到异常通知执行了，此时控制台的输出结果如图：

从上面两次输出结果中可以看出，基于 XML 声明式的 AOP 开发已经成功实现。

基于 Annotation 的声明式

在 Spring 中，尽管使用 XML 配置文件可以实现 AOP 开发，但是如果所有的相关的配置都集中在配置文件中，势必会导致 XML 配置文件过于臃肿，从而给维护和升级带来一定的困难。为此，AspectJ 框架为 AOP 开发提供了另一种开发方式——基于 Annotation 的声明式。AspectJ 允许使用注解定义切面、切入点和增强处理，而 Spring 框架则可以识别并根据这些注解生成 AOP 代理。

关于 Annotation 注解的介绍如表所示：

Annotation 注解介绍
名称说明
@Aspect用于定义一个切面
@Before用于定义前置通知，相当于 BeforeAdvice
@AfterReturning用于定义后置通知，相当于 AfterReturningAdvice
@Around用于定义环绕通知，相当于MethodInterceptor
@AfterThrowing用于定义抛出通知，相当于ThrowAdvice
@After用于定义最终final通知，不管是否异常，该通知都会执行
@DeclareParents用于定义引介通知，相当于IntroductionInterceptor（不要求掌握）

下面使用注解的方式重新实现“基于XML的声明式”部分的功能。

1. 创建切面类 MyAspect

在 src 目录下创建一个名为 com.mengma.aspectj.annotation 的包，在该包下创建一个切面类 MyAspect，如下所示：

package com.mengma.aspectj.annotation;

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.Before;
import org.aspectj.lang.annotation.Pointcut;

public class MyAspect {
	// 用于取代：<aop:pointcut expression="execution ( * com.mengma.dao.*.* (..))" id="myPointCut" />
	// 要求：方法必须是private，没有值，名称自定义，没有参数
	@Pointcut("execution ( * com.mengma.dao.*.* (..))")
	private void myPointCut() {
		
	}
	
	// 前置通知
	@Before("myPointCut()")
	public void myBefore(JoinPoint joinPoint) {
		System.out.print("前置通知，目标：");
		System.out.print(joinPoint.getTarget() + "方法名称：");
		System.out.println(joinPoint.getSignature().getName());
	}
	
	// 后置通知
	@AfterReturning(value = "myPointCut()")
	public void myAfterReturning(JoinPoint joinPoint) {
		System.out.print("后置通知，方法名称：" + joinPoint.getSignature().getName());
	}
	
	// 环绕通知
	@Around("myPointCut()")
	public Object myAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
		System.out.println("环绕开始"); // 开始
		Object obj = proceedingJoinPoint.proceed(); // 执行当前目标方法
		System.out.println("环绕开始"); // 结束
		return obj;
	}
	
	// 异常通知
	@AfterThrowing(value = "myPointCut()", throwing = "e")
	public void myAfterThrowing(JoinPoint joinPoint, Throwable e) {
		System.out.println("异常通知，出错了" + e.getMessage());
	}
	
	// 最终通知
	@After("myPointCut()")
	public void myAfter() {
		System.out.println("最终通知");
	}
}

上述代码中，第 13 行 @Aspect 注解用于声明这是一个切面类，该类作为组件使用，所以要添加 @Component 注解才能生效。第 19 行中 @Poincut 注解用于配置切入点，取代 XML 文件中配置切入点的代码。

在每个通知相应的方法上都添加了注解声明，并且将切入点方法名“myPointCut”作为参数传递给要执行的方法，如需其他参数（如异常通知的异常参数），可以根据代码提示传递相应的属性值。

2. 为目标类添加注解

在 com.mengma.dao.CustomerDaoImpl 目标类中添加注解 @Repository（"customerDao"）。

3. 创建Spring配置文件

在 com.mengma.aspectj.annotation 包下创建 applicationContext.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"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
            http://www.springframework.org/schema/aop
            http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">
    
    <!--扫描含com.mengma包下的所有注解-->
    <context:component-scan base-package="com.mengma"/>
    <!-- 使切面开启自动代理 -->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

上述代码中，首先导入了 AOP 命名空间及其配套的约束，使切面类中的 @AspectJ 注解能够正常工作；第 13 行代码添加了扫描包，使注解生效。需要注意的是，这里还包括目标类 com.mengma.dao.CustomerDaoImpl 的注解，所以 base-package 的值为 com.mengma；第 15 行代码的作用是切面开启自动代理。

4. 创建测试类

在 com.mengma.aspectj.annotation 包下创建一个名为 AnnotationTest 的测试类，如下所示：

package com.mengma.aspectj.annotation;

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

import com.mengma.dao.CustomerDao;

public class AnnotationTest {
	@Test
	public void test() {
		String xmlPath = "com/mengma/aspectj/xml/applicationContext.xml";
		ApplicationContext applicationContext = new ClassPathXmlApplicationContext(xmlPath);
		// 从Spring容器获取实例
		CustomerDao customerDao = (CustomerDao) applicationContext.getBean("customerDao");
		// 执行方法
		customerDao.add();
	}
	
}

5. 运行项目并查看结果

使用 JUnit 测试运行 AnnotationTest ，运行成功后，控制台的输出结果如图：

 

 删除 add() 方法中的“int i=1/0；”，重新运行 AnnotationTest，此时控制台的输出结果如下图 ：

从上面两次运行的输出结果中可以看出，已成功使用 Annotation 的方式实现了 AOP 开发。与其他方式相比，基于 Annotation 方式实现 AOP 的效果是最方便的方式，所以实际开发中推荐使用注解的方式。

jiuyuefenglove
关注
专栏目录
基于Java语言的Spring框架学习与实践设计源码
09-28
本项目为Java语言编写的基于Spring框架的学习与实践源码，共包含49个文件，其中包括34个Java源文件、13个XML配置文件以及1个Markdown文档。
springboot 集成redis-om-spring使用
qq_27354909的博客
08-15 515
/</</</说明：因为v0.9.1之后集成了Spring AI相关的，所以在Spring AIv1.0.0版后才处理，所以先用v0.9.0。
傻傻的分不清Redis Stack和Redis关系，全新体验：全文搜索、向量数据库、文档数据库，真的很香。
专注于分享最佳资源、最佳工具、有味道的技术文章
12-29 3088
傻傻的分不清Redis Stack和Redis关系，全新体验：全文搜索、向量数据库、文档数据库，真的很香。
spring学习笔记 （3）aop的原理与实现
weixin_42640037的博客
06-03 238
（一）spring aop原理
Spring详解(五)
sj_1993的博客
04-01 546
AspectJ AspectJ是一个基于java预言的AOP框架，它提供了强大的AOP功能，Spring2.0以后SpringAOP引入了对AspectJ的支持 AspectJ实现AOP有两种方式： 基于xml的声明式AspectJ 配置切面 在Spring的配置文件中，配置切面使用的事<aop:aspect>元素，该元素会将一个定义好的Spri...
Spring使用AspectJ开发AOP
weixin_45743799的博客
03-11 479
AspectJ 是一个基于 Java 语言的 AOP 框架，它扩展了 Java 语言。Spring 2.0 以后，新增了对 AspectJ 方式的支持，新版本的 Spring 框架，建议使用 AspectJ 方式开发 AOP。 使用 AspectJ 开发 AOP 通常有两种方式： 基于 XML 的声明式。 基于 Annotation 的声明式。 基于XML的声明式 基于 XML 的声明式...
基于Java语言的SpringCloud框架学习与实践设计源码
10-02
该项目为基于Java语言的SpringCloud框架设计的学习与实践源码，总计包含82个文件，其中包含32个Java源文件、21个XML配置文件、11个YAML配置文件、8个Idea项目文件、8个编译后的.class文件以及2个Markdown文档。...
基于Java语言的SpringSecurity框架学习与实践设计源码
10-06
本项目为基于Java语言的SpringSecurity框架的学习与实践设计，包含109个文件，其中Java源文件92个，XML配置文件8个，Git忽略文件2个，其他文件类型包括IML、MD、MVNW、CMD、SQL、YML、HTML等。项目以学习Spring...
基于Java语言的SpringSecurity安全框架学习与设计源码实践
09-26
该项目为Java语言的SpringSecurity安全框架学习与实践项目，包含69个文件，包括49个Java源代码文件、9个XML配置文件、7个属性文件，旨在通过实际源码设计来深入理解SpringSecurity的安全机制。
基于Java的Spring Security框架源码学习与实践
10-03
本项目深入探讨了基于Java的Spring Security框架的源码，涉及88个文件，其中包含34个Java源文件、34个类文件、12个XML配置文件、以及少量Markdown、YAML和Git相关文件。该学习内容为个人学习笔记，不具备直接参考...
spring-security（记住密码，CSRF）
最新发布
2302_79087378的博客
11-10 359
PersistentTokenRepository实现类InMemoryTokenRepositoryImpl基于内存实现JdbcTokenRepositoryImpl基于数据库实现@Bean。
后端SpringBoot及vue proxyTable解决跨域
qq_42059717的博客
11-06 359
昨天上线项目遇到了一个奇怪的问题，本来服务实在腾讯云的轻量应用服务器的，但是迁移到一个香港的服务器之后就出现了各种各样的问题。Nginx 开启Https Springboot开启Https，先后出现了噔噔蹬蹬但是我其实已经部署了一个项目了的，那个用的proxyTable,新部署的这个用的是里边的env控制的。后来改成proxyTable就好了。
Spring中@Autowired@Resource和@Inject注解区别
2401_87333857的博客
11-06 433
同时，它默认是采用byType装配，当指定了1SR-330规范中的@Named注解之后，变成byName装配。它也可以出现在方法上，构造函数上和字段上但是需要注意的是:因为IRE无法决定构造方法注入的优先级，所以规范中规定类中只能有一个构造方法带@Inject注解。@Autowired:来源于spring框架自身默认是byType自动装配，当配合了@Qualifier注解之后，在没有指定name属性时是byType自动装配，当指定了name属性之后，采用byName方式自动装配。
SpringBoot助力的共享汽车业务优化系统
2402_85762143的博客
11-09 1030
在整个系统测试中，根据需求文档和设计文档，逐一对功能进行检测并写好测试用例，有效避免残片缺陷，因为产品出现缺陷不仅影响功能，而且可以导致数据的不准确，导致产品质量的降低，经过测试，才能使得产品的稳定性和成熟度得到极大的提升，产品质量也才有保证。近来，软件工程界趋向于一种新的观点，即认为软件生命周期每一阶段中都应包含测试，从而检验本阶段的成果是否接近预期的目标，尽可能早的发现错误并加以修正，如果不在早期阶段进行测试，错误的延时扩散常常会导致最后成品测试的巨大困难。任务：消除软件故障，保证程序的可靠运行。
基于 SpringBoot 实现QQ邮箱验证码注册功能
2301_79201049的博客
11-06 652
找到并开通以下的邮件协议服务，而且服务开启也较为简单，需要我们发送一个短信到指定的号码，开启后平台会提供一个授权码，一定要记住这个授权码，发邮件的时候需要这个。host 是根据服务主机区分，网易邮箱是 smtp.163.com, qq邮箱是 smtp.qq.com。其中的 username 是你第一步中操作的邮箱账号，nickname 是接收者收到邮件中显示的发件人。发送邮件的核心依赖是 mail ，由于该项目还涉及其他依赖就全都导进来了。（1）首先打开QQ邮箱，点击设置并来到账号页面。
为何选择Spring AI Alibaba开发智能客服平台？
JavaEdge全是干货的技术号
11-09 701
本文来看如何使用Spring AI Alibaba构建Agent应用。
七、Spring Boot集成Spring Security之前后分离认证最佳实现
JavaEE技术进阶之路
11-06 967
前后分离项目认证流程代码实现，基于spring security原生流程设计，实现RESTFUL接口、分布式缓存
Spring-Day8
2301_78630849的博客
11-09 529
一组关联的数据库操作；要么都成功，要么都失败，保证业务操作完整性的一种数据库机制。
Spring框架学习心得与实践经验分享
5. **面向未来的学习态度**：Spring框架也在不断地更新和迭代，保持学习的热情和对新技术的敏感度是开发者必备的素质。例如，我通过学习Spring Boot来快速构建应用，并且关注Spring Cloud的最新动态以适应微服务的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值