SSM框架下Log4j的配置（1）

前言

---

Log4j是用来做什么的？
Log4j需要什么样的配置文件才能运行？
Log4j结合SSM框架是如何在web.xml配置的？

什么是Log4j？

  Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
  简单的来说，Log4j可以理解为一个通过配置文件进行配置的日志操作工具，特别是web工程中日志显得很重要。

一、导入jar包

官网（Download Apache log4j 1.2）下载log4j需要的log4j-x.x.x.jar，导入lib中，或者也可以使用Maven导入jar包（关于maven导jar包的方式，我这里有介绍）

二、log4j.properties介绍

---

1. log4j.properties文件内容

Log4j主要分为三个重要的组成部分：

• 日志信息的优先级：从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；
• 日志信息的输出目的地：日志信息的输出目的地指定了日志将打印到Console控制台还是文件中；
• 日志信息的输出格式：而输出格式则控制了日志信息的显示内容。

一个简单常用的配置内容如下：

log4j.rootLogger=INFO,Console,File
#控制台日志
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.Target=System.out
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n
#普通文件日志
log4j.appender.File=org.apache.log4j.RollingFileAppender
log4j.appender.File.File=logs/ssm.log
log4j.appender.File.DatePattern=yyyy-MM-dd'.log'
log4j.appender.File.MaxFileSize=10MB
#输出日志，如果换成DEBUG表示输出DEBUG以上级别日志
log4j.appender.File.Threshold=ALL
log4j.appender.File.layout=org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n

（1）配置 log4j.rootLogger

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

• level： 是之前所说日志的优先级，分为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL（也可以自定义），但一般Log4j只使用ERROR、WARN、INFO、DEBUG（优先级从高到低）。如果只定义了INFO级别，那么应用程序中的DEGUG级别信息不会被打印出来，这是因为DEGUG级别比INFO低。

日志级别从高到低分别为：

off： 最高等级，用于关闭所有日志记录。
fatal：指出每个严重的错误事件将会导致应用程序的退出。
error：指出虽然发生错误事件，但仍然不影响系统的继续运行。
warm：表明会出现潜在的错误情形。
info：一般和在粗粒度级别上，强调应用程序的运行全程。
debug：一般用于细粒度级别上，对调试应用程序非常有帮助。
all： 最低等级，用于打开所有日志记录。

• appenderName： 是之前说的指定日志信息输出的地方，一般有console,all,interface,error...，在上面例子中我们只用到了Console、File

（2）配置Appender日志输出地

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
……
log4j.appender.appenderName.optionN = valueN

其中Appender有以下几种

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

（3）配置Layout输出信息格式布局

Log4j提供了以下几种布局方式：

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

其中的打印风格格式类似于C语言的打印风格，具体不做介绍。

#level为INFO，输出地为Console控制台与File文件
log4j.rootLogger=INFO,Console,File
#信息输出到Console控制台日志
log4j.appender.Console=org.apache.log4j.ConsoleAppender

#Console控制台输出
log4j.appender.Console.Target=System.out
#布局模式为灵活的布局模式
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
#控制台输出信息打印格式：[优先级][线程名][日期格式][类全名][应用程序中指定的消息logger.info("listAll")][换行]
#[INFO][http-nio-8081-exec-2][2018-04-25 12:16:25][com.test.controller.XXXController] - listAll
log4j.appender.Console.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n

#每天产生一个日志文件
log4j.appender.File=org.apache.log4j.RollingFileAppender
#日志输出的到文件：logs/all.log
log4j.appender.File.File=logs/ssm.log
#日志文件格式：日期格式后缀名
log4j.appender.File.DatePattern=yyyy-MM-dd'.log'
log4j.appender.File.MaxFileSize=10MB
#Threshold属性可以指定日志level，如果为INFO级别则输出INFO及以上的级别日志
#但也要看rootLogger下的指定的level
log4j.appender.File.Threshold=ALL
log4j.appender.File.layout=org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n

三. log4j.properties存放位置及加载

---

关于log4j.properties存放位置及加载方式我总结了三个，至于其主要的区别这里不做介绍，日后需要更加深入了解时会加以记录。

（1）一般在Java项目中存放到src/config或者src下，此时不需要在web.xml中加Log4j监听器Log4jConfigListener

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>/WEB-INF/classes/log4j.properties</param-value>
    <!-- 或者<param-value>classpath:log4j.properties</param-value> -->
 </context-param>

（2）创建Maven Project后，一般都放到resources文件夹下，这里的log4j.xml是log4j.properties的另外一种配置文件形式，其加载方式同上。

（3）在JavaWeb Project中也可以存放在WEB-INF下，此时就需要在web.xml中增加Log4j监听器Log4jConfigListener

<!-- log4j配置文件 -->
<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>/WEB-INF/log4j.properties</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

最后整合了SSM Log4j源码链接：

https://github.com/Jian0110/ssm