Spring AOP实现方式
引入依赖:(虽然该项目不是springboot项目,但是只需引入下面一个依赖即可)
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
<version>2.4.4</version>
</dependency>
①XML+接口方式开启(spring API)
我们首先要了解一下我们都有哪些接口可以实现:
第一步我们先配置好类包括切面类和要切入的类
切面类:(包括切入时间和切入内容)
package com.offcn.aop;
import org.springframework.aop.MethodBeforeAdvice;
import java.lang.reflect.Method;
/**
* method:切入点方法名
* args:切入点方法参数
* target:切入点方法所在类对象
*/
//实现前置通知类接口,在切入点方法执行前先执行前置通知
public class AopBefore implements MethodBeforeAdvice {
@Override
public void before(Method method, Object[] args, Object target) throws Throwable {
System.out.println("前置通知..........");
}
}
package com.offcn.aop;
import org.springframework.aop.AfterReturningAdvice;
import java.lang.reflect.Method;
/**
* returnValue:切入点方法返回值
* method:切入点的方法名
* args:切点方法参数
* target:切点方法所在类的对象
*/
//实现后置通知类接口,在切入点方法执行后还要执行后置通知
public class AopAfterReturning implements AfterReturningAdvice {
@Override
public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
System.out.println("后置通知.......");
}
}
切入目标类:
package com.offcn.service;
public class UserService {
public void add(){
System.out.println("增加了一个用户...");
}
}
其次在xml文件中引入aop约束并注册bean,以下两种方法任选其一即可:
<?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
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
<bean id="userService" class="com.offcn.service.UserService"></bean>
<bean id="aopAfter" class="com.offcn.aop.AopAfterReturning"></bean>
<bean id="aopBefore" class="com.offcn.aop.AopBefore"></bean>
</beans>
如果嫌每个类都要配置bean麻烦可以通过在每个类上添加注解@Component,然后在配置文件中添加扫描包即可:
<?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
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
<context:component-scan base-package="com.offcn"></context:component-scan>
<!--这样nbcb包下每个有注解的类都会注册到容器当中——>
</beans>
注册完成之后,需要通过标签<aop:config ></aop:config >来定义切面,切点。在bean下面开启AOP。
- 配置切点名字id:pointcut(名字随意取),切点位置表达式expression:execution(* com.offcn.service.UserService.*(…)) 意思为UserService包下所有方法都是切入点,如果只想切入特定方法,只需把 * 号替换成相应的方法即可。(…)表示所有方法的参数不定,可以没有可以有多个。
- 配置通知:接下来我们就要配置切面,切点映射关系,即告诉切面切入的位置是哪。
<aop:config>
<!-- 配置切点即切入位置在哪里,可以配置多个切点只需id不同即可-->
<aop:pointcut id="pointcut" expression="execution(* com.xxx.service.UserService.*(..))"/>
<!--
<aop:pointcut id="pointcut1" expression="execution(* com.xxx.service.xxx.*(..))"/>
<aop:pointcut id="pointcut2" expression="execution(* com.xxx.service.xxx.*(..))"/>
-->
<!--配置切面,切点映射关系,告诉每个切面的切入位置分别是什么-->
<aop:advisor advice-ref="aopAfter" pointcut-ref="pointcut"></aop:advisor>
<aop:advisor advice-ref="aopBefore" pointcut-ref="pointcut"></aop:advisor>
</aop:config>
测试
package com.offcn.main;
import com.offcn.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Test {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
UserService userService = context.getBean("userService", UserService.class);
userService.add();
}
}
结果:
注意
这里有一个问题要注意,假设上面说的UserService不是一个类,而是一个接口,我们把他的实现类注册到spring容器中,那么我们调用context.getBean()方法时,第二个参数不能写成实现类的class,只能写接口的class。
public interface UserService {
public void add();
}
public class UserServiceImpl implements UserService{
@Override
public void add() {
System.out.println("增加了一个用户........");
}
}
<bean id="userServiceImpl" class="com.offcn.service.UserServiceImpl"></bean>
正确写法:
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
UserService userService = context.getBean("userServiceImpl", UserService.class);
userService.add();
//或者我们不写第二个参数直接强转
//ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
//UserService userService = (UserService)context.getBean("userServiceImpl");
//serviceImpl.add();
错误写法:
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
UserServiceImpl serviceImpl = context.getBean("userServiceImpl", UserServiceImpl.class);
serviceImpl.add();
报错:
错误原因为spring动态代理,代理的是接口!
②XML+自定义类方式实现
第一种方式我们采用spring自带的API接口,如果要实现某种通知我们还需记住相应的接口并且一个接口只能实现一种通知,多种通知我们要多种实现类来完成,略嫌麻烦。第二种就允许我们可以自定类和方法来实现通知。
首先配置文件注册bean:
<?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
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
<bean id="userServiceImpl" class="com.offcn.service.UserServiceImpl"></bean>
<!--注册bean时我们只需把切面类注册进来即可-->
<bean id="myAdvice" class="com.offcn.aop.MyAdvice"></bean>
</beans>
public class UserServiceImpl implements UserService{
@Override
public void add() {
System.out.println("增加了一个用户........");
}
}
自定义切面类,包含各种通知方法:
public class MyAdvice {
public void before(){
System.out.println("前置通知.....");
}
public void after(){
System.out.println("后置通知.....");
}
public void throwing(){
System.out.println("异常通知.....");
}
}
配置AOP:
<aop:config>
<!--先配置切点 确定切入位置-->
<aop:pointcut id="pointcut" expression="execution(* com.offcn.service.UserServiceImpl.*(..))"/>
<!--配置自定义切面类映射-->
<aop:aspect ref="myAdvice">
<!--配置切面类中切点映射关系-->
<aop:before method="before" pointcut-ref="pointcut"></aop:before>
<aop:after-returning method="after" pointcut-ref="pointcut"></aop:after-returning>
<aop:after-throwing method="throwing" pointcut-ref="pointcut"></aop:after-throwing>
</aop:aspect>
</aop:config>
测试
package com.offcn.main;
import com.offcn.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Test {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
UserService userService = context.getBean("userService", UserService.class);
userService.add();
}
}
结果:
注意:
-
异常通知只有在方法发生异常时才会通知,其他时候不产生作用。
-
在使用环绕通知时,必须在方法中添加参数ProceedingJoinPoint并且调用proceed方法,切入点的方法即userService.add()才能运行,不然切入点方法不会运行,请自行测试:
public void around(ProceedingJoinPoint pjp){
System.out.println("环绕通知1.....");
try {
pjp.proceed();
} catch (Throwable throwable) {
throwable.printStackTrace();
}
System.out.println("环绕通知2.....");
}
- <aop:after >和<aop:after-returning >区别:
after无论是否发生异常,都会通知。
after-returning只有在不发生异常时才会有作用。
③注解方式开启AOP(常用)
以上两种方法都要在配置文件中注入映射关系才能起作用,稍显繁琐。通过注解的方式,我们就可以从配置文件中解脱出来。常用注解有以下几种:
首先我们还是注册bean,通过注解的方式我们选择第二种即扫描包的形式注册:
<?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
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
<context:component-scan base-package="com.offcn"></context:component-scan>
<!--通过<aop:aspectj-autoproxy />声明自动为spring容器中那些配置@Aspect切面的bean创建代理,织入切面。如果要通过注解方式启动aop,必须写上,否则 切面不会生效-->
<aop:aspectj-autoproxy/>
</beans>
接下来我们需要在切入点类上添加注解@Component:
@Component
public class UserServiceImpl implements UserService{
@Override
public void add() {
System.out.println("增加了一个用户........");
}
}
切面类除了@Component外还需要添加注解@Aspect:
package com.offcn.aop;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
@Component
@Aspect
public class MyAdviceComponent {
//使用 @Pointcut注解声明切点表达式,避免频繁使用表达式。否则必须在每个注解上面标明切点表达式!
@Pointcut(value = "execution(* com.offcn.service.UserServiceImpl.*(..))")
public void qiedian(){};
@Before("qiedian()")
public void before(){
System.out.println("前置通知.....");
}
@AfterReturning("qiedian()")
public void afterReturning(){
System.out.println("后置返回通知.....");
}
}
测试
package com.offcn.main;
import com.offcn.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Test {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
//使用注解方式注册bean,getBean时只需把要注入的类的首字母小写,其他不变即可取得该类对象
UserService service = (UserService)context.getBean("userServiceImpl");
service.add();
}
}
结果:
注意
使用注解时必须在配置文件中标明<aop:aspectj-autoproxy/ >,否则注解不起作用!除非该项目是springboot项目,那么就不需要写了!
以上就是我对spring aop的总结,欢迎您的纠正。如果能帮到你,请给我点一个赞。