Java中的日志——Java.util.logging、log4j、commons-logging

亦凉 2022-06-18 00:24 136阅读 0赞

[Java][]中给项目程序添加log主要有三种方式，一使用JDK中的java.util.logging包，一种是log4j，一种是[commons-logging][]。其中log4j和[commons-logging][]都是apache软件基金会的开源项目。这三种方式的区别如下：

Java.util.logging，JDK标准库中的类，是JDK 1.4 版本之后添加的日志记录的功能包。

log4j，最强大的记录日志的方式。可以通过配置 .properties 或是 .xml 的文件， 配置日志的目的地，格式等等。

commons-logging，最综合和常见的日志记录方式，是Java中的一个日志接口，一般会与log4j一起使用。自带SimpleLog可用于日志记录。

### 1.Java.util.logging ###

【例1.1】：日志的简单使用

**\[java\]** [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **package** lwf.log.test; 
2.  
3.  **import** java.util.logging.Logger; 
4.  
5.  **public****class** LogTest \{ 
6.  **static** String strClassName = LogTest.**class**.getName(); 
7.  **static** Logger logger = Logger.getLogger(strClassName); 
8.  
9.  **public****static****double** division(**int** value1, **int** value2) \{ 
10. **double** result = 0; 
11. **try** \{ 
12.  result = value1 / value2; 
13.  \} **catch**(ArithmeticException e) \{ 
14.  logger.warning("除数不能为0."); 
15.  e.printStackTrace(); 
16.  \} 
17. **return** result; 
18.  \} 
19. 
20. **public****static****void** main(String\[\] args) \{ 
21.  System.out.println(division(5, 0)); 
22.  \} 
23. \}

结果：

![Center][]

从这个例子中你会看到控制台上输出了日期时间，类名，方法名和“\[warning\]除数不能为0.”的信息。

Logger是Java Logging API中的一个类，Logger.getLogger方法创建了一个Logger实例。每一个Logger实例都必须有个名称，通常的做法是使用类名称定义Logger实例。

logger.warning方法用来输出日志信息，除了warning处，还有severe、info等。我们可以把【例1】再改一下，让其输出各种日志信息。

【例1.2】：日志的级别

**\[java\]** [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **public****static****double** division(**int** value1, **int** value2) \{ 
2.  **double** result = 0; 
3.  **try** \{ 
4.   result = value1 / value2; 
5.   \} **catch**(ArithmeticException e) \{ 
6.   logger.severe("\[severe\]除数不能为0."); 
7.   logger.warning("\[warning\]除数不能为0."); 
8.   logger.info("\[info\]除数不能为0."); 
9.   logger.config("\[config\]除数不能为0."); 
10.  logger.fine("\[fine\]除数不能为0."); 
11.  logger.finer("\[finer\]除数不能为0."); 
12.  logger.finest("\[finest\]除数不能为0."); 
13.  e.printStackTrace(); 
14.  \} 
15. **return** result; 
16. \}

结果：

![Center 1][]

Java Logging API提供了七个日志级别用来控制输出。这七个级别分别是：

<table style="color:rgb(85,85,85); font-family:&quot;microsoft yahei&quot;; font-size:15px; line-height:35px; border-collapse:collapse"> 
 <tbody> 
 <tr> 
 <td> 级别 </td> 
 <td> SEVERE </td> 
 <td> WARNING&nbsp; </td> 
 <td> INFO </td> 
 <td> CONFIG&nbsp; </td> 
 <td> FINE&nbsp; </td> 
 <td> FINER </td> 
 <td> FINEST </td> 
 </tr> 
 <tr> 
 <td> 调用方法 </td> 
 <td> severe() </td> 
 <td> warning() </td> 
 <td> info() </td> 
 <td> config() </td> 
 <td> fine() </td> 
 <td> finer() </td> 
 <td> finest() </td> 
 </tr> 
 <tr> 
 <td> 含意 </td> 
 <td> 严重 </td> 
 <td> 警告 </td> 
 <td> 信息 </td> 
 <td> 配置 </td> 
 <td> 良好 </td> 
 <td> 较好 </td> 
 <td> 最好 </td> 
 </tr> 
 </tbody> 
</table>

但在上面的例子中我们可以看到只输出了SEVERE、WARNING、INFO三个等级的日志，并没有如我们相像中的好样输出各个级别的日志信息。这是因为默认日志输出级别的设置是info，也就是说只有info或它以上的级别被输出，它以下的级别不被输出。那如何修改这个设置呢？

日志(Log)的配制:

1.代码设置

使用setLevel();但这种方式不能改变console的级别，只能改变输出到文件的日志的级别。

2.修改logging.properties

默认的外部配置文件 是JRE中lib/logging.properties文件。你可以打开这个文件，修改以下两行为：

这种方式会影响jre下所有用户。

为了不影响到所有的用户，我们还可以通过LogManager的readConfiguration(InputStream ins)读取指定的配制文件。

【例1.3】：LogManager管理日志

**\[java\]** [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **package** lwf.log.test; 
2.  
3.  **import** java.io.IOException; 
4.  **import** java.io.InputStream; 
5.  **import** java.util.logging.FileHandler; 
6.  **import** java.util.logging.Handler; 
7.  **import** java.util.logging.Level; 
8.  **import** java.util.logging.LogManager; 
9.  **import** java.util.logging.LogRecord; 
10. **import** java.util.logging.Logger; 
11. **import** java.util.logging.SimpleFormatter; 
12. 
13. **public****class** LogTest \{ 
14. **static** String strClassName = LogTest.**class**.getName(); 
15. **static** Logger logger = Logger.getLogger(strClassName); 
16. **static** LogManager logManager = LogManager.getLogManager(); 
17. 
18. **static** \{ 
19.  InputStream inputStream = **null**; 
20. **try** \{ 
21. //读取配制文件
22.  inputStream = LogTest.**class**.getClassLoader().getResourceAsStream("log.properties"); 
23.  logManager.readConfiguration(inputStream); 
24. //添加Logger
25.  logManager.addLogger(logger); 
26.  \} **catch** (SecurityException e) \{ 
27.  e.printStackTrace(); 
28.  \} **catch** (IOException e) \{ 
29.  e.printStackTrace(); 
30.  \} 
31.  \} 
32. **public****static****double** division(**int** value1, **int** value2) \{ 
33. **double** result = 0; 
34. **try** \{ 
35.  result = value1 / value2; 
36.  \} **catch**(ArithmeticException e) \{ 
37.  logger.severe("\[severe\]除数不能为0."); 
38.  logger.warning("\[warning\]除数不能为0."); 
39.  logger.info("\[info\]除数不能为0."); 
40.  logger.config("\[config\]除数不能为0."); 
41.  logger.fine("\[fine\]除数不能为0."); 
42.  logger.finer("\[finer\]除数不能为0."); 
43.  logger.finest("\[finest\]除数不能为0."); 
44.  e.printStackTrace(); 
45.  \} 
46. **return** result; 
47.  \} 
48. 
49. **public****static****void** main(String\[\] args) \{ 
50.  System.out.println(division(5, 0)); 
51.  \} 
52. \}

log.properties:

<table style="color:rgb(85,85,85); font-family:&quot;microsoft yahei&quot;; font-size:15px; line-height:35px; border-collapse:collapse"> 
 <tbody> 
 <tr> 
 <td> #&nbsp;"handlers"&nbsp;specifies&nbsp;a&nbsp;comma&nbsp;separated&nbsp;list&nbsp;of&nbsp;log&nbsp;Handler&nbsp; #handlers=&nbsp;java.util.logging.ConsoleHandler handlers=&nbsp;java.util.logging.FileHandler &nbsp; #&nbsp;Default&nbsp;logging&nbsp;level. .level=&nbsp;CONFIG &nbsp; #&nbsp;default&nbsp;file&nbsp;output&nbsp;is&nbsp;in&nbsp;"E:\Test"&nbsp;directory. java.util.logging.FileHandler.pattern&nbsp;=&nbsp;E:/Test/Log%u.log&nbsp; java.util.logging.FileHandler.limit&nbsp;=&nbsp;50000 java.util.logging.FileHandler.count&nbsp;=&nbsp;1 java.util.logging.FileHandler.formatter&nbsp;=&nbsp;java.util.logging.SimpleFormatter &nbsp; #&nbsp;Limit&nbsp;the&nbsp;message&nbsp;that&nbsp;are&nbsp;printed&nbsp;on&nbsp;the&nbsp;console&nbsp;to&nbsp;CONFIG&nbsp;and&nbsp;above. java.util.logging.ConsoleHandler.level&nbsp;=&nbsp;CONFIG java.util.logging.ConsoleHandler.formatter&nbsp;=&nbsp;java.util.logging.SimpleFormatter &nbsp; &nbsp; #&nbsp;Facility&nbsp;specific&nbsp;properties.Provides&nbsp;extra&nbsp;control&nbsp;for&nbsp;each&nbsp;logger. #&nbsp;For&nbsp;example,&nbsp;set&nbsp;the&nbsp;com.xyz.foo&nbsp;logger&nbsp;to&nbsp;only&nbsp;log&nbsp;SEVERE&nbsp;messages: com.xyz.foo.level&nbsp;=&nbsp;SEVERE </td> 
 </tr> 
 </tbody> 
</table>

这样，用户就可以自己定义配制文件了。在E:\\Test下可以看到输出的日志文件Log0.log

java.util.logging包中类的关系图如下：

![Center 2][]

参考文章：

[http://blog.csdn.net/dl88250/article/details/1843813][http_blog.csdn.net_dl88250_article_details_1843813]

### 2.log4j  ###

1.项目串导入log4j的jar包

如Eclipse下项目名右键，Build Path\\Add Libraries，添加一组用户自己的jar包。项目结构如下：

![Center 3][]

2.修改log4j的配制文件，设置日志输出的级别、格式等

log4j的log有5个级别：FATAL(严重的 )、ERROR(错误 )、WARN(警告)、INFO(信息)、DEBUG(调试 )。

3.在项目代码中适当添加日志。

【例2.1】

log4j.properties:

代码：

**\[java\]** [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  **package** lwf.log.test; 
2.  
3.  **import** org.apache.log4j.Logger; 
4.  
5.  **public****class** Log4jTest \{ 
6.  **private****static** Logger logger = Logger.getLogger(Log4jTest.**class**); 
7.  
8.  **public****static****void** main(String\[\] args) \{ 
9.   System.out.println("This is log4j test."); 
10. // 记录debug级别的信息 
11.  logger.debug("This is debug message."); 
12. // 记录info级别的信息 
13.  logger.info("This is info message."); 
14. // 记录error级别的信息 
15.  logger.error("This is error message."); 
16.  \} 
17. 
18. \}

log4j的使用和配制另参见：[http://blog.csdn.net/luoweifu/article/details/43638495][http_blog.csdn.net_luoweifu_article_details_43638495]

### 3.commons-logging ###

commons-logging提供的是一个日志(Log)接口(interface)，是为那些需要建立在不同环境下使用不同日志[架构][Link 1]的组件或库的开发者创建的，其中包括Apache Log4j以及Java log的日志架构。把日志信息抽象成commons-logging的Log接口，并由commons-logging在运行时决定使用哪种日志架构。因为Log4j的强大功能，commons-logging一般会和Log4j一起使用，这几乎成为了Java日志的标准工具。

commons-logging有两个基本的抽象类：Log(基本记录器)和LogFactory(负责创建Log实例)。当commons-logging.jar被加入到CLASSPATH（通常将commons-logging.jar放在web project下的WebContent\\WEB-INF\\lib目录中）之后，它会合理地猜测你想用的日志工具，然后进行自我设置，用户根本不需要做任何设置。默认的LogFactory是按照下列的步骤去发现并决定那个日志工具将被使用的（按照顺序，寻找过程会在找到第一个工具时中止，这个顺序非常重要）:

00001. 寻找当前factory中名叫org.apache.commons.logging.Log配置属性的值

00002. 寻找系统中属性中名叫org.apache.commons.logging.Log的值

00003. 如果应用程序的classpath中有log4j,则使用相关的包装(wrapper)类(Log4JLogger)

00004. 如果应用程序运行在jdk1.4的系统中，使用相关的包装类(Jdk14Logger)

00005. 使用简易日志包装类(SimpleLog)

commons-logging与log4j的配合使用：

项目目录结构：

![Center 4][]

common-logging.properties：

代码：

**\[cpp\]** [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  package lwf.log.test; 
2.  
3.  import org.apache.log4j.Logger; 
4.  
5.  **public****class** Log4jTest \{ 
6.  **private****static** Logger logger = Logger.getLogger(Log4jTest.**class**); 
7.  
8.  **public****static****void** main(String\[\] args) \{ 
9.   System.out.println("This is log4j test."); 
10. // 记录debug级别的信息 
11.  logger.debug("This is debug message."); 
12. // 记录info级别的信息 
13.  logger.info("This is info message."); 
14. // 记录error级别的信息 
15.  logger.error("This is error message."); 
16.  \} 
17. 
18. \}

参考：

[http://www.cnblogs.com/xwdreamer/archive/2011/12/28/2304598.html][http_www.cnblogs.com_xwdreamer_archive_2011_12_28_2304598.html]

[http://shift8.iteye.com/blog/1316802][http_shift8.iteye.com_blog_1316802]

http://blog.csdn.net/luoweifu/article/details/46495045

[Java]: http://lib.csdn.net/base/javase
[commons-logging]: http://mirrors.cnnic.cn/apache//commons/logging/binaries/commons-logging-1.2-bin.zip
[view plain]: http://blog.csdn.net/luoweifu/article/details/43777293#
[CODE]: https://code.csdn.net/assets/CODE_ico.png
[CODE_CODE]: https://code.csdn.net/snippets/603932
[ico_fork.svg]: https://code.csdn.net/assets/ico_fork.svg
[ico_fork.svg 1]: https://code.csdn.net/snippets/603932/fork
[Center]: /images/20220618/8720b4c0b2a64899923dee38ad9cea75.png
[Center 1]: /images/20220618/f0691f90d6324c25bf6dd40607f70835.png
[Center 2]: /images/20220618/2df35ecc07014f3bba97e90a973ceaae.png
[http_blog.csdn.net_dl88250_article_details_1843813]: http://blog.csdn.net/dl88250/article/details/1843813
[Center 3]: /images/20220618/e9663d2d822149bc82941c05d79f3fee.png
[http_blog.csdn.net_luoweifu_article_details_43638495]: http://blog.csdn.net/luoweifu/article/details/43638495
[Link 1]: http://lib.csdn.net/base/architecture
[Center 4]: /images/20220618/bc370b7d16f741208f5f09676e42717d.png
[http_www.cnblogs.com_xwdreamer_archive_2011_12_28_2304598.html]: http://www.cnblogs.com/xwdreamer/archive/2011/12/28/2304598.html
[http_shift8.iteye.com_blog_1316802]: http://shift8.iteye.com/blog/1316802