SpringBoot统一日志框架
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot统一日志框架相关的知识,希望对你有一定的参考价值。
参考技术A 通常一个完整的应用下会依赖于多种不同的框架,而且它们记录日志使用的日志框架也不尽相同。我们在使用 Spring Boot 时,同样可能用到其他的框架,这些框架的底层都有自己的日志框架,此时我们也需要对日志框架进行统一。SLF4J 官方给出的统一日志框架的方案一共需要以下 3 步 :
Soring Boot 作为一款优秀的开箱即用的框架,已经为用户完成了其中 2 步:引入替换包和导入 SLF4J 实现。我们按住Ctrl,点击spring-boot-starter-web,查看spring-boot-starter-web的Maven依赖,可以看到spring-boot-starter,如下图:
我们再按住Ctrl,点击spring-boot-starter,查看spring-boot-starter的Maven依赖,可以看到spring-boot-starter-logging,如下图:
继续按住Ctrl,点击spring-boot-starter-logging,查看spring-boot-starter-logging的Maven依赖,如下图:
从图上我们可以看出spring-boot-starter-logging 的 Maven 依赖不但引入了 logback-classic (包含了日志框架 SLF4J 的实现),还引入了 log4j-to-slf4j(log4j 的替换包),jul-to-slf4j (JUL 的替换包),即 Spring Boot 已经为我们完成了统一日志框架的 3 个步骤中的 2 步。
SpringBoot 底层使用 slf4j+logback 的方式记录日志,当我们引入了依赖了其他日志框架的第三方框架时,只需要把这个框架所依赖的日志框架排除,即可实现日志框架的统一。比如下图:
日志配置
根据项目需要我们还可以在配置文件配置日志的一些属性。如下图:
运行项目我们可以看到配置已经生效了,项目结构中出现了配置的日志输出文件my.log。
SPRINGBOOT9--AOP的使用(本例展示统一处理Web请求日志)
AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。
AOP是Spring框架中的一个重要内容,它通过对既有程序定义一个切入点,然后在其前后切入不同的执行内容,比如常见的有:
打开数据库连接/关闭数据库连接、打开事务/关闭事务、记录日志等。基于AOP不会破坏原来程序逻辑,因此它可以很好的对业务逻辑的各个部分进行隔离,
从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。
准备工作:
pom中引入:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
* Spring Boot中使用AOP统一处理Web请求日志
* 使用@Aspect注解将一个java类定义为切面类
* 使用@Pointcut定义一个切入点,可以是一个规则表达式,比如下例中某个package下的所有函数,也可以是一个注解等。
* 根据需要在切入点不同位置的切入内容
* 使用@Before在切入点开始处切入内容
* 使用@After在切入点结尾处切入内容
* 使用@AfterReturning在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
* 使用@Around在切入点前后切入内容,并自己控制何时执行切入点自身的内容
* 使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑
/***
* 在WebLogAspect切面中,分别通过doBefore和doAfterReturning两个独立函数实现了切点头部和
* 切点返回后执行的内容,若我们想统计请求的处理时间,就需要在doBefore处记录时间,并在doAfterReturning
* 处通过当前时间与开始处记录的时间计算得到请求处理的消耗时间。
* 那么我们是否可以在WebLogAspect切面中定义一个成员变量来给doBefore和doAfterReturning一起访问呢?
* 是否会有同步问题呢?
* 的确,直接在这里定义基本类型会有同步问题,所以我们可以引入ThreadLocal对象
*/
/***
* 优化:AOP切面的优先级
* 由于通过AOP实现,程序得到了很好的解耦,但是也会带来一些问题,比如:我们可能会对Web层做多个切面,校验用户,校验头信息等等,这个时候经常会碰到切面的处理顺序问题。
* 所以,我们需要定义每个切面的优先级,我们需要@Order(i)注解来标识切面的优先级。i的值越小,优先级越高。假设我们还有一个切面是CheckNameAspect用来校验name必须为didi,
* 我们为其设置@Order(10),而上文中WebLogAspect设置为@Order(5),所以WebLogAspect有更高的优先级,这个时候执行顺序是这样的:
* 在@Before中优先执行@Order(5)的内容,再执行@Order(10)的内容
* 在@After和@AfterReturning中优先执行@Order(10)的内容,再执行@Order(5)的内容
* 所以我们可以这样子总结:
* 在切入点前的操作,按order的值由小到大执行
* 在切入点后的操作,按order的值由大到小执行
*/
以上是关于SpringBoot统一日志框架的主要内容,如果未能解决你的问题,请参考以下文章
Java分享客栈 超简洁SpringBoot使用AOP统一日志管理