springboot如何使用logback-spring配置日志格式,並分環境配置

配置不生效的解決辦法

註意:如果配置不生效,則說明spring優先加載瞭其他配置:

解決辦法:

  1. 添加啟動參數 -Dlogging.config=classpath:logback-spring.xml
  2. 修改名字為 logback.xml, SpringBoot首先去查找標準的日志配置文件,如果找不到在去找拼接Spring的配置的文件, 標準文件名: “logback-test.groovy“, “logback-test.xml“, “logback.groovy“,”logback.xml” 等
  3. 排除 第三方jar包中的日志配置

springboot中使用這個LoggingApplicationListener類進行初始化,具體流程可查源碼

logback-spring結尾的可以使用springboot的分環境註入特性:

直接貼代碼,放到resource下面就行瞭:

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!-- logback-spring 的文件可以基於環境配置,相對路徑會默認成項目根目錄開始 -->
    <springProfile name="comp">
        <property name="LOG_HOME" value="/home/houzheng/logs"/>
    </springProfile>
    <!-- home環境,windows -->
    <springProfile name="home">
        <property name="LOG_HOME" value="D:/logs"/>
    </springProfile>
    <!--控制臺輸出appender-->
    <appender name="console" 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>
            <!--設置編碼-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!--文件輸出,時間窗口滾動-->
    <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志名,指定最新的文件名,其他文件名使用FileNamePattern -->
        <File>${LOG_HOME}/timeFile/out.log</File>
        <!--文件滾動模式-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名,可設置文件類型為gz,開啟文件壓縮-->
            <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>30</MaxHistory>
            <!--按大小分割同一天的-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </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>
            <!--設置編碼-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!--指定基礎的日志輸出級別-->
    <root level="INFO">
        <!--appender將會添加到這個loger-->
        <appender-ref ref="console"/>
        <appender-ref ref="timeFileOutput"/>
    </root>
    <!-- 單獨指定某個包的日志打印,級別,appender等   -->
    <!-- addtivity: 可選。是否向上級 loger(也就是 root 節點)傳遞打印信息。默認為 true,
        設置addtivity是因為這裡已經指定瞭appender,如果再向上傳遞就會被root下的appender再次打印 -->
<!--    <logger name="com.hou.postgresql.user.service.impl.TestUserServiceImpl" level="WARN" addtivity="false">-->
<!--        <appender-ref ref="console"/>-->
<!--    </logger>-->
     <!-- 單獨指定某個包的日志打印,級別,appender等,也可以在代碼中使用 name屬性獲取 LoggerFactory.getLogger("LogName");   -->
     <logger name="AudiLogNameFormat" level="info" additivity="false">
        <appender-ref ref="Log"/>
    </logger>
</configuration>

Springboot項目下的logback.xml

直接上模板,其中有註釋,在現有的項目裡拷出來的。

<configuration>
    <!-- %m輸出的信息,%p日志級別,%t線程名,%d日期,%c類的全名,,,, -->
    
    <!-- 定義一個控制臺輸出的appender -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d %p (%file:%line\)- %m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    
    <!-- 定義一個變量 下面可以引用 -->
    <property name="LOG_HOME" value="/log" />
	<!-- 定義一個sql語句的日志文件存放位置 格式 規則 等信息 -->
    <appender name="mysqllog"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志文件路徑 與項目同級 -->
        <File>${LOG_HOME}/mysql.log</File>
        <!-- 日志內容規則 編碼方式 -->
        <encoder>
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 設置日志的分文件規則 以及命名 個人理解默認按天來分 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/mysql.log.%d.%i</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 設置日志文件最大size -->
                <maxFileSize>64 MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
	<!-- 定義一個error的日志文件存放位置 格式 規則 等信息 -->
    <appender name="errorlog"
             class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志文件路徑 與項目同級 -->
        <File>${LOG_HOME}/mysql.log</File>
        <!-- 日志內容規則 編碼方式 -->
        <encoder>
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 設置日志的分文件規則 以及命名 個人理解默認按天來分 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/mysql.log.%d.%i</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 設置日志文件最大size -->
                <maxFileSize>64 MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
	<!-- 設置root全局日志的控制臺 使用上面第一個定義的'STDOUT' -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
	<!-- 設置mapper相應目錄下的sql語句的輸出 使用瞭定義的'mysqllog'和'STDOUT' 其中'mysqllog'是輸出到文件中 'STDOUT'是控制臺 
	additivity是否追加到root中 默認true 如果為true則會在debug時打印兩條sql 所以這裡為false -->
    <logger name="com.xxx.mapper" level="DEBUG" additivity="false">
        <appender-ref ref="mysqllog" />
        <appender-ref ref="STDOUT" />
    </logger>
    <logger name="com.mytian.service" level="WARN">
    </logger>
</configuration>

在項目中使用時:

Logger logger = LoggerFactory.getLogger(所在類名.class);

以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。

推薦閱讀: