文章目录*
文章目录
Spring框架学习笔记05：Spring AOP基础
一、Spring AOP
（一）AOP基本含义
AOP（Aspect-OrientedProgramming，面向切面编程），可以说是OOP（Object-Oriented Programing，面向对象编程）的补充和完善。OOP引入封装、继承和多态性等概念来建立一种对象层次结构，用以模拟公共行为的一个集合。当我们需要为分散的对象引入公共行为的时候，OOP则显得无能为力。也就是说，OOP允许你定义从上到下的关系，但并不适合定义从左到右的关系。例如日志功能。日志代码往往水平地散布在所有对象层次中，而与它所散布到的对象的核心功能毫无关系。对于其他类型的代码，如安全性、异常处理和透明的持续性也是如此。这种散布在各处的无关的代码被称为横切（cross-cutting）代码，在OOP设计中，它导致了大量代码的重复，而不利于各个模块的重用。而AOP技术则恰恰相反，它利用一种称为“横切”的技术，剖解开封装的对象内部，并将那些影响了多个类的公共行为封装到一个可重用模块，并将其名为“Aspect”，即方面。所谓“方面”，简单地说，就是将那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块间的耦合度，并有利于未来的可操作性和可维护性。AOP代表的是一个横向的关系，如果说“对象”是一个空心的圆柱体，其中封装的是对象的属性和行为；那么面向方面编程的方法，就仿佛一把利刃，将这些空心圆柱体剖开，以获得其内部的消息。而剖开的切面，也就是所谓的“方面”了。然后它又以巧夺天功的妙手将这些剖开的切面复原，不留痕迹。
（二）AOP基本作用
-
软件开发原则：高内聚，低耦合
-
Spring的AOP作用在于解耦。AOP让一组类共享相同的行为（比如事务管理、日志管理、安全管理）。
-
OOP（Object-Oriented Programming）只能通过继承类或实现接口来增加代码的耦合度，而且类继承是单根继承（不允许一子多父），阻碍了将更多的行为添加到一组类上，此时AOP可以弥补OOP的不足。
任务：骑士执行任务前和执行任务后，游吟诗人唱赞歌
（一）采用传统方式实现
- 修改勇敢骑士类
- 修改救美骑士类
- 执行测试类 - TestKnight
（二）采用传统方式实现的缺点
- 每个骑士类的embarkOnQuest()方法都要修改，耦合度太高，当骑士类数量很大时，这个任务完成起来就十分枯燥繁琐。
下面我们采用AOP方式来实现同样的功能，通过对比可以更好地体会采用AOP方式的优越性。
二、采用配置方式使用AOP
（一）创建包
- 在net.wh.spring包里创建lesson05.aop_xml子包
（二）创建杀龙任务类
- 在aop_xml子包里创建杀龙任务类 - SlayDragonQuest
（三）创建勇敢骑士类
- 在aop_xml子包里创建勇敢骑士类 - BraveKnight
（四）创建游吟诗人类
- 在aop_xml子包里创建游吟诗人类 - Minstrel
（五）创建Spring配置文件
- 在resources里创建aop_xml目录，在里面创建spring-config.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: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
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/aop
https://www.springframework.org/schema/aop/spring-aop.xsd">
<!--组件扫描-->
<context:component-scan base-package="net.wh.spring.lesson05.aop_xml"/>
<!--AOP配置-->
<aop:config>
<!--定义切面-->
<aop:aspect ref="minstrel">
<!--定义切点-->
<aop:pointcut id="embark" expression="execution(* net.wh.spring.lesson05..*.embarkOnQuest(..))"/>
<!--声明前置通知-->
<aop:before method="singBeforeQuest" pointcut-ref="embark"/>
<!--声明后置通知-->
<aop:after method="singAfterQuest" pointcut-ref="embark"/>
</aop:aspect>
</aop:config>
</beans>
1、切点
- 在使用Spring框架配置AOP时，不管是通过XML配置文件还是注解方式，都需要定义pointcut（切点）。
2、切点表达式
-
拦截类里的指定方法："execution(* net.hw.spring.lesson05..*.embarkOnQuest(..))" -
拦截类里的所有方法："execution(* net.hw.spring.lesson05..*.*(..))"
3、切点函数
execution()是最常用的切点函数，整个表达式可以分为五个部分。
- execution()：表达式主体。
- 第一个**号：表示返回类型，’'号表示所有的类型。
- 包名：表示需要拦截的包名，后面的两个句点表示当前包和当前包的所有子包，net.hw.spring.lesson05包、子孙包下所有类的方法。
- 第二个**号：表示类名，""号表示所有的类。
- **(…)：最后这个星号表示方法名，’'号表示所有的方法，后面括弧里面表示方法的参数，两个句点表示任何参数。
（六）在pom文件里添加AOP相关依赖
<!--Spring AOP-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${spring.version}</version>
</dependency>
<!--AspectJ支持-->
<dependency>
<groupId>aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.5.4</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.6</version>
<scope>runtime</scope>
</dependency>
（七）创建测试类 - TestKnight
在test/java里创建net.wh.spring.lesson05.aop_xml包，在包里创建TestKnight
package net.wh.spring.lesson05.aop_xml;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class TestKnight {
private ClassPathXmlApplicationContext context; // 基于类路径XML配置文件的应用容器
@Before
public void init() {
// 基于Spring配置文件创建应用容器
context = new ClassPathXmlApplicationContext("aop_xml/spring-config.xml");
}
@Test
public void testBraveKnight() {
// 根据名称从应用容器中获取勇敢骑士对象
BraveKnight braveKnight = (BraveKnight) context.getBean("Mike");
// 勇敢骑士执行任务
braveKnight.embarkOnQuest();
}
@After
public void destroy() {
// 关闭应用容器
context.close();
}
}
运行测试方法，查看测试结果
（九）课堂练习
1、增加救美任务类与救美骑士类
-
编写RescueDamselQuest类的方法
package net.wh.spring.lesson05.aop_xml; import org.springframework.stereotype.Component; @Component public class RescueDamselQuest { public void embark() { System.out.println("执行救美任务。"); } } -
编写DamselRescuingKnight类的方法
package net.wh.spring.lesson05.aop_xml;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class DamselRescuingKnight {
@Autowired
private RescueDamselQuest rescueDamselQuest;
public void embarkOnQuest() {
rescueDamselQuest.embark();
}
}
2、在测试类里增加测试方法 - testDamselRescuingKnight()
-
运行测试方法testDamselRescuingKnight()
三、采用注解方式使用AOP
(一) 在net.wh.spring包里创建lesson05.aop_annotation子包
（二）创建杀龙任务类
- 在aop_annotation子包里创建杀龙任务类 - SlayDragonQuest
（三）创建勇敢骑士类
- 在aop_annotation子包里创建勇敢骑士类 - BraveKnight
（四）创建游吟诗人切面
- 在aop_annotation子包里创建游吟诗人切面 - MinstrelAspect
package net.wh.spring.lesson05.aop_annotation;
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.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
@Aspect // 声明为切面
@Component // 交给Spring容器管理
public class MinstrelAspect {
// 注解声明切点
@Pointcut("execution(* net.wh.spring.lesson05..*.embarkOnQuest(..))")
public void embark() {
}
// 注解声明前置通知
@Before("embark()")
public void singBeforeQuest(JoinPoint joinPoint) {
System.out.println("啦啦啦，骑士出发了！");
}
// 注解声明后置通知
@After("embark()")
public void singAfterQuest(JoinPoint joinPoint) {
System.out.println("真棒啊！骑士完成了任务！");
}
}
（五）创建Spring配置类
- 在aop_annotation子包里创建Spring配置类 - AopConfig
package net.wh.spring.lesson05.aop_annotation;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
@Configuration // 标明Spring配置类
@ComponentScan("net.wh.spring.lesson05.aop_annotation") // 组件扫描
@EnableAspectJAutoProxy // 开启Spring对AspectJ的支持
public class AopConfig {
}
（六）创建骑士测试类
- 在test/java/aop_annotation子包里创建测试类 - TestKnight
package net.wh.spring.lesson05.aop_annotation;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class TestKnight {
private AnnotationConfigApplicationContext context; // 基于注解配置类的应用容器
@Before
public void init() {
// 基于注解配置类创建应用容器
context = new AnnotationConfigApplicationContext(AopConfig.class);
}
@Test
public void testBraveKnight() {
// 根据名称从应用容器里获取勇敢骑士对象
BraveKnight knight = (BraveKnight) context.getBean("Mike");
// 勇敢骑士执行任务
knight.embarkOnQuest();
}
@After
public void destroy() {
// 关闭应用容器
context.close();
}
}
- 运行测试，查看测试结果
（七）课堂练习
1、增加救美任务类与救美骑士类
- 救美任务类
package net.wh.spring.lesson05.aop_annotation;
import org.springframework.stereotype.Component;
@Component
public class RescueDamselQuest {
public void embark() {
System.out.println("执行救美任务。");
}
}
- 救美骑士类
package net.wh.spring.lesson05.aop_annotation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class DamselRescuingKnight {
@Autowired
private RescueDamselQuest rescueDamselQuest;
public void embarkOnQuest() {
rescueDamselQuest.embark();
}
}
2、在测试类里增救美骑士测试方法 - testDamselRescuingKnight()
3、运行testDamselRescuingKnight()方法，查看结果
四、实现注解式拦截
（一）拦截的含义
在某个方法被访问之前进行拦截，然后在方法执行之前或之后加入某些操作，其实就是AOP的一种实现策略。Spring提供拦截器（Interceptor），它通过动态拦截Action调用的对象，允许开发者定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。本案例，我们不用拦截器，学习注解式拦截。
（二）创建注解接口
在aop_annotation子包里创建注解接口 - Action
package net.wh.spring.lesson05.aop_annotation;
import java.lang.annotation.*;
@Target(ElementType.METHOD) // 拦截目标 - 方法
@Retention(RetentionPolicy.RUNTIME) // 保留策略 - 运行时
@Documented // 注解文档化
public @interface Action {
String name();
}
1、@Target({ElementType.TYPE}) 注解
ElementType 这个枚举类型的常量提供了一个简单的分类：注解可能出现在Java程序中的语法位置（这些常量与元注解类型(@Target)一起指定在何处写入注解的合法位置）
2、 @Retention({RetentionPolicy.Runtime}) 注解
RetentionPolicy这个枚举类型的常量描述保留注解的各种策略，它们与元注解(@Retention)一起指定注释要保留多长时间
3、@Documented注解
Documented注解表明这个注解是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注解了文档化，它的注解成为公共API的一部分。
（三）修改勇敢骑士类
- 给embarkOnQuest()添加自定义注解Action，并设置其name属性
（四）修改游吟诗人切面
package net.wh.spring.lesson05.aop_annotation;
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.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
@Aspect // 声明为切面
@Component // 交给Spring容器管理
public class MinstrelAspect {
// 注解声明切点
// 注解声明切点
@Pointcut("@annotation(net.wh.spring.lesson05.aop_annotation.Action)")
public void embark() {
}
// 注解声明前置通知
@Before("embark()")
public void singBeforeQuest(JoinPoint joinPoint) {
// 获取方法签名
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 获取被拦截的方法
Method method = signature.getMethod();
// 获取注解式拦截
Action action = method.getAnnotation(Action.class);
// 提示用户被拦截了
System.out.println("[" + action.name() + "]拦截了[" + method.getName() + "]：拦截前！");
System.out.println("啦啦啦，骑士出发了！");
}
// 注解声明后置通知
@After("embark()")
public void singAfterQuest(JoinPoint joinPoint) {
// 获取方法签名
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 获取被拦截的方法
Method method = signature.getMethod();
// 获取注解式拦截
Action action = method.getAnnotation(Action.class);
// 提示用户被拦截了
System.out.println("[" + action.name() + "]拦截了[" + method.getName() + "]：拦截前！");
System.out.println("真棒啊！骑士完成了任务！");
}
}
（五）运行测试方法testBraveKnight()，查看效果
（六）修改救美骑士类，给embarkOnQuest()添加自定义注解Action
（七）运行测试方法testDamselRescuingKnight()，查看效果
（八）课堂练习
任务：输出骑士完成任务的耗时
-
创建耗时切面类 - ElapseAspect
-
package net.wh.spring.lesson05.aop_annotation; 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.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.stereotype.Component; import java.lang.reflect.Method; import java.util.Date; @Aspect // 声明为切面 @Component // 交给Spring容器管理 public class ElapseAspect { public int SartTime; public int EndTime; // 注解声明切点 @Pointcut("@annotation(net.wh.spring.lesson05.aop_annotation.Action)") public void embark() { } @Before("embark()") public void singBeforeQuest() { SartTime = (int) new Date().getTime(); } @After("embark()") public void singAfterQuest() { EndTime = (int) new Date().getTime(); int a = EndTime-SartTime; System.out.println("任务耗时："+a+"毫秒"); } } -
运行测试方法testBraveKnight()，查看效果
- 运行测试方法testDamselRescuingKnight()，查看效果
- 只让耗时切面起作用，查看运行结果
public void embark() {
}
@Before(“embark()”)
public void singBeforeQuest() {
SartTime = (int) new Date().getTime();
}
@After("embark()")
public void singAfterQuest() {
EndTime = (int) new Date().getTime();
int a = EndTime-SartTime;
System.out.println("任务耗时："+a+"毫秒");
}
}
- 运行测试方法testBraveKnight()，查看效果
[外链图片转存中...(img-CQ9d8twn-1625547111632)]
- 运行测试方法testDamselRescuingKnight()，查看效果
[外链图片转存中...(img-8raUEyTw-1625547111633)]
- 只让耗时切面起作用，查看运行结果
315
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
