SpringBoot的日志框架

时间:2020-05-30
本文章向大家介绍SpringBoot的日志框架,主要包括SpringBoot的日志框架使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

Spring Boot与日志

1. 日志框架

市面上的日志框架:

日志门面(抽象层) 日志实现
JCL SLF4j jboss-logging log4j JUL log4j2 logback

对比:

  • jboss-logging:使用场景太少

  • JCL:落后,最后一次更新2014

  • JUL:不强大

  • Log4j2:多数框架无法适配

  • log4j:没有logback完善

日志门面选择:SLF4J

日志实现选择:Logback

SpringBoot:底层是spring框架,spring框架默认是JCL

SpringBoot选用SLF4J和Logback

2.SLF4j使用

1.如何在系统中使用SLF4j

开发的时候,日志记录方法的调用,应该调用日志抽象层里面的方法

给系统里面导入slf4j和logback的jar包

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

图示:

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

2.问题

项目中的多个框架都自带有日志框架,十分混乱,需要进行统一日志记录,要让其他框架都统一使用我们指定的日志框架

利用适配器模式,使用jar包替换原来框架中的日志框架:

  1. 将系统中其他的日志框架先排除出去
  2. 用中间包来替换原有的日志框架
  3. 我们导入slf4j其他的实现

3. SpringBoot日志关系

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.3.0.RELEASE</version>
      <scope>compile</scope>
</dependency>

SpringBoot使用它来做日志功能

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
  <version>2.3.0.RELEASE</version>
  <scope>compile</scope>
</dependency>

总结

  1. SpringBoot底层也是使用slf4j+logback的方式进行日志记录

    1. SpringBoot也把其他的日志都替换成了slf4j
    2. 中间替换包与原来的包类结构几乎一致,只是在最底层的创建logFactory的时候将它创建为我们要使用的slf4j
    3. SpringBoot能自动适配所有日志,底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖 的日志框架配除掉
    4. 注意:新版的spring没有集成commons-logging

关于新版的详细改动参照官方文档

4.日志使用

1.默认配置

SpringBoot默认帮我们配置好了日志

//记录器:记录日志
    Logger logger = LoggerFactory.getLogger(getClass());
@Test
void contextLoads() {

    //日志的级别:
    //由低到高  trace<debug<info<warn<error ,可以调整需要输出的日志级别;
    // 日志只会在这个级别以后的高级别生效
    logger.trace("这是trance日志.........");
    logger.debug("这是debug日志...........");
    //springBoot默认使用info级别及之后的,称为root级别,可以在配置文件中指定
    logger.info("这是info日志.....");
    logger.warn("这是warn日志......");
    logger.error("这是error日志......");

}
指定级别
logging.level.com.jiat=trace

日志输出格式规则:除下的符号,其他输入都原样输出

符号 表示
%d{yyyy-MM-dd HH:mm:ss:SSS} 表示日期时间
%thread 表示线程名
%-5level 级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割
%msg 日志消息
%n 换行符

SpringBoot修改日志的默认配置

注意name和path是冲突的,同时存在只辨别name

#logging.file.name指定完整的路径
logging.file.name=E:/springboot.log

#在当前磁盘(项目所在的磁盘)的根路径下创建spring以及子目录log;使用spring.log作为默认文件
logging.file.path=/spring/log


#在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread]  %-5level %logger{50} -%msg%n
#指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} == [%thread] == %-5level == %logger{50} -%msg%n

2. 制定配置

给类路径下放上每个日志框架自己的配置文件即可;SpirngBoot就不会使用默认配置

Logging System Customization
Logback logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy
Log4j2 log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging) logging.properties

Because the standard logback.xml configuration file is loaded too early, you cannot use extensions in it. You need to either use logback-spring.xml or define a logging.config property.

logback.xml:直接就被日志框架识别了;

logback-spring.xml:日志框架不直接加载日志的配置项,由SpringBoot识别,可以使用高级功能

以下代码添加在<appender>的<layout>中
<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
    <!-- 可以指定某段配置只在特殊环境下生效 -->
</springProfile>
 <springProfile name="dev | staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

5.切换日志框架

可以按照slf4j的日志适配图,进行相关的切换

将不用的日志框架移除,重新添加要使用的日志框架依赖

$flag 上一页 下一页