基于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

么么叽~

相关文章
|
27天前
|
Java Spring
Springboot中Aop的使用
Springboot中Aop的使用
|
28天前
|
监控 Java API
掌握 Spring Boot AOP:使用教程
Spring Boot 中的面向切面编程(AOP)为软件开发提供了一种创新方法,允许开发者将横切关注点与业务逻辑相分离。这不仅提高了代码的复用性和可维护性,而且还降低了程序内部组件之间的耦合度。下面,我们深入探讨如何在 Spring Boot 应用程序中实践 AOP,以及它为项目带来的种种益处。
|
1月前
|
存储 JSON Java
SpringBoot集成AOP实现每个接口请求参数和返回参数并记录每个接口请求时间
SpringBoot集成AOP实现每个接口请求参数和返回参数并记录每个接口请求时间
37 2
|
11天前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
|
18天前
|
前端开发 Java
干货文:SpringBoot 配置 AOP 打印请求参数和返回参数
干货文:SpringBoot 配置 AOP 打印请求参数和返回参数
34 1
|
28天前
|
存储 关系型数据库 MySQL
【mybatis-plus】Springboot+AOP+自定义注解实现多数据源操作(数据源信息存在数据库)
【mybatis-plus】Springboot+AOP+自定义注解实现多数据源操作(数据源信息存在数据库)
|
1月前
|
Java
SpringBoot整合AOP整合aspectj实现面向切面编程实现参数接收和请求时间打印
SpringBoot整合AOP整合aspectj实现面向切面编程实现参数接收和请求时间打印
6 0
|
2月前
|
SQL NoSQL Java
【七】springboot整合AOP实现日志操作
【七】springboot整合AOP实现日志操作
45 0
|
3月前
|
Java 测试技术 开发者
探究 Spring Boot 的核心:IOC 和 AOP
Spring Boot 作为一种简化 Spring 应用开发的工具,继承了 Spring 框架的核心概念,其中最重要的是控制反转(IOC)和面向切面编程(AOP)。它们是 Spring 框架的基础,同时也深深植根于 Spring Boot 中。本文将讨论 IOC 和 AOP 的概念以及它们在 Spring Boot 中的应用。
62 4
|
Java Spring Maven
SpringBoot AOP 拦截器 Aspect
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/catoop/article/details/71541612 常用用于实现拦截的有:Filter、HandlerInterceptor、MethodInterceptor 第一种Filter属于Servlet提供的,后两者是Spring提供的,HandlerInterceptor属于Spring MVC项目提供的,用来拦截请求,在MethodInterceptor之前执行。
1982 0