SpringBoot系列:8、日志slf4j

1、概述

市场上有非常多的日志框架,比如:JUL(java.util.logging)、JCL(Apache Commons-Logging)、Log4j、Log4j2、Logback、SLF4j、jboss-logging等等。SpringBoot在框架内部使用的是JCL,spring-boot-starter-logging采用了slf4j+logback的形式,同时SpringBoot也能自动适配(JUL、log4j2、lobback)并简化配置。

  • 日志门面(日志的一个抽象层)
    • JCL(Apache Commons-Logging)
    • SLF4j
    • jboss-logging
  • 日志实现
    • Log4j
    • JUL(java.util.logging)
    • Log4j2
    • Logback

2、SLF4j使用

2.1 如何在系统中使用SLF4j

官方的用户手册地址:http://www.slf4j.org/manual.html

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的jar和logback的实现jar,调用日志记录方法时,不直接调用日志的实现类而是调用日志的抽象层方法。slf4j具体的使用可以参考下图:


file

2.2 使用统一的日志框架

让系统中所有的日志都统一到slf4j:

  • 将系统的其他日志框架先排除掉
  • 用中间包来替换原有的日志框架
  • 导入slf4j其他的实现
    file

3、SpringBoot的日志关系

3.1 创建项目

新建一个项目springboot-logging,其中pom.xml的依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

3.2 查看日志依赖关系

SpringBoot使用的日志功能:

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

在IDEA中打开pom.xml文件,查看依赖关系,如下图所示:

file

  • SpringBoot底层的日志也是使用slf4j+logback的方式进行日志记录
  • SpringBoot把其他的日志都替换成slf4j

3.3 日志的使用

1、SpringBoot默认的日志级别是info,在测试类中添加以下代码并运行。

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootLoggingApplicationTests {

    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    public void contextLoads() {

        // 日志级别,由低到高,trace < debug < info < warn < error
        logger.trace("这是Trace日志...");
        logger.debug("这是debug日志...");
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("设施error日志...");

    }

}

运行结果:

file

2、修改日志级别
在application.yml配置文件中增加以下配置:

logging:
  level:
    com:
      xiaoh:
        springboot:
          logging: trace

在运行单元测试,结果如下:

file

3、日志的其他配置

logging:
  level:
    com:
      xiaoh:
        springboot:
          logging: trace
  # 不指定路径时,在当前项目下生成springboot.log日志
  # 也可以指定完整的路径
  #file: springboot.log
  # 指定目录,日志文件使用默认的spring.log
  path: /spring/log
  pattern:
    # 在控制台输出的日志格式
    console: %d{yyyy-MM-dd HH:mm:ss.SSS} {%thread} %-5level %logger{50} - %msg%n
    # 在文件中的日志格式
    file: %d{yyyy-MM-dd HH:mm:ss.SSS} {%thread} %-5level %logger{50} - %msg%n

日志输出格式:
- %d:表示日期时间
- %thread:表示线程名
- %-5level:表示级别从左显示5个字符宽度
- %logger{50}:表示logger名字最长50个字符,否则按照句点分隔
- %msg:日志消息
- %n:换行符

4、如何自定义配置文件
参考官方文档:https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-logging.html#boot-features-custom-log-configuration

file

在resources目录下新建一个配置文件logback-spring.xml:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
  <!-- appender是configuration的子节点,是负责写日志的组件。 -->
  <!-- ConsoleAppender:把日志输出到控制台 -->
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>[ %-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n</pattern>
      <!-- 控制台也要使用UTF-8,不要使用GBK,否则会中文乱码 -->
      <charset>UTF-8</charset>
    </encoder>
  </appender>
  <!-- RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
  <!-- 以下的大概意思是:1.先按日期存日志,日期变了,将前一天的日志文件名重命名为XXX%日期%索引,新的日志仍然是demo.log -->
  <!--             2.如果日期没有发生变化,但是当前日志的文件大小超过1KB时,对当前日志进行分割 重命名-->
  <appender name="springbootlog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--<File>logs/iot-%d{yyyy-MM-dd}.%i.log</File> -->
    <!-- rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。 -->
    <!-- TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- 活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次 -->
      <!-- 文件名:log/demo.2017-12-05.0.log -->
      <fileNamePattern>${LOG_HOME}/logs/APP-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <!-- 每产生一个日志文件,该日志文件的保存期限为30天 -->
      <maxHistory>30</maxHistory>
      <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <!-- maxFileSize:这是活动文件的大小,默认值是10MB,测试时可改成1KB看效果 -->
        <maxFileSize>64MB</maxFileSize>
      </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder>
      <!-- pattern节点,用来设置日志的输入格式 -->
      <pattern>
        [ %-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n
      </pattern>
      <!-- 记录日志的编码:此处设置字符集 - -->
      <charset>UTF-8</charset>
    </encoder>
  </appender>
  <!-- 控制台输出日志级别 -->
  <root level="info">
    <appender-ref ref="STDOUT" />
  </root>
  <!-- 指定项目中某个包,当有日志操作行为时的日志记录级别 -->
  <!-- com.liyan为根包,也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
  <!-- 级别依次为【从高到低】:FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
  <logger name="com.xiaoh.springboot" level="INFO">
    <appender-ref ref="springbootlog" />
  </logger>
</configuration>

4、源码

GitHub:https://github.com/chenjiecg/SpringBoot.git

本文由博客一文多发平台 OpenWrite 发布!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,919评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,567评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,316评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,294评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,318评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,245评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,120评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,964评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,376评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,592评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,764评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,460评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,070评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,697评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,846评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,819评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,665评论 2 354

推荐阅读更多精彩内容