基于logback 实现springboot超级详细的日志配置

前言

java web 下有好几种日志框架,比如:logback,log4j,log4j2(slj4f 并不是一种日志框架,它相当于定义了规范,实现了这个规范的日志框架就能够用 slj4f 调用)。其中性能最高的应该使 logback 了,而且 springboot 默认使用的也是 logback 日志,所以本篇将会详细的讲解 logback 的日志配置方案。

本篇主要内容如下:

•logback 配置文件的构成
•如何将日志输出到文件
•如何按时间,按大小切分日志
•如何将让一个日志文件中只有一种日志级别
•如何将指定包下的日志输出到指定的日志文件中

简单使用

如果无需复杂的日志配置,执行简单设置日志打印级别,打印方式可直接再 application.yml 中配置。

默认情况下 Spring Boot 将 info 级别的日志输出到控制台中,不会写到日志文件,且不能进行复杂配置。

打印到文件中

想要将日志输出到文件中,可通过如下两个配置:

logging:
 # 配置输出额日志文件名,可以带路径
 # file: out.log
 # 配置日志存放路径,日志文件名为:spring.log
 path: ./log
 file:
  # 设置日志文件大小
  max-size: 10MB

注意:file 和 path 是不能同时配置的,如果同时配置path不会生效。

打印级别控制

可通过配置控制日志打印级别,格式如下:

logging.level.*=TRACE/DEBUG/INFO/...

*可以为包名或 Logger 名,如下:
logging:
 level:
  # root日志以WARN级别输出
  root: info
  # 此包下所有class以DEBUG级别输出
  com.example.log_demo.log1: warn

logback 详细配置

接下来说明如何通过独立的 xml 配置文件来配置日志打印。虽然 springboot 是要消灭 xml 的,但是有些复杂功能还是得编写 xml。使用 xml 后要将 application.yml 中的配置去掉,避免冲突.

根据不同的日志系统,按照指定的规则组织配置文件名,并放在 resources 目录下,就能自动被 spring boot 加载:

•Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
•Log4j: log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
•Log4j2: log4j2-spring.xml, log4j2.xml
•JDK (Java Util Logging): logging.properties

想要自定义文件名的可配置:logging.config指定配置文件名:

logging.config=classpath:logging-config.xml

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml ),命名为 logback-spring.xml 的日志配置文件, spring boot 可以为它添加一些 spring boot 特有的配置项(下面会提到)。

logback 配置文件的组成

根节点<configuration>有 5 个子节点,下面来进行一一介绍。

<root>节点

root 节点是必选节点,用来指定最基础的日志输出级别,只有一个 level 属性,用于设置打印级别,可选如下:TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF。

root 节点可以包含 0 个或多个元素,将appender添加进来。如下:

<root level="debug">
 <appender-ref ref="console" />
 <appender-ref ref="file" />
</root>

appender 也是子节点之一,将会在后面说明。

<contextName>节点

设置上下文名称,默认为default,可通过%contextName来打印上下文名称,一般不使用此属性。

<property>节点

用于定义变量,方便使用。有两个属性:name,value。定义变量后,可以使用${}来使用变量。如下:

<property name="path" value="./log"/>
<property name="appname" value="app"/>

<appender>节点

appender 用来格式化日志输出的节点,这个最重要。有两个属性:

•name:该本 appender 命名
•class:指定输出策略,通常有两种:控制台输出,文件输出

下面通过例子来说明这个怎么用:

1.输出到控制台/按时间输出日志

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
  <!--设置存储路径变量-->
  <property name="LOG_HOME" value="./log"/>

  <!--控制台输出appender-->
  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    <!--设置输出格式-->
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
      <!--设置编码-->
      <charset>UTF-8</charset>
    </encoder>
  </appender>

  <!--文件输出,时间窗口滚动-->
  <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--日志名,指定最新的文件名,其他文件名使用FileNamePattern -->
    <File>${LOG_HOME}/timeFile/out.log</File>
    <!--文件滚动模式-->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!--日志文件输出的文件名,可设置文件类型为gz,开启文件压缩-->
      <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
      <!--日志文件保留天数-->
      <MaxHistory>30</MaxHistory>
      <!--按大小分割同一天的-->
      <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>10MB</maxFileSize>
      </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>

    <!--输出格式-->
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
      <!--设置编码-->
      <charset>UTF-8</charset>
    </encoder>

  </appender>

  <!--指定基础的日志输出级别-->
  <root level="INFO">
    <!--appender将会添加到这个loger-->
    <appender-ref ref="console"/>
    <appender-ref ref="timeFileOutput"/>
  </root>
</configuration>

1.设置只输出单个级别

在 appender 中设置,filter 子节点,在默认级别上再此过滤,配置 onMatch,onMismatch 可实现只输出单个级别

<appender ...>
  <filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>INFO</level>
    <!--接受匹配-->
    <onMatch>ACCEPT</onMatch>
    <!--拒绝不匹配的-->
    <onMismatch>DENY</onMismatch>
  </filter>
</appender>

<logger>节点

构成

此节点用来设置一个包或具体的某一个类的日志打印级别、以及指定<appender>,有以下三个属性:

•name: 必须。用来指定受此 loger 约束的某个包或者某个具体的类
•level:可选。设置打印级别。默认为 root 的级别。
•addtivity: 可选。是否向上级 loger(也就是 root 节点)传递打印信息。默认为 true。

使用示例如下:

1.不指定级别,不指定 appender

<!-- 控制com.example.service下类的打印,使用root的level和appender -->
<logger name="com.example.service"/>

2.指定级别,不指定 appender

<!-- 控制com.example.service下类的打印,使用root的appender打印warn级别日志 -->
<logger name="com.example.service" level="WARN"/>

3.指定级别,指定 appender

<!-- 控制com.example.service下类的打印,使用console打印warn级别日志 -->
<!-- 设置addtivity是因为这里已经指定了appender,如果再向上传递就会被root下的appender再次打印 -->
<logger name="com.example.service" level="WARN" addtivity="false">
  <appender-ref ref="console">
</logger>

通过指定 appender 就能将指定的包下的日志打印到指定的文件中。

多环境日志输出

通过设置文件名为-spring 结尾,可分环境配置 logger,示例如下:

<configuration>
  <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
  <springProfile name="test,dev">
    <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
      <appender-ref ref="console"/>
    </logger>
  </springProfile>
  <!-- 生产环境. -->
  <springProfile name="prod">
    <logger name="com.example.demo" level="INFO" additivity="false">
      <appender-ref ref="timeFileOutput"/>
    </logger>
  </springProfile>
</configuration>

通过配置spring.profiles.active也能做到切换上面的 logger 打印设置

结束

日志打印可以很复杂, 这里只是说明了常用的 logback 配置,代码详见:github

总结

以上所述是小编给大家介绍的基于logback 实现springboot超级详细的日志配置,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对我们网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

(0)

相关推荐

  • 在SpringBoot中使用Logback管理记录日志

    SpringBoot的默认日志配置 SpringBoot 开箱即用,默认帮你配置了日志框架,使用 Commons Logging ,但是默认配置也提供了对常用日志的支持,如: Java Util Logging , Log4J , Log4J2 和 Logback.每种Logger都可以通过配置使用控制台或者文件输出日志内容. 控制台输出 关于log日志,首先说说的5个日志级别 LEVEL: 从高到低分别是 ERROR . WARN . INFO . DEBUG . TRACE 低级别的会输出高

  • SpringBoot日志配置简单介绍

    1.在application.properties文件中加入logging.level.root=debug 全部日志级别设置为debug:这里的root是包的级别,root表示所有的包用同一个日志级别:如果把等号后面设置为off表示关闭日志: 2.logging.file=/data/tpmslogs/tpms.log,指定日志文件的路径和名称: 3.logging.pattern.console= 设置控制台输出的日志格式 4.logging.file.console= 设置文件输出的日志格

  • SpringBoot中logback日志保存到mongoDB的方法

    Springboot默认集成的就是logback,logback相对来说是优秀于log4j的,log4j2也是参考了logback的设计. 自定义Appender非常简单,继承一下AppenderBase类即可. 可以看到有个AppenderBase,有个UnsynchronizedAppenderBase,还有个AsyncAppenderBase继承了UnsynchronizedAppenderBase.从名字就能看出来区别,异步的.普通的.不加锁的. 我们定义一个MongoDBAppend

  • SpringBoot通过yml和xml文件配置日志输出方法

    SpringBoot中默认使用Logback进行日志输出,可以同时使用SpringBoot框架的配置文件application.yml或是通过logback的配置文件logback.xml进行配置. 通过application.yml配置 <?xml version="1.0" encoding="UTF-8"?> <configuration debug="false"> <!--定义日志文件的存储地址 勿在 Lo

  • 基于logback 实现springboot超级详细的日志配置

    前言 java web 下有好几种日志框架,比如:logback,log4j,log4j2(slj4f 并不是一种日志框架,它相当于定义了规范,实现了这个规范的日志框架就能够用 slj4f 调用).其中性能最高的应该使 logback 了,而且 springboot 默认使用的也是 logback 日志,所以本篇将会详细的讲解 logback 的日志配置方案. 本篇主要内容如下: •logback 配置文件的构成 •如何将日志输出到文件 •如何按时间,按大小切分日志 •如何将让一个日志文件中只有

  • SpringBoot超详细讲解自动配置原理

    目录 SpringBoot自动配置原理 SpringBoot特点 1.依赖管理 A.父项目做依赖管理 B.开发导入starter场景启动器 C.可以修改默认版本号 2.自动配置 A.自动配好Tomcat B.自动配好SpringMVC C.默认的包结构 D.各种配置拥有默认值 E.按需要加载所有自动配置项 SpringBoot自动配置原理 了解SpringBoot自动配置原理 1.SpringBoot特点 2.容器功能 3.自动配置原理入门 4.开发技巧 SpringBoot特点 1.依赖管理

  • SpringBoot项目的logback日志配置(包括打印mybatis的sql语句)

    关于logback日志的详解见这位仁兄的博客:Spring Boot-日志配置(超详细) 我在这就开门见山直接介绍我们项目日志的配置使用吧!~ 1.基本介绍 默认情况下,Spring Boot项目就会用Logback来记录日志,并用INFO级别输出到控制台.如下图: 实际开发中我们不需要直接添加logback日志依赖. 你会发现 spring-boot-starter 其中包含了 spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架 lo

  • springboot利用@Aspect实现日志工具类的详细代码

    目录 一.导包 二.在启动类上进行注解自动扫描 三.工具类 四.结果 一.导包 <dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjrt</artifactId> <version>1.8.12</version> </dependency> <dependency> <groupId>org.aspectj<

  • springboot利用AOP完成日志统计的详细步骤

    目录 1.创建日志表 2.创建实体类 3.创建枚举类 4.创建自定义注解 5.获取ip的util 6.线程池util 7.HttpServletRequest实现类 8.添加过滤器 9.添加AOP核心类 10.接口测试 步骤写的很详细,可以直接复制拿来用的,其中用到了过滤器.自定义注解以及AOP切面,来完成日志记录统计,感兴趣的收藏起来,以后遇到了可以直接用. 可能步骤会比较多,但是整体跟着思路下来,应该没什么大问题的. 项目用到了过滤器,可能有的人会不理解,之所以用过滤器是因为想要在日志记录p

  • SpringBoot详细讲解日志文件

    目录 1 日志的功能是什么? 2 如何自定义日志打印 2.1 在程序中获取日志对象 2.2 调用日志对象打印日志 2.3 查看日志打印的结果 3 日志的级别 3.1 日志级别的分类 3.2 日志级别的设置 4 日志持久化 5 更简单的日志输出 5.1 添加 lombok 依赖 5.2 输出日志 5.3 lombok 更多的注解 1 日志的功能是什么? 如果程序报错了, 却不能从控制台查看日志, 那么就不知道错误的原因了. 日志的功能 : 快速的排查和定位问题 记录用户登录的日志 记录系统的操作日

  • Springboot使用Logback实现日志配置与异常记录

    目录 概述 logback配置详解 logback配置 异常情况 概述 默认情况下,SpringBoot内部使用logback作为系统日志实现的框架,将日志输出到控制台,不会写到日志文件.如果在application.properties或application.yml配置,这样只能配置简单的场景,保存路径.日志格式等.复杂的场景(区分 info 和 error 的日志.每天产生一个日志文件等)满足不了,只能自定义配置文件logback-spring.xml或者logback.xml.本篇文章主

  • Spring Boot 日志配置方法(超详细)

    默认日志 Logback : 默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台.在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了. 从上图可以看到,日志输出内容元素具体如下: 时间日期:精确到毫秒 日志级别:ERROR, WARN, INFO, DEBUG or TRACE 进程ID 分隔符:- 标识实际日志的开始 线程名:方括号括起来(可能会截断控制台输出) Logger名:通常使用源代码的类名 日志内容 添加日志依赖 假如mave

  • spring boot使用logback实现多环境日志配置详解

    软件生存周期中,涉及代码运行的环节有编码.测试和维护阶段,而一套成熟的代码,在此三个阶段,数据库.日志路径.日志级别.线程池大小等配置一般会不一样.作为开发人员,希望将代码与配置解耦合,不同的环境,代码一套,而配置多套. 针对于多环境的配置,可以使用maven的profile及filter配置,在打包环节通过打包命令 mvn clean package -P dev/test/product决定所打环境的war/jar包.此种解决方案,产生的war\jar包在不同环境的是不同的,因此MD5校验和

  • 浅谈SpringBoot是如何实现日志的

    前言 休息日闲着无聊看了下 SpringBoot 中的日志实现,把我的理解跟大家说下. 门面模式 说到日志框架不得不说门面模式.门面模式,其核心为外部与一个子系统的通信必须通过一个统一的外观对象进行,使得子系统更易于使用.用一张图来表示门面模式的结构为: 简单来说,该模式就是把一些复杂的流程封装成一个接口供给外部用户更简单的使用.这个模式中,设计到3个角色. 1).门面角色:外观模式的核心.它被客户角色调用,它熟悉子系统的功能.内部根据客户角色的需求预定了几种功能的组合(模块). 2).子系统(

随机推荐