SpringBoot实现SpringAop，AOP实现日志

2024-04-16 15:38
文章标签 java 实现 日志 springboot spring aop springaop

本文主要是介绍SpringBoot实现SpringAop，AOP实现日志，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

B站视频地址


关于什么是AOP，AOP用来做什么，AOP里面的两种代理这里都不做讨论。本文只是在应用的层面去讲解AOP


一、关于AOP里面的一些概念

  • Joinpoint（连接点)： 类里面可以被增强的方法，这些方法称为连接点
  • Pointcut（切入点）：所谓切入点是指我们要对哪些Joinpoint进行拦截的定义
  • Advice（通知）：所谓通知是指拦截到Joinpoint之后所要做的事情就是通知.通知分为前置通知，后置通知，异常通知，最终通知，环绕通知（切面要完成的功能）
  • Aspect（切面）： 是切入点和通知（引介）的结合
  • Target（目标对象）：代理的目标对象（要增强的类）
  • Weaving（织入）： 是把增强应用到目标的过程，把advice 应用到 target的过程
  • Proxy（代理）：一个类被AOP织入增强后，就产生一个结果代理类
  • Before（前置通知）：在目标方法之前执行
  • After（后置通知）：在目标方法之后执行（不管目标方法是否执行成功都会执行）
  • AfterReturning（正常后置通知）：目标方法正常执行结束后执行
  • AfterThrowing（异常后置通知）：目标方法异常后执行
  • Around（环绕通知）：目标方法执行前后都执行

二、Demo搭建

 <!-- spring-boot-starter-aop --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId><version>2.2.0.RELEASE</version></dependency>

2-1、切面定义

@Aspect
@Component
public class LogAspect {}

2-2、Pointcut定义

也就是我们要对那些方法进行AOP处理


2-2-1、使用匹配方式

就是配置我们要把哪些包下面的方法进行AOP拦截了。

下面这个就是对com.koron.workorder包下面的servlet包下面的类全部进行拦截

具体的配置百度一下SpringAOP切点配置就行

private static final String POINT_CUT_INCLUDE = "execution(public * com.koron.workorder..servlet.*.*(..))";@Pointcut(POINT_CUT_INCLUDE)
public void controllerLog() {
}

2-2-2、注解方式拦截

在方法上面使用了这个注解就会被AOP拦截

自定义注解

这个注解里面有三个参数，当然了这个是自定义的，你想要几个完全根据业务来定义即可

import java.lang.annotation.*;@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogDefined {String operate() default "";String module() default "";String desc() default "";
}

pointCut书写

@Pointcut("@annotation(com.xdx97.mianshiba.common.aop.log.LogDefined)")
public void controllerLog() {
}

2-3、advice通知


2-3-1、前置通知（Before）

在执行目标方法之前执行

// 前置通知
@Before("controllerLog()")
public void logBefore(JoinPoint joinPoint){System.out.println("before");
}

2-3-2、后置通知（After）

在目标方法之后执行（不管目标方法是否执行成功都会执行）

@After("controllerLog()")
public void logAfter(JoinPoint point){System.out.println("after");
}

2-3-3、正常后置通知（AfterReturning）

目标方法正常执行结束后执行，result是目标方法返回的结果

@AfterReturning(pointcut = "controllerLog()", returning = "result")
public void logAfterReturning(JoinPoint point,String result){System.out.println("result = " + result);System.out.println("logAfterReturning");
}

2-3-4、异常后置通知（AfterThrowing）

目标方法异常后执行

@AfterThrowing("controllerLog()")
public void logAfterThrowing(JoinPoint point){System.out.println("logAfterThrowing");
}

2-3-5、环绕通知（Around）

目标方法执行前后都执行

@Around("controllerLog()")
public Object logAround(ProceedingJoinPoint point) throws Throwable {System.out.println("目标方法执行前...");Object proceed = point.proceed();System.out.println("目标方法执行后...");return proceed;
}

point.proceed();

这句代码，就是去执行目标方法， proceed 是目标方法的返回值。


2-3-6、其它

我们看到每一个通知方法里面都有JoinPoint参数，我们可以从里面获取数据，比如获取请求的参数

Object[] args = joinPoint.getArgs();
for (Object item : args){System.out.println(item);
}

2-3-7、测试

TestController

import com.xdx97.mianshiba.common.aop.log.LogDefined;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;@RestController
public class TestController {@GetMapping("/test")@LogDefined(operate = "测试",module = "测试模块",desc="简单描述")public String fun(@RequestParam String str){System.out.println("active" + str);return "success";}
}

执行结果

http://127.0.0.1:8888/test?str=31231

目标方法执行前...
31231
before
active31231
目标方法执行后...
after
result = success
logAfterReturning

完整的切面

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;@Aspect
@Component
public class LogAspect {@Pointcut("@annotation(com.xdx97.mianshiba.common.aop.log.LogDefined)")public void controllerLog() {}// 前置通知@Before("controllerLog()")public void logBefore(JoinPoint joinPoint){Object[] args = joinPoint.getArgs();for (Object item : args){System.out.println(item);}System.out.println("before");}// 后置通知 不管异常不异常都会执行@After("controllerLog()")public void logAfter(JoinPoint point){System.out.println("after");}// 返回通知--当代码运行正常后执行@AfterReturning(pointcut = "controllerLog()", returning = "result")public void logAfterReturning(JoinPoint point,String result){System.out.println("result = " + result);System.out.println("logAfterReturning");}// 异常通知 -- 发送异常后执行@AfterThrowing("controllerLog()")public void logAfterThrowing(JoinPoint point){System.out.println("logAfterThrowing");}// 环绕通知@Around("controllerLog()")public Object logAround(ProceedingJoinPoint point) throws Throwable {System.out.println("目标方法执行前...");Object proceed = point.proceed();System.out.println("目标方法执行后...");return proceed;}
}

三、实现log

import com.xdx97.mianshiba.bean.pojo.common.BUser;
import com.xdx97.mianshiba.common.utils.RedisUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;@Aspect
@Component
public class LogAspect {@Pointcut("@annotation(com.xdx97.mianshiba.common.aop.log.LogDefined)")public void controllerLog() {}// 返回通知--当代码运行正常后执行@AfterReturning(pointcut = "controllerLog()", returning = "result")public void logAfterReturning(JoinPoint point,String result){// 1、从request里面获取tokenServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = servletRequestAttributes.getRequest();String token = request.getHeader("token");// 2、使用token从Redis里面获取用户信息BUser user = (BUser)RedisUtils.get(token);Map<String,Object> map = new HashMap<>();map.put("userId",user.getId());map.put("userName", user.getUserName());// 3、获取拦截的参数MethodSignature signature = (MethodSignature) point.getSignature();//从切面织入点处通过反射机制获取织入点处的方法Method logMethod = signature.getMethod();//获取切入点所在的方法LogDefined logDefined = logMethod.getAnnotation(LogDefined.class); //获取操作if (logDefined != null) { //记录操作信息try {map.put("operate",logDefined.operate());map.put("module",logDefined.module());map.put("desc",logDefined.desc());} catch (Exception e) {throw new RuntimeException("操作日志字段名填写有误");}}// 4、把数据插入数据库  map}
}

四、其它

4-1、AOP执行顺序

我们可以在切面上加入 @Order(1) 注解，里面的数值越小，执行顺序越前。

这篇关于SpringBoot实现SpringAop，AOP实现日志的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/909205。

相关文章

SpringBoot中HTTP连接池的配置与优化

SpringBoot中HTTP连接池的配置与优化

《SpringBoot中HTTP连接池的配置与优化》这篇文章主要为大家详细介绍了SpringBoot中HTTP连接池的配置与优化的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录一、HTTP连接池的核心价值二、Spring Boot集成方案方案1：Apache HttpCl
阅读更多...
使用animation.css库快速实现CSS3旋转动画效果

使用animation.css库快速实现CSS3旋转动画效果

《使用animation.css库快速实现CSS3旋转动画效果》随着Web技术的不断发展，动画效果已经成为了网页设计中不可或缺的一部分，本文将深入探讨animation.css的工作原理，如何使用以及... 目录1. css3动画技术简介2. animation.css库介绍2.1 animation.cs
阅读更多...
Spring Boot项目打包和运行的操作方法

Spring Boot项目打包和运行的操作方法

《SpringBoot项目打包和运行的操作方法》SpringBoot应用内嵌了Web服务器,所以基于SpringBoot开发的web应用也可以独立运行,无须部署到其他Web服务器中,下面以打包dem... 目录一、打包为JAR包并运行1.打包为可执行的 JAR 包2.运行 JAR 包二、打包为WAR包并运行
阅读更多...
Java进行日期解析与格式化的实现代码

Java进行日期解析与格式化的实现代码

《Java进行日期解析与格式化的实现代码》使用Java搭配ApacheCommonsLang3和Natty库,可以实现灵活高效的日期解析与格式化,本文将通过相关示例为大家讲讲具体的实践操作,需要的可以... 目录一、背景二、依赖介绍1. Apache Commons Lang32. Natty三、核心实现代
阅读更多...
Spring Boot 常用注解整理(最全收藏版)

Spring Boot 常用注解整理(最全收藏版)

《SpringBoot常用注解整理(最全收藏版)》本文系统整理了常用的Spring/SpringBoot注解,按照功能分类进行介绍,每个注解都会涵盖其含义、提供来源、应用场景以及代码示例,帮助开发... 目录Spring & Spring Boot 常用注解整理一、Spring Boot 核心注解二、Spr
阅读更多...
SpringBoot实现接口数据加解密的三种实战方案

SpringBoot实现接口数据加解密的三种实战方案

《SpringBoot实现接口数据加解密的三种实战方案》在金融支付、用户隐私信息传输等场景中,接口数据若以明文传输,极易被中间人攻击窃取,SpringBoot提供了多种优雅的加解密实现方案,本文将从原... 目录一、为什么需要接口数据加解密？二、核心加解密算法选择1. 对称加密（AES）2. 非对称加密（R
阅读更多...
基于Go语言实现Base62编码的三种方式以及对比分析

基于Go语言实现Base62编码的三种方式以及对比分析

《基于Go语言实现Base62编码的三种方式以及对比分析》Base62编码是一种在字符编码中使用62个字符的编码方式,在计算机科学中,,Go语言是一种静态类型、编译型语言,它由Google开发并开源,... 目录一、标准库现状与解决方案1. 标准库对比表2. 解决方案完整实现代码（含边界处理）二、关键实现细
阅读更多...
详解如何在SpringBoot控制器中处理用户数据

详解如何在SpringBoot控制器中处理用户数据

《详解如何在SpringBoot控制器中处理用户数据》在SpringBoot应用开发中,控制器（Controller）扮演着至关重要的角色,它负责接收用户请求、处理数据并返回响应,本文将深入浅出地讲解... 目录一、获取请求参数1.1 获取查询参数1.2 获取路径参数二、处理表单提交2.1 处理表单数据三、
阅读更多...
MySQL精准控制Binlog日志数量的三种方案

MySQL精准控制Binlog日志数量的三种方案

《MySQL精准控制Binlog日志数量的三种方案》作为数据库管理员,你是否经常为服务器磁盘爆满而抓狂？Binlog就像数据库的“黑匣子”,默默记录着每一次数据变动,但若放任不管,几天内这些日志文件就... 目录 一招修改配置文件：永久生效的控制术1.定位my.cnf文件2.添加核心参数不重启热更新：高手应
阅读更多...
python通过curl实现访问deepseek的API

python通过curl实现访问deepseek的API

《python通过curl实现访问deepseek的API》这篇文章主要为大家详细介绍了python如何通过curl实现访问deepseek的API,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编... API申请和充值下面是deepeek的API网站https://platform.deepsee
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2