slf4j-api、slf4j-log4j12、log4j之间关系

喜欢ヅ旅行 2022-02-05 11:15 320阅读 0赞

**Content**

*  [1. slf4j-api][]
 *  [2. slf4j-api、slf4j-log4j12、log4j][2._slf4j-api_slf4j-log4j12_log4j]
 *  [3. log4j ][3. log4j]
    
     *  [3.1 log4j的使用][3.1 log4j]
     *  [3.2 log4j配置使用][3.2 log4j]
        
         *  [3.2.1 定义配置文件][3.2.1]
         *  [3.2.2 在代码中使用log4j][3.2.2 _log4j]
 *  [x. 参考资料][x.]

[Top][]

# 1. slf4j-api #

**slf4j**:Simple Logging Facade for Java，为java提供的简单日志Facade。Facade门面，更底层一点说就是接口。它允许用户以自己的喜好，在工程中通过slf4j接入不同的日志系统。

因此slf4j入口就是众多接口的集合，它不负责具体的日志实现，只在编译时负责寻找合适的日志系统进行绑定。具体有哪些接口，全部都定义在slf4j-api中。查看slf4j-api源码就可以发现，里面除了public final class LoggerFactory类之外，都是接口定义。因此slf4j-api本质就是一个接口定义。

它只提供一个核心slf4j api(就是slf4j-api.jar包)，这个包只有日志的接口，并没有实现，所以如果要使用就得再给它提供一个实现了些接口的日志包，比 如：log4j,common logging,jdk log日志实现包等，但是这些日志实现又不能通过接口直接调用，实现上他们根本就和slf4j-api不一致，因此slf4j又增加了一层来转换各日志实 现包的使用，比如slf4j-log4j12等。

slf4j+log4j组合使用模式：  
1. slf4j-api-1.5.11.jar  
2. slf4j-log4j12-1.5.11.jar  
3. log4j-1.2.15.jar  
4. log4j.properties(也可以是 log4j.xml)

具体使用日志类的API：

1. log4j：

import org.apache.log4j.Logger;

Logger logger= Logger.getLogger(xx.class);

2. slf4j+log4j：（推荐）

import  org.slf4j.Logger;

import  org.slf4j.LoggerFactory;

Logger logger = LoggerFactory.getLogger(xx.class);

[Top][]

# 2. slf4j-api、slf4j-log4j12、log4j #

下图比较清晰的描述了它们之间的关系，例子为当系统采用log4j作为日志框架实现的调用关系：

![563799-20180315141502815-1515901676.png][]

1. 首先系统包含slf4j-api作为日志接入的接口：编译时slf4j-api中public final class LoggerFactor类中private final static void bind()方法会寻找具体的日志实现类绑定，主要通过StaticLoggerBinder.getSingleton()的语句调用。  
2. slf4j-log4j12是链接slf4j-api和log4j中间的适配器：它实现了slf4j-api中StaticLoggerBinder接口，从而使得在编译时绑定的是slf4j-log4j12的getSingleton()方法。  
3. log4j是具体的日志系统：通过slf4j-log4j12初始化Log4j，达到最终日志的输出。

[Top][]

# 3. log4j  #

## 3.1 log4j的使用 ##

（1）使用eclipse创建maven工程，在maven中增加依赖：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>// 一般创建工程，建议通过slf4j设计日志系统，方便扩展</code> <code>&lt;dependency&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;groupId&gt;org.slf4j&lt;/groupId&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;artifactId&gt;slf4j-log4j12&lt;/artifactId&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;version&gt;</code><code>1.7</code><code>.</code><code>22</code><code>&lt;/version&gt;</code> <code>&lt;/dependency&gt;</code> &nbsp; <code>// 可以用于学习log4j，正式项目中不推荐使用，这样是依赖具体的log4j日志系统。</code> <code>&lt;dependency&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;groupId&gt;log4j&lt;/groupId&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;artifactId&gt;log4j&lt;/artifactId&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;version&gt;</code><code>1.2</code><code>.</code><code>17</code><code>&lt;/version&gt;</code> <code>&lt;/dependency&gt;　　</code> </td> 
 </tr> 
 </tbody> 
</table>

（2）src创建log4j.properties文件

![563799-20180315145739142-1059317532.png][]

log4j.properties的内容如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code># 级别，名称</code> <code>log4j.rootLogger = debug, console</code> &nbsp; <code>log4j.appender.console = org.apache.log4j.ConsoleAppender #日志输出到控制台</code> <code>log4j.appender.console.Target = System.out</code> <code>log4j.appender.console.layout = org.apache.log4j.PatternLayout</code> <code>log4j.appender.console.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%m%n # 日志格式</code> </td> 
 </tr> 
 </tbody> 
</table>

org.apache.log4j.App.java

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>package</code>&nbsp;<code>org.apache.log4j;</code> &nbsp; <code>import</code>&nbsp;<code>org.slf4j.Logger;</code> <code>import</code>&nbsp;<code>org.slf4j.LoggerFactory;</code> &nbsp; <code>/**</code> <code>&nbsp;</code><code>* Hello world!</code> <code>&nbsp;</code><code>*</code> <code>&nbsp;</code><code>*/</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>App { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>static</code>&nbsp;<code>final</code>&nbsp;<code>Logger LOG = LoggerFactory.getLogger(App.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOG.info(</code><code>"info"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOG.debug(</code><code>"debug"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LOG.error(</code><code>"error"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"Hello World!"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}　　</code> </td> 
 </tr> 
 </tbody> 
</table>

运行之后结果如下：

![563799-20180315150608421-2081613936.png][]

## 3.2 log4j配置使用 ##

Log4j由三个重要的组件构成：**日志信息的优先级**，**日志信息的输出目的地**，**日志信息的输出格式**。

日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；

日志信息的输出目的地指定了日志将打印到控制台还是文件中；

而输出格式则控制了日志信息的显示内容。

### 3.2.1 定义配置文件 ###

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

（1）配置根Logger

log4j.rootLogger = level, appenderName, appenderName, …

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

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

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

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

**appenderName**就是指level级别的日志信息输出到哪个地方，可以同时指定多个输出目的地。

（2）配置日志信息输出目的地Appender

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

其中，Log4j提供的appender有以下几种：

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

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

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

其中，Log4j提供的layout有以下几种：

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

log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息

<table> 
 <tbody> 
 <tr> 
 <td> %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL&nbsp; %r 输出自应用启动到输出该log信息耗费的毫秒数&nbsp; %c 输出所属的类目，通常就是所在类的全名&nbsp; %t 输出产生该日志事件的线程名&nbsp; %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”&nbsp; %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921&nbsp; %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10) </td> 
 </tr> 
 </tbody> 
</table>

实例：

![563799-20180315153020804-71573670.png][]

### 3.2.2 在代码中使用log4j ###

（1）获取Logger

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)

通过指定的名字获得记录器，如果必要的话，则为每个类创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

（2）读取log4j.properties配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>BasicConfigurator.configure()：自动快速地使用缺省Log4j环境</code> <code>PropertyConfigurator.configure(String configFilename)：读取使用property文件编写的配置文件</code> <code>DOMConfigurator.configure(String filename)：读取XML形式的配置文件</code> </td> 
 </tr> 
 </tbody> 
</table>

（3）记日志

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>Logger.debug(message);&nbsp;</code> <code>Logger.info(message);&nbsp;</code> <code>Logger.warn(message);&nbsp;</code> <code>Logger.error(message);</code> </td> 
 </tr> 
 </tbody> 
</table>

[Top][]

# x. 参考资料 #

http://logging.apache.org/log4j/1.2/manual.html

http://blog.csdn.net/chen3749102/article/details/52795786

http://blog.csdn.net/tanga842428/article/details/52924725

http://blog.csdn.net/sunny\_na/article/details/55212029

[1. slf4j-api]: https://www.cnblogs.com/lujiango/p/8573411.html#_label0
[2._slf4j-api_slf4j-log4j12_log4j]: https://www.cnblogs.com/lujiango/p/8573411.html#_label1
[3. log4j]: https://www.cnblogs.com/lujiango/p/8573411.html#_label2
[3.1 log4j]: https://www.cnblogs.com/lujiango/p/8573411.html#_lab2_2_0
[3.2 log4j]: https://www.cnblogs.com/lujiango/p/8573411.html#_lab2_2_1
[3.2.1]: https://www.cnblogs.com/lujiango/p/8573411.html#_label3_2_1_0
[3.2.2 _log4j]: https://www.cnblogs.com/lujiango/p/8573411.html#_label3_2_1_1
[x.]: https://www.cnblogs.com/lujiango/p/8573411.html#_label3
[Top]: https://www.cnblogs.com/lujiango/p/8573411.html#_labelTop
[563799-20180315141502815-1515901676.png]: /images/20220205/2c497df5a3864f098ceca84df1ca2182.png
[563799-20180315145739142-1059317532.png]: /images/20220205/4f31700040ee4509b1d9a0c0c49d0a5c.png
[563799-20180315150608421-2081613936.png]: /images/20220205/39a4e5297f074a9e858616f15c98e69f.png
[563799-20180315153020804-71573670.png]: /images/20220205/40cb5eab40f848e2ac007e8f707444ed.png