前言:实际项目开发中,关键的位置打印一定的日志信息十分必要,便于测试/调试/维护。不同于平常练习刷题,不可能将错误信息输出到标准输出,日志是我们查看的主要手段了。此文,是在我看了许多博客后,总结一下的,基本上从0开始,有些博客说的关键处不明不白,对于我这种新手理解十分困难,在自己全都搞明白之后,特意总结了此文供初学者。
基本上参考的以下两篇博客
所述内容大同小异,本文对此进行了更清晰的说明,希望对新手有所帮助。
一 工具介绍
Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。
SLF4J,即简单日志门面(Simple Logging Facade for Java),不是具体的日志解决方案,它只服务于各种各样的日志系统。按照官方的说法,SLF4J是一个用于日志系统的简单Facade,允许最终用户在部署其应用时使用其所希望的日志系统。实际上,SLF4J所提供的核心API是一些接口以及一个LoggerFactory的工厂类。从某种程度上,SLF4J有点类似JDBC,不过比JDBC更简单,在JDBC中,你需要指定驱动程序,而在使用SLF4J的时候,不需要在代码中或配置文件中指定你打算使用那个具体的日志系统。如同使用JDBC基本不用考虑具体数据库一样,SLF4J提供了统一的记录日志的接口,只要按照其提供的方法记录即可,最终日志的格式、记录级别、输出方式等通过具体日志系统的配置来实现,因此可以在应用中灵活切换日志系统。
二 我的理解和说明
1. 目前先按照本博客的大体步骤进行,尽量做到每一步知其所以然。主要是两大步骤,配置log4j和项目中的使用。
2.首先注意Java的项目是maven项目,在pom.xml文件中添加配置(如下);如果不知道maven就去百度,如果不用maven的话就自己导入相应的包吧。
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.x</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.x</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.x</version>
</dependency>
3. 日志的内容其实都是我们自己控制的,你的输出级别,你要输出的内容和位置,相比于我们直接用文件输出流输出什么东西的方式(比如保存一段文本),日志输出的优势是我们能取到当前位置的 线程,类名,代码的行数等调试时有用信息。这就是日志使用的核心功能。
4. 还有许多我也不明白的,供大家进阶继续学习吧。比如slf4j到底是啥我也没看到,总之就是照着模板学;比如哪些位置哪些信息很关键,要靠丰富的经验;还有许多可供选择的日志配置,没有尝试,等等。但是按照本文的框架,应该基本入门,也基本够用了。
三 添加log4j配置文件及解读
在项目类路径下添加log4j.properties配置文件,具体内容如下:
### set log levels ###
log4j.rootLogger = DEBUG,stdout,D,E
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.Threshold = INFO
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = app_debug.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = app_error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
看懵了吧,下面我们一一说明。
1)rootLogger = DEBUG,stdout,D,E #配置根logger
其基本格式为 log4j.rootLogger = LEVEL, appenderName1 , appenderName2 ...
在说明之前有必要补充一下日志的等级划分。日志等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL七级,内容范围依次降提升;如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO, WARN, ERROR等的log信息,而DEBUG信息不会被显示。FATAL是致命错误(会崩溃),ERROR是一般错误。
现在再来看第一句的配置,DEBUG指定该日志配置的等级,然后将等级为DEBUG的日志信息输出到stdout和D,E这三个目的地(名字随便起,这里stdout指标准输出,D指Debug,E指Error)。然后下面的语句就是对这几个目的地的配置了。
2)log4j.appender.stdout=org.apache.log4j.ConsoleAppender #配置日志信息输出目的地Appender
此句为定义名为stdout的输出端是哪种类型,可以是:
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
接下来是与输出目的地的配置相关的控制:
Target , File 分别就是输出目的地的目标、文件名啦。此处可将相应的内容写到相应的目的地及文件中,比如debug.log, error.log.
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
Threshold=DEBUG:指定日志消息的输出最低层次。 # 应当注意每个appender的级别应该是不同的,比如error类的单独放到一个文件中,更方便我们排除错误~
当选择RollingFileAppender时,MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
3)log4j.appender.stdout.layout=org.apache.log4j.PatternLayout # 定义名为stdout的输出端的layout类型
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
4)log4j.appender.stdout.layout.ConversionPattern= [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n
如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下:
%p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL,
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目,通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main (TestLog4.Java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java servlets这样的多客户多线程的应用中。
%%: 输出一个"%"字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息 (注意下文log的使用时传入的参数)
%n: 输出一个回车换行符,Windows平台为"/r/n",Unix平台为"/n"输出日志信息换行
%d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。
2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,"-"号指定左对齐。
3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边较远输出的字符截掉。
总结一下:
日志的关键配置包括输出目标,信息等级,文件形式和格式控制,各个配置灵活调整,可在不同的文件中找到不同的有用的信息,格式控制中%c/%t/%l在一个庞大的项目中十分有用。接下来我们看看怎么在代码中使用。
四 在项目中使用log
首先把上文的log4j配置添加到web.xml中,这应该是基于spring-web的,如果不指定,则默认找classpath下的log4j.properties或log4j.xml。
<!-- log4j配置文件位置 -->
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:log4j.properties</param-value>
</context-param>
<!-- 利用spring来使用log4j -->
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
博客里大神如下使用的,这是用的slf4j工具,创建日志实例的语句略有不同,使用方法时一样的。
// 导入slf4j类
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
// 添加slf4j日志实例对象
private final static Logger logger = LoggerFactory.getLogger(Test.class);
// 输出日志
logger.info("输出日志");
鄙人是直接用的log4j,如下:
public class TestLog4j {
private static Logger logger = Logger.getLogger(TestLog4j.class); // 可以是类的字段
public static void main(String[] args) {
// Logger logger = Logger.getLogger(TestLog4j. class ); // 也可以是方法中的局部变量
// 然后在某个过程中你想要的位置使用logger,比如抛出异常的语句,自行定义日志的输出内容 logger.error
logger.debug( " app run " );
logger.error( " error when read file.txt" );
}
}
输出结果大概是这样的,这两条信息也相应输出到了两个文件中,同时也显示在标准输出上。
[DEBUG] 2018-05-23 10:36:10,138 method:learn01.TestLog4j.main(TestLog4j.java:10)
app run
[ERROR] 2018-05-23 10:36:10,150 method:learn01.TestLog4j.main(TestLog4j.java:11)
error when read file.txt
这样,在日志文件中,会按你的要求输出信息,按照你的格式,在%m处就是相应的传入的字符串(如“app run”),而其他内容请参考上面配置部分的教程。
好啦大功告成,希望像我一样的新手可以看明白~