log4j的配置和使用

日志记录

在应用程序中添加日志记录总的来说基于三个目的：

1. 监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；
2. 跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。
3. 最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。

1.log4j是什么？

在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；

我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

2.log4j的概念

 Log4j中有三个主要的组件，它们分别是 Logger、Appender和Layout。

 Log4j 允许开发人员定义多个Logger，每个Logger拥有自己的名字，Logger之间通过名字来表明隶属关系。有一个Logger称为Root，它永远 存在，且不能通过名字检索或引用，可以通过Logger.getRootLogger()方法获  得，其它Logger通过 Logger.getLogger(String name)方法。
 Appender则是用来指明将所有的log信息存放到什么地方，Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。
 Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。
 Log4j中将要输出的Log信息定义了5种级别，依次为DEBUG、INFO、WARN、ERROR和FATAL，当输出时，只有级别高过配置中规定的 级别的信息才能真正的输出，这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码，这点实在是方便啊。

3.log4j的配置文件

其实也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两 种格式的配置文件：XML格式和Java的property格式【Java特性文件（键=值）】。

配置根Logger

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

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。
Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 

配置日志的输出目的地Appender

Log4j提供的appender有以下几种：

  org.apache.log4j.ConsoleAppender（控制台）
  org.apache.log4j.FileAppender（文件）
  org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
  org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生新文件）
  org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

配置日志信息的格式（布局）

Log4j提供的layout有以下几种：
  org.apache.log4j.HTMLLayout（以HTML表格形式布局），
  org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
  org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
  org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息） 

4.在Maven项目中加入log4j

<1>在pom.xml中加入依赖jar包

 

添加Jar包的时候有个窍门可以避免因为粗心写错了而找半天错误

 然后选择版本

 点开之后把下面的代码粘贴到pom.xml中即可

有的时候从maven的远程仓库下载jar包到本地仓库的时候可能会因为网络等原因导致下载的jar包有问题，Eclipse中会报错：

已有maven工程时出现的fail to read artifact descriptor....问题 

一般情况下将从maven远端下载到本地的文件删除掉（可以将报错的jar删掉，也可以直接清空C:Usersyourname.m2 epository 文件夹）

然后右键对应项目，Maven->Update projects，快捷键为Alt+F5

在弹出的对话框中选择强制更新

 <2>在项目中新建log4j2.xml文件或者log4j2.properties文件

xml示例如下

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<configuration status="off" monitorInterval="1800">  
    <properties>  
        <property name="LOG_HOME">logs</property>  
        <property name="SERVICE_NAME">smarthome-phipush-messagepush</property>
    </properties>  
    <appenders>
        <!-- 定义控制台输出 -->
        <Console name="Console" target="SYSTEM_OUT" follow="true">
            <PatternLayout
                pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
                
        </Console>
        <!-- 程序员调试日志，每100M一个文件 -->
        <RollingRandomAccessFile name="DevLog"
            fileName="${LOG_HOME}/${SERVICE_NAME}.log" filePattern="${LOG_HOME}/${SERVICE_NAME}.%d{yyyy-MM-dd-HH}.log">
            <PatternLayout
                pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
            <SizeBasedTriggeringPolicy size="100MB" />
        </RollingRandomAccessFile>
        <Async name="async-devlog">
            <AppenderRef ref="DevLog" />
            <AppenderRef ref="Console" />
        </Async>
    </appenders>
    <loggers>
        <!-- Root Logger -->
        <root level="DEBUG">
            <AppenderRef ref="async-devlog" />
        </root>
    </loggers>
</configuration>  

放在src下的话就不用配置 否则得去web.xml里面配置一个Listener

<3>在代码中使用Log4j

<3.1>获取记录器

相关包：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

private static final Logger logger = LogManager.getLogger(TestLog4j.class);

<3.2>读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为： 
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。 
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。 
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

<3.3>插入记录信息

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ; 
Logger.info ( Object message ) ; 
Logger.warn ( Object message ) ; 
Logger.error ( Object message ) ;

<4>启动Spring项目

会发现在指定目录下打印出来的log文件

参考文章：

https://www.ibm.com/developerworks/cn/java/l-log4j/index.html