Log4j配置讲解

在开发的过程中，日志的作用不可或缺；在后期的维护中，日志显得更为重要。
今天就有log4j为例，引入日志监控管理，让日志更好的为我们服务。

log4j介绍

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。
Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

配置介绍

通常我们在项目中使用日志的时候，特别是使用log4j做日志监控的时候，我们会新建一个名称为log4j.properties文件，然后这个文件名就是默认的日志配置文件名，如果名字不是该默认名的话，在不指定配置文件位置的情况下，配置不会生效，所以文件名称的使用一定要注意。

接下来我们先看一下配置文件中的一些内容：

Log4j有三个主要的组件：Loggers(记录器)，Appenders (输出源)和Layouts(布局)。这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

所以我们就一个一个的开始介绍。

首先是记录器，也是配置根，Loggers。
语法：

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

这里需要注意，如果配置根的level比之后的日志lever高的话，以配置根为准，相当于在这里定义了整个项目日志的最低level。
Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。
appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

接下来看一下输出目的地，Appenders
语法：

log4j.appender.appenderName  = className 
log4j.appender.appenderName.Option1 = value1 
… 
log4j.appender.appenderName.OptionN = valueN 

通常使用的className如下：

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

这里需要注意的是，对应的appenderName和Loggers里的appenderName要做好对应，否则配置的Appender会不起效。

然后看一下布局，Layout
语法：

log4j.appender.appenderName.layout =className 
log4j.appender.appenderName.layout.Option1 = value1 
… 
log4j.appender.appenderName.layout.OptionN = valueN 

通过上面的内容可以看出，其实layout布局也是内嵌与appender中的，也就是说对于每个appender的配置，都可以配置它的布局格式。
其中的常用className如下：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）
这里面最常用的可能就是PatternLayout了。

小demo

这里我们看一个简单的配置

### set log levels ###
log4j.rootLogger = info ,stdout,FILE  

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender  
log4j.appender.stdout.Target = System.out  
### 可以灵活地指定布局模式 ###
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout  
log4j.appender.stdout.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n  

###输出到日志文件 ###
log4j.appender.FILE = org.apache.log4j.DailyRollingFileAppender  
log4j.appender.FILE.File = logs/log.log  
log4j.appender.FILE.Append = true  
log4j.appender.FILE.Threshold = INFO
### 可以灵活地指定布局模式 ###
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout  
log4j.appender.FILE.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

如上就是一个简单的配置，首先我们在

log4j.rootLogger = info ,stdout,FILE  

这里设置了整个日志最低级别为info，当然这里可以按照需求随时变动；然后后面设置了两个appender，所以在这里都需要标注上。

接下来是stdout的配置

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender  
log4j.appender.stdout.Target = System.out  
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout  
log4j.appender.stdout.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n  

可以看到我们对于控制台的输出进行了配置，并且指定了输出地点以及布局格式。
看到我们自定义的布局格式是这样的，每个参数的含义如下：
%d：输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
%t：输出产生该日志事件的线程名。
%r：输出自应用程序启动到输出该log信息耗费的毫秒数。
%p：输出日志信息的优先级，即DEBUG，INFO，WARN，ERROR，FATAL。
%m:：输出代码中指定的具体日志信息。
%n：输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”。

然后是FILE文件配置

###输出到日志文件 ###
log4j.appender.FILE = org.apache.log4j.DailyRollingFileAppender  
log4j.appender.FILE.File = logs/log.log  
log4j.appender.FILE.Append = true  
log4j.appender.FILE.Threshold = INFO
### 可以灵活地指定布局模式 ###
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout  
log4j.appender.FILE.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

这里会在特定的路径下生成日志文件，我们选择的是每天生成一个日志文件，方便我们做监控查阅。
这里涉及到几个参数
Threshold=INFO:指定日志消息的输出最低层次。
File=logs/log.log:指定消息输出到logs/log.log文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

到此一个简单的日志配置就完成了，这个用来应付自己手动开发的小项目基本够用了，但是如果对于大型项目的开发就显得相形见绌了。

上面的内容主要参考了如下两篇blog：
第一个
第二个
更为详细的内容可以在上面两篇blog中找到对应的信息。
如果想获取更多的信息，那么就去Log4j官网

拓展内容

感觉只讲这点东西好像就太少了，那我们讲点历史，然后再深入一点吧。

首先看一下SLF4J，这个可能没听说过吧~

很久很久以前，Apache说服log4j以及其他的日志按照commons-logging的标准编写，但是由于commons-logging的类加载器有点问题，实现起来也不友好，因此log4j的作者创作了SLF4J，也因此与commons-logging平分天下。

“诶？怎么又多出来个什么东西？commons-logging是什么玩应？”

别慌~

commons-logging和slf4j都是日志的接口，供用户使用，而没有提供实现。log4j、logback、java.logging才是日志的真正实现。当我们调用接口时，接口的工程会自动寻找恰当的实现，返回一个实现的实例。

我们再看一下下面这张图

这张图算是SLF4J实现各种日志对接的原理图。

接下来我们看一下，SLF4J如何和Log4j对接

A.添加SLF4J的jar包
B.添加适配器jar包：slf4j-log4j12
tip：实际只添加适配器jar包就可以了。

通过结合SLF4J，Log4j也可使用参数替代字符串拼接，这样只会检查一次日志级别，且只在需要输出日志的时候才会拼接字符串。代码更优雅、性能也有提升。

讲了这些有什么用呢？
说实话，没什么用，权当做一次知识拓展吧~

为什么要以类名作为logger的名字？
首先我们要知道，类通常以类代表的对象或者类可以实现的功能来命名，这种命名方式提高了可读性，易于他人 识别。同样的，以类名作为logger的名字可以快速定位产生日志的类，还可以更精确地对每个类的日志级别、输出目的地和输出样式进行调整。

这部分参考Log4j官网对于API的描述。

可以看到官方解释如下
对于参数为Class的getLogger方法，将Class名作为对应日志记录器的名称。
对于参数为String的getLogger方法，首先会检索以name为参数命名的日志记录器，如果该实例存在则返回，否则新建一个实例。
默认情况下，当前类日志等级会继承它最近的祖先类的日志等级，这也是Log4j的核心功能之一。

本篇到此结束，如果有什么遗漏或错误，还请不吝赐教。