前言
一个系统的运行,日志是很重要的组成部分。记录系统运行的各种状态,方便出现问题调试。
java web开发中,主流使用的日志处理器是log4j
这里分享下我当前的日志配置。
介绍
log4j
日志框架.slf4j
定义了很多日志处理的接口,依托log4j等具体日志框架来实现日志功能。
使用它的话有利于后期更换日志框架。
需求(问题)
之前写代码,经常使用 System.out.println进行调试。每次调试之后,还需要去删除代码。太费事了。使用log4j后,完全避免这样的问题。只需要修改日志级别即可。
总结下我当前项目的日志需求如下:
- 日志实现不同包或者类不同的日志级别。(最主要的需求)
- 日志的设置可以复用。不能多次重复编写
- 多种日志组合。写入文件、写入到控制台、发送邮件等。
解决
- 引入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 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL -->
<!-- %r 输出自应用启动到输出该log信息耗费的毫秒数 -->
<!-- %c 输出所属的类目,通常就是所在类的全名 -->
<!-- %t 输出产生该日志事件的线程名 -->
<!-- %n 输出一个回车换行符,Windows平台为“/r/n”,Unix平台为“/n” -->
<!-- %d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日
22:10:28,921 -->
<!-- %l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.<a href="http://lib.csdn.net/base/17"
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(每天产生一个日志文件), -->
<!-- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件), -->
<!-- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) -->
<!-- ========================================================================== -->
<!-- ================= 全部日志记录到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>
<!--- 异步测试,当日志达到缓存区大小时候执行所包的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');
- 最后的结果