Log4J使用详解

柔光的暖阳◎ 2022-05-15 22:45 147阅读 0赞

# 一、基本介绍 #

## 1、简介 ##

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。上述这些功能都可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。官方网站:[http://jakarta.apache.org/log4j][http_jakarta.apache.org_log4j]

## 2、Log4j的组成 ##

Log4j由三个重要的组成构成：日志记录器(Loggers)，输出端(Appenders)和日志格式化器(Layout)：

*  Logger：控制要启用或禁用哪些日志记录语句，并对日志信息进行级别限制
 *  Appenders : 指定了日志将打印到控制台还是文件中
 *  Layout : 控制日志信息的显示格式

Log4j中将要输出的Log信息定义了5种级别，依次为DEBUG、INFO、WARN、ERROR和FATAL，当输出时，只有级别高过配置中规定的 级别的信息才能真正的输出，这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码。

# 二、Log4J核心概念 #

## 1、Logger对象的获得或创建 ##

Logger被指定为实体，由一个String类的名字识别。Logger的名字是大小写敏感的，且名字之间具有继承关系，子名用父名作为前缀，用点“.”分隔，例如x.y是x.y.z的父亲。root Logger(根Logger)是所有Logger的祖先，它有如下属性：

*  它总是存在的。
 *  它不可以通过名字获得。

root Logger可以通过以下语句获得：

public static Logger Logger.getRootLogger();

或：

public static Logger Logger.getLogger(Class clazz)

其中调用Logger.getLogger(Class clazz)是目前Logger对象最理想的方法。

## 2、日志级别 ##

每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：

*  off 最高等级，用于关闭所有日志记录。
 *  fatal 指出每个严重的错误事件将会导致应用程序的退出。
 *  error 指出虽然发生错误事件，但仍然不影响系统的继续运行，主要是程序的错误
 *  warm 为一般警告，比如session丢失
 *  info 为一般要显示的信息，比如登录登出
 *  debug 一般用于细粒度级别上，为程序的调试信息，对调试应用程序非常有帮助。
 *  all 最低等级，用于打开所有日志记录。

上面这些级别是定义在org.apache.log4j.Level类中，Log4j只建议使用4个级别，分别是ERROR、WARN、INFO、DEBUG。通过使用日志级别，可以控制应用程序中相应级别日志信息的输出。例如，如果使用了info级别，则应用程序中所有低于info级别的日志信息(如debug)将不会被打印出来。

public class Log4jTest {
    
        public static void main(String[] args) {
            
            Logger logger = Logger.getLogger(Log4jTest.class);
            
            //使用默认的配置信息，不需要写log4j.properties
            BasicConfigurator.configure();
            //设置日志输出级别为info，这将覆盖配置文件中设置的级别
            logger.setLevel(Level.INFO);
            //下面的消息将被输出
            logger.info("this is an info");
            logger.warn("this is a warn");
            logger.error("this is an error");
            logger.fatal("this is a fatal");
    
        }

## 3、输出端Appender ##

Appender用来指定日志信息输出到哪个地方，可以同时指定多个输出目的地。Log4j允许将信息输出到许多不同的输出设备中，一个log信息输出目的地就叫做一个Appender。每个Logger都可以拥有一个或多个Appender，每个Appender表示一个日志的输出目的地。可以使用Logger.addAppender(Appender app)为Logger增加一个Appender，也可以使用Logger.removeAppender(Appender app)为Logger删除一个Appender。以下为Log4j几种常用的输出目的地：

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:middle;"><strong>配置</strong></td> 
   <td style="vertical-align:middle;"><strong>描述</strong></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.ConsoleAppender</td> 
   <td style="vertical-align:middle;">将日志信息输出到控制台</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.FileAppender</td> 
   <td style="vertical-align:middle;">将日志信息输出到一个文件</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.DailyRollingFileAppender</td> 
   <td style="vertical-align:middle;">将日志信息输出到一个日志文件，并且每天输出到一个新的日志文件</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.RollingFileAppender</td> 
   <td style="vertical-align:middle;">将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.WriteAppender</td> 
   <td style="vertical-align:middle;">将日志信息以流格式发送到任意指定地方</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">org.apache.log4j.jdbc.JDBCAppender</td> 
   <td style="vertical-align:middle;">通过JDBC把日志信息输出到数据库中</td> 
  </tr> 
 </tbody> 
</table>

## 4、日志格式化器Layout ##

Log4J的，Log4j提供的日志输出格式有以下四种：

*  HTMLLayout : 以HTML表格形式布局，格式化日志输出为HTML表格形式如下

![70][]

*  SimpleLayout : 以一种非常简单的方式格式化日志输出，它打印三项内容：级别-信息

*  PatternLayout : 可以灵活地指定布局模式，根据指定的转换模式格式化日志输出，或者如果没有指定任何转换模式，就使用默认的转化模式格式。下面的代码实现了PatternLayout和FileAppender的程序

public static void main(String[] args) {
            
            Logger logger = Logger.getLogger(Log4jTest.class);        
            PatternLayout layout = new PatternLayout ();
            //HTMLLayout  layout = new HTMLLayout();
            FileAppender appender = null;
            try
            {
                //把输出端配置到out.txt
                appender = new FileAppender(layout,"out.txt",false);
            }catch(Exception e)
            {            
            }
            logger.addAppender(appender);//添加输出端
            logger.setLevel((Level)Level.DEBUG);//覆盖配置文件中的级别
            logger.debug("debug");
            logger.info("info");
            logger.warn("warn");
            logger.error("error");
    }

*  TTCCLayout : 包含日志产生的时间、线程、类别等等信息

# 三、Log4j的配置 #

## 1、配置说明 ##

配置Log4j环境就是指配置root Logger，包括把Logger为哪个级别，为它增加哪些Appender,以及为这些Appender设置Layout，等等。因为所有其他的Logger都是root Logger的后代，所以它们都继承了root Logger的性质。这些可以通过设置系统属性的方法来隐式地完成，也可以在程序中调用XXXConfigurator.configure()方法来显式地完成。有以下几种方式来配置Log4j。

*  配置放在文件里，通过环境变量传递文件名等信息，利用Log4j默认的初始化过程解析并配置。
 *  配置放在文件里，通过应用服务器配置传递文件甸等信息，利用一个特定的Servlet来完成配置。
 *  在程序中调用BasicConfigor.configure()方法。
 *  配置放在文件里，通过命令行PropertyConfigurator.configure(args\[\])解析log4j.properties文件并配置Log4j。

下面对BasicConfigurator.configure()方法和PropertyConfigurator.config()方法分别进行介绍。

**BasicConfigurator.configure()方法      **它使用简单的方法配置Log4j环境。这个方法完成的任务是：

*  用默认的方式创建PatternLayout对象p

PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x-%m%n");

*  用p创建ConsoleAppender对象a，目标是System.out，标准输出设备

ConsoleAppender a = new CpnsoleAppender(p,ConsoleAppender.SYSTEM_OUT);

*  为root Logger增加一个ConsoleAppender p

rootLogger.addAppender(p);

*  把rootLogger的log level设置为DUBUG级别

rootLogger.setLevel(Level.DEBUG);

**PropertyConfigurator.configure()方法      **当使用以下语句生成Logger对象时：

static Logger logger = Logger.getLogger(mycalss.class);

如果没有调用BasicConfigurator.configure()，PropertyConfigurator.configure()或DOMConfigurator.configure()方法，Log4j会自动加载CLASSPATH下名为log4j.properties的配置文件。如果把此配置文件改为其他名字，例如my.properties,程序虽然仍能运行，但会报出不能正确初始化Log4j系统的提示。这时可以在程序中加上：

PropertyConfigurator.configure("classes/my.properties");

问题即可解决。

## 2、log4j.properties配置详解 ##

虽然可以不用配置文件，而在程序中实现配置，但这种方法在如今的系统开发中显然是不可取的，能采用配置文件的地方一定一定要用配置文件。Log4j支持两 种格式的配置文件：XML格式和Java的property格式。因为项目中用到的主要都是property格式的，所以下面我们就只讲这一种格式的配置方式

### 1.配置根Logger ###

其语法为：

log4j.rootLogger = [level],[appenderName],[ppenderName2]...

说明：

*  \[level\]是日志记录的优先级，分别为DEBUG,INFO,WARN,ERROR 
 *  \[appenderName\]就是指定日志信息输出到哪个地方。可同时指定多个输出目的

### 2.配置输出目的地Appender ###

其语法为：

log4j.appender.[appenderName] = [fully.qualified.name.of.appender.class]

说明：

*  \[appenderName\]是取的日志输出到哪个地方的名称，如1中的appenderName设置为R，那么这里也为R
 *  \[fully.qualified.name.of.appender.class\]表示输出不同位置的实现类（可取org.apache.log4j.FileAppender）

下面再来详细讲解一下，每个日志输出位置的选项属性：

***ConsoleAppender选项属性***

*  Threshold = DEBUG:指定日志消息的输出最低层次（log4j.appender.\[appenderName\].Threshold  =DEBUG）
 *  ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
 *  Target = System.err:默认值System.out,输出到控制台(err为红色,out为黑色)

***FileAppender选项属性 ***

*  Threshold = INFO:指定日志消息的输出最低层次
 *  ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
 *  File = C:\\log4j.log:指定消息输出到C:\\log4j.log文件
 *  Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
 *  Encoding = UTF-8:可以指定文件编码格式

***DailyRollingFileAppender选项属性 ***

*  Threshold = WARN:指定日志消息的输出最低层次 
 *  ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
 *  File = C:\\log4j.log:指定消息输出到C:\\log4j.log文件 
 *  Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
 *  DatePattern=yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。还可以按用以下参数:

【yyyy-MM:每月 ;yyyy-ww:每周 ;yyyy-MM-dd:每天; yyyy-MM-dd-a:每天两次;yyyy-MM-dd-HH:每小时 】

*  Encoding = UTF-8:可以指定文件编码格式

***RollingFileAppender选项属性 ***

*  Threshold = ERROR:指定日志消息的输出最低层次
 *  ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
 *  File = C:/log4j.log:指定消息输出到C:/log4j.log文件 
 *  Append = FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容 
 *  MaxFileSize = 100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动.如:log4j.log.1 
 *  MaxBackupIndex = 2:指定可以产生的滚动文件的最大数 
 *  Encoding = UTF-8:可以指定文件编码格式

### 3.配置日志信息的格式(布局) ###

其语法为：

log4j.appender.[appenderName].layout = [fully.qualified.name.of.layout.class]

说明：

*  \[fully.qualified.name.of.layout.class\] 表示布局的实现类（可取org.apache.log4j.PatternLayout）

下面再来详细讲解一下，每个布局的选项属性：

***HTMLLayout选项属性 ***

*  LocationInfo = TRUE:默认值false,输出java文件名称和行号 
 *  Title=Struts Log Message:默认值 Log4J Log Messages

***PatternLayout选项属性 ***

*  ConversionPattern = %-d\{yyyy-MM-dd HH:mm:ss\} - \[ %p \] %m%n:格式化指定的消息(参数意思下面有)

***XMLLayout选项属性 ***

*  LocationInfo = TRUE:默认值false,输出java文件名称和行号

附加，Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:middle;">符号</td> 
   <td style="vertical-align:middle;">含义</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%m</td> 
   <td style="vertical-align:middle;">输出代码中指定的消息</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%p</td> 
   <td style="vertical-align:middle;">输出优先级，即DEBUG,INFO,WARN,ERROR,FATAL</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%r</td> 
   <td style="vertical-align:middle;">输出自应用启动到输出该log信息耗费的毫秒数</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%c</td> 
   <td style="vertical-align:middle;">输出所属的类目,通常就是所在类的全名&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%t</td> 
   <td style="vertical-align:middle;">输出产生该日志事件的线程名</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%n</td> 
   <td style="vertical-align:middle;">输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%d</td> 
   <td style="vertical-align:middle;">输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式&nbsp;<br> 如：%d{yyyy年MM月dd日 HH:mm:ss,SSS}，输出类似：2012年01月05日 22:10:28,921&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%l</td> 
   <td style="vertical-align:middle;">&nbsp;输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数&nbsp;<br> 如：Testlog.main(TestLog.java:10)&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">%F</td> 
   <td style="vertical-align:middle;">输出日志消息产生时所在的文件名称&nbsp;</td> 
  </tr> 
  <tr> 
   <td>%L</td> 
   <td>输出代码中的行号</td> 
  </tr> 
  <tr> 
   <td>%x</td> 
   <td>输出和当前线程相关联的NDC(嵌套诊断环境),像java servlets多客户多线程的应用中&nbsp;</td> 
  </tr> 
  <tr> 
   <td>%%</td> 
   <td>输出一个"%"字符&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

*  %5c: 输出category名称，最小宽度是5，category<5，默认的情况下右对齐 
 *  %-5c:输出category名称，最小宽度是5，category<5，"-"号指定左对齐,会有空格 
 *  %.5c:输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格 
 *  %20.30c:category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉

[http_jakarta.apache.org_log4j]: http://jakarta.apache.org/log4j
[70]: /images/20220516/25e5781f32d74f099ee41f0b58cf3395.png