需求:

spring boot 用自带的logback打印日志:

1. 多环境打印.
2. 生产环境输出到控制台和文件,一天一个文件,保留30天.
3. 开发环境输出到控制台.
4. 测试环境输出到控制台和打印sql(mybatis)输出.

用idea添加一个web模块的spring boot项目.

直接上logback-spring.xml放在resources下面

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--引入默认的一些设置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--web信息-->
    <logger name="org.springframework.web" level="info"/>

    <!--写入日志到控制台的appender,用默认的,但是要去掉charset,否则windows下tomcat下乱码-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_PATH" value="D:/logs/yunchuang/yunchuang"/>
    <!--写入日志到文件的appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名,每天一个文件-->
            <FileNamePattern>${LOG_PATH}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <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>

    <!--异步到文件-->
    <appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>500</queueSize>
        <appender-ref ref="FILE"/>
    </appender>

    <!--生产环境:打印控制台和输出到文件-->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="asyncFileAppender"/>
        </root>
    </springProfile>

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

    <!--测试环境:打印控制台-->
    <springProfile name="test">
        <!-- 打印sql -->
        <logger name="com.yunchuang.dao" level="DEBUG"/>
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>

修改application.yml添加多环境

spring:
  profiles:
    active: prod
---
server:
  port: 8009
spring:
  profiles: dev
---
server:
  port: 8009
spring:
  profiles: test
---
server:
  port: 8008
spring:
  profiles: prod

加入一个RestController来测试日志是否成功.

package com.yunchuang;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
* log
*
* @author 尹冬飞
* @create 2017-04-12 16:28
*/
@RestController
public class LogDemo {
    private static Logger log= LoggerFactory.getLogger(LogDemo.class);
 
    @GetMapping("/")
    public String a(){
        log.trace("======trace");
        log.debug("======debug");
        log.info("======info");
        log.warn("======warn");
        log.error("======error");
        return "123";
    }
}

下面是我怎么写出来上面这些东西的.

官方文档:howto-configure-logback-for-logging

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <logger name="org.springframework.web" level="DEBUG"/>
</configuration>

官方文档:profile_specific_configuration

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev, staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

由这2个部分就可以看出来logback是怎么配置的了,打印日志需要引入base.xml,多环境打印需要<springProfile>标签.只要把怎么打印放入多环境标签即可.所以需要打开base.xml看看他是怎么写入日志的.

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

<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->

<included>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</included>

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

<!--
Console appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>
</included>

• 打开defaults.xml发现是一些系统默认设置.
• 打开console-appender.xml发现是输出到控制台的appender设置.
• 打开file-appender.xml发现是输出到文件的appender设置.
• <root>标签注入了这2个appender,同时打印到控制台和文件.因为你在<configuration debug="true">时启动项目就能看到控制台,就能发现他会输出日志到一个文件.可以到我的电脑里找到这个文件.

所以整个框架就明了了.在自己定义配置的logback-spring.xml里需要的几部分

• defaults.xml系统的一些默认设置保留.
• console-appender.xml打印到控制台的设置保留.但是需要去掉设置编码,所以把里面的代码考过来,并去掉编码设置.因为这里会乱码,下面详细说.
• <root>保留,放到多环境里.想只打印到控制台,就注入控制台appender,想打印控制台和文件就注入控制台和文件这2个appender即可.
• 打印sql,用<logger name="com.yunchuang.dao" level="DEBUG" />
• 名称为什么是logback-spring.xml,官方文档里有说明,用了扩展表达式,必须用这个名字.

Paste_Image.png

原理方面请参考这个,讲的挺细的:

• logback 常用配置详解（序）logback 简介
• SpringBoot中的日志配置，多环境日志配置