基于springboot实现一个简单的aop

简介: 要实现aop,首先你要知道你拿aop来干啥,我们今天就以记录日志来说,因为这个最常用,一般对于重要的数据库操作,我们需要记录操作人、什么时间、做了什么,关于做了什么怎么实现我们后面细讲

简介

AOP(Aspect-Oriented Programming:面向切面编程)


aop能将一些繁琐、重复、无关业务的逻辑封装起来,在一个地方进行统一处理,常用于日志记录、事务管理、权限控制等,aop能在不改变原有代码逻辑的基础上对某个方法、某类方法、或者整个类进行无侵入式的加强,有效降低了代码耦合度,并且提高了项目扩展性;


ok废话说完,进入正题,如何实现一个aop


要实现aop,首先你要知道你拿aop来干啥,我们今天就以记录日志来说,因为这个最常用,一般对于重要的数据库操作,我们需要记录操作人、什么时间、做了什么,关于做了什么怎么实现我们后面细讲(要想知道做了什么,肯定得知道是哪个方法、并且哪些参数,这些属于进阶操作,我们先简单实现一个aop)


我们先new一个切面

@Aspect
@Component
public class LogAspect {
    @Pointcut("execution(* com.example.mydemos.controller..*(..))")
    public void controllerMethod() {
    }
    @Before("controllerMethod()")
    public void beforeExecute() {
        System.out.println("before...");
    }
    @After("controllerMethod()")
    public void afterExecute() {
        System.out.println("after...");
    }
}

关于注解


@Aspect:告诉spring这是一个切面;

@Component:将切面交由spring来管理;

@Pointcut:切入点,直白点就是指定你需要从哪个地方切入,再直白点就是你想增强的目标方法,这里需要了解下execution表达式,可以通过这里来指定你需要切入的方法,可以指定单个方法、整个类的所有方法、类的某些方法、整个包下所有类的所有方法等;

@Before:目标方法执行前需要做的事;

@After:目标方法执行后需要做的事

还有几个常用注解:


@Around(能自由的指定在目标方法执行前后做增强逻辑,需要手动调用ProceedingJoinPoint的proceed方法来执行目标方法,不调用则目标方法不会执行,如果目标方法有返回值,还需手动返回)


@AfterReturning(在目标方法正常执行完成后做增强,如果你需要获取方法返回值就用它)


@AfterThrowing(当目标方法执行过程中抛出异常时执行)


执行时机:

切入目标方法时,先织入Around,再织入Before,退出目标方法时,先织入Around,再织入AfterReturning,最后才织入After


来个测试controller

就是个平平无奇的普通controller

@RestController
public class HiController {
    @GetMapping("/hi")
    public String sayHello() {
        System.out.println("hi, good morning~");
        return "hi bro ~";
    }
}

我这个controller是放在Pointcut对应com.example.mydemos.controller包下的,所以该包下的所有类的所有方法都会被增强


先假设后验证


按照上述demo

当我访问"/hi"时,会先执行@Before对应方法,输出"before…",再执行HiController 中的sayHello方法,输出"hi, good morning~",并且返回"hi bro ~",最后执行@After对应方法,输出"after…"


验证:

项目跑起来访问"/hi"


//

676087397e374431920c46367bebaf1f.png

控制台

1d46483263964cb7a3ebaf7b426e5958.png

验证成功~


一个最基础的aop实现完毕,接下来搞点进阶操作

  • 获取目标方法参数

再来个测试controller

@RestController
public class HelloController {
    @GetMapping("/hello/{title}/{content}")
    public String sayHello(@PathVariable("title") String title, @PathVariable("content") String content) {
        System.out.println(title + ":" + content);
        return "hello ya~";
    }
}

500a7de0791043e6abf4dfc0a35f3773.png

现在我们有两个controller,顺便能测试下execution规则是否生效,我的规则是com.example.mydemos.controller下的所有方法都增强


HelloController的sayHello方法有两个参数title和content,看我们能不能拿到


获取目标方法参数需要用到JoinPoint,经测试,在@Before和@After中均能获取

    @Before("controllerPointcut()")
    public void beforeExecute(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        List<Object> list = Arrays.asList(args);
        System.out.println("before中的目标方法参数");
        list.forEach(System.out::println);
        System.out.println("before...");
    }
    @After("controllerPointcut()")
    public void afterExecute(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        List<Object> list = Arrays.asList(args);
        System.out.println("after中的目标方法参数");
        list.forEach(System.out::println);
        System.out.println("after...");
    }

joinPoint.getArgs()会返回一个object数组,这就是你的目标方法参数

测试

de8622ec6e6b401094a14185173283c8.png

结果

ef4f468d968b48b293de53d840f187f5.png

  • 获取目标方法名

所有符合规则的方法都会被增强,那我怎么知道当前执行的是哪个方法呢?

    @Before("controllerPointcut()")
    public void beforeExecute(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println("before中的方法名:"+name);
        System.out.println("before...");
    }
    @After("controllerPointcut()")
    public void afterExecute(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println("after中的方法名:"+name);
        System.out.println("after...");
    }

joinPoint.getSignature().getName()返回的就是方法名

8716c47b8cca468f8697434ade0ab320.png

655f361548694718a41ad34381c653a2.png

d8b052586aee4826850e49027212d08e.png

  • 获取目标方法返回值

这个就需要用到@Around或者@AfterReturning

一、@Around

    @Around("controllerPointcut()")
    public Object aruondExecute(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("around before...");
        String name = joinPoint.getSignature().getName();
        Object o = joinPoint.proceed();
        System.out.println("方法" + name + "的返回值是" + o);
        System.out.println("around after...");
        return o;
    }

注意,如果用around,需手动调用ProceedingJoinPoint.proceed才能执行目标方法,并且如果目标方法有返回值,需要手动return

访问"/hi"

49c0c7e3ac3e4d83b91ebb4dc85c5dbc.png

二、@AfterReturning


    @AfterReturning(value = "controllerPointcut()", returning = "result")
    public void AfterReturningExecute(JoinPoint joinPoint, Object result) {
        System.out.println("AfterReturning...");
        String name = joinPoint.getSignature().getName();
        System.out.println("方法" + name + "的返回值是" + result);
    }

用AfterReturning的话需要添加一个参数returning,用于接收返回值,且AfterReturning注解中的形参要和AfterReturningExecute中的一致,不然识别不到

访问"/hi"

b7430d20a1ab498192352d6e393fb5a3.png


文中demo已上传至gitee

顺便求个star

么么叽~

相关文章
|
11月前
|
XML Java 开发者
Spring Boot中的AOP实现
Spring AOP(面向切面编程)允许开发者在不修改原有业务逻辑的情况下增强功能,基于代理模式拦截和增强方法调用。Spring Boot通过集成Spring AOP和AspectJ简化了AOP的使用,只需添加依赖并定义切面类。关键概念包括切面、通知和切点。切面类使用`@Aspect`和`@Component`注解标注,通知定义切面行为,切点定义应用位置。Spring Boot自动检测并创建代理对象,支持JDK动态代理和CGLIB代理。通过源码分析可深入了解其实现细节,优化应用功能。
527 6
|
9月前
|
Java API 微服务
微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——Spring Boot 中的 AOP 处理
本文详细讲解了Spring Boot中的AOP(面向切面编程)处理方法。首先介绍如何引入AOP依赖,通过添加`spring-boot-starter-aop`实现。接着阐述了如何定义和实现AOP切面,包括常用注解如`@Aspect`、`@Pointcut`、`@Before`、`@After`、`@AfterReturning`和`@AfterThrowing`的使用场景与示例代码。通过这些注解,可以分别在方法执行前、后、返回时或抛出异常时插入自定义逻辑,从而实现功能增强或日志记录等操作。最后总结了AOP在实际项目中的重要作用,并提供了课程源码下载链接供进一步学习。
1033 0
|
9月前
|
Java 开发者 微服务
微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——什么是AOP
本文介绍了Spring Boot中的切面AOP处理。AOP(Aspect Oriented Programming)即面向切面编程,其核心思想是分离关注点。通过AOP,程序可以将与业务逻辑无关的代码(如日志记录、事务管理等)从主要逻辑中抽离,交由专门的“仆人”处理,从而让开发者专注于核心任务。这种机制实现了模块间的灵活组合,使程序结构更加可配置、可扩展。文中以生活化比喻生动阐释了AOP的工作原理及其优势。
510 0
|
11月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
769 8
|
监控 安全 Java
什么是AOP?如何与Spring Boot一起使用?
什么是AOP?如何与Spring Boot一起使用?
838 5
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
281 1
|
缓存 NoSQL Java
Springboot自定义注解+aop实现redis自动清除缓存功能
通过上述步骤,我们不仅实现了一个高度灵活的缓存管理机制,还保证了代码的整洁与可维护性。自定义注解与AOP的结合,让缓存清除逻辑与业务逻辑分离,便于未来的扩展和修改。这种设计模式非常适合需要频繁更新缓存的应用场景,大大提高了开发效率和系统的响应速度。
469 2
|
前端开发 Java
Springboot 自定义注解AOP实现时间参数格式转换
Springboot 自定义注解AOP实现时间参数格式转换
551 0
Springboot 自定义注解AOP实现时间参数格式转换
|
2月前
|
JavaScript Java 关系型数据库
基于springboot的项目管理系统
本文探讨项目管理系统在现代企业中的应用与实现,分析其研究背景、意义及现状,阐述基于SSM、Java、MySQL和Vue等技术构建系统的关键方法,展现其在提升管理效率、协同水平与风险管控方面的价值。