使用Log4j在程序中加入日志

类别:Java 点击:0 评论:0 推荐:

在网上学习了一下Log4j,以下是一些简单的学习笔记

Apache的开源项目Log4j是一个功能强大的日志组件,提供快速有效的日志记录,开发者通过简单的学习,即可为自己的程序中加入非常实用的日志功能。
在apache网站:http://jakarta.apache.org/log4j 可以免费下载到Log4j最新版本的软件包,解压,将其中打包好的的log4j-1.x.x.jar文件复制到classpath相关目录下 。

一、快速体验
ok,现在就可以来体验一下Log4j的功能,按以下步骤在程序中快速加入了日志功能。
参看下面这个简单的例子一:
第一步: 用import导入Log4j需要使用的相关的类
第二步: 定义获取一个日志记录器Logger的对象
第三步: 装入Log4j的配置文件,或者使用缺省环境的配置
第四步:现在可以在你的程序中想输出日志的地方,使用Logger类提供的以下方法,插入不同优先级的日志了。
 debug(Object message ) ;
 info(Object message ) ;
 warn(Object message ) ;
 error(Object message ) ;

大功告成!是不是非常简单呢?完全可以取代以前常用来调试程序的System.out.println("xxxxxxxxxxxx")这样的语句,而且log4j可以通过自定义配置文件来灵活地对日志输出的级别进行控制。
#########################################
例子一:
package com.study;

/**导入Log4j需要使用的相关的类*/
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;

/**
 * <p>Title: Log4j例子</p>
 * <p>Description: 快速在程序中使用Log4j</p>
 * <p>Copyright: Copyright (c) 2004</p>
 * @author Robin
 * @version 1.0
 */
public class HelloLog4j {

  //定义日志记录器logger,所有的日志由它来负责记录,
  static Logger logger=Logger.getLogger(HelloLog4j.class.getClass());

  public static void main(String[] args) {
    //使用缺省环境来配置Log4j
    BasicConfigurator.configure();
 //使用配置文件来配置Log4j
 //PropertyConfigurator.configure ( "D:\\testLog4j.properties" ) ;

    //插入日志信息
    logger.info("HelloLog4j开始执行");
    try {
      HelloLog4j helloLog4j1 = new HelloLog4j();
      int count=helloLog4j1.count(1,-32);
      logger.debug("count的值为:"+count);
    }
    catch (Exception e) {
      logger.error("error"+e.getMessage());
    }
    logger.info("HelloLog4j执行完成");   
  }
  /**
   * 求两整数数之和
   * */
  public int count(int a,int b) {
    int add=a+b;
    if (add<0){
      logger.warn("两数之和小于零");
    }
    return add;
  }
}
#########################################
二、配置Log4j
我们可以通过自定义定义配置文件来对日志的输出进行动态的控制。
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件(键=值)。
可以用以下方式来载入配置文件:
 1、载入使用Java 键—值对的属性文件编写的配置文件。
 PropertyConfigurator.configure ( String configFilename)
 2、载入XML形式的配置文件
 DOMConfigurator.configure ( String filename )。

看一个简单的java属性配置文件testLog4j.properties:
#########################################
#指定根Logger,及日志输出级别,大于等于该级别的日志将被输出( DEBUG < INFO < WARN < ERROR < FATAL ) 设为OFF可以关闭日志
log4j.rootLogger=DEBUG, A1,A2
#指定log输出目的,这里设为输出日志到指定目录的文件my.log中
log4j.appender.A1=org.apache.log4j.FileAppender
log4j.appender.A1.File=d:\\study\\my.log
#指定日志信息的格式
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%r %d{yyyy-MM-dd HH:mm:ss} %c %p -%m%n

#把A2输出到控制台
log4j.appender.A2=org.apache.log4j.ConsoleAppender
log4j.appender.A2.layout=org.apache.log4j.SimpleLayout

#还可以单独指定输出某个包的日志级别
#log4j.logger.com.study.HelloLog4j=INFO
#########################################

1、配置根Logger,其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName2
level:日志的级别,指定这条日志信息的重要性。分为ALL < DEBUG < INFO < WARN <ERROR < FATAL < OFF
一般常用的为 DEBUG , INFO ,WARN ,ERROR四种,分别对应Logger类的四种方法
 debug(Object message ) ;
 info(Object message ) ;
 warn(Object message ) ;
 error(Object message ) ;
如果设置级别为INFO,则优先级大于等于INFO级别(如:INFO、WARN、ERROR)的日志信息将可以被输出,小于该级别的如:DEBUG将不会被输出
appenderName :就是指定日志信息输出目的地,比如(打印到控制台,输出到文件等)。同一条日志信息可以配置多个输出目的地。

2、配置log输出目的地
 Log4j提供以下几种:
 org.apache.log4j.ConsoleAppender(控制台)
 org.apache.log4j.FileAppender(文件)
 org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
 org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
 org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
3、log信息的格式
 org.apache.log4j.HTMLLayout(HTML表格形式)
 org.apache.log4j.SimpleLayout(简单格式的日志,只包括日志信息的级别和指定的信息字符串 ,如:DEBUG - Hello)
 org.apache.log4j.TTCCLayout(日志的格式包括日志产生的时间、线程、类别等等信息)
 org.apache.log4j.PatternLayout(灵活地自定义日志格式)

当使用org.apache.log4j.PatternLayout来自定义信息格式时,可以使用
log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %p -%m%n 来格式化信息
%c    输出所属类的全名,可写为 %c{Num} ,Num类名输出的范围  如:"com.sun.aaa.classB", %C{2}将使日志输出输出范围为:aaa.classB
%d    输出日志时间其格式为 可指定格式 如 %d{HH:mm:ss}等
%l    输出日志事件发生位置,包括类目名、发生线程,在代码中的行数
%n    换行符
%m    输出代码指定信息,如info(“message”),输出message
%p    输出日志的优先级,即 FATAL ,ERROR 等
%r    输出从启动到显示该条日志信息所耗费的时间(毫秒数)
%t    输出产生该日志事件的线程名
更详细参数信息可参看类org.apache.log4j.PatternLayout的API doc文档

关于性能:
加入日志总是会带来一些性能损耗,当然绝大多数情况下可以忽略不计。
1、当某个级别的日志被屏蔽输出时,比如,配置级别为INFO,那么程序中DEBUG级别的日志语句将被禁止输出
如:
 logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
以上语句中,虽然debug语句里的消息不会输出到日志里,但消息中字符串构造的操作依然会执行,当操作比较复杂时,有时会带来一些性能损耗,可以改成一下写法:
 if(logger.isDebugEnabled() {
        logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
    }
则一旦DEBUG级别被禁止输出,则不会执行日志信息后面的字符串操作。
2、由于日志记录器Logger,支持命名的层次,所以在子层次向上查找继承自父层次的日志级别时,也可能会有一些性能损耗。

总之,Log4j的设计目标已经充份考虑到了速度优先。经过多次的改写,性能问题已经几乎基本完全不是问题,它是一个非常优秀的工具组件,使用它带来的好处,大大多于失去的那一点点性能损耗。完全可以大胆使用。

本文地址:http://com.8s8s.com/it/it11780.htm