1.5 初探Spring AOP
一、提出游吟诗人唱赞歌任务
骑士执行任务前和执行任务后，游吟诗人唱赞歌
1、采用传统方式实现
修改day04子包的勇敢骑士类
修改day04子包里的救美骑士类
执行测试类 - TestKnight
二、采用配置方式使用AOP
1、创建本讲所需子包
在net.hf.spring包里创建day05.aop_xml子包
2、创建杀龙任务类
在aop_xml子包里创建杀龙任务类 - SlayDragonQuest
package net.hf.spring.day05.aop_xml;
import org.springframework.stereotype.Component;
/**
* 功能：杀龙任务类
* 作者：hf
* 日期：2023年02月22日
*/
@Component
public class SlayDragonQuest {
public void embark() {
System.out.println("执行杀龙任务……");
}
}
3、创建勇敢骑士类
在aop_xml子包里创建勇敢骑士类 - BraveKnight
package net.hf.spring.day05.aop_xml;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 功能：勇敢骑士类
* 作者：hf
* 日期：2023年02月22日
*/
@Component("RobinHood")
public class BraveKnight {
@Value("罗宾汉")
private String name;
@Autowired
private SlayDragonQuest slayDragonQuest;
public void embarkOnQuest() {
System.out.print("勇敢骑士[" + name + "]");
slayDragonQuest.embark();
}
}
4、创建游吟诗人类
在aop_xml子包里创建游吟诗人类 - Minstrel
package net.hf.spring.day05.aop_xml;
import org.springframework.stereotype.Component;
/**
* 功能：游吟诗人类
* 作者：hf
* 日期：2023年02月22日
*/
@Component
public class Minstrel {
/**
* 骑士出发前唱赞歌
*/
public void singBeforeQuest() {
System.out.println("啦啦啦，骑士出发了~");
}
/**
* 骑士凯旋时唱赞歌
*/
public void singAfterQuest() {
System.out.println("真棒啊！骑士完成了任务~");
}
}
5、创建Spring配置文件
在resources里创建aop_xml目录，在里面创建spring-config.xml配置文件
<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.hf.spring.day05.aop_xml"/>
<aop:config>
<aop:aspect ref="minstrel">
<aop:pointcut id="embark" expression="execution(* net.hf.spring.day05..*.embarkOnQuest(..))"/>
<aop:before method="singBeforeQuest" pointcut-ref="embark"/>
<aop:after method="singAfterQuest" pointcut-ref="embark"/>
aop:aspect>
aop:config>
beans>
6、添加AOP相关依赖
在pom.xml文件里添加AOP相关依赖
<!--Spring AOP-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>5.3.25</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.19</version>
<scope>runtime</scope>
</dependency>
注意：添加新的依赖之后，记得更新
7、创建测试类 - TestKnight
在test/java里创建net.hf.spring.day05.aop_xml包，在包里创建TestKnight类
package net.hf.spring.day05.aop_xml;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* 功能：测试骑士类
* 作者：hf
* 日期：2023年02月22日
*/
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("RobinHood");
// 勇敢骑士执行任务
braveKnight.embarkOnQuest();
}
@After
public void destroy() {
// 关闭应用容器
context.close();
}
}
运行testBraveKinght()方法，查看结果
三、采用注解方式使用AOP
1、创建子包
在net.hf.spring包里创建day05.aop_annotation子包
2、创建杀龙任务类
在aop_annotation子包里创建杀龙任务类 - SlayDragonQuest
package net.hf.spring.day05.aop_annotation;
import org.springframework.stereotype.Component;
/**
* 功能：杀龙任务类
* 作者：hf
* 日期：2023年02月28日
*/
@Component
public class SlayDragonQuest {
public void embark() {
System.out.println("执行杀龙任务……");
}
}
3、创建勇敢骑士类
在aop_annotation子包里创建勇敢骑士类 - BraveKnight
package net.hf.spring.day05.aop_annotation;
import net.hf.spring.day05.aop_xml.SlayDragonQuest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 功能：勇敢骑士类
* 作者：hf
* 日期：2023年02月28日
*/
@Component("RobinHood")
public class BraveKnight {
@Value("罗宾汉")
private String name;
@Autowired
private SlayDragonQuest slayDragonQuest;
/**
* 勇敢骑士执行杀龙任务
*/
@Action(name = "动作拦截器")
public void embarkOnQuest() {
System.out.print("勇敢的[" + name + "]");
slayDragonQuest.embark();
}
}
4、创建游吟诗人切面
在aop_annotation子包里创建游吟诗人切面 - MinstrelAspect
package net.hf.spring.day05.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;
/**
* 功能：游吟诗人切面类
* 作者：hf
* 日期：2023年02月28日
*/
@Aspect // 声明为切面类
@Component("minstrel") // 声明为Spring组件
public class MinstrelAspect {
// 注解声明切入点
@Pointcut("execution(* net.h分、
.spring.day05..*.embarkOnQuest(..))")
public void embark() {
}
// 注解声明前置通知
@Before("embark()")
public void singBeforeQuest(JoinPoint joinPoint) {
System.out.println("啦啦啦，骑士出发了~");
}
// 注解声明后置通知
@After("embark()")
public void singAfterQuest(JoinPoint joinPoint) {
System.out.println("真棒啊！骑士完成了任务~");
}
}
切面类与切面配置文件的对应关系
5、创建Spring配置类
在aop_annotation子包里创建Spring配置类 - SpringConfig
package net.hf.spring.day05.aop_annotation;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
/**
* 功能：Spring配置类
* 作者：hf
* 日期：2023年02月28日
*/
@Configuration // 声明为Spring配置类
@ComponentScan("net.hf.spring.day05.aop_annotation") // 组件扫描
@EnableAspectJAutoProxy // 启用Spring对AspectJ的支持
public class SpringConfig {
}
6、创建骑士测试类
在test/java/的aop_annotation子包里创建测试类 - TestKnight
package net.hf.spring.day05.aop_annotation;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/**
* 功能：测试骑士类
* 作者：hf
* 日期：2023年02月28日
*/
public class TestKnight {
private AnnotationConfigApplicationContext context; // 基于注解配置类的应用容器
@Before
public void init() {
// 基于注解配置类创建应用容器
context = new AnnotationConfigApplicationContext(SpringConfig.class);
}
@Test
public void testBraveKnight() {
// 根据名称从应用容器里获取勇敢骑士对象
BraveKnight knight = (BraveKnight) context.getBean("RobinHood");
// 勇敢骑士执行任务
knight.embarkOnQuest();
}
@After
public void destroy() {
// 关闭应用容器
context.close();
}
}
7、测试勇敢骑士，查看效果
运行测试方法 - testBraveKnight()
四、实现注解式拦截
1、创建注解接口
在aop_annotation子包里创建注解接口 - Action
package net.hf.spring.day05.aop_annotation;
import java.lang.annotation.*;
/**
* 功能：动作注解接口
* 作者：hf
* 日期：2023年02月28日
*/
@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的一部分。
2、修改勇敢骑士类
勇敢骑士类
package net.hf.spring.day05.aop_annotation;
import net.hf.spring.day05.aop_xml.SlayDragonQuest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 功能：勇敢骑士类
* 作者：hf
* 日期：2023年02月28日
*/
@Component("RobinHood")
public class BraveKnight {
@Value("罗宾汉")
private String name;
@Autowired
private SlayDragonQuest slayDragonQuest;
/**
* 勇敢骑士执行杀龙任务
*/
@Action(name = "动作拦截器")
public void embarkOnQuest() {
System.out.print("勇敢的[" + name + "]");
slayDragonQuest.embark();
}
}
3、修改游吟诗人切面
游吟诗人切面类
package net.hf.spring.day05.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;
/**
* 功能：游吟诗人切面类
* 作者：hf
* 日期：2023年02月28日
*/
@Aspect // 声明为切面类
@Component("minstrel") // 声明为Spring组件
public class MinstrelAspect {
// 注解声明切入点
@Pointcut("@annotation(net.hf.spring.day05.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("真棒啊！骑士完成了任务~");
}
}
4、测试勇敢骑士
运行测试方法testBraveKnight()，查看效果
5、修改救美骑士类
救美骑士类 - RescueDamselKnight
package net.hf.spring.day05.aop_annotation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 功能：救美骑士类
* 作者：hf
* 日期：2023年02月28日
*/
@Component
public class RescueDamselKnight {
@Value("格拉海德")
private String name;
@Autowired
private RescueDanselQuest rescueDamselQuest;
@Action(name = "狂飙拦截器")
public void embarkOnQuest() {
System.out.print("救美骑士[" + name + "]");
rescueDamselQuest.embark();
}
}
6、测试救美骑士
运行测试方法testRescueDamselKnight()，查看效果
