java開發日志處理一般是由 一個日志門面 和 一個日志實現配套使用。
日志門面如Slf4j 、jboss-loggin等
日志實現如log4j、log4j2、logback等。
其中門面Slf4j和實現log4j、logback的作者是同一人,logback是對log4j的升級,因為作者認為log4j太爛了。log4j2是Apache的一個日志實現,性能優異,但是可能和部分框架存在兼容問題,容易踩坑,所以采用Slf4j+logback,因為他倆是同一作者。
Maven依賴如下
<dependencies> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.16</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.5</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> </dependencies>
依賴說明
lombok的依賴可以去掉,但是在使用的時候就需要手動創建log對象。代碼如下
private static final Logger logger = LoggerFactory.getLogger(當前類名.class);
使用lombok只需在類的頭部添加注解@Slf4j即可
@Slf4j public class TestClass { public static void main(String[] args) { log.debug("信息..."); } }
配置文件
1.logback首先會試着查找logback.groovy文件;
2.當沒有找到時,繼續試着查找logback-test.xml文件;
3.當沒有找到時,繼續試着查找logback.xml文件;
4.如果仍然沒有找到,則使用默認配置(打印到控制台)。
自定義日志配置
根據不同的日志系統,你可以按如下規則組織配置文件名,就能被正確加載:
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特有的配置項。
默認的命名規則,並且放在 src/main/resources 下面即可
下面提供了兩份案例,一份詳情,一份精簡
詳情版
<?xml version="1.0" encoding="utf-8" ?> <!-- 從高到地低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL --> <!-- 日志輸出規則 根據當前ROOT 級別,日志輸出時,級別高於root默認的級別時 會輸出 --> <!-- 以下 每個配置的 filter 是過濾掉輸出文件里面,會出現高級別文件,依然出現低級別的日志信息,通過filter 過濾只記錄本級別的日志--> <!-- 屬性描述 scan:性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true scanPeriod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位, 默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鍾。debug:當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態。默認值為false。 --> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <!-- 定義日志文件 輸入位置 --> <property name="logPath" value="./java-starter/log" /> <!-- 日志最大的歷史 30天 --> <property name="maxHistory" value="30"/> <!-- 配置項, 通過此節點配置日志輸出位置(控制台、文件、數據庫)、輸出格式等--> <!-- ConsoleAppender代表輸出到控制台 --> <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender"> <!-- layout代表輸出格式 --> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%date %level [%thread] %logger [%file:%line] %msg%n</pattern> </layout> </appender> <!-- 日志輸出文件 --> <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender"> <encoder> <pattern>%date %level [%thread] %logger [%file:%line] %msg%n</pattern> </encoder> <!-- 滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件 RollingFileAppender--> <!-- 滾動策略,它根據時間來制定滾動策略.既負責滾動也負責觸發滾動 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 輸出路徑 --> <fileNamePattern>${logPath}/info/%d.log</fileNamePattern> <!-- 可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件假設設置每個月滾動,且<maxHistory>是6, 則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些為了歸檔而創建的目錄也會被刪除--> <maxHistory>${maxHistory}</maxHistory> </rollingPolicy> <!-- 按照固定窗口模式生成日志文件,當文件大於20MB時,生成新的日志文件。窗口大小是1到3,當保存了3個歸檔文件后,將覆蓋最早的日志。 <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>${logPath}/%d{yyyy-MM-dd}/.log.zip</fileNamePattern> <minIndex>1</minIndex> <maxIndex>3</maxIndex> </rollingPolicy> --> <!-- 查看當前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動 <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize> </triggeringPolicy> --> </appender> <!-- 特殊記錄Error日志 --> <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 只記錄ERROR級別日志,添加范圍過濾,可以將該類型的日志特殊記錄到某個位置 --> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level> </filter> <encoder> <pattern>%date %level [%thread] %logger [%file:%line] %msg%n</pattern> </encoder> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${logPath}/error/%d.log</fileNamePattern> <!-- 日志最大的歷史 60天 --> <maxHistory>60</maxHistory> </rollingPolicy> </appender> <!-- 根節點,表名基本的日志級別,里面可以由零個或多個<appender-ref>元素,標識那些appender將會添加到這個loger。--> <!-- level="info"代表基礎日志級別為info。用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特殊值INHERITED或者同義詞NULL,代表強制執行上級的級別。 --> <root level="error"> <!-- 引入控制台輸出規則 --> <appender-ref ref="consoleLog" /> <appender-ref ref="fileInfoLog" /> <appender-ref ref="fileErrorLog" /> </root> </configuration>
精簡版
<?xml version="1.0" encoding="UTF-8"?> <configuration xmlns="http://ch.qos.logback/xml/ns/logback" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ch.qos.logback/xml/ns/logback logback.xsd"> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%date{HH:mm:ss} [%t] %logger - %m%n</pattern> </encoder> </appender> <logger name="c" level="debug" additivity="false"> <appender-ref ref="STDOUT"/> </logger> <root level="ERROR"> <appender-ref ref="STDOUT"/> </root> </configuration>