SpringBoot——日志及原理

2021-03-14 19:28

阅读:631

标签:cte   net   his   gap   需要   实时   前缀   stat   命名   

一、SpringBoot日志


选用 SLF4j(接口)和 logback(实现类),除了上述日志框架,市场上还存在 JUL(java.util.logging)、JCL(Apache Commons Logging)、Log4j、Log4j2、SLF4j、jboss-logging 等。SpringBoot 在框架内部使用JCL,SpringBoot 的 spring-boot-starter-logging 采用了 SLF4j+logback 的形式,SpringBoot 也能自动适配(jul、log4j2、logback)并简化配置。其实 logback 是 log4j 的升级版,因为 log4j 在性能上有缺陷(因为log4j在多线程情况下,会竞争 Logger的锁),且 SLF4j 也是 logback 的开发者开发的一个日志接口(日志门面)。

日志门面 日志实现

JCL(Jakarta Commons Logging)

SLF4J(Simple Logging Facade for Java)

Jobss-logging

Log4j

JUL(Java Util Logging)

Log4j2

Logback

二、SLF4j 使用


【1】以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象类层里面的方法。
 ● 给系统里面导入 slf4j 的 jar和 logback 的实现 jar,Java 类中的使用如下所示:很常用

1 import org.slf4j.Logger;
2 import org.slf4j.LoggerFactory;
3 
4 public class HelloWorld {
5   public static void main(String[] args) {
6     Logger logger = LoggerFactory.getLogger(HelloWorld.class);//记录器
7     logger.info("Hello World");
8   }
9 }

● 根据 SLF4J抽象类,提供实现类的时候,SLF4j 官方提供的配置逻辑如下所示,有的需要加入整合的jar包。

技术图片

注意:每一个日志的实现框架都有自己的配置文件。使用 slf4j以后,配置文件还是做成日志实现框架自己本身的配置文件

【2】常见问题:同一个系统中,包涵多种框架可能就会使用多种日志记录(slf4j+logback)、Spring(commons-logging)、Hibernate(Jboss-logging)、MyBatis等,如果我们要统一使用slf4j记录日志,思想如下:
    ?  将系统中其他日志框架先排除出去;
    ?  用中间包替换原有的日志框架;
    ?  我们导入 slf4j唯一日志的实现;具体可见下方,官方给出的图解:
技术图片技术图片?

三、Spring Boot日志关系


测试 springBoot 的日志使用,首先引入日志的 starter启动器。
 ? 首先我们查看下 pom.xml中的依赖关系:右键——>Diagrams——>Show Dependencies...  
技术图片技术图片?
 ? 可以查看到我们我们使用最多的启动器:spring‐boot‐starter

1 dependency>
2     groupId>org.springframework.bootgroupId>
3     artifactId>spring‐boot‐starterartifactId>
4 dependency>

 ? 而我们使用的日志启动器 spring‐boot‐starter‐logging 依赖于 spring‐boot‐starter,SpringBoot 使用它来做日志功能:

1 dependency>
2     groupId>org.springframework.bootgroupId>
3     artifactId>spring‐boot‐starter‐loggingartifactId>
4 dependency>

? 而spring‐boot‐starter‐logging 启动器的底层依赖实现关系如下:
技术图片技术图片?
总结:1)、SpringBoot 底层也是使用 slf4j+logback 的方式进行日志记录的。
    2)、SpringBoot 也考虑到了其他日志,将他们都替换成了 slf4通过替换包。
    3)、中间替换包?我们通过引入的jar包查看究竟:
技术图片技术图片?

    4)、如果我们引入了其他框架?一定要把这个框架的默认日志依赖移除掉。我们点进 spring‐boot‐starter‐logging 会发现如下SpringBoot 引入 springframework 依赖时自动排除了 commons-logging 依赖,避免冲突,我们也应如此。

 1 dependency>
 2     groupId>org.springframeworkgroupId>
 3     artifactId>spring‐coreartifactId>
 4     exclusions>
 5         exclusion>
 6             groupId>commons‐logginggroupId>
 7             artifactId>commons‐loggingartifactId>
 8         exclusion>
 9     exclusions>
10 dependency>

总结:SpringBoot 能够自动适配所有的日志,而且底层使用 slf4j+logback 的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉。

四、日志使用


【1】默认配置:SpringBoot 已经帮我们配置好了日志,日志级别=info。

 1 //日志记录器
 2 Logger logger = LoggerFactory.getLogger(getClass());
 3 
 4 @Test
 5 public void contextLoads() {
 6     //日志的级别:优先级tracedebug 7     //可以调整输出的日志级别;日志就只会在这个级别及以后的高级别生效
 8     logger.trace("这是跟踪日志");
 9     logger.debug("这是调试日志");
10     //SpringBoot默认使用的是 info级别的;root级别
11     logger.info("这是自定义");
12     logger.warn("这是警告日志");
13     logger.error("这是错误日志");
14 }

【2】修改日志级别,可以细化到给包分配级别,配置文件中配置如下:

 1 #修改打印级别 == 可以细化到包级别
 2 logging.level.com=trace
 3 #下面path与file都不指定时,日志输出到控制台,两个都指定时,file生效
 4 #指定目录,文件名默认spring.log中,如下是在当前磁盘根路径下创建var文件和里面的log文件。
 5 logging.path=/var/log  
 6 #指定文件名 当前项目下生成springboot.log日志,也可以指定到本地文件中d:/springboot.log等
 7 logging.file=springboot.log
 8 #在控制台日志输入的格式
 9 logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
10 #在文件中日志输出的格式
11 #日志输出格式:
12 #    %d表示日期时间,
13 #    %thread表示线程名,
14 #    %‐5level:级别从左显示5个字符宽度
15 #    %logger{50} 表示logger名字最长50个字符,否则按照句点分割。
16 #    %msg:日志消息,
17 #    %n是换行符
18 logging.pattern.file=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n

【3】SpringBoot 的默认日志配置位于 spring-boot-1.5.17.RELEASE.jar:org.springframework.boot:logging 文件,例如查看logback 文件夹中的 base.xml 和 defaults.xml。

 1 
 2 included>
 3     include resource="org/springframework/boot/logging/logback/defaults.xml" />
 4     property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
 5     include resource="org/springframework/boot/logging/logback/console-appender.xml" />
 6     include resource="org/springframework/boot/logging/logback/file-appender.xml" />
 7         
 8     root level="INFO">
 9         appender-ref ref="CONSOLE" />
10         appender-ref ref="FILE" />
11     root>
12 included>

【4】如果觉得日志配置不够用,客户可以自己指定配置:给类路径下(resource)放每个日志框架自己定义的配置文件即可(如下名称的日志文件),这样 SpringBoot 就不适用默认配置。可以参考 SpringBoot 官网中的 logging模块。
技术图片

 ● 例如创建如上的 logback.xml 放入 resource中,将会直接被日志框架直接识别了。内容如下,作为参考:

 1 xml version="1.0" encoding="UTF-8"?>
 2 
 7 configuration scan="false" scanPeriod="60 seconds" debug="false">
 8     
 9     property name="LOG_HOME" value="/app/log" />
10     
11     property name="appName" value="atguigu-springboot">property>
12     
13     appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
14         
23         layout class="ch.qos.logback.classic.PatternLayout">
24             pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
25         layout>
26     appender>
27 
28       
29     appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
30         
31         file>${LOG_HOME}/${appName}.logfile>
32         
36         rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
37             
41             fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
42             
47             MaxHistory>365MaxHistory>
48             
51             timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
52                 maxFileSize>100MBmaxFileSize>
53             timeBasedFileNamingAndTriggeringPolicy>
54         rollingPolicy>
55              
56         layout class="ch.qos.logback.classic.PatternLayout">
57             pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%npattern>
58         layout>
59     appender>
60 
61     
69     
70     logger name="com.atguigu" level="debug" />
71     
72     logger name="org.springframework" level="debug" additivity="false">logger>
73 
74     
78     root level="info">
79         appender-ref ref="stdout" />
80         appender-ref ref="appLogAppender" />
81     root>
82 configuration> 

● 当命名中带有 spring 时,例如:logback-spring.xml:日志框架就不直接加载日志的配置项,由 SpringBoot解析日志配置,但可以使用 SpringBoot的高级 springProfile功能,如下配置。如果不带 spring使用 springProfile标签时就会出错。

1 layout class="ch.qos.logback.classic.PatternLayout">
2     
3     springProfile name="dev">
4         pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐ %msg%npattern>
5     springProfile>
6     springProfile name="!dev">
7         pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level%logger{50} ‐ %msg%npattern>
8     springProfile>
9 layout>

五、切换日志框架


根据官方文档如下配置:可以看出首先排除 logging启动器,依赖 log4j2的启动器即可。(排除:可以通过 pom.xml的依赖视图,右键Exclude)

 1 dependency>
 2     groupId>org.springframework.bootgroupId>
 3     artifactId>spring-boot-starter-webartifactId>
 4 dependency>
 5 dependency>
 6     groupId>org.springframework.bootgroupId>
 7     artifactId>spring-boot-starterartifactId>
 8     exclusions>
 9         exclusion>
10             groupId>org.springframework.bootgroupId>
11             artifactId>spring-boot-starter-loggingartifactId>
12         exclusion>
13     exclusions>
14 dependency>
15 dependency>
16     groupId>org.springframework.bootgroupId>
17     artifactId>spring-boot-starter-log4j2artifactId>
18 dependency>

六、按天分类日志


logback-spring.xml 配置如下:

 1   
 2  appender name="logFile" class="ch.qos.logback.core.rolling.RollingFileAppender">                   
 3      Prudent>truePrudent> 
 4      rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
 5          FileNamePattern> applog/%d{yyyy-MM-dd}/%d{yyyy-MM-dd}.log FileNamePattern> 
 6      rollingPolicy> 
 7      layout class="ch.qos.logback.classic.PatternLayout"> 
 8          Pattern> %d{yyyy-MM-dd HH:mm:ss} -%msg%n Pattern> 
 9      layout> 
10  appender>

SpringBoot——日志及原理

标签:cte   net   his   gap   需要   实时   前缀   stat   命名   

原文地址:https://www.cnblogs.com/zhengzhaoxiang/p/13976389.html


评论


亲,登录后才可以留言!