在Java程序设计中,有时候为了记日志,我们会输出到控制台,或者直接写到文件。这样做能满足需求,但是,非常不灵活。这里讲解一款“优秀的Java日志API库”Log4j的使用。
1、环境准备
在IDEA中,新建一个工程“Log4jTest”,然后,在工程目录下新建一个lib目录,导入从Apache官方网站下载的Log4j的jar包,复制到lib目录下。最后,将lib目录添加到Module的依赖中。如下图:
2、Log4j版的“Hello World”
下面通过一个最简单的例子,来大概介绍log4j的使用。
2.1 跑通
在上面工程的src目录中新建一个java文件Log4jTest.java
,输入如下代码:
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
/**
* Created by chengxia on 2018/12/2.
*/
public class Log4jTest {
public static Logger log4jLogger = Logger.getLogger(Log4jTest.class);
public static void main(String[] args) {
PropertyConfigurator.configure ( "log4j.properties" ) ;
System.out.println("Log printing starts!");
log4jLogger.trace("Hello world! Log level: trace");
log4jLogger.debug("Hello world! Log level: debug");
log4jLogger.info("Hello world! Log level: info");
log4jLogger.warn("Hello world! Log level: warn");
log4jLogger.error("Hello world! Log level: error");
log4jLogger.fatal("Hello world! Log level: fatal");
System.out.println("Log printing ends!");
}
}
然后,在工程的根目录下,新建一个log4j的配置文件log4j.properties
,在其中输入log4j文件的配置信息:
log4j.rootLogger=ALL, LogTo1
log4j.appender.LogTo1=org.apache.log4j.ConsoleAppender
log4j.appender.LogTo1.layout=org.apache.log4j.PatternLayout
log4j.appender.LogTo1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
然后运行Log4jTest.java
文件,可以在控制台中看到如下的日志输出:
Log printing starts!
0 TRACE [main] Log4jTest - Hello world! Log level: trace
2 DEBUG [main] Log4jTest - Hello world! Log level: debug
2 INFO [main] Log4jTest - Hello world! Log level: info
2 WARN [main] Log4jTest - Hello world! Log level: warn
2 ERROR [main] Log4jTest - Hello world! Log level: error
2 FATAL [main] Log4jTest - Hello world! Log level: fatal
Log printing ends!
Process finished with exit code 0
这个最简单的用log4j记录日志的java程序就跑通了。
2.2 说明
2.2.1 Java程序
从上面的例子中,可以看出,使用log4j记日志,在Java程序中,只需要两部准备工作:
-
Logger.getLogger(Log4jTest.class);
得到一个Logger实例 -
PropertyConfigurator.configure ("log4j.properties")
根据配置文件,配置日志文件输出信息。
这两部准备工作做完之后,通过直接调用Logger实例的trace、debug、fatal等方法,可以直接记录不同级别的日志。
2.2.2 log4j配置文件
上面log4j.properties
配置文件中的第一行是根Logger配置,其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level是日志记录的级别,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。
上面log4j.properties
配置文件中的后三行,就是配置日志信息输出到哪儿,可以同时指定多个输出目的地。
首先,指定日志输出的append,语法如下:
log4j.appender.appenderName = fully.qualified.name.of.appender.class
其中,Log4j提供的appender有以下几种:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
然后,需要配置appender的布局格式,语法如下:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
其中,Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
到这里,不难理解,上面的例子中,我们将日志输出目的地指定为控制台,并定义了格式。
2.2.3 修改配置文件
上面的配置文件说明中,提到过,可以在配置文件中,修改使日志同时输出到不同的地方。这里我们就简单的做一下修改,将上面例子中的配置文件改为:
log4j.rootLogger=ALL, LogTo1, LogTo2
log4j.appender.LogTo1=org.apache.log4j.ConsoleAppender
log4j.appender.LogTo1.layout=org.apache.log4j.PatternLayout
log4j.appender.LogTo1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
log4j.appender.LogTo2=org.apache.log4j.ConsoleAppender
log4j.appender.LogTo2.layout=org.apache.log4j.PatternLayout
log4j.appender.LogTo2.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
也就是将日志输出到两个地方,这两个地方都是控制台,格式也一样。运行上面同样的java程序:
Log printing starts!
0 TRACE [main] Log4jTest - Hello world! Log level: trace
0 TRACE [main] Log4jTest - Hello world! Log level: trace
1 DEBUG [main] Log4jTest - Hello world! Log level: debug
1 DEBUG [main] Log4jTest - Hello world! Log level: debug
1 INFO [main] Log4jTest - Hello world! Log level: info
1 INFO [main] Log4jTest - Hello world! Log level: info
1 WARN [main] Log4jTest - Hello world! Log level: warn
1 WARN [main] Log4jTest - Hello world! Log level: warn
1 ERROR [main] Log4jTest - Hello world! Log level: error
1 ERROR [main] Log4jTest - Hello world! Log level: error
1 FATAL [main] Log4jTest - Hello world! Log level: fatal
1 FATAL [main] Log4jTest - Hello world! Log level: fatal
Log printing ends!
可以看出,日志确实在控制台输出了两份,尽管这没有意义。更多时候,我们可能想让日志同时输出到文件和控制台,这时候,需要修改log4j配置文件,如下:
log4j.rootLogger=ALL, Log2Console, Log2File
log4j.appender.Log2Console=org.apache.log4j.ConsoleAppender
log4j.appender.Log2Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Log2Console.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
log4j.appender.Log2File = org.apache.log4j.FileAppender
log4j.appender.Log2File.File = log4j.log
log4j.appender.Log2File.Encoding=UTF-8
log4j.appender.Log2File.layout=org.apache.log4j.PatternLayout
log4j.appender.Log2File.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss}[ %p ]%m%n
log4j.appender.Log2File.append = true
运行程序,可以看出日志分别输出到了控制台和文件,如下图。
除了对日志输出目的地进行控制,在log4j配置文件中,也能很方便地对日志输出的级别进行设置。修改上面例子中的日志级别,不符合条件的日志就不会再打出了,大家可以自行实验。
2.2.4 log4j.properties配置文件的路径
缺省地,log4j会读取src目录下的名为log4j.properties的文件作为其日志配置文件。如果是这种情况的话,不需要在程序中显示调用PropertyConfigurator.configure ("log4j.properties")
。也就是下面的代码也能正常运行:
import org.apache.log4j.Logger;
/**
* Created by chengxia on 2018/12/2.
*/
public class Log4jTest {
public static Logger log4jLogger = Logger.getLogger(Log4jTest.class.getName());
public static void main(String[] args) {
System.out.println("Log printing starts!");
log4jLogger.trace("Hello world! Log level: trace");
log4jLogger.debug("Hello world! Log level: debug");
log4jLogger.info("Hello world! Log level: info");
log4jLogger.warn("Hello world! Log level: warn");
log4jLogger.error("Hello world! Log level: error");
log4jLogger.fatal("Hello world! Log level: fatal");
System.out.println("Log printing ends!");
}
}
运行结果如下:
这个特性,可以用在jar包中log4j的日志记录,避免了显示指定log4j.properties文件路径的问题。
3、Log4j的优势
从上面看出,log4j实现了对日志输出更加细粒度的控制。不仅如此,更加关键的一点在于:在上面修改配置文件的实验中,没有改动一行java代码。这样,可以通过改配置文件,就可以控制程序的日志输出,这样,不用改应用程序,也就不用重新编译。我在Log4j官网的介绍中,看到了如下一句话:
It is fully configurable at runtime using external configuration files.
也就是说,没有理解错的话,这个配置文件的改动,应该是可以在运行时生效的。这样一来,就十分强大了。
另外,上面例子中,在获得Logger类实例的时候,传入了类名作为参数。实际上,log4j中也可以通过修改配置文件,也实现日志输出包粒度的控制。大家可以自行实验。
参考
-
使用Log4j进行日志操作
简单的log4j日志例子 - Log4j的Apache官网主页
-
log4j日志输出到文件的配置
日志记录到文件的一个例子 - What does threshold mean in Log4J?