需求:
spring boot 用自帶的logback打印日志:
- 多環(huán)境打印.
- 生產(chǎn)環(huán)境輸出到控制臺(tái)和文件,一天一個(gè)文件,保留30天.
- 開發(fā)環(huán)境輸出到控制臺(tái).
- 測試環(huán)境輸出到控制臺(tái)和打印sql(mybatis)輸出.
用idea添加一個(gè)web模塊的spring boot項(xiàng)目.
直接上logback-spring.xml放在resources下面
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--引入默認(rèn)的一些設(shè)置-->
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<!--web信息-->
<logger name="org.springframework.web" level="info"/>
<!--寫入日志到控制臺(tái)的appender,用默認(rèn)的,但是要去掉charset,否則windows下tomcat下亂碼-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<!--定義日志文件的存儲(chǔ)地址 勿在 LogBack 的配置中使用相對(duì)路徑-->
<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">
<!--日志文件輸出的文件名,每天一個(gè)文件-->
<FileNamePattern>${LOG_PATH}.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天數(shù)-->
<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>
<!--生產(chǎn)環(huán)境:打印控制臺(tái)和輸出到文件-->
<springProfile name="prod">
<root level="info">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="asyncFileAppender"/>
</root>
</springProfile>
<!--開發(fā)環(huán)境:打印控制臺(tái)-->
<springProfile name="dev">
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
<!--測試環(huán)境:打印控制臺(tái)-->
<springProfile name="test">
<!-- 打印sql -->
<logger name="com.yunchuang.dao" level="DEBUG"/>
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
</configuration>
修改application.yml添加多環(huán)境
spring:
profiles:
active: prod
---
server:
port: 8009
spring:
profiles: dev
---
server:
port: 8009
spring:
profiles: test
---
server:
port: 8008
spring:
profiles: prod
加入一個(gè)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個(gè)部分就可以看出來logback是怎么配置的了,打印日志需要引入base.xml,多環(huán)境打印需要<springProfile>標(biāo)簽.只要把怎么打印放入多環(huán)境標(biāo)簽即可.所以需要打開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發(fā)現(xiàn)是一些系統(tǒng)默認(rèn)設(shè)置. - 打開
console-appender.xml發(fā)現(xiàn)是輸出到控制臺(tái)的appender設(shè)置. - 打開
file-appender.xml發(fā)現(xiàn)是輸出到文件的appender設(shè)置. -
<root>標(biāo)簽注入了這2個(gè)appender,同時(shí)打印到控制臺(tái)和文件.因?yàn)槟阍?code><configuration debug="true">時(shí)啟動(dòng)項(xiàng)目就能看到控制臺(tái),就能發(fā)現(xiàn)他會(huì)輸出日志到一個(gè)文件.可以到我的電腦里找到這個(gè)文件.
所以整個(gè)框架就明了了.在自己定義配置的logback-spring.xml里需要的幾部分
-
defaults.xml系統(tǒng)的一些默認(rèn)設(shè)置保留. -
console-appender.xml打印到控制臺(tái)的設(shè)置保留.但是需要去掉設(shè)置編碼,所以把里面的代碼考過來,并去掉編碼設(shè)置.因?yàn)檫@里會(huì)亂碼,下面詳細(xì)說. -
<root>保留,放到多環(huán)境里.想只打印到控制臺(tái),就注入控制臺(tái)appender,想打印控制臺(tái)和文件就注入控制臺(tái)和文件這2個(gè)appender即可. - 打印sql,用
<logger name="com.yunchuang.dao" level="DEBUG" /> - 名稱為什么是logback-spring.xml,官方文檔里有說明,用了擴(kuò)展表達(dá)式,必須用這個(gè)名字.
Paste_Image.png
原理方面請(qǐng)參考這個(gè),講的挺細(xì)的:
