log4j的使用经验及技巧

       Java开发项目很多都有记录日志的功能，使用较多的日志组件要属log4j，在网上有许多资料，结合以往项目，谈谈我在使用它的经验和技巧。log4j组件记录日志很多项目使用比较简单，简单配置一下，就可以记录日志了，许多开发人员往往只对应用系统的业务程序比较关注，对记录日志并不关注很多，只要实现记录日志就可以。但在项目维护中，往往根据日志查看分析问题原因，日志记录内容、方式就显得比较重要，设计合理的记录日志的内容、方式，会给我们分析问题原因带来便利。

      1.使用一定规范命名方式来命名日志文件

       例如：在集群环境下记录日志，为便于区分不同机器、不同时间等因素产生的日志，可以采用一定的命名方式来区分。下面以实例说明。

看看一般方式的简单日志组件配置文件如下

<appender name="FILE_INFO" class="org.apache.log4j.RollingFileAppender">                   <param name="File" value="/usr/local/logs/xxx_info.log"/>     <layout class="org.apache.log4j.PatternLayout">         <param name="ConversionPattern" value="%d %p [%c] [%M]:%L - %m%n"/>     </layout>     <filter class="org.apache.log4j.varia.LevelRangeFilter">         <param name="levelMin" value="INFO" />         <param name="levelMax" value="INFO" />         <param name="AcceptOnMatch" value="true" />     </filter> </appender>

        按这种方式在单机环境下可以很方便的查询日志。但是在集群环境下，因为项目同时部署在多个机器上，log4j生成的日志文件在每台机器上都叫xxx_info.log,在开发维护的过程中很难区分那个文件是哪台服务上的，尤其在日志查询比较频繁的情况下做区分有一定的工作量。
       为解决这一问题，我们可以约定一个日志文件的命名方式，比如增加机器标识、时间标识。如100_xxx_info.log.2012-02-01，是在ip为172.20.80.100这台机器上2012-02-01日产生的日志。

       实现这一功能需要对log4j的Appender做些改动。通过查看log4j源码可以看出来所有的文件输出都会继承FileAppender ，修改setFile(String file)方法即可实现。范例代码如下：

package test; 。。。 public class DailyRollingFileAppender extends FileAppender { 。。。 /* 从配置文件读取日志文件名 */                                                                                                                                                                            public void setFile(String file) {         String val = file.trim();         int index = val.lastIndexOf('/') + 1;         String path = val.substring(0, index);         String name = val.substring(index);         fileName = path + getIpSuffix() + "_" + name;     }     // 获取本机ip最后一位(双网卡内网ip)     private String getIpSuffix() {         String ip = null;         String suffix = "";         NetworkInterface ni;         try {             ni = NetworkInterface.getByName("eth1");             if (ni == null)                 ni = NetworkInterface.getByName("eth0");             Enumeration<InetAddress> ias = ni.getInetAddresses();             for (; ias.hasMoreElements();) {                 InetAddress ia = ias.nextElement();                 if (ia instanceof InetAddress) {                     ip = ia.getHostAddress();                 }             }             if (ip == null) {                 InetAddress addr = InetAddress.getLocalHost();                 ip = addr.getHostAddress();             }         } catch (SocketException e1) {             e1.printStackTrace();         } catch (UnknownHostException e) {             e.printStackTrace();         }         if (ip != null) {             int index = ip.lastIndexOf('.') + 1;             suffix = ip.substring(index);         }         return suffix;     }

log4j.xml配置文件修改如下：

<appender name="FILE_INFO" class="test.DailyRollingFileAppender">                                                                                                      <param name="File" value="/usr/local/logs/bss_info.log"/>  <layout class="org.apache.log4j.PatternLayout">   <param name="ConversionPattern" value="%d %p [%c] [%M]:%L - %m%n"/>  </layout>  <filter class="org.apache.log4j.varia.LevelRangeFilter">   <param name="levelMin" value="INFO" />   <param name="levelMax" value="INFO" />   <param name="AcceptOnMatch" value="true" />  </filter> </appender>

经这样配置，log4j日志组件生成的日志文件格式为类似100_xxx_info.log.2012-02-01，这样就便于区分日志，便于分析。