SpringBoot日志框架logback

时间  2019-11-29
标签 springboot 日志 框架 logback 栏目 Spring 繁體版
原文   原文链接
  • 简单日志配置
  • logback的介绍及配置
  • logback的使用
  • logback.xml配置示例
一.简单日志配置

spring boot内部使用Commons Logging来记录日志，但也保留外部接口可让一些日志框架来进行实现，例如Java Util Logging,Log4J2还有Logback。若是你想用某一种日志框架来进行实现的话，就必须先配置，默认状况下，spring boot使用Logback做为日志实现的框架。html

1.1 配置控制台日志的debug级别 默认状况下，spring boot从控制台打印出来的日志级别只有ERROR, WARN 还有INFO，若是你想要打印debug级别的日志，能够经过application.properites配置debug=truejava

1.2 在生产环境环境下，你能够经过命令行进行配置日志的debug级别 java -jar C:\Users\Administrator\app\xx\demo.jar --debugmysql

1.3 配置logging.level.*来具体输出哪些包的日志级别 logging.level.root=INFO logging.level.org.springframework.web=DEBUG logging.level.org.hibernate=ERRORweb

1.4 将日志输出到文件中 默认状况下spring boot是不将日志输出到日志文件中，但你能够经过在application.properites文件中配置logging.file文件名称和logging.path文件路径，将日志输出到文件中 logging.path=F:\demo logging.file=demo.log logging.level.root=infospring

这里须要注意几点： 这里若不配置具体的包的日志级别，日志文件信息将为空 若只配置logging.path，那么将会在F:\demo文件夹生成一个日志文件为spring.log（该文件名是固定的，不能更改）。若是path路径不存在，会自动建立该文件夹 若只配置logging.file，那将会在项目的当前路径下生成一个demo.log日志文件。这里可使用绝对路径如，会自动在e盘下建立文件夹和相应的日志文件。 logging.file=E:\demo\demo.logsql

logging.path和logging.file同时配置，不会在这个路径有F:\demo\demo.log日志生成，logging.path和logging.file不会进行叠加（要注意） logging.path和logging.file的value均可以是相对路径或者绝对路径 这就是基础的日志配置，能够直接在application.properties配置，咱们还能够在classpath路径下，经过定义具体的日志文件来配置——logback.xml数据库

二. logback的介绍及配置

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分红三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你能够很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供经过Http来访问日志的功能。 Logback是要与SLF4J结合起来用两个组件的官方网站以下：   点击查看——>logback的官方网站   点击查看——> SLF4J的官方网站apache

maven配置安全

<groupId>ch.qos.logback</groupId>  
       <artifactId>logback-classic</artifactId>  
    <version>1.0.11</version>  
</dependency> 
复制代码

Logback优势 Logback和log4j是很是类似的，若是你对log4j很熟悉，那对logback很快就会驾轻就熟。下面列了logback相对于log4j的一些优势：springboot

1.更快的实现  Logback的内核重写了，在一些关键执行路径上性能提高10倍以上。并且logback不只性能提高了，初始化内存加载也更小了。

二、很是充分的测试  Logback通过了几年，数不清小时的测试。Logback的测试彻底不一样级别的。在做者的观点，这是简单重要的缘由选择logback而不是log4j。

三、 Logback-classic实现了 SLF4j   在使用SLF4j中，你都感受不到logback-classic。并且由于logback-classic很是天然地实现了SLF4J，  所 以切换到log4j或者其余，很是容易，只须要提供成另外一个jar包就OK，根本不须要去动那些经过SLF4JAPI实现的代码。

四、自动从新加载配置文件  当配置文件修改了，Logback-classic能自动从新加载配置文件。扫描过程快且安全，它并不须要另外建立一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。

五、配置文件能够处理不一样的状况 开发人员常常须要判断不一样的Logback配置文件在不一样的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不一样，能够经过,和来实现，这样一个配置文件就能够适应多个环境。

六、Filters（过滤器） 有些时候，须要诊断一个问题，须要打出日志。在log4j，只有下降日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你能够继续 保持那个日志级别而除掉某种特殊状况，如alice这个用户登陆，她的日志将打在DEBUG级别而其余用户能够继续打在WARN级别。要实现这个功能只需 加4行XML配置。能够参考MDCFIlter 。

七、SiftingAppender（一个很是多功能的Appender）  它能够用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender可以区别日志事件跟进用户的Session，而后每一个用户会有一个日志文件。

八、自动压缩已经打出来的log  RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，因此甚至对于大的日志文件，在压缩过程当中应用不会受任何影响。

九、堆栈树带有包版本 Logback在打出堆栈树日志时，会带上包的数据。

十、自动去除旧的日志文件  经过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你能够控制已经产生日志文件的最大数量。若是设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

2.3 Logback的配置介绍

一、Logger、appender及layout Logger做为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也能够定义日志类型、级别。 Appender主要用于指定日志输出的目的地，目的地能够是控制台、文件、远程套接字服务器、 MySQL、 PostreSQL、 Oracle和其余数据库、 JMS和远程UNIX Syslog守护进程等。  Layout 负责把事件转换成字符串，格式化的日志信息的输出。

二、logger context 各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各 logger。其余全部logger也经过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger 名称为参数。用同一名字调用LoggerFactory.getLogger 方法所获得的永远都是同一个logger对象的引用。

三、有效级别及级别的继承 Logger 能够被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于 ch.qos.logback.classic.Level类。若是 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

四、打印方法与基本的选择规则 打印方法决定记录请求的级别。例如，若是 L 是一个 logger 实例，那么，语句 L.info("..")是一条级别为 INFO 的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，不然，称为被禁用。记录请求级别为 p，其logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。 该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

3、Logback的使用

Logback使用介绍：

1、:Logback配置根元素 属性包括： 1,scan: 当此属性设置为true时，配置文件若是发生改变，将会被从新加载，默认值为true。 2,scanPeriod: 设置监测配置文件是否有修改的时间间隔，若是没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 3,debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 子元素： ：上下文名字； :定义属性，可使用${}在配置文件中使用； 二，：在logback中是用于具体记录日志的组件，能够用来配置日志记录方式，日志记录格式等； 属性包括： name:appender的名字，用于下面在配置日志的时候指定； class:使用到的appender类； 常见的appender： 1，ch.qos.logback.core.ConsoleAppender:输出到控制台； 2，ch.qos.logback.core.FileAppender：输出到文件； 3，ch.qos.logback.core.rolling.RollingFileAppender：输出到文件，能够配置滚动策略，当日志达到某个条件以后分文件记录； 4，还有其余的appender，好比写到数据库等； 元素的基本格式： ... 元素用来规定日志的输出格式，全部表达式都以%开始表示接下来是一个特殊标识符 常见标识符： 1，%logger{n}：输出Logger对象类名，n表明长度； 2，%class{n}:输出所在类名， 3，d{pattern}或者date{pattern}：输出日志日期，格式同java； 4，L/line：日志所在行号； 5，m/msg：日志内容； 6，method：所在方法名称； 7，p/level：日志级别； 8，thread：所在线程名称；

3.1 Logback的默认配置 若是配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，建立一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。

一、Logback的配置文件 Logback 配置文件的语法很是灵活。正由于灵活，因此没法用 DTD 或 XML schema 进行定义。尽管如此，能够这样描述配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。

二、Logback默认配置的步骤

(1). 尝试在 classpath 下查找文件 logback-test.xml； (2). 若是文件不存在，则查找文件 logback.xml； (3). 若是两个文件都不存在，logback 用 Bas icConfigurator 自动对本身进行配置，这会致使记录输出到控制台。

三、logback-spring.xml 文件

springboot默认支持logback.xml或者logback-spring.xml，推荐使用logback-spring.xml，springboot会增长额外功能；

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->  
    <property name="LOG_PATH" value="/path" />  
    <!-- 控制台输出 -->   
    <appender name="STDOUT" 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>   
        </encoder> 
    </appender>
    <!-- 按照天天生成日志文件 -->   
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern> 
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </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>   
        </encoder> 
        <!--日志文件最大的大小-->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
         <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
    </appender> 
   <!-- show parameters for hibernate sql 专为 Hibernate 定制 --> 
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />  
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />  
    <logger name="org.hibernate.SQL" level="DEBUG" />  
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />  
    
    <!--myibatis log configure--> 
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root> 
     <!--日志异步到数据库 -->  
    <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
        <!--日志异步到数据库 --> 
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
           <!--链接池 --> 
           <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
              <driverClass>com.mysql.jdbc.Driver</driverClass>
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
              <user>root</user>
              <password>root</password>
            </dataSource>
        </connectionSource>
  </appender>
</configuration>
复制代码

3.2 在程序用引用Logback

package com.jd.springboot; 

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

public class HelloController{
     //定义一个全局的记录器，经过LoggerFactory获取
     private final static Logger logger = LoggerFactory.getLogger(HelloController.class); 
    
    public static void main(String[] args) {
        logger.info("logback 成功了");
        logger.error("logback 成功了");
    }
}
复制代码

四. logback.xml配置示例

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--
       说明：
       一、日志级别及文件
           日志记录采用分级记录，级别与日志文件名相对应，不一样级别的日志信息记录到不一样的日志文件中
           例如：error级别记录到log_error_xxx.log或log_error.log（该文件为当前记录的日志文件），而log_error_xxx.log为归档日志，
           日志文件按日期记录，同一天内，若日志文件大小等于或大于10M，则按0、一、2...顺序分别命名
           例如log-level-2018-12-28.0.log
           其它级别的日志也是如此。
       二、文件路径
           若开发、测试用，在Eclipse中运行项目，则到Eclipse的安装路径查找logs文件夹，以相对路径../logs。
           若部署到Tomcat下，则在Tomcat下的logs文件中
       三、Appender
           FILEERROR对应error级别，文件名以log-error-xxx.log形式命名
           FILEWARN对应warn级别，文件名以log-warn-xxx.log形式命名
           FILEINFO对应info级别，文件名以log-info-xxx.log形式命名
           FILEDEBUG对应debug级别，文件名以log-debug-xxx.log形式命名
           stdout将日志信息输出到控制上，为方便开发测试使用
    -->
    <contextName>SpringBootDemo</contextName>
    <property name="LOG_PATH" value="D:\\JavaWebLogs" />
    <!--设置系统日志目录-->
    <property name="APPDIR" value="SpringBootDemo" />

    <!-- 日志记录器，日期滚动记录 -->
    <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_error.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例现在天是2013-12-21日志，当前写的日志文件路径为file节点指定，能够将此文件与file指定文件路径设置为不一样路径，从而将当前日志文件或归档日志文件置不一样的目录。
            而2018-12-28的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日志记录以外，还配置了日志文件不能超过2M，若超过2M，日志文件会以索引0开始，
            命名日志文件，例如log-error-2018-12-28.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日志记录器，日期滚动记录 -->
    <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例现在天是2018-12-28日志，当前写的日志文件路径为file节点指定，能够将此文件与file指定文件路径设置为不一样路径，从而将当前日志文件或归档日志文件置不一样的目录。
            而2018-12-28的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日志记录以外，还配置了日志文件不能超过10M，若超过10M，日志文件会以索引0开始，
            命名日志文件，例如log-error-2018-12-28.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日志记录器，日期滚动记录 -->
    <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_info.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例现在天是2018-12-28日志，当前写的日志文件路径为file节点指定，能够将此文件与file指定文件路径设置为不一样路径，从而将当前日志文件或归档日志文件置不一样的目录。
            而2018-12-28的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日志记录以外，还配置了日志文件不能超过10M，若超过10M，日志文件会以索引0开始，
            命名日志文件，例如log-error-2018-12-28.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!--encoder 默认配置为PatternLayoutEncoder-->
        <encoder>
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <logger name="org.springframework" level="WARN" />
    <logger name="org.hibernate" level="WARN" />

    <!-- 生产环境下，将此级别配置为适合的级别，以避免日志文件太多或影响程序性能 -->
    <root level="INFO">
        <appender-ref ref="FILEERROR" />
        <appender-ref ref="FILEWARN" />
        <appender-ref ref="FILEINFO" />

        <!-- 生产环境将请stdout,testfile去掉 -->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>
复制代码

点击查看SpringBoot从入门到高级视频教程

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程