Log4j1的使用与log4j.properties的配置

这里介绍Log4j１（即Log4j 1.x版本），这里以普通的Java项目为例，用eclipse编写，项目结构如下图所示：

该项目主要包括：

java文件：Log4jv1Util 以及 Log4jv1Test
一些log4j的jar包：
log4j的配置文件：log4j.properties

Log4jv1Util的代码如下所示：

package cn.zc.tool.utils.log4jv1.main;

import java.io.FileInputStream;
import java.util.Properties;

import org.apache.log4j.PropertyConfigurator;

public class Log4jv1Util {

    /**
     * 初始化配置文件log4j.properties
     */
    public static void initLog4jv1Config() {
        // 获取工程目录
        String path = System.getProperty("user.dir");
        //path += "/conf/";
        String file = path + "/conf/log4j.properties";
        initLog4jv1Config(file);
    }
    
    /**
     * 初始化配置文件log4j.properties
     * @param file log4j.properties文件，例如 /path/to/log4j.properties
     */
    public static void initLog4jv1Config(String file) {
        Properties props = null;
        FileInputStream fis = null;
        
        try {
            // 从配置文件dbinfo.properties中读取配置信息
            props = new Properties();
            fis = new FileInputStream(file);
            props.load(fis);
            PropertyConfigurator.configure(props);// 装入log4j配置信息
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (fis != null)
                try {
                    fis.close();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            fis = null;
        }
    }
    
}

Log4jv1Test的代码如下所示：

package cn.zc.tool.utils.log4jv1.test;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.log4j.Logger;

import cn.zc.tool.utils.log4jv1.main.Log4jv1Util;

public class Log4jv1Test {

    private static Logger LOG = Logger.getLogger(Log4jv1Test.class);
    
    //private static Log myLOG = LogFactory.getLog("Log4jv1Hello");
    private static Logger myLOG = Logger.getLogger("Log4jv1Hello");
    
    public static void main(String[] args) {
        // 获取工程目录
        //String path = System.getProperty("user.dir");
        //path+="/conf/log4j.properties";
        //Log4jv1Util.initLog4jv1Config(path);
        
        Log4jv1Util.initLog4jv1Config();
        
        outputMessage(LOG);
        outputMessage(myLOG);
    }
    
    public static void outputMessage(Logger log) {
        log.trace("Trace Message!");
        log.debug("Debug Message!");
        log.info("Info Message!");
        log.warn("Warn Message!");
        log.error("Error Message!");
        log.fatal("Fatal Message!");
    }
}

log4j.properties的配置如下所示：

#log4j.properties 使用
#一.参数意义说明
#输出级别的种类
#ERROR、WARN、INFO、DEBUG
#ERROR 为严重错误 主要是程序的错误
#WARN 为一般警告，比如session丢失
#INFO 为一般要显示的信息，比如登录登出
#DEBUG 为程序的调试信息
#配置日志信息输出目的地
#log4j.appender.appenderName = fully.qualified.name.of.appender.class
#1.org.apache.log4j.ConsoleAppender（控制台）
#2.org.apache.log4j.FileAppender（文件）
#3.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
#4.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
#5.org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
#配置日志信息的格式
#log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
#1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
#2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
#3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
#4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
#控制台选项
#Threshold=DEBUG:指定日志消息的输出最低层次。
#ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
#Target=System.err：默认情况下是：System.out,指定输出控制台
#FileAppender 选项
#Threshold=DEBUF:指定日志消息的输出最低层次。
#ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
#File=mylog.txt:指定消息输出到mylog.txt文件。
#Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
#RollingFileAppender 选项
#Threshold=DEBUG:指定日志消息的输出最低层次。
#ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
#File=mylog.txt:指定消息输出到mylog.txt文件。
#Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
#MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
#MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
#log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
#日志信息格式中几个符号所代表的含义：
# -X号: X信息输出时左对齐；
# %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
# %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
# %r: 输出自应用启动到输出该log信息耗费的毫秒数
# %c: 输出日志信息所属的类目，通常就是所在类的全名
# %t: 输出产生该日志事件的线程名
# %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)
# %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
# %%: 输出一个"%"字符
# %F: 输出日志消息产生时所在的文件名称
# %L: 输出代码中的行号
# %m: 输出代码中指定的消息,产生的日志具体信息
# %n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行
# 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
# 1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
# 2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
# 3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
# 4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。

################################################################################

######
#配置根Logger，格式：log4j.rootLogger=[level], appenderName1, appenderName2,  …
#其中 [level] 是日志输出级别，共有5级：FATAL 0；ERROR 3； WARN 4；INFO 6；DEBUG 7 。
# 如果设置了根Logger，就会屏蔽掉其它Logger；
######
log4j.rootLogger=INFO, stdout, log4jv1Appender
log4jv1.logs.dir=./logs/

######
#配置日志信息输出目的地Appender
#格式：
#log4j.appender.appenderName=fully.qualified.name.of.appender.class 
#log4j.appender.appenderName.option1=value1 
# … 
#log4j.appender.appenderName.optionN=valueN 
#
#配置日志信息的格式（布局）
#log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class 
#log4j.appender.appenderName.layout.option1=value1 
#… 
#log4j.appender.appenderName.layout.optionN=valueN 
######

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n

#
log4j.appender.log4jv1Appender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.log4jv1Appender.DatePattern='.'yyyy-MM-dd-HH
log4j.appender.log4jv1Appender.File=${log4jv1.logs.dir}/server.log
log4j.appender.log4jv1Appender.layout=org.apache.log4j.PatternLayout
log4j.appender.log4jv1Appender.layout.ConversionPattern=[%d] %p %m (%c)%n

################################################################################

######
#配置其它Logger，要想其它Logger生效，必须注释掉根Logger的配置
#如果类里面是private static final Logger log = Logger.getLogger("Log4jv1");
#则格式：log4j.logger.secondLogger=[level], appenderName1, appenderName2, …
#
#如果类里面是private static final Logger log = Logger.getLogger(Log4jv1.class);
#并且Log4jv1类是com.zc.log4jv1.main.Log4jv1
#则格式：log4j.logger.secondLogger=[level], appenderName1, appenderName2,  …
######

#1
log4j.logger.Log4jv1Demo=INFO,mylog4jv1
log4j.appender.mylog4jv1=org.apache.log4j.FileAppender
log4j.appender.mylog4jv1.File=${log4jv1.logs.dir}/MyLog4jv1Hello.log
log4j.appender.mylog4jv1.layout=org.apache.log4j.PatternLayout
log4j.appender.mylog4jv1.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n
#2
log4j.logger.com.zc.log4jv1.main.Log4jv1Demo=INFO,log4jv1
log4j.appender.log4jv1=org.apache.log4j.FileAppender
log4j.appender.log4jv1.File=${log4jv1.logs.dir}/Log4jv1Hello.log
log4j.appender.log4jv1.layout=org.apache.log4j.PatternLayout
log4j.appender.log4jv1.layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n

################################################################################

######
#其它例子
#log4j.appender.requestAppender=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.requestAppender.DatePattern='.'yyyy-MM-dd-HH
#log4j.appender.requestAppender.File=${log4jv1.logs.dir}/kafka-request.log
#log4j.appender.requestAppender.layout=org.apache.log4j.PatternLayout
#log4j.appender.requestAppender.layout.ConversionPattern=[%d] %p %m (%c)%n

# Change the two lines below to adjust the general broker logging level (output to server.log and stdout)
#log4j.logger.kafka=INFO
#log4j.logger.org.apache.kafka=INFO

# Change to DEBUG or TRACE to enable request logging
#log4j.logger.kafka.request.logger=WARN, requestAppender
#log4j.additivity.kafka.request.logger=false
######

################################################################################