首页 > 其他分享 >Spring Boot学习随笔- 实现AOP(JoinPoint、ProceedingJoinPoint、自定义注解类实现切面)

Spring Boot学习随笔- 实现AOP(JoinPoint、ProceedingJoinPoint、自定义注解类实现切面)

时间:2023-12-19 17:11:22浏览次数:41  
标签:自定义 Spring ProceedingJoinPoint System println 执行 方法 public out

学习视频:【编程不良人】2021年SpringBoot最新最全教程

第十一章、AOP

11.1 为什么要使用AOP

  • 问题

    1. 现有业务层开发存在问题
      1. 额外功能代码存在大量冗余
      2. 每个方法都需要书写一遍额外功能代码不利于项目维护
  • Spring中的AOP

    AOP:Aspect 切面 + Oriented 面向 Programmaing 面向切面编程

    Aspect(切面) = Advice(通知) + Pointcut(切入点)

    Advice 通知:业务逻辑中的一些附加操作称之通知

    Pointcut 切入点:配置通知应用于项目中那些业务操作

  • Advice通知就是附加操作的代码,Advice通知类型都有不同的执行策略和用途。

    @Before 在目标方法执行之前执行的通知。它不能阻止方法的执行,但可以在方法执行前添加额外的功能。
    @AfterReturning 在目标方法正常返回后执行的通知。例如,如果一个方法正常返回而没有抛出异常,就会执行这个通知。
    @AfterThrowing 在目标方法抛出异常后执行的通知。如果一个方法抛出异常,就会执行这个通知。
    @After 在目标方法执行之后执行的通知。无论目标方法如何退出(正常返回或抛出异常),都会执行的通知。
    @Around 包围目标方法的通知,可以在目标方法执行前后添加额外的功能,并决定是否继续执行目标方法。
  • Pointcut 是切入点,决定了Advice加在哪个具体方法代码上,具体使用方式:

    1.切入点直接写在附加操作里面
    @Around(value="execution(* login(..))")
    2.通过@Pointcut注解 声明切入点,实现复用
    @Pointcut("execution(* login(..))") // 复用切入点,解耦合
        public void myPointcut(){}
    
    @Around("myPointcut()")
    @After("myPointcut()")
    @Before("myPointcut()")
    

11.2 AOP的实现

  • 引入依赖

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    
  • 目前UserServiceImp存在的问题

    以log日志这种额外功能为例,这样的重复操作存在冗余代码和耦合

    @Service
    public class UserServiceImpl implements UserService {
        @Override
        public void save(String name) {
            System.out.println("========log========");
            System.out.println("UserServiceImpl.save");
        }
    
        @Override
        public void delete(Integer id) {
            System.out.println("========log========");
            System.out.println("UserServiceImpl.delete");
        }
    
        @Override
        public void update(String name) {
            System.out.println("========log========");
            System.out.println("UserServiceImpl.update");
        }
    
        @Override
        public String find(String name) {
            System.out.println("========log========");
            System.out.println("UserServiceImpl.find");
            return "name";
        }
    }
    
  • 我们通过一个切面配置类来解耦合

    /**
     * 自定义切面配置类
     */
    @Configuration  // 指定当前类为配置类
    @Aspect // 代表这个类是一个切面配置类
    public class MyAspectConfig {
    
        @Before("execution(* com.example.service.*.*(..))") // @Before代表在业务逻辑执行前运行 value代表切入点
        public void before() {
            System.out.println(" =====前置附加操作:log====== ");
        }
    }
    
  • 通过切入点,完成整个业务的额外功能覆盖,运行效果

11.3 JoinPoint 参数详解

JoinPoint参数可以在通知体内声明,用于获取有关方法执行的信息。JoinPoint参数提供了许多有用的方法,例如getSignature()可以获取方法的签名,getArgs()可以获取方法的参数列表,getTarget()可以获取目标对象等。通过JoinPoint参数,我们可以在通知中访问和操作方法执行时的上下文信息。

JoinPoint参数通常用于以下几种情况:

  1. 记录日志:获取方法的签名和参数列表,从而记录方法的执行情况,包括方法名、参数值等。
  2. 异常处理:获取方法执行时抛出的异常信息,从而进行相应的异常处理。
  3. 性能监控:获取方法的执行时间、参数值等信息,用于性能监控和优化。
获取执行方法的信息
@Before("execution(* com.example.service.*.*(..))") // 
public void before(JoinPoint joinPoint) {
    String methodName = joinPoint.getSignature().getName();
    String className = joinPoint.getTarget().getClass().getName();
    Object[] args = joinPoint.getArgs();
    System.out.println("Before 执行方法: " + methodName + " 在类:" + className);
    System.out.println("方法参数 = " + Arrays.toString(args));
}

11.4 @Around 环绕附加操作

使用@Around注解的方法,参数必须声明ProceedingJoinPoint,这个参数可以控制目标方法的执行

@Around("execution(* com.example.service.*.*(..))")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    System.out.println("======进入环绕的前置操作======");
    System.out.println("当前执行类 = " + pjp.getSignature().getName());
    System.out.println("方法名 = " + pjp.getTarget().getClass().getSimpleName());
    //放行目标方法执行
    Object proceed = pjp.proceed(); // 目标方法继续执行
    System.out.println(" =====进入环绕的后置操作========= ");
    return proceed;
}
  • 运行效果

11.5 自定义注解方式的切入点表达式@annotation

通过自定义注解@annotation实现切面的好处在于可以使切面的定义更加灵活和可重用。使用自定义注解可以将切面的逻辑和配置信息封装在注解中,使得切面的使用和配置变得更加简单和直观。

  • MyAdvice 自定义注解

    @Retention(RetentionPolicy.RUNTIME) // 指定运行时保留
    @Target(ElementType.METHOD) //指定修饰 方法
    public @interface MyAdvice {
    }
    
  • 放在通知里的@annotation属性使用,代表只有被@MyAdvice修饰的方法才会被加入额外功能

    **@Around("@annotation(com.example.config.MyAdvice)")**
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
    			
    }
    
  • 通过将注解加在业务逻辑上,实现给目标方法加上额外功能的目的

    UserServiceImpl	
    @Override
    @MyAdvice
    public String find(String name) {
    //        System.out.println("========log========");
        System.out.println("UserServiceImpl.find");
        return "name";
    }
    

标签:自定义,Spring,ProceedingJoinPoint,System,println,执行,方法,public,out
From: https://www.cnblogs.com/eyewink/p/17914158.html

相关文章

  • SpringBoot中使用Aspect实现切面
    相关概念切面(Aspect):首先要理解‘切’字,需要把对象想象成一个立方体,传统的面向对象变成思维,类定义完成之后(封装)。每次实例化一个对象,对类定义中的成员变量赋值,就相当于对这个立方体进行了一个定义,定义完成之后,就等着被使用,等着被回收。面向切面编程则是指,对于一个我们已经封装......
  • 最近在使用SpringBoot整合MyBatis-Plus时出现的问题
    版本信息:IDEA2022、jdk17、maven3.8.6、SpringBoot3+MyBatis-Plus依赖版本信息:<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.3</version&g......
  • springboot 记录使用log4j与logback发送日志到syslog服务器
    Linux服务器配置编辑/etc/rsyslog.conf文件。(我的在这里,根据自己系统查看)#取消注释这几行$ModLoadimudp$UDPServerRun514#ProvidesTCPsyslogreception$ModLoadimtcp$InputTCPServerRun514..........#末位追加:local2.info/var/log/login_info.log......
  • SpringBoot读取resources下的文件以及resources的资源路径
    1.这种可以但是在容器中获取不到(以下几种都可以只要不在容器)。InputStreaminputStream=this.getClass().getResourceAsStream("/static/imgs/aha.png");Propertiespps=newProperties();Filefile=ResourceUtils.getFile("classpath:defult.properties");pps.loa......
  • SpringBoot启动热部署
    1.在pom.xml中添加依赖<!--devtools热部署--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><optional>true</opt......
  • 【转载】Springboot2.x 使用 Redis
    参考https://blog.csdn.net/weixin_43749805/article/details/131399516https://juejin.cn/post/7076244567569203208https://blog.csdn.net/oJingZhiYuan12/article/details/126386904注意classjava.lang.Integercannotbecasttoclasscom.xiaqiuchu.demo.entity.S......
  • 2023最新中级难度Spring Cloud面试题,包含答案。刷题必备!记录一下。
    好记性不如烂笔头内容来自[面试宝典-中级难度SpringCloud面试题合集](https://offer.houxu6.top/tag/SpringCloud)问:SpringCloud是什么?SpringCloud是一个微服务框架,它提供了一系列分布式系统解决方案。它利用了SpringBoot的开发便利性巧妙地简化了分布式系统基础设......
  • 2023最新高级难度Spring Cloud面试题,包含答案。刷题必备!记录一下。
    好记性不如烂笔头内容来自[面试宝典-高级难度SpringCloud面试题合集](https://offer.houxu6.top/tag/SpringCloud)问:请简述SpringCloud与微服务治理平台Istio的关系?SpringCloud和Istio都是用于构建和管理微服务架构的工具,但它们在某些方面存在不同之处。定位与职......
  • 【流式传输】使用Spring Boot实现ChatGpt流式传输
    引言在ChatGpt火了这么久,他的那种单字单字返回的格式可能让很多朋友感到好奇,在之前我用c#写了一个版本的,同时支持IAsyncEnumerable以及SSE,今天把之前写的Java版本的也发出来,和大家一起学习,有不对的地方,欢迎各位大佬指正。Code我这边用的是JDK21版本,可以看到下......
  • spring framework启动问题
    正确Gradle版本查看gradle/wrapper/gradle-wrapper.propertiesAbuildscanwasnotpublishedasyouhavenotauthenticatedwithserver'ge.spring.io'.注释ge.conventionsplugins{ id"com.gradle.enterprise"version"3.6.1"// id&quo......