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。

相关文章

JavaScript中的isTrusted属性及其应用场景详解

JavaScript中的isTrusted属性及其应用场景详解

《JavaScript中的isTrusted属性及其应用场景详解》在现代Web开发中,JavaScript是构建交互式应用的核心语言,随着前端技术的不断发展,开发者需要处理越来越多的复杂场景,例如事件... 目录引言一、问题背景二、isTrusted 属性的来源与作用1. isTrusted 的定义2. 为
阅读更多...
C#提取PDF表单数据的实现流程

C#提取PDF表单数据的实现流程

《C#提取PDF表单数据的实现流程》PDF表单是一种常见的数据收集工具,广泛应用于调查问卷、业务合同等场景,凭借出色的跨平台兼容性和标准化特点,PDF表单在各行各业中得到了广泛应用,本文将探讨如何使用... 目录引言使用工具C# 提取多个PDF表单域的数据C# 提取特定PDF表单域的数据引言PDF表单是一
阅读更多...
使用Python实现高效的端口扫描器

使用Python实现高效的端口扫描器

《使用Python实现高效的端口扫描器》在网络安全领域,端口扫描是一项基本而重要的技能,通过端口扫描,可以发现目标主机上开放的服务和端口,这对于安全评估、渗透测试等有着不可忽视的作用,本文将介绍如何使... 目录1. 端口扫描的基本原理2. 使用python实现端口扫描2.1 安装必要的库2.2 编写端口扫
阅读更多...
Java循环创建对象内存溢出的解决方法

Java循环创建对象内存溢出的解决方法

《Java循环创建对象内存溢出的解决方法》在Java中,如果在循环中不当地创建大量对象而不及时释放内存,很容易导致内存溢出（OutOfMemoryError）,所以本文给大家介绍了Java循环创建对象... 目录问题1. 解决方案2. 示例代码2.1 原始版本（可能导致内存溢出）2.2 修改后的版本问题在
阅读更多...
PyCharm接入DeepSeek实现AI编程的操作流程

PyCharm接入DeepSeek实现AI编程的操作流程

《PyCharm接入DeepSeek实现AI编程的操作流程》DeepSeek是一家专注于人工智能技术研发的公司,致力于开发高性能、低成本的AI模型,接下来,我们把DeepSeek接入到PyCharm中... 目录引言效果演示创建API key在PyCharm中下载Continue插件配置Continue引言
阅读更多...
MySQL分表自动化创建的实现方案

MySQL分表自动化创建的实现方案

《MySQL分表自动化创建的实现方案》在数据库应用场景中,随着数据量的不断增长,单表存储数据可能会面临性能瓶颈,例如查询、插入、更新等操作的效率会逐渐降低,分表是一种有效的优化策略,它将数据分散存储在... 目录一、项目目的二、实现过程（一）mysql 事件调度器结合存储过程方式1. 开启事件调度器2. 创
阅读更多...
使用Python实现操作mongodb详解

使用Python实现操作mongodb详解

《使用Python实现操作mongodb详解》这篇文章主要为大家详细介绍了使用Python实现操作mongodb的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、示例二、常用指令三、遇到的问题一、示例from pymongo import MongoClientf
阅读更多...
SQL Server使用SELECT INTO实现表备份的代码示例

SQL Server使用SELECT INTO实现表备份的代码示例

《SQLServer使用SELECTINTO实现表备份的代码示例》在数据库管理过程中,有时我们需要对表进行备份,以防数据丢失或修改错误,在SQLServer中,可以使用SELECTINT... 在数据库管理过程中，有时我们需要对表进行备份，以防数据丢失或修改错误。在 SQL Server 中，可以使用 SE
阅读更多...
基于Go语言实现一个压测工具

基于Go语言实现一个压测工具

《基于Go语言实现一个压测工具》这篇文章主要为大家详细介绍了基于Go语言实现一个简单的压测工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录整体架构通用数据处理模块Http请求响应数据处理Curl参数解析处理客户端模块Http客户端处理Grpc客户端处理Websocket客户端
阅读更多...
Java CompletableFuture如何实现超时功能

Java CompletableFuture如何实现超时功能

《JavaCompletableFuture如何实现超时功能》：本文主要介绍实现超时功能的基本思路以及CompletableFuture（之后简称CF）是如何通过代码实现超时功能的,需要的... 目录基本思路CompletableFuture 的实现1. 基本实现流程2. 静态条件分析3. 内存泄露 bug
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2