前言

一個系統(tǒng)的運行，日志是很重要的組成部分。記錄系統(tǒng)運行的各種狀態(tài)，方便出現(xiàn)問題調(diào)試。
java web開發(fā)中，主流使用的日志處理器是log4j
這里分享下我當前的日志配置。

介紹

• log4j
  日志框架.

• slf4j
  定義了很多日志處理的接口,依托l(wèi)og4j等具體日志框架來實現(xiàn)日志功能。
  使用它的話有利于后期更換日志框架。

需求(問題)

之前寫代碼，經(jīng)常使用 System.out.println進行調(diào)試。每次調(diào)試之后，還需要去刪除代碼。太費事了。使用log4j后,完全避免這樣的問題。只需要修改日志級別即可。

總結(jié)下我當前項目的日志需求如下:

• 日志實現(xiàn)不同包或者類不同的日志級別。(最主要的需求)
• 日志的設(shè)置可以復用。不能多次重復編寫
• 多種日志組合。寫入文件、寫入到控制臺、發(fā)送郵件等。

解決

• 引入jar包。

<dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>




        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.21</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>

• 編寫配置

<?xml version="1.0" encoding="UTF-8" ?>     
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>

    <!-- ========================== 自定義輸出格式說明================================ -->
    <!-- %p 輸出優(yōu)先級，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL -->
    <!-- %r 輸出自應(yīng)用啟動到輸出該log信息耗費的毫秒數(shù) -->
    <!-- %c 輸出所屬的類目，通常就是所在類的全名 -->
    <!-- %t 輸出產(chǎn)生該日志事件的線程名 -->
    <!-- %n 輸出一個回車換行符，Windows平臺為“/r/n”，Unix平臺為“/n” -->
    <!-- %d 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 
        22：10：28，921 -->
    <!-- %l 輸出日志事件的發(fā)生位置，包括類目名、發(fā)生的線程，以及在代碼中的行數(shù)。舉例：Testlog4.main(TestLog4.<a  
        class='replace_word' title="Java EE知識庫" target='_blank' style='color:#df3434; 
        font-weight:bold;'>Java</a>:10) -->
    <!-- ========================================================================== -->

    <!-- ========================== 輸出方式說明================================ -->
    <!-- Log4j提供的appender有以下幾種: -->
    <!-- org.apache.log4j.ConsoleAppender(控制臺), -->
    <!-- org.apache.log4j.FileAppender(文件), -->
    <!-- org.apache.log4j.DailyRollingFileAppender(每天產(chǎn)生一個日志文件), -->
    <!-- org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產(chǎn)生一個新的文件), -->
    <!-- org.apache.log4j.WriterAppender(將日志信息以流格式發(fā)送到任意指定的地方) -->
    <!-- ========================================================================== -->

    <!-- ================= 全部日志記錄到debug.log，每天一份 ===================== -->
    <appender name="DEBUG.FILE" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="logs/debug.log" />
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
        <param name="Threshold" value="debug" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="[%d{yyyy-MM-dd HH:mm:ss/} %-5p] [%t] (%c:%L) - %m%n" />
        </layout>
    </appender>
    <!-- ================= ERROR級別日志記錄到error.log，每天一份 ===================== -->
    <appender name="ERROR.FILE" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="logs/error.log" />
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
        <param name="Threshold" value="error" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="[%d{yyyy-MM-dd HH:mm:ss/} %-5p] [%t] (%c:%L) - %m%n" />
        </layout>
    </appender>

    <!-- ================= WARN-FATAL級別日志紅色字體輸出到控制臺 ===================== -->
    <appender name="CONSOLE.ERR" class="org.apache.log4j.ConsoleAppender">
        <param name="target" value="System.err" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="[ %p ] %d{yyyy-MM-dd HH:mm:ss} - %c - %F(%L) - %m%n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="warn" />
            <param name="LevelMax" value="fatal" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
    </appender>
    <!-- ================= DEBUG-INFO級別日志黑色字體輸出到控制臺 ===================== -->
    <appender name="CONSOLE.OUT" class="org.apache.log4j.ConsoleAppender">
        <param name="target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="[ %p ] %d{yyyy-MM-dd HH:mm:ss} - %c - %F(%L) - %m%n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="debug" />
            <param name="LevelMax" value="info" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
    </appender>

    <!-- ======================= ERROR日志郵件通知  ========================= -->
    <appender name="EMAIL.163" class="org.apache.log4j.net.SMTPAppender">
        <param name="Threshold" value="error" />
        <param name="BufferSize" value="512" />
        <param name="SMTPHost" value="smtp.163.com" />
        <param name="SMTPUsername" value="xxxx@163.com" />
        <param name="SMTPPassword" value="xxxxxx" />
        <param name="From" value="xxxx@163.com" />
        <param name="To" value="xxxx@qq.com" />
        <param name="Subject" value="[ lightai project ] Runtime exception report" />
        <param name="LocationInfo" value="true" />
        <param name="SMTPDebug" value="true" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="[ %p ] %d{yyyy-MM-dd HH:mm:ss.SSS} - %c - %F(%L) - %m%n" />
        </layout>
    </appender>

    <!--- 異步測試，當日志達到緩存區(qū)大小時候執(zhí)行所包的appender -->
    <appender name="ASYNC.EMAIL" class="org.apache.log4j.AsyncAppender">
        <param name="BufferSize" value="1" />
        <appender-ref ref="EMAIL.163" />
    </appender>

    <!-- 指定包的日志級別 -->
    <logger name="com.insigmaunited.lightai.controller">
        <level value="debug" />
        <appender-ref ref="CONSOLE.OUT" />
    </logger>



    <!-- 項目日志級別配置 -->
    <root>
        <priority value="warn" />
        <appender-ref ref="CONSOLE.OUT" />
        <appender-ref ref="CONSOLE.ERR" />
        <appender-ref ref="DEBUG.FILE" />
        <appender-ref ref="ERROR.FILE" />
        <!--<appender-ref ref="ASYNC.EMAIL" />-->
    </root>

</log4j:configuration>

• 載入配置

在java web項目的web.xml中 添加

<!-- log4jConfigLocation：log4j配置文件存放路徑 -->
  <context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>classpath:log4j.xml</param-value>
  </context-param>

• 初始化
  每個需要記錄日志的類中添加
  這里我的類是UserController

 protected final static Logger logger = LoggerFactory.getLogger(UserController.class);

• 使用

logger.debug('test');

• 最后的結(jié)果

image.png