在继续上一篇的Debug调试之后,把spring boot的日志框架使用情况逐步蚕食。

参考:http://tengj.top/2017/04/05/springbo

开篇之前,贴上完整application.properties日志相关配置

【spring boot】8.spring boot的日志框架logback使用

 

=============================================================================================

简介:spring boot的默认日志框架Logback

SLF4J——Simple Logging Facade For Java,它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback,commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口,而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。

 

Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。

默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。在刚开始运行一个崭新的spring boot项目时,你就可以在控制台看到INFO级别的日志了。

有如下的7各部分:

  • ①时间日期:精确到毫秒

  • ②日志级别:ERROR> WARN>INFO>DEBUG > TRACE  优先级如前面,默认情况下是INFO,则INFO以及优先级更高的WARN和ERROR会被显示

  • ③进程ID  就是PID

  • ④分隔符:--- 标识实际日志的开始

  • ⑤线程名:方括号括起来(可能会截断控制台输出)

  • ⑥Logger名:通常使用源代码的类名

  • ⑦日志内容

【spring boot】8.spring boot的日志框架logback使用

可以从上面看到,这个spring boot是启动在8928这个进程上的。

在任务管理器中可以看到【如果任务管理的的进程选项卡中看不到PID,http://www.cnblogs.com/sxdcgaq8080/p/7853081.html

【spring boot】8.spring boot的日志框架logback使用

 

 ======================================================================================================

一、在项目application.properties配置就可以使用log功能

1.要在spring boot中使用日志功能,在pom.xml中配置maven架包

 

<!--使用spring boot日志框架-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>

 

但是其实是不用配置的,因为在spring-boot-starter-web下已经引用了日志的架包,如下图:

【spring boot】8.spring boot的日志框架logback使用

 

 2.两种使用情况

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。

  2.1 控制台输出

Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序--debug标志来启用“调试”模式(开发的时候推荐开启),以下两种方式:

    2.1.1在运行命令后加入--debug标志,如:$ java -jar springTest.jar --debug

    2.1.2在application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别

如下:

配置文件application.properties中配置:

debug=true

启动,观察控制台打印出来的日志如下:

【spring boot】8.spring boot的日志框架logback使用

 

 

  2.2文件输出

 

默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.file或logging.path属性。

  • logging.file,设置文件,可以是绝对路径,也可以是相对路径。如:logging.file=my.log

  • logging.path,设置目录,会在该目录下创建spring.log文件,并写入日志内容,如:logging.path=/var/log

如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。

如果只配置 logging.path,在 /var/log文件夹生成一个日志文件为 spring.log

注:二者不能同时使用,如若同时使用,则只有logging.file生效

①默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件

②默认级别为:ERROR、WARN、INFO

 

    2.2.1  logging.file,设置文件

      2.2.1.1 配置文件application.properties中配置【logging.file  相对路径】

logging.file = myloggin.log

生成日志文件在项目【相当于项目根目录下的相对路径】

【spring boot】8.spring boot的日志框架logback使用

 

        2.2.1.2 在配置文件applicarion.properties中配置【logging.file  绝对路径】

logging.file = d:/myloggin.log

生成日志文件,位置如下:

【spring boot】8.spring boot的日志框架logback使用

 

      2.2.2 logging.path,设置目录

         2.2.2.1 在配置文件appilication.properties中设置【logging.path  相对路径】

logging.path = /log

生成日志文件在当前项目所在的磁盘的根目录下生成一个log文件夹,在文件夹中生成spring.log日志文件【特定名字就是spring.log】

【spring boot】8.spring boot的日志框架logback使用

 

         2.2.2.2 在配置文件application.properties中配置【logging.path 绝对路径】

logging.path = e:/log

会在指定目录的文件夹中生成spring.log日志文件【特定文件名spring.log】

【spring boot】8.spring boot的日志框架logback使用

 

 

 =========================================================================================================

二、日志等级在application.properties的控制

 根据开篇贴上的配置文件中的配置属性,可以看到在application.properties中配置日志等级就是一个配置,

格式为:logging.level.* = LEVEL

  • logging.level:日志级别控制前缀,*为包名或Logger名

  • LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例:

  • logging.level.com.sxd=DEBUG  com.sxd包下所有class以DEBUG级别输出,包括其优先级以上

  • logging.level.root=WARN    root日志以WARN级别输出,包括其优先级以上

 

=====================================================================================================

三、完全控制和解析日志配置

1.正经的提出问题:

上面两步,可以看到日志可以在控制台或者文件中显示出来,但是都是统一的样式,统一的等级,或者只能配置一个路径。

如果想完全控制日志,

    ①例如:我想在控制台输出的日志格式是这样的,但是在文件中能不能以另外一种格式输出?

     ②例如:我的日志文件输出,能不能自己控制文件的大小,文件名,日志文件总共多少就得清理?

    ③例如:能不能在不同的环境下,有不同的日志操作,比如在生产环境下,我的Service层的日志不会被打印,但是在开发环境下就要被打印出来

 

等等等等的,如果想完全控制日志的使用,往下看----->

 

2.慢慢的分析问题:

由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。那现在在application.properties中配置些许的属性已经不能完全满足了。

所以通过系统属性和传统的Spring Boot外部配置文件 才 可以很好的支持日志控制和管理。

  问题1:外部的日志配置文件应该叫什么名字呢?

根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:

  • 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

 

注意:Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项【特有的就是spring boot的profile多环境配置

  问题2:日志配置文件应该放在哪里呢?

放在src/main/resources下面即可。

  问题3:那不使用logback-spring.xml名字,使用自己定义的日志配置文件名行不行?

如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:

logging.config=classpath:logging-自定义.xml

  问题4:那我想使用spring boot的profile多环境配置,日志配置文件应该用什么名字?使用流程是怎么样?

如果想使用profile多环境配置,

  第一:日志配置文件名应该定义成logback-spring.xml。

  第二:然后在日志配置文件中,使用<springProfile name="dev">  </springProfile>标签来包住想要在这种环境下使用的配置。使用如下截图:

【spring boot】8.spring boot的日志框架logback使用

【spring boot】8.spring boot的日志框架logback使用

【spring boot】8.spring boot的日志框架logback使用

  第三:最后application.properties配置文件中,选择激活哪一种或哪几种环境即可

【spring boot】8.spring boot的日志框架logback使用

【spring boot】8.spring boot的日志框架logback使用

附录: 

 在没有设置profile的情况下,一般启动情况下,控制台打印出的日志都能看到这么一句话:

【spring boot】8.spring boot的日志框架logback使用

 

 

3.拆析一个基本的logback-spring.xml文件

下面粘上一个基本的文件代码:

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback</contextName>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="log.path" value="E:\\log\\logback.log" />

    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <!--<pattern>%d %p (%file:%line\)- %m%n</pattern>-->
            <!--格式化输出:%d:表示日期    %thread:表示线程名     %-5level:级别从左显示5个字符宽度  %msg:日志消息    %n:是换行符-->
            <pattern>控制台-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %msg%n</pattern>
            <charset>GBK</charset>
        </encoder>
    </appender>

    <!--输出到文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <!--格式化输出:%d:表示日期    %thread:表示线程名     %-5level:级别从左显示5个字符宽度  %msg:日志消息    %n:是换行符-->
            <pattern>文件记录-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>GBK</charset>
        </encoder>
    </appender>

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

    <logger name="com.sxd.controller"/>
    <logger name="com.sxd.util.LogTestController" level="WARN" additivity="false">
        <appender-ref ref="console" />
    </logger>



</configuration>
View Code

相关文章: