Spring Boot 使用 Aop 实现日志全局拦截
前面的章节我们学习到 Spring Boot Log 日志使用教程 和 Spring Boot 异常处理与全局异常处理,本章我们结合 Aop 面向切面编程来实现全局拦截异常并记录日志。
在 Spring Boot 中 Aop 与 Ioc 可以说是 Spring 的灵魂,其功能也是非常强大。
1 新建 Spring Boot 项目
1)File > New > Project,如下图选择 Spring Initializr
然后点击 【Next】下一步
2)填写 GroupId
(包名)、Artifact
(项目名) 即可。点击 下一步
groupId=com.fishpro
artifactId=aoplog
3)选择依赖 Spring Web Starter
前面打钩。
4)项目名设置为 spring-boot-study-aoplog
2 Pom 中引入 aop 依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--aop-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
3 编写处理代码
3.1 程序原理及流程
在 Spring Boot 应用程序中使用 @Aspect 注解来实现 aop ,非常的简单。本示例代码主要实现
本代码供新增了4个文件,文件清单如下,斜杠前是包名,需要新建
- annotation/Log.java 自定义日志拦截注解
- aspect/LogAspect.java 自定义日志拦截注解触发条件、环绕增强(在请求前和请求后的执行逻辑)
- aspect/WebLogAspect.java 基于 Web 的日志拦截,定义了 Web 的请求前动作、请求后动作、请求生命周期中的动作
- controller/IndexController.java 控制层 Controller 类,方便测试,定了
/log
本示例使用到的新的注解包括
- @Aspect 面向切面编程注解,通常应用在类上
- @Pointcut Pointcut是植入Advice的触发条件。每个Pointcut的定义包括2部分,一是表达式,二是方法签名。方法签名必须是 public及void型。可以将Pointcut中的方法看作是一个被Advice引用的助记符,因为表达式不直观,因此我们可以通过方法签名的方式为 此表达式命名。因此Pointcut中的方法只需要方法签名,而不需要在方法体内编写实际代码
- @Around:环绕增强,相当于MethodInterceptor
- @AfterReturning:后置增强,相当于AfterReturningAdvice,方法正常退出时执行
- @Before:标识一个前置增强方法,相当于BeforeAdvice的功能,相似功能的还有
- @AfterThrowing:异常抛出增强,相当于ThrowsAdvice
- @After: final增强,不管是抛出异常或者正常退出都会执行
流程说明
如图所示,用户访问 IndexController
的 /log
路由的时候,被 WebLogAspect
拦截到了带有 @log
注解方法的信息,根据 WebLogAspect
中的定义处理了请求前 请求后 请求中的信息 并存于日志中。
3.2 自定义日志注解 @log
本文不打算详细说明什么是自定义注解,如何使用,可以知道的是,
- 注解是一种元数据形式。即注解是属于java的一种数据类型,和类、接口、数组、枚举类似
- 注解用来修饰,类、方法、变量、参数、包。
- 注解不会对所修饰的代码产生直接的影响。
定义注解 @Log,在 anotation 包下 Log.java
/**
* 使用@interface将定义一个注解 这里是log
* 用于日志aop编程
* */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
String value() default "";
}
如何使用,我没有在 IndexController 的方法中使用 @Log 注解
3.3 定义测试用 IndexController
@Controller
public class IndexController {
@Log("日志注解,配合WebAspect记录请求前、请求后、请求过程")
@RequestMapping("/log")
@ResponseBody
public String log(String name){
return "log";
}
}
3.4 定义 aop 类 LogAspect 与 WebLogAspect
@Aspect
@Component
public class LogAspect {
private static final Logger logger=LoggerFactory.getLogger(LogAspect.class);
/**
* 这里指定使用 @annotation 指定com.fishpro.aoplog.annotation.Log log注解
* */
@Pointcut("@annotation(com.fishpro.aoplog.annotation.Log)")
public void logPointCut(){
}
public Object around(ProceedingJoinPoint point) throws Throwable{
long beginTime = System.currentTimeMillis();
// 执行方法
Object result = point.proceed();
// 执行时长(毫秒)
long time = System.currentTimeMillis() - beginTime;
//异步保存日志 这里是文本日志
return result;
}
void saveLog(ProceedingJoinPoint joinPoint, long time) throws InterruptedException{
}
}
@Aspect
@Component
public class WebLogAspect {
private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
/**
* 指定 controller 包下的注解
* */
@Pointcut("execution( * com.fishpro.aoplog.controller.*.*(..))")//两个..代表所有子目录,最后括号里的两个..代表所有参数
public void logPointCut() {
}
/**
* 指定当前执行方法在logPointCut之前执行
* */
@Before("logPointCut()")
public void doBefore(JoinPoint joinPoint) throws Throwable{
// 接收到请求,记录请求内容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 记录下请求内容
logger.info("请求地址 : " + request.getRequestURL().toString());
logger.info("HTTP METHOD : " + request.getMethod());
// 获取真实的ip地址
//logger.info("IP : " + IPAddressUtil.getClientIpAddress(request));
logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
+ joinPoint.getSignature().getName());
logger.info("参数 : " + Arrays.toString(joinPoint.getArgs()));
//loggger.info("参数 : " + joinPoint.getArgs());
}
/**
* 指定在方法之后返回
* */
@AfterReturning(returning = "ret", pointcut = "logPointCut()")// returning的值和doAfterReturning的参数名一致
public void doAfterReturning(Object ret) throws Throwable {
// 处理完请求,返回内容(返回值太复杂时,打印的是物理存储空间的地址)
logger.info("返回值 : " + ret);
}
@Around("logPointCut()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
long startTime = System.currentTimeMillis();
Object ob = pjp.proceed();// ob 为方法的返回值
logger.info("耗时 : " + (System.currentTimeMillis() - startTime));
return ob;
}
}
3.5 测试
在浏览器输入,注意端口在 application.yml 中已经改为了8085
http://localhost:8085/log?name=fishpro
在控制台输出
2019-07-13 17:12:15.388 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : 请求地址 : http://localhost:8085/log
2019-07-13 17:12:15.388 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : HTTP METHOD : GET
2019-07-13 17:12:15.389 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : CLASS_METHOD : com.fishpro.aoplog.controller.IndexController.log
2019-07-13 17:12:15.389 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : 参数 : [fishpro]
2019-07-13 17:12:17.219 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : 耗时 : 4934
2019-07-13 17:12:17.997 INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect : 返回值 : log
关联阅读:
欢迎关注我的微信公众号,我们一起编程聊天看世界

Spring Boot 使用 Aop 实现日志全局拦截的更多相关文章
- spring boot集成aop实现日志记录
1.pom依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId> ...
- Spring Boot使用AOP的正确姿势
一.为什么需要面向切面编程? 面向对象编程(OOP)的好处是显而易见的,缺点也同样明显.当需要为多个不具有继承关系的对象添加一个公共的方法的时候,例如日志记录.性能监控等,如果采用面向对象编程的方法, ...
- Spring Boot系列一:默认日志logback配置解析
前言 今天来介绍下Spring Boot如何配置日志logback,我刚学习的时候,是带着下面几个问题来查资料的,你呢 如何引入日志? 日志输出格式以及输出方式如何配置? 代码中如何使用? 正文 Sp ...
- Spring Boot学习——AOP编程的简单实现
首先应该明白一点,AOP是一种编程范式,是一种程序设计思想,与具体的计算机编程语言无关,所以不止是Java,像.Net等其他编程语言也有AOP的实现方式.AOP的思想理念就是将通用逻辑从业务逻辑中分离 ...
- spring boot 中AOP的使用
一.AOP统一处理请求日志 也谈AOP 1.AOP是一种编程范式 2.与语言无关,是一种程序设计思想 面向切面(AOP)Aspect Oriented Programming 面向对象(OOP)Obj ...
- spring boot使用slf4j输出日志
spring boot使用slf4j输出日志 https://blog.csdn.net/qq442270636/article/details/79406346 Spring Boot SLF4J日 ...
- Spring Boot Logback几种日志详解
日志对于应用程序来说是非常重要的,Spring框架本身集成了不少其他工具,我们自身的应用也会使用到第三方库,所以我们推荐在Spring应用中使用SLF4J/Logback来记录日志. SLF4J与Lo ...
- Spring Boot中使用logback日志框架
说明:Spring Boot在最新的版本中默认使用了logback框架.一般来说使用时只需在classpath下创建logback.xml即可,而官方推荐使用logback-spring.xml替代, ...
- spring boot使用AOP切面编程
spring boot使用AOP 1.在pom文件中添加依赖: <!--spring boot aop切面--> <dependency> <groupId>org ...
随机推荐
- L1-2 倒数第N个字符串
思路 这题就是一道进制转换,用26进制表示一个数,以及26进制下的数的加减操作. 代码 #include <bits/stdc++.h> using namespace std; int ...
- 二分题 D - Salary Changing codeforce
题意:给出n个人(n是奇数),s钱:s为总的可以付工钱的钱: 每一个工人有一个付工钱的区间,只要在这个区间范围内,随便一个数都可以当作给这个工人付了钱: 老板要付给每个工人钱,并且付钱的中位数要尽可能 ...
- Java通过反射读取泛型
1.在这里有必要先提一句关于javabean,建议有一个构造器,而不是必须要写的,这是一个良好的习惯. 这样做肯定是有好处的,如果你的一个类写了带参的构造方法,而没有写空的构造方法,那么,如有有一个类 ...
- 在VS2017中配置VLD(Visual Leak Detector)内存泄漏检测工具
首先在官方下载VLD 下载地址: https://kinddragon.github.io/vld/ 此版本为V2.5.1,为最后发布版本,下载后安装.加入你的安装路径为:VLD_Path,后面会用到 ...
- QT+VS后中文字符乱码问题
在VS中写QT项目会出现中文乱码现象,尤其是控件的中文乱码以及qDebug()时候中文乱码通用的解决办法: 在头文件(.h)前面加上如下代码: #ifdef WIN32 #pragma executi ...
- 046_使用Scanner获得键盘输入 047_控制语句介绍 048_控制语句_if单选择结构 049_ifelse双选择结构 050_ifelseifelse多选择结构
046_使用Scanner获得键盘输入 package test_package;import java.util.Scanner;/** * 测试获得键盘输入 * @author * */publi ...
- jmeter实现服务器端后台接口性能测试
实现目的 在进行服务器端后台接口性能测试时,需要连接到Linux服务器端,然后通过命令调用socket接口,这个过程就需要用到jmeter的SSH Command取样器实现了. 脚本实现 设置CSV ...
- 解决vscode出现两个光标的问题
转载自本人独立博客:https://liushiming.cn/2020/01/20/vscode-two-cursors-in-vim-mode/ 问题概述 今天用vscode的vim模式编辑htm ...
- 【原】移动端vue页面点透事件 - 分析与解决
近期项目遇到了vue页面事件被带到下一个页面的问题,也就是我们常说的点透事件,主要表现在android机器上,花了不少时间折腾,简单做下总结~ vue页面之间的切换通过Vue Router的route ...
- [HTTP]HTTP/1.1 协议Expect: 100-continue
在追踪请求时发现了这么一个http头 基础知识背景:1)“Expect: 100-continue”的来龙去脉: HTTP/1.1 协议里设计 100 (Continue) HTTP 状态码的的目的是 ...