java.util.logging.Logger

来源:互联网 发布:windows模块安装程序 编辑:程序博客网 时间:2024/05/18 18:53


Java日志工具之java.util.logging.Logger

http://www.oseye.net/user/kevin/blog/237 发布于14-03-15 被阅读 1988 次 评论 0 条 

今天总结下JDK自带的日志工具Logger,虽然它一直默默无闻,但有时使用它却比较方便。更详细的信息可以查看JDK API手册,本文只是简单示例入门。

创建Logger

我们可以使用Logger的工厂方法

  1. public static Logger getLogger(String name)
来创建,其中name是logger 的名称,这应该是一个圆点分隔的名称,并且通常应该基于子系统的包名或类名(如net.oseye),这是就Logger的名称空间。如果已经创建了具有给定名称的 logger,则返回该 logger。否则创建一个新的 logger。

每个Logger都有一个"父"Logger,也就是 Logger 名称空间中与其最近的现有祖先,而最顶层有个“Root”Logger,是所有Logger的顶级祖先。

Logger的级别

Level 类定义了一组可用来控制日志输出的标准日志级别。日志 Level 对象是有序的,并且是通过有序的整数来指定。在给定的级别上启用日志记录也就启用了所有较高级别的日志记录。 客户机一般应该使用预定义的 Level 常量(如 Level.SEVERE)。

Logger的级别是比较详细,全部定义在java.util.logging.Level里面,各级别按降序排列如下:

SEVERE(最高值)
WARNING
INFO
CONFIG
FINE
FINER
FINEST(最低值)

此外,还有一个级别 OFF,可用来关闭日志记录,使用级别 ALL 启用所有消息的日志记录。

每个Logger都只关心自己的最低 Level。如果将 Logger 的级别设置为 null,那么它的有效级别继承自父 Logger,这可以通过其父 Logger 一直沿树向上递归得到。 

logger默认的级别是INFO,比INFO更低的日志将不显示,Logger的默认级别定义是在jre安装目录的lib下的logging.properties(properties的使用讲解)文件中:

  1. ############################################################
  2. # Global properties
  3. ############################################################
  4. .....
  5. # Default global logging level.
  6. # This specifies which kinds of events are logged across
  7. # all loggers. For any given facility this global level
  8. # can be overriden by a facility specific level
  9. # Note that the ConsoleHandler also has a separate level
  10. # setting to limit messages printed to the console.
  11. .level= INFO

简单示例

  1. package net.oseye;
  2. import java.util.logging.Logger;
  3. public class RunMain {
  4.  
  5. public static void main(String[] args) {
  6. Logger log=Logger.getLogger("oseye");
  7. Logger logtmp=Logger.getLogger("oseye");
  8. log.fine("fine日志测试");
  9. log.info("info日志测试");
  10. log.warning("warning日志测试");
  11. System.out.println(log==logtmp);
  12. System.out.println(System.getProperty("java.home"));
  13. }
  14. }
输出:

三月 15, 2014 11:14:04 上午 net.oseye.RunMain main
INFO: info日志测试
三月 15, 2014 11:14:04 上午 net.oseye.RunMain main
WARNING: warning日志测试
true
C:\Program Files\Java\jre7

可以看到比info级别低的fine日志没有显示,而log和logtmp都是名为"oseye"的Logger。

此时你可以修改logging.properties来设置级别,但首先需要确定你用的那个JRE(安装JDK后会有多个JRE),只有找到正确的JRE修改的配置才有效,本例中使用的JRE是:

C:\Program Files\Java\jre7

Logger的Handler

Handler 对象从 Logger 中获取日志信息,并将这些信息导出,而且向父级递归传递信息。例如,它可将这些信息写入控制台或文件中,也可以将这些信息发送到网络日志服务中,或将其转发到操作系统日志中。 Handler 类通常使用 LogManager 属性来设置 Handler 的 Filter、Formatter 和 Level 的默认值。Handler的子类如下:

  1. java.util.logging.Handler
  2. java.util.logging.MemoryHandler
  3. java.util.logging.StreamHandler
  4. java.util.logging.ConsoleHandler
  5. java.util.logging.FileHandler
  6. java.util.logging.SocketHandler
可以使用下面的方法来操作Handler:
  1. public void addHandler(Handler handler) //添加
  2. public void removeHandler(Handler handler) //删除
  3. public Handler[] getHandlers() //获取
  4. public void setUseParentHandlers(boolean useParentHandlers) //是否应该将其输出发送到它的父 Logger
示例代码:
  1. package net.oseye;
  2.  
  3. import java.util.logging.ConsoleHandler;
  4. import java.util.logging.Handler;
  5. import java.util.logging.Logger;
  6.  
  7. public class RunMain {
  8.  
  9. public static void main(String[] args) {
  10. Logger log=Logger.getLogger("oseye");
  11. Handler[] handleList=log.getHandlers();
  12. System.out.println("oseye的handler数:"+handleList.length);
  13. handleList=log.getParent().getHandlers();
  14. System.out.println("oseye的父级handler数:"+handleList.length);
  15. for(Handler h:handleList){
  16. System.out.println(h);
  17. }
  18. log.addHandler(new ConsoleHandler());
  19. log.info("两个handler处理,一个自定义,另一个是祖先");
  20. }
  21. }
输出:

oseye的handler数:0
oseye的父级handler数:1
java.util.logging.ConsoleHandler@125844f
三月 15, 2014 11:35:12 上午 net.oseye.RunMain main
INFO: 两个handler处理,一个自定义,另一个是祖先
三月 15, 2014 11:35:12 上午 net.oseye.RunMain main
INFO: 两个handler处理,一个自定义,另一个是祖先

  • 默认的oseye是没有handler的,但其父级有默认的是ConsoleHander,这个可以在默认的logging.properties配置文件可以看到:
    1. handlers= java.util.logging.ConsoleHandler
  • 增加了一个ConsoleHandler,可以看到信息是向上传递的,直到达到顶层,但可以使用setUseParentHandlers来设置是否传递;
  • 每个handler也可以设置自己的Level,这个留给你当家庭作业吧。

日志内容的格式化

一般来说,每个日志记录 Handler 都有关联的 Formatter。Formatter 接受 LogRecord,并将它转换为一个字符串。 有些 Formatter(如 XMLFormatter)需要围绕一组格式化记录来包装头部和尾部字符串。可以使用 getHeader 和 getTail 方法来获得这些字符串。 
  1. package net.oseye;
  2.  
  3. import java.io.File;
  4. import java.util.logging.FileHandler;
  5. import java.util.logging.Formatter;
  6. import java.util.logging.Level;
  7. import java.util.logging.LogRecord;
  8. import java.util.logging.Logger;
  9.  
  10. public class RunMain {
  11.  
  12. public static void main(String[] args) throws Exception {
  13. Logger log=Logger.getLogger("oseye");
  14. FileHandler fileHandler=new FileHandler("d:"+File.separator+"log.txt");
  15. fileHandler.setFormatter(new Formatter() {
  16. @Override
  17. public String format(LogRecord arg0) {
  18. return arg0.getLoggerName()+"\t"+arg0.getLevel()+"\t"+arg0.getMessage();
  19. }
  20. });
  21. fileHandler.setLevel(Level.WARNING);
  22. log.addHandler(fileHandler);
  23. log.setUseParentHandlers(false);
  24. log.warning("警告信息");
  25. }
  26. }
示例中使用了FileHandler,而且禁止日志消息向上传递,在"d:\log.txt"中可以看到:

oseye WARNING 警告信息

在setFormatter时我使用匿名类(你可以使用别的方式),其中LogRecord 对象用于在日志框架和单个日志 Handler 之间传递日志请求。

自定义配置文件

自定义配置文件有两种方式:

  1. Logger默认的是使用jre安装目录的lib下的logging.properties配置文件,但logging.properties明确的给出使用其他自定义配置文件的说明:
    1. ############################################################
    2. # Default Logging Configuration File
    3. #
    4. # You can use a different file by specifying a filename
    5. # with the java.util.logging.config.file system property.
    6. # For example java -Djava.util.logging.config.file=myfile
    7. ############################################################
    因此如果你的配置文件是"d:\logging.properties",当你执行的使用这样用即可:
    1. java -Djava.util.logging.config.file=d:\logging.properties net.oseye.RunMain
  2. 使用LogManager
    Logger默认的是使用jre安装目录的lib下的logging.properties配置文件,这可以从java.util.logging.LogManager的代码看出:

    从代码中我们可以有两种方式加载自定义配置文件,第一种是指定加载自定义的LogManager类,然后再在LogManager来加载自定义配置文件;第二种方式是通过设置"java.util.logging.config.file"系统属性,从而加载自定义配置文件。
    我们用第二种示例,第一种作为家庭作业吧
    1. package net.oseye;
    2. import java.util.logging.Logger;
    3.  
    4. public class RunMain {
    5. public static void main(String[] args) throws Exception {
    6. System.setProperty("java.util.logging.config.file", "d:\\logging.properties");
    7. Logger log = Logger.getLogger("oseye");
    8. log.warning("警告信息");
    9. }
    10. }
    上面示例我用的是绝对路径,实际生成中切记不可如此,可根据需求自己修改。
0 0
原创粉丝点击