前面通过创建动态代理,将公共的代码抽取出来,既实现了事务控制,又保证了代码的简明性。下面叙述利用Spring的AOP来实现这个过程。
AOP
在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。
简单的说它就是把我们程序重复的代码抽取出来,在需要执行的时候,使用动态代理的技术,在不修改源码的基础上,对我们的已有方法进行增强。
AOP相关术语
- Joinpoint(连接点): 所谓连接点是指那些被拦截到的点。在spring中,这些点指的是方法,因为spring只支持方法类型的连接点。
- Pointcut(切入点): 所谓切入点是指我们要对哪些Joinpoint进行拦截的定义。
- Advice(通知/增强): 所谓通知是指拦截到Joinpoint之后所要做的事情就是通知。 通知的类型:前置通知,后置通知,异常通知,最终通知,环绕通知。
- Introduction(引介): 引介是一种特殊的通知在不修改类代码的前提下, Introduction可以在运行期为类动态地添加一些方法或Field。
- Target(目标对象): 代理的目标对象。
- Weaving(织入): 是指把增强应用到目标对象来创建新的代理对象的过程。 spring采用动态代理织入,而AspectJ采用编译期织入和类装载期织入。
- Proxy(代理): 一个类被AOP织入增强后,就产生一个结果代理类。
- Aspect(切面): 是切入点和通知(引介)的结合。
AOP示例
pom文件导入坐标如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.ethan</groupId>
<artifactId>day03_eesy_03springAOP</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.7</version>
</dependency>
</dependencies>
</project>
AspectJ是一个面向切面的框架,它扩展了Java语言。AspectJ定义了AOP语法,它有一个专门的编译器用来生成遵守Java字节编码规范的Class文件。
有一个业务层接口:
package com.ethan.service;
/**
* @author Ethan
* @date 2020/1/26 - 9:17
* 账户的业务层接口
*/
public interface AccountService {
void saveAccount();
void updateAccount(int i);
int deleteAccount();
}
该接口实现类如下:
package com.ethan.service.impl;
import com.ethan.service.AccountService;
/**
* @author Ethan
* @date 2020/1/26 - 9:19
* 账户的业务层实现类
*/
public class AccountServiceImpl implements AccountService {
public void saveAccount() {
System.out.println("执行了保存");
}
public void updateAccount(int i) {
System.out.println("执行了更新" + i);
}
public int deleteAccount() {
System.out.println("执行了删除");
return 0;
}
}
在每次执行业务层方法时,需要用一个日志类来记录日志:
package com.ethan.utils;
/**
* @author Ethan
* @date 2020/1/26 - 9:21
* 记录日志的工具类,它里面提供了公共的代码
*/
public class Logger {
/**
* 用于打印日志,计划让其在切入点方法执行之前执行(切入点方法就是业务层方法)
*/
public void printLog() {
System.out.println("Logger类中的printLog方法开始记录日志了");
}
}
切面配置如下,注意导入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.xsd"> <!-- bean definitions here -->
<!--配置spring的ioc,把service对象配置进来-->
<bean id="accountService" class="com.ethan.service.impl.AccountServiceImpl"></bean>
<!--spring中基于XML的AOP配置步骤
1.把通知Bean也交给spring管理
2.使用aop:config标签表明开始AOP的配置
3.使用aop:aspect标签表明配置切面
id:是给切面提供一个唯一标识
ref:是指定通知类bean的id
4.在aop:aspect标签的内部使用对应标签来配置通知的类型
我们现在示例是让printLog方法在切入点方法执行之前执行,所以是前置通知
aop:before表示前置通知
method:用于指定Logger类中哪个方法是前置通知
pointcut属性:用于指定切入点表达式,该表达式的含义是对业务层中哪些方法增强
切入点表达式的写法:
关键字:execution(表达式)
标准的表达式写法:
execution(public void com.ethan.service.impl.AccountServiceImpl.saveAccount())
访问修饰符可以省略
void com.ethan.service.impl.AccountServiceImpl.saveAccount()
返回值可以用通配符:
* com.ethan.service.impl.AccountServiceImpl.saveAccount()
包名可以使用通配符,表示任意包,但是有几级包就需要写几个*
* *.*.*.*.AccountServiceImpl.saveAccount()
包名可以使用..表示当前包及其子包
* *..AccountServiceImpl.saveAccount()
类名和方法名都可以用*通配
* *..*.*()
参数列表:
可以直接写数据类型:
基本类型直接写名称 * *..*.*(int)
引用类型写包名.类名的方式 java.lang.String
可以用通配符表示任意类型,但是必须有参数* *..*.*(*)
可以使用..有无参数类型,可以是任意类型参数
全通配写法:
* *..*.*(..)
实际开发中切入点表达式的通常写法:
切到业务层实现类下的所有方法
* com.ethan.service.impl.*.*(..)
-->
<!--配置Logger类-->
<bean id="logger" class="com.ethan.utils.Logger"></bean>
<!--配置AOP-->
<aop:config>
<!--配置切面-->
<aop:aspect id="logAdvice" ref="logger">
<!--配置通知的类型,并且建立通知方法和切入点方法的关联-->
<aop:before method="printLog" pointcut="execution(* *..*.*(..))"></aop:before>
</aop:aspect>
</aop:config>
</beans>
测试类如下:
package com.ethan.test;
import com.ethan.service.AccountService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* @author Ethan
* @date 2020/1/26 - 9:38
*/
public class AOPTest {
public static void main(String[] args) {
ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
AccountService as = (AccountService) ac.getBean("accountService");
as.saveAccount();
as.updateAccount(2);
as.deleteAccount();
}
}
这时,增强代码已经能够切入连接点,并且实现的是前置通知。
各种通知类型
根据增强代码和切入点的相对位置,通知类型可以划分如下:
先在日志类定义各种日志类型:
package com.ethan.utils;
import org.aspectj.lang.ProceedingJoinPoint;
/**
* @author Ethan
* @date 2020/1/26 - 9:21
* 记录日志的工具类,它里面提供了公共的代码
*/
public class Logger {
/**
* 前置通知
*/
public void beforePrintLog() {
System.out.println("Logger类中的前置通知beforePrintLog方法开始记录日志了");
}
/**
* 后置通知
*/
public void afterReturningPrintLog() {
System.out.println("Logger类中的后置通知afterReturningPrintLog方法开始记录日志了");
}
/**
* 异常通知
*/
public void afterThrowingPrintLog() {
System.out.println("Logger类中的异常通知afterThrowingPrintLog方法开始记录日志了");
}
/**
* 最终通知
*/
public void afterPrintLog() {
System.out.println("Logger类中的最终通知afterPrintLog方法开始记录日志了");
}
}
对于各种类型的通知配置如下:
<?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.xsd"> <!-- bean definitions here -->
<!--配置spring的ioc,把service对象配置进来-->
<bean id="accountService" class="com.ethan.service.impl.AccountServiceImpl"></bean>
<!--配置Logger类-->
<bean id="logger" class="com.ethan.utils.Logger"></bean>
<!--配置AOP-->
<aop:config>
<!--配置切面-->
<aop:aspect id="logAdvice" ref="logger">
<!--配置前置通知-->
<aop:before method="beforePrintLog" pointcut="execution(* com.ethan.service.impl.*.*(..))"></aop:before>
<!--配置后置通知-->
<aop:after-returning method="afterReturningPrintLog" pointcut="execution(* com.ethan.service.impl.*.*(..))"></aop:after-returning>
<!--配置异常通知-->
<aop:after-throwing method="afterThrowingPrintLog" pointcut="execution(* com.ethan.service.impl.*.*(..))"></aop:after-throwing>
<!--配置最终通知-->
<aop:after method="afterPrintLog" pointcut="execution(* com.ethan.service.impl.*.*(..))"></aop:after>
</aop:aspect>
</aop:config>
</beans>
可以通过配置切入点表达式来简化表达式:
<?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.xsd"> <!-- bean definitions here -->
<!--配置spring的ioc,把service对象配置进来-->
<bean id="accountService" class="com.ethan.service.impl.AccountServiceImpl"></bean>
<!--配置Logger类-->
<bean id="logger" class="com.ethan.utils.Logger"></bean>
<!--配置AOP-->
<aop:config>
<!--配置切入点表达式-->
<!--此标签写在aop:aspect标签内部只能当前切面使用,它还可以写在aspect外面,此时就变成所有切面可用-->
<aop:pointcut id="pt1" expression="execution(* com.ethan.service.impl.*.*(..))"/>
<!--配置切面-->
<aop:aspect id="logAdvice" ref="logger">
<!--配置环绕通知-->
<aop:around method="aroundPrintLog" pointcut-ref="pt1"></aop:around>
</aop:aspect>
</aop:config>
</beans>
环绕通知的实现:
/**
* 环绕通知
* 问题:当我们配置了环绕通知之后,切入点方法没有执行,而通知方法执行了。
* 分析:通过对比动态代理中的环绕通知代码,发现动态代理中的环绕通知有明确的业务层切入点方法调用,而我们的代码中没有
* 解决:spring框架为我们提供了一个接口ProceedingJoinPoint。该接口有一个方法proceed(),此方法就相当于明确调用切入点方法
* 该接口可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供该接口的实现类供我们使用。
* 它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式
*/
public Object aroundPrintLog(ProceedingJoinPoint pjp) {
Object rtValue = null;
try {
Object[] args = pjp.getArgs(); //得到方法执行所需的参数
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了");
rtValue = pjp.proceed(args); //明确调用业务层方法(切入点方法)
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了");
return rtValue;
} catch (Throwable throwable) {
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了");
throwable.printStackTrace();
throw new RuntimeException();
} finally {
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了");
}
}
利用注解实现AOP
AOP配置如下:
<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.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
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.xsd">
<!--配置spring创建容器时要扫描的包-->
<context:component-scan base-package="com.ethan"></context:component-scan>
<!--配置spring开启注解AOP的支持-->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>
AccountServiceImpl
类加上相应注解:
package com.ethan.service.impl;
import com.ethan.service.AccountService;
import org.springframework.stereotype.Service;
/**
* @author Ethan
* @date 2020/1/26 - 9:19
* 账户的业务层实现类
*/
@Service("accountService")
public class AccountServiceImpl implements AccountService {
public void saveAccount() {
System.out.println("执行了保存");
int a = 1/0;
}
public void updateAccount(int i) {
System.out.println("执行了更新" + i);
}
public int deleteAccount() {
System.out.println("执行了删除");
return 0;
}
}
日志类标注的注解如下:
package com.ethan.utils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
/**
* @author Ethan
* @date 2020/1/26 - 9:21
* 记录日志的工具类,它里面提供了公共的代码
*/
@Component("logger")
@Aspect //表示当前类是一个切面类
public class Logger {
@Pointcut("execution(* com.ethan.service.impl.*.*(..))")
private void pt1() {}
/**
* 前置通知
*/
@Before("pt1()")
public void beforePrintLog() {
System.out.println("Logger类中的前置通知beforePrintLog方法开始记录日志了");
}
/**
* 后置通知
*/
@AfterReturning("pt1()")
public void afterReturningPrintLog() {
System.out.println("Logger类中的后置通知afterReturningPrintLog方法开始记录日志了");
}
/**
* 异常通知
*/
@AfterThrowing("pt1()")
public void afterThrowingPrintLog() {
System.out.println("Logger类中的异常通知afterThrowingPrintLog方法开始记录日志了");
}
/**
* 最终通知
*/
@After("pt1()")
public void afterPrintLog() {
System.out.println("Logger类中的最终通知afterPrintLog方法开始记录日志了");
}
/**
* 环绕通知
* 问题:当我们配置了环绕通知之后,切入点方法没有执行,而通知方法执行了。
* 分析:通过对比动态代理中的环绕通知代码,发现动态代理中的环绕通知有明确的业务层切入点方法调用,而我们的代码中没有
* 解决:spring框架为我们提供了一个接口ProceedingJoinPoint。该接口有一个方法proceed(),此方法就相当于明确调用切入点方法
* 该接口可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供该接口的实现类供我们使用。
* 它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式
*/
@Around("pt1()")
public Object aroundPrintLog(ProceedingJoinPoint pjp) {
Object rtValue = null;
try {
Object[] args = pjp.getArgs(); //得到方法执行所需的参数
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了(前置)");
rtValue = pjp.proceed(args); //明确调用业务层方法(切入点方法)
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了(后置)");
return rtValue;
} catch (Throwable throwable) {
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了(异常)");
throwable.printStackTrace();
throw new RuntimeException();
} finally {
System.out.println("Logger类中的环绕通知afterPrintLog方法开始记录日志了(最终)");
}
}
}