SpringBoot入门03-初始SpringBoot的日志配置

SpringBoot的日志配置

1. 前言
2. log4j2的导入和使用

1、前言

SpringBoot内部采用的是Commons Logging来进行日志记录，并且日志有很多框架可以选择，例如SpringBoot默认使用的就是Logback，但是也有Log4j,log4j2等等框架可以选择。

常见的日志框架：

• java.util.logging:jdk1.4版本引入的java原生日志框架
• Log4j:apache开源项目，是之前十分火热的日志框架，但是16年后停止维护
• Log4j2
• Logback:Log4j的改良版本

Logback的一般日志格式如下：

2019-03-28 09:46:31.385  INFO 12084 --- [           main] com.example.demo.DemoApplication         : Starting DemoApplication on LAPTOP-L2Q766GE with PID 12084 (D:\Dwork\Idea_workspace\demo\demo1\target\classes started by 13467 in D:\Dwork\Idea_workspace\demo)
2019-03-28 09:46:31.389  INFO 12084 --- [           main] com.example.demo.DemoApplication         : No active profile set, falling back to default profiles: default
2019-03-28 09:46:32.935  INFO 12084 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2019-03-28 09:46:32.952  INFO 12084 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2019-03-28 09:46:32.952  INFO 12084 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: 

从上面的日志输出格式我们可以看出日志一般包括如下内容：

• 时间日期
• 日志级别：ERROR,WARN,INFO,DEBUG,TRACE
• 进程ID
• 分隔符
• 线程名:一般都是利用[]括起来的部分
• Logger名：通常使用源代码的类名
• 日志内容

SpringBoot自带的配置Logback

Logback的默认输出日志级别有：INFO , WARN ,ERROR，其他的日志级别需要我们手动开启：

• 命令行配置：java -jar app.jar --debug=true,开启debug级别的日志输出
• 资源文件配置：application.properties配置debug=true即可。 （但是对于自己的项目想要输出debug,需要额外配置：（logging.level.=））

Logback的文件保存:默认情况日志只在控制台输出，不会写入日志文件中，但我们可以通过在application.properties设置logging.file和logging.path属性来将日志写入文件中

• logging.file：将日志写入指定的文件中。
• logging.path:将名为spring.log写入到指定的文件夹中。

日志可以进行属性的设置：

• **logging.file.max-size:**限制日志文件的大小
• **logging.file.max-history:**限制日志保留天数

2、log4j2的导入和使用

1、引入log4j2的依赖

首先我们要将SpringBoot自带的日志框架注销：

 <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
            <version>2.0.0</version>
 </dependency>

然后在导入log4j2的依赖

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2、配置log4j2-spring.xml

如果自定义了文件名,需要在application.yml中配置如下：

logging:
  config: xxxx.xml
  level:
    cn.jay.repository: trace

3、log4j2-spring.xml配置文件配置

log4j采用的是.properties的文件来进行配置，但是log4j2弃用了这种方式，采用的是.xml，.json这种方式。
log4j2-spring.xml的配置文件模板：

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--变量配置-->
    <Properties>
        <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定义日志存储的路径，不要配置相对路径 -->
        <property name="FILE_PATH" value="更换为你的日志路径" />
        <property name="FILE_NAME" value="更换为你的项目名" />
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>