Spring系列(四)：Spring AOP详解和实现方式(xml配置和注解配置)

• Z时代
• 2024-01-10
• 分类：综合

本文内容纲要：

- 四、使用注解配置Spring AOP

参考文章：http://www.cnblogs.com/hongwz/p/5764917.html

一、什么是AOP

AOP（Aspect Oriented Programming），即面向切面编程，可以说是OOP（Object Oriented Programming，面向对象编程）的补充和完善。OOP引入封装、继承、多态等概念来建立一种对象层次结构，用于模拟公共行为的一个集合。不过OOP允许开发者定义纵向的关系，但并不适合定义横向的关系，例如日志功能。日志代码往往横向地散布在所有对象层次中，而与它对应的对象的核心功能毫无关系对于其他类型的代码，如安全性、异常处理和透明的持续性也都是如此，这种散布在各处的无关的代码被称为横切（cross cutting），在OOP设计中，它导致了大量代码的重复，而不利于各个模块的重用。

AOP技术恰恰相反，它利用一种称为"横切"的技术，剖解开封装的对象内部，并将那些影响了多个类的公共行为封装到一个可重用模块，并将其命名为"Aspect"，即切面。所谓"切面"，简单说就是那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块之间的耦合度，并有利于未来的可操作性和可维护性。

使用"横切"技术，AOP把软件系统分为两个部分：核心关注点和横切关注点。业务处理的主要流程是核心关注点，与之关系不大的部分是横切关注点。横切关注点的一个特点是，他们经常发生在核心关注点的多处，而各处基本相似，比如权限认证、日志、事物。AOP的作用在于分离系统中的各种关注点，将核心关注点和横切关注点分离开来。

二、AOP核心概念

1、横切关注点

对哪些方法进行拦截，拦截后怎么处理，这些关注点称之为横切关注点

2、切面（aspect）

类是对物体特征的抽象，切面就是对横切关注点的抽象

3、连接点（joinpoint）

被拦截到的点，因为Spring只支持方法类型的连接点，所以在Spring中连接点指的就是被拦截到的方法，实际上连接点还可以是字段或者构造器

4、切入点（pointcut）

对连接点进行拦截的定义

5、通知（advice）

所谓通知指的就是指拦截到连接点之后要执行的代码，通知分为前置、后置、异常、最终、环绕通知五类

6、目标对象

代理的目标对象

7、织入（weave）

将切面应用到目标对象并导致代理对象创建的过程

8、引入（introduction）

在不修改代码的前提下，引入可以在运行期为类动态地添加一些方法或字段

三、Spring对AOP的支持

Spring中AOP代理由Spring的IOC容器负责生成、管理，其依赖关系也由IOC容器负责管理。因此，AOP代理可以直接使用容器中的其它bean实例作为目标，这种关系可由IOC容器的依赖注入提供。Spring创建代理的规则为：

1、默认使用Java动态代理来创建AOP代理，这样就可以为任何接口实例创建代理了

2、当需要代理的类不是代理接口的时候，Spring会切换为使用CGLIB代理，也可强制使用CGLIB

AOP编程其实是很简单的事情，纵观AOP编程，程序员只需要参与三个部分：

1、定义普通业务组件

2、定义切入点，一个切入点可能横切多个业务组件

3、定义增强处理，增强处理就是在AOP框架为普通业务组件织入的处理动作

所以进行AOP编程的关键就是定义切入点和定义增强处理，一旦定义了合适的切入点和增强处理，AOP框架将自动生成AOP代理，即：代理对象的方法=增强处理+被代理对象的方法。

下面给出一个Spring AOP的.xml文件模板，名字叫做aop.xml，之后的内容都在aop.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:tx="http://www.springframework.org/schema/tx"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
</beans>

基于Spring的AOP简单实现

注意一下，在讲解之前，说明一点：使用Spring AOP，要成功运行起代码，只用Spring提供给开发者的jar包是不够的，请额外上网下载两个jar包：

1、aopalliance.jar

2、aspectjweaver.jar

开始讲解用Spring AOP的XML实现方式，先定义一个接口：

1 public interface HelloWorld
2 {
3     void printHelloWorld();
4     void doPrint();
5 }

定义两个接口实现类：

1 public class HelloWorldImpl1 implements HelloWorld
 2 {
 3     public void printHelloWorld()
 4     {
 5         System.out.println("Enter HelloWorldImpl1.printHelloWorld()");
 6     }
 7     
 8     public void doPrint()
 9     {
10         System.out.println("Enter HelloWorldImpl1.doPrint()");
11         return ;
12     }
13 }
1 public class HelloWorldImpl2 implements HelloWorld
 2 {
 3     public void printHelloWorld()
 4     {
 5         System.out.println("Enter HelloWorldImpl2.printHelloWorld()");
 6     }
 7     
 8     public void doPrint()
 9     {
10         System.out.println("Enter HelloWorldImpl2.doPrint()");
11         return ;
12     }
13 }

横切关注点，这里是打印时间：

1 public class TimeHandler
2 {
3     public void printTime()
4     {
5         System.out.println("CurrentTime = " + System.currentTimeMillis());
6     }
7 }

有这三个类就可以实现一个简单的Spring AOP了，看一下aop.xml的配置：

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4     xmlns:aop="http://www.springframework.org/schema/aop"
 5     xmlns:tx="http://www.springframework.org/schema/tx"
 6     xsi:schemaLocation="http://www.springframework.org/schema/beans
 7         http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
 8         http://www.springframework.org/schema/aop
 9         http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
10         
11         <bean id="helloWorldImpl1" class="com.xrq.aop.HelloWorldImpl1" />
12         <bean id="helloWorldImpl2" class="com.xrq.aop.HelloWorldImpl2" />
13         <bean id="timeHandler" class="com.xrq.aop.TimeHandler" />
14         
15         <aop:config>
16             <aop:aspect id="time" ref="timeHandler">
17                 <aop:pointcut id="addAllMethod" expression="execution(* com.xrq.aop.HelloWorld.*(..))" />
18                 <aop:before method="printTime" pointcut-ref="addAllMethod" />
19                 <aop:after method="printTime" pointcut-ref="addAllMethod" />
20             </aop:aspect>
21         </aop:config>
22 </beans>

写一个main函数调用一下：

1 public static void main(String[] args)
 2 {
 3     ApplicationContext ctx = 
 4             new ClassPathXmlApplicationContext("aop.xml");
 5         
 6     HelloWorld hw1 = (HelloWorld)ctx.getBean("helloWorldImpl1");
 7     HelloWorld hw2 = (HelloWorld)ctx.getBean("helloWorldImpl2");
 8     hw1.printHelloWorld();
 9     System.out.println();
10     hw1.doPrint();
11     
12     System.out.println();
13     hw2.printHelloWorld();
14     System.out.println();
15     hw2.doPrint();
16 }

运行结果为：

1 CurrentTime = 1446129611993
 2 Enter HelloWorldImpl1.printHelloWorld()
 3 CurrentTime = 1446129611993
 4 
 5 CurrentTime = 1446129611994
 6 Enter HelloWorldImpl1.doPrint()
 7 CurrentTime = 1446129611994
 8 
 9 CurrentTime = 1446129611994
10 Enter HelloWorldImpl2.printHelloWorld()
11 CurrentTime = 1446129611994
12 
13 CurrentTime = 1446129611994
14 Enter HelloWorldImpl2.doPrint()
15 CurrentTime = 1446129611994

看到给HelloWorld接口的两个实现类的所有方法都加上了代理，代理内容就是打印时间

基于Spring的AOP使用其他细节

1、增加一个横切关注点，打印日志，Java类为：

1 public class LogHandler
 2 {
 3     public void LogBefore()
 4     {
 5         System.out.println("Log before method");
 6     }
 7     
 8     public void LogAfter()
 9     {
10         System.out.println("Log after method");
11     }
12 }
1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4     xmlns:aop="http://www.springframework.org/schema/aop"
 5     xmlns:tx="http://www.springframework.org/schema/tx"
 6     xsi:schemaLocation="http://www.springframework.org/schema/beans
 7         http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
 8         http://www.springframework.org/schema/aop
 9         http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
10         
11         <bean id="helloWorldImpl1" class="com.xrq.aop.HelloWorldImpl1" />
12         <bean id="helloWorldImpl2" class="com.xrq.aop.HelloWorldImpl2" />
13         <bean id="timeHandler" class="com.xrq.aop.TimeHandler" />
14         <bean id="logHandler" class="com.xrq.aop.LogHandler" />
15         
16         <aop:config>
17             <aop:aspect id="time" ref="timeHandler" order="1">
18                 <aop:pointcut id="addTime" expression="execution(* com.xrq.aop.HelloWorld.*(..))" />
19                 <aop:before method="printTime" pointcut-ref="addTime" />
20                 <aop:after method="printTime" pointcut-ref="addTime" />
21             </aop:aspect>
22             <aop:aspect id="log" ref="logHandler" order="2">
23                 <aop:pointcut id="printLog" expression="execution(* com.xrq.aop.HelloWorld.*(..))" />
24                 <aop:before method="LogBefore" pointcut-ref="printLog" />
25                 <aop:after method="LogAfter" pointcut-ref="printLog" />
26             </aop:aspect>
27         </aop:config>
28 </beans>

测试类不变，打印结果为：

1 CurrentTime = 1446130273734
 2 Log before method
 3 Enter HelloWorldImpl1.printHelloWorld()
 4 Log after method
 5 CurrentTime = 1446130273735
 6 
 7 CurrentTime = 1446130273736
 8 Log before method
 9 Enter HelloWorldImpl1.doPrint()
10 Log after method
11 CurrentTime = 1446130273736
12 
13 CurrentTime = 1446130273736
14 Log before method
15 Enter HelloWorldImpl2.printHelloWorld()
16 Log after method
17 CurrentTime = 1446130273736
18 
19 CurrentTime = 1446130273737
20 Log before method
21 Enter HelloWorldImpl2.doPrint()
22 Log after method
23 CurrentTime = 1446130273737

要想让logHandler在timeHandler前使用有两个办法：

（1）aspect里面有一个order属性，order属性的数字就是横切关注点的顺序

（2）把logHandler定义在timeHandler前面，Spring默认以aspect的定义顺序作为织入顺序

2、我只想织入接口中的某些方法

修改一下pointcut的expression就好了：

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4     xmlns:aop="http://www.springframework.org/schema/aop"
 5     xmlns:tx="http://www.springframework.org/schema/tx"
 6     xsi:schemaLocation="http://www.springframework.org/schema/beans
 7         http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
 8         http://www.springframework.org/schema/aop
 9         http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
10         
11         <bean id="helloWorldImpl1" class="com.xrq.aop.HelloWorldImpl1" />
12         <bean id="helloWorldImpl2" class="com.xrq.aop.HelloWorldImpl2" />
13         <bean id="timeHandler" class="com.xrq.aop.TimeHandler" />
14         <bean id="logHandler" class="com.xrq.aop.LogHandler" />
15         
16         <aop:config>
17             <aop:aspect id="time" ref="timeHandler" order="1">
18                 <aop:pointcut id="addTime" expression="execution(* com.xrq.aop.HelloWorld.print*(..))" />
19                 <aop:before method="printTime" pointcut-ref="addTime" />
20                 <aop:after method="printTime" pointcut-ref="addTime" />
21             </aop:aspect>
22             <aop:aspect id="log" ref="logHandler" order="2">
23                 <aop:pointcut id="printLog" expression="execution(* com.xrq.aop.HelloWorld.do*(..))" />
24                 <aop:before method="LogBefore" pointcut-ref="printLog" />
25                 <aop:after method="LogAfter" pointcut-ref="printLog" />
26             </aop:aspect>
27         </aop:config>
28 </beans>

表示timeHandler只会织入HelloWorld接口print开头的方法，logHandler只会织入HelloWorld接口do开头的方法

3、强制使用CGLIB生成代理

前面说过Spring使用动态代理或是CGLIB生成代理是有规则的，高版本的Spring会自动选择是使用动态代理还是CGLIB生成代理内容，当然我们也可以强制使用CGLIB生成代理，那就是aop:config里面有一个"proxy-target-class"属性，这个属性值如果被设置为true，那么基于类的代理将起作用，如果proxy-target-class被设置为false或者这个属性被省略，那么基于接口的代理将起作用

四、使用注解配置Spring AOP

继续使用上面的案例的代码

1. 定义接口：

1 package com.study.spring.springtest;
2 
3 public interface HelloWorld
4 {
5     void printHelloWorld();
6     void doPrint();
7 }

2.定义两个接口的实现类(被代理的目标类)，这里使用Spring的注解生成bean，不用再在aop.xml文件里面配置bean了

1 package com.study.spring.springtest;
 2 
 3 import org.springframework.stereotype.Service;
 4 
 5 /**
 6  * 被代理的目标类
 7  * @author THINKPAD
 8  *
 9  */
10 @Service
11 public class HelloWorldImpl1 implements HelloWorld
12 {
13     public void printHelloWorld()
14     {
15         System.out.println("Enter HelloWorldImpl1.printHelloWorld()");
16     }
17     
18     public void doPrint()
19     {
20         System.out.println("Enter HelloWorldImpl1.doPrint()");
21         return ;
22     }
23 }
1 package com.study.spring.springtest;
 2 
 3 import org.springframework.stereotype.Service;
 4 
 5 /**
 6  * 被代理的目标类
 7  * @author THINKPAD
 8  *
 9  */
10 @Service
11 public class HelloWorldImpl2 implements HelloWorld {
12     public void printHelloWorld() {
13         System.out.println("Enter HelloWorldImpl2.printHelloWorld()");
14     }
15 
16     public void doPrint() {
17         System.out.println("Enter HelloWorldImpl2.doPrint()");
18         return;
19     }
20 }

3.定义横切关注点，@Component表示该类的实例会被Spring IOC容器管理；@Aspect表示声明一个切面；@Before表示printTime为前置通知，通过参数execution声明一个切点，@After表示printTime2为后置通知，通过参数execution声明一个切点

1 package com.study.spring.springtest;
 2 
 3 import org.aspectj.lang.annotation.After;
 4 import org.aspectj.lang.annotation.Aspect;
 5 import org.aspectj.lang.annotation.Before;
 6 import org.springframework.stereotype.Component;
 7 /**
 8  * 横切关注点
 9  * @author THINKPAD
10  *
11  */
12 @Component
13 @Aspect
14 public class TimeHandler
15 {
16     @Before("execution(* com.study.spring.springtest.HelloWorld.*(..))")
17     public void printTime()
18     {
19         System.out.println("前置当前时间 = " + System.currentTimeMillis());
20     }
21     @After("execution(* com.study.spring.springtest.HelloWorld.*(..))")
22     public void printTime2()
23     {
24         System.out.println("后置当前时间  = " + System.currentTimeMillis());
25     }
26 }

4.aop.xml的文件现在就变得很简洁了，内容如下

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 4     xmlns:p="http://www.springframework.org/schema/p"
 5     xmlns:aop="http://www.springframework.org/schema/aop"
 6     xmlns:context="http://www.springframework.org/schema/context"
 7     xsi:schemaLocation="http://www.springframework.org/schema/beans
 8         http://www.springframework.org/schema/beans/spring-beans.xsd
 9         http://www.springframework.org/schema/context
10         http://www.springframework.org/schema/context/spring-context-4.3.xsd
11         http://www.springframework.org/schema/aop
12         http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">
13         <!--开启Spring注解扫描器  -->
14         <context:component-scan base-package="com.study.spring.springtest" />
15         <!-- 在配置IOC的基础上增加了aop:aspectj-autoproxy节点，Spring框架会自动为与AspectJ切面配置的Bean创建代理，
16         proxy-target-class="true"属性表示被代理的目标对象是一个类，
17                 而非实现了接口的类，反之proxy-target-class="false" 主要是为了选择不同的代理方式。-->
18         <aop:aspectj-autoproxy proxy-target-class="false"></aop:aspectj-autoproxy>
19 </beans>

5.写一个测试类

1 package com.study.spring.springtest;
 2 
 3 import javax.annotation.Resource;
 4 
 5 import org.springframework.beans.factory.annotation.Autowired;
 6 import org.springframework.context.ApplicationContext;
 7 import org.springframework.context.support.ClassPathXmlApplicationContext;
 8 
 9 public class TestAOP {
10     public static void main(String[] args) {
11         ApplicationContext ctx = new ClassPathXmlApplicationContext("aop.xml");
12 
13         HelloWorld hw1 = (HelloWorld) ctx.getBean("helloWorldImpl1");
14         HelloWorld hw2 = (HelloWorld) ctx.getBean("helloWorldImpl2");
15         hw1.printHelloWorld();
16         System.out.println();
17         hw1.doPrint();
18 
19         System.out.println();
20         hw2.printHelloWorld();
21         System.out.println();
22         hw2.doPrint();
23     }
24 }

输出结果：

前置当前时间 = 1507959657130
Enter HelloWorldImpl1.printHelloWorld()
后置当前时间  = 1507959657130
前置当前时间 = 1507959657130
Enter HelloWorldImpl1.doPrint()
后置当前时间  = 1507959657130
前置当前时间 = 1507959657130
Enter HelloWorldImpl2.printHelloWorld()
后置当前时间  = 1507959657130
前置当前时间 = 1507959657130
Enter HelloWorldImpl2.doPrint()
后置当前时间  = 1507959657131

本文内容总结：四、使用注解配置Spring AOP，

原文链接：https://www.cnblogs.com/leeSmall/p/7667040.html

以上是 Spring系列(四)：Spring AOP详解和实现方式(xml配置和注解配置) 的全部内容， 来源链接： utcz.com/z/296941.html