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。

相关文章

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》：本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim
阅读更多...
Qt spdlog日志模块的使用详解

Qt spdlog日志模块的使用详解

《Qtspdlog日志模块的使用详解》在Qt应用程序开发中,良好的日志系统至关重要,本文将介绍如何使用spdlog1.5.0创建满足以下要求的日志系统,感兴趣的朋友一起看看吧... 目录版本摘要例子logmanager.cpp文件main.cpp文件版本spdlog版本：1.5.0采用1.5.0版本主要
阅读更多...
如何配置Spring Boot中的Jackson序列化

如何配置Spring Boot中的Jackson序列化

《如何配置SpringBoot中的Jackson序列化》在开发基于SpringBoot的应用程序时,Jackson是默认的JSON序列化和反序列化工具,本文将详细介绍如何在SpringBoot中配置... 目录配置Spring Boot中的Jackson序列化1. 为什么需要自定义Jackson配置？2.
阅读更多...
Java中使用Hutool进行AES加密解密的方法举例

Java中使用Hutool进行AES加密解密的方法举例

《Java中使用Hutool进行AES加密解密的方法举例》AES是一种对称加密,所谓对称加密就是加密与解密使用的秘钥是一个,下面：本文主要介绍Java中使用Hutool进行AES加密解密的相关资料... 目录前言一、Hutool简介与引入1.1 Hutool简介1.2 引入Hutool二、AES加密解密基础
阅读更多...
Spring Boot项目部署命令java -jar的各种参数及作用详解

Spring Boot项目部署命令java -jar的各种参数及作用详解

《SpringBoot项目部署命令java-jar的各种参数及作用详解》：本文主要介绍SpringBoot项目部署命令java-jar的各种参数及作用的相关资料,包括设置内存大小、垃圾回收... 目录前言一、基础命令结构二、常见的 Java 命令参数1. 设置内存大小2. 配置垃圾回收器3. 配置线程栈大小
阅读更多...
SpringBoot实现微信小程序支付功能

SpringBoot实现微信小程序支付功能

《SpringBoot实现微信小程序支付功能》小程序支付功能已成为众多应用的核心需求之一,本文主要介绍了SpringBoot实现微信小程序支付功能,文中通过示例代码介绍的非常详细,对大家的学习或者工作... 目录一、引言二、准备工作（一）微信支付商户平台配置（二）Spring Boot项目搭建（三）配置文件
阅读更多...
解决SpringBoot启动报错:Failed to load property source from location 'classpath:/application.yml'

解决SpringBoot启动报错:Failed to load property source from location 'classpath:/application.yml'

《解决SpringBoot启动报错:Failedtoloadpropertysourcefromlocationclasspath:/application.yml问题》这篇文章主要介绍... 目录在启动SpringBoot项目时报如下错误原因可能是1.yml中语法错误2.yml文件格式是GBK总结在启动S
阅读更多...
Spring中配置ContextLoaderListener方式

Spring中配置ContextLoaderListener方式

《Spring中配置ContextLoaderListener方式》：本文主要介绍Spring中配置ContextLoaderListener方式,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录Spring中配置ContextLoaderLishttp://www.chinasem.cntene
阅读更多...
基于Python实现高效PPT转图片工具

基于Python实现高效PPT转图片工具

《基于Python实现高效PPT转图片工具》在日常工作中,PPT是我们常用的演示工具,但有时候我们需要将PPT的内容提取为图片格式以便于展示或保存,所以本文将用Python实现PPT转PNG工具,希望... 目录1. 概述2. 功能使用2.1 安装依赖2.2 使用步骤2.3 代码实现2.4 GUI界面3.效
阅读更多...
MySQL更新某个字段拼接固定字符串的实现

MySQL更新某个字段拼接固定字符串的实现

《MySQL更新某个字段拼接固定字符串的实现》在MySQL中,我们经常需要对数据库中的某个字段进行更新操作,本文就来介绍一下MySQL更新某个字段拼接固定字符串的实现,感兴趣的可以了解一下... 目录1. 查看字段当前值2. 更新字段拼接固定字符串3. 验证更新结果mysql更新某个字段拼接固定字符串 -
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2