初次接觸javaweb項目的日志是log4j文件,但是后來發現通過配置logback.xml文件實現日志輸出非常好用。經過上午的學習,現總結如下:
直接上配置文件和注釋:
<?xml version="1.0" encoding="UTF-8" ?>
<!-- configuration是logback.xml文件的根節點,里面有三個屬性:
scan:當此屬性為true時,logback.xml文件如果發生改變,將會被重新加載,默認值是true
scanPeriod:設置監測配置文件是否有修改的時間間隔(通俗講:就是設置多長時間查看一下logback.xml文件有沒有被修改)
如果沒有給出時間單位,默認是ms,並且當scan為true時,此屬性生效,默認間隔時間是1分鍾。
debug:當此屬性設置為true時,將打印出logback.xml內部日志消息,實時查看logback.xml的運行狀態,默認值是false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 整個logback.xml文件中只有四個主要的標簽:其一是根標簽configuration,其余是三個子標簽:appende,logger,root
但是有人會疑問:那property和timestamp是做什么的?答案是:這兩個標簽是用來為以上提到的是三個子標簽定義屬性和賦值的。例如:
第一個property標簽中定義了一個USER_HOME屬性,其值是/logs,scope是這個屬性的作用范圍,scope="context"是指該屬性只能在本配置文件中使用。
而timestamp定義了一個時間戳,也就是定義了一個時間格式,以供三個子標簽使用。
-->
<property name="USER_HOME" value="/logs" />
<property scope="context" name="FILE_NAME" value="mylog-logback" />
<timestamp key="byDay" datePattern="yyyy-MM-dd" />
<!-- 第一個子標簽appender:
name:標簽名,為了讓其他標簽調用的唯一標示,相當於html標簽中的id
class:引用的類,從此類中可以看出該appender標簽定義的是日志輸出的位置,也就是往哪里輸出
ch.qos.logback.core.ConsoleAppender可以看出是往控制台上輸出。
encoder:該標簽中定義了日志的輸出格式
-->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度 %msg:日志消息,%n是換行符
級別分別是:TRACE < DEBUG < INFO <WARN < ERROR
-->
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n </pattern>
</encoder>
</appender>
<!--
class:從此類中可以看出該appender標簽定義的日志輸出位置是回滾文件,也就是說:把日志輸出到一個文件中,並且該文件可以回滾,至於怎么回滾請看下面的注釋
-->
<appender name="log_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 定義了日志文件的目錄結構和文件名:磁盤根目錄:/logs/mylog-logback.log
注意了:該文件名是在日志文件沒有觸發回滾要求時的文件名,也就是說現在的日志文件還沒有滿足xxMB,一旦滿足了就會按照rollingPolicy里設置的屬性進行重新命名
-->
<file>${USER_HOME}/${FILE_NAME}.log</file>
<!-- rollingPolicy:回滾策略
fileNamePattern:標簽中定義的是日志文件一旦滿足5MB就重新命名成新文件的命名格式,其中minIndex和maxIndex分別對應的是滿足5MB的日志文件的命名序號(1~10)對應%i.log中的i值。
如:mylog-logback-2016-07-12-1.log,mylog-logback-2016-07-12-2.log,mylog-logback-2016-07-12-3.log
-->
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>${USER_HOME}/${byDay}/${FILE_NAME}-${byDay}-%i.log</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>10</maxIndex>
</rollingPolicy>
<!-- 觸發策略:當日志文件滿足5MB就會出發回滾策略-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-4relative [%thread] %-5level %logger{35} - %msg%n
</pattern>
</encoder>
</appender>
<!-- 設置哪個目錄或者包,類使用哪個日志
將控制impl包下的所有類的日志的打印,level是打印級別:debug,如果不設置level,它將繼承它的上級<root>的日志級別“DEBUG”
如果沒有設置addtivity,默認為true,將此loger的打印信息向上級傳遞;
如果沒有設置appender-ref,此loger本身不打印任何信息。
-->
<logger name="com.jbat.service.impl" level="debug" additivity="true">
<appender-ref ref="log_file" />
</logger>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
<appender-ref ref="log_file" />
</root>
<!--執行過程總結:
當 執行com.jbat.service.impl類的方法時,會首先執行<logger name="com.jbat.service.impl" />本身如果引用了appender-ref標簽,就按照ref="log_file" 設置的格式打印;
當執行不在impl中的方法時,會將級別為“DEBUG”及大於“DEBUG”的日志信息傳遞給root,root接到下級傳遞的信息,交給已經配置好的名為“STDOUT”和“log_file”的appender處理,“STDOUT”appender將信息打印到控制台,“log_file”appender將信息打印到日志文件;
-->
</configuration>
