如何在项目中用好log4J写项目日志

2008 - 04 - 18

博客分类： 
• Java基础

log4j

一般的系统对程序的调试信息只进行了简单的粗放处理，将这些信息直接用System.out.println()语句输出到控制台中。由于在调度过程中程序员为了能够跟踪程序的运行情况往往将大量信息输出到控制台，而在调度成功后没有相应地将这些信息屏蔽掉，在程序部署运行后，往往一个简单的业务功能调用也会输出大容量的过程调度信息，一方面造成了大量IO的读写，占用硬盘空间，另一方面则因为日志量大，很难查找到运行期有用的日志信息。

程序异常，资源释放操作失败这些信息是发现程序问题，定位出错点的信息依据，得不到这些信息将导致程序错误被屏蔽，要想使问题浮出水面程序必须能够提供详细而简洁的日志信息。

?log4J是为java语言量身定做的一个日志模块，用统一的接口写日志，通过配置文件信息控制日志信息的输出格式、目的及输出级别（指定输出级别后，只有比输出级别更高的日志会被输出）。可以在不更改程序输出日志的情况下方便日志输出的控制，为日志的操作提供了很大的灵活性。
2 log4J的基本操作
2.1写日志的API

 log4J将日志分为5个级别，从低到高分别是DEBUG,INFO,WARN,ERROR,FATAL,相应地log4J为记录这5个级别提供了5个方法，它们分别是：

   public void debug(Object obj)

   public void info(Object obj)

   public void warn(Object obj)

   public void error(Object obj)

   public void fatal(Object obj)

同时每个方法还对应一个带Throwable入参的重载函数,用于将异常一并记录到日志中：

   public void debug(Object obj,Throwable ex)

   public void info(Object obj,Throwable ex)

   public void warn(Object obj,Throwable ex)

   public void error(Object obj,Throwable ex)

   public void fatal(Object obj,Throwable ex)

5个级别记录信息的重要性依次提升，下面就每个记录方法对应的应用场合举例如下：
2.1.1 写日志API的使用示例

     在程序中如何恰当级别的日志记录API记录日志信息是非常重要的，一般的我们将信息以其重要性调用将其划分为5个级别，分别调用相应的API来记录，我们以一个查询数据库的代码段来说明各级别的划分：

Connection conn = null;
    String sqlStr = "select * from table1 where a=’"+a+"’";
    // 测试变量是否正确，在调度时查看，以后不会用
    logger.debug("sqlStr字串为:"+sqlStr);
    // ...
    try
    {
    conn = DBBean.getConnection();
    Statement stat = conn.createStatement();
    ResultSet rs = stat.executeQuery(sqlStr);
    if(rs.next())
    {
         logger.info("有记录");
               // 查看程序运行中的信息，反映程序及配置信息的情况
    }
    else
    {
           logger.warn("因配置要求至少要有一条记录，请核对配置信息。");
          // 假设配置信息要求一条配置记录，当找不到记录时应该警告，
               // 以并更改配置
    }
    }catch(SQLException e)
    {
              logger.error("数据查询时发生异常",e);
             // 发生了查询异常，可能是sqlStr语句的语法错误造成的
    }
    finally
    {
    try
    {
     if(conn != null)
    {
      conn.close();
       conn = null;
    }
    }
    catch(SQLException e)
    {
            logger.warn("数据连接无法关闭，连接将无法释放",e);
            // 数据连接无法关闭将导致资源泄漏，可能是系统原因产生的
               // 如果持续产生这个问题，开发人员需要查明原因，
               // 否则系统将因数据连接资源无法释放而崩溃
    }
    }