Java应用-Log4j学习

1. 入门

1.1 对比

通常，写代码免不了输出各种调试信息。如果没有任何日志工具，都会使用System.out.println来做到。这样做虽然直观有效，但缺点如下：

1. 不知道这句话在哪个类，哪个线程出来的
2. 不知道什么时候、前后两句输出间隔了多少时间
3. 无法关闭调试信息，一旦System.out.println多了之后，到处都是输出，增加定位自己所需信息的难度
4. 。。。。。。

如代码所示：

public class TestLog4j {
	
	public static void main(String[] args) throws InterruptedException {
		
		System.out.println("跟踪信息");
		System.out.println("调试信息");
		System.out.println("输出信息");
		System.out.println("警告信息");
		System.out.println("错误信息");
		System.out.println("致命信息");

	}

输出：

 1.2 导入jar包

略。。。

1.3 使用Log4j

为应对上述情况，使用Log4j来进行日志输出。采用如下代码：

package log4j;
 
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
 
public class TestLog4j {
	//基于类的名称获取日志对象
    static Logger logger = Logger.getLogger(TestLog4j.class);
    public static void main(String[] args) throws InterruptedException {
        //获取默认配置
    	BasicConfigurator.configure();
    	//设置日志输出级别
        logger.setLevel(Level.DEBUG);
        //进行不同级别的日志输出
        logger.trace("跟踪信息");
        logger.debug("调试信息");
        logger.info("输出信息");
        Thread.sleep(1000);//为了便于观察日志输出的时间差
        logger.warn("警告信息");
        logger.error("错误信息");
        logger.fatal("致命信息");
 
    }
}

输出：

 可见输出结果有如下改观：

1. 知道是log4j.TestLog4j这个类里的日志
2. 知道是在[main]线程里的日志
3. 日志级别观察，一共有6个级别 TRACE  DEBUG  INFO  WARN  ERROR  FATAL
4. 日志级别输出范围可控制，如代码表示，只输出高于DEBUG级别的，那么TRACE级别的日志自动不输出
5. 每句日志消耗的毫秒数（最前面的数字），可观察，这样就能进行性能计算

2. Log4j配置讲解

2.1 log4j.properties

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=5

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

2.2 运行TestLog4j

两个效果：

1. 输出在控制台，并且格式有所变化，如下所示，会显示是哪个类的哪一行输出的信息
2. 不仅仅在控制台有输出，把日志输出到了G:\JavaWeb\Workspaces\Log4j\example.log这个位置

代码：

package log4j;

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;

public class TestLog4j {
	static Logger logger = Logger.getLogger(TestLog4j.class);
	public static void main(String[] args) throws InterruptedException {
		//与BasicConfigurator.configure();方式不同，采用指定配置文件。Log4j的配置方式按照Log4j.propertirs中设置进行
		PropertyConfigurator.configure("G:\\JavaWeb\\Workspaces\\Log4j\\src\\log4j.properties");
		for (int i = 0; i < 5000; i++) {
			logger.trace("跟踪信息");
			logger.debug("调试信息");
			logger.info("输出信息");
			logger.warn("警告信息");
			logger.error("错误信息");
			logger.fatal("致命信息");
		}
	}
}

输出：

2.3 解释log4j.properties

#设置日志输出的等级为debug，低于debug就不会输出了
#设置日志输出的两种地方，分别叫做stdout和R
log4j.rootLogger=debug, stdout, R

#第一个地方stdout，输出到控制台
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

#输出格式是 %5p [%t] (%F:%L) - %m%n
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

#第二个地方R，以滚动的方式输出到文件，文件名为example.log，文件最大100k，最多滚动5个文件
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=5

#输出格式是 %p %t %c - %m%n
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

2.4 格式解释

log4j日志输出格式一览：

%c 输出日志信息所属的类的全名
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy-MM-dd HH:mm:ss }，输出类似：2002-10-18- 22：10：28
%f 输出日志信息所属的类的类名
%l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行
%m 输出代码中指定的信息，如log(message)中的message
%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推
%r 输出自应用启动到输出该日志信息所耗费的毫秒数
%t 输出产生该日志事件的线程名

所以：
%5p [%t] (%F:%L) - %m%n 就表示
宽度是5的优先等级 线程名称 (文件名:行号) - 信息 回车换行

3. log4j.xml

3.1 log4j.xml

除了使用log4j.properties,也可以使用xml格式进行配置，在src目录下装备log4j.xml文件

代码：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "-//log4j/log4j Configuration//EN" "log4j.dtd">
 
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
     
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
       <layout class="org.apache.log4j.PatternLayout"> 
          <param name="ConversionPattern" value="%d %-5p %c.%M:%L - %m%n"/> 
       </layout> 
    </appender>
  
    <!-- specify the logging level for loggers from other libraries -->
    <logger name="com.opensymphony">
        <level value="ERROR" />
    </logger>
 
    <logger name="org.apache">
         <level value="ERROR" />
    </logger>
    <logger name="org.hibernate">
         <level value="ERROR" />
    </logger>
   
   <!-- for all other loggers log only debug and above log messages -->
     <root>
        <priority value="ERROR"/> 
        <appender-ref ref="STDOUT" /> 
     </root> 
     
</log4j:configuration> 

3.2 修改TestLog4j

使用log4j.xml作为配置文件，并运行

代码：

package log4j;

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;

public class TestLog4j {
	static Logger logger = Logger.getLogger(TestLog4j.class);
	public static void main(String[] args) throws InterruptedException {
		//与BasicConfigurator.configure();方式不同，采用指定配置文件。Log4j的配置方式按照Log4j.propertirs中设置进行
		PropertyConfigurator.configure("G:\\JavaWeb\\Workspaces\\Log4j\\src\\log4j.xml");
		for (int i = 0; i < 5000; i++) {
			logger.trace("跟踪信息");
			logger.debug("调试信息");
			logger.info("输出信息");
			logger.warn("警告信息");
			logger.error("错误信息");
			logger.fatal("致命信息");
		}
	}
}

输出：

致谢：

主要参考： Log4j