本文详细介绍了SLF4J与Log4J的使用方法，阐述了SLF4J的优势，包括其门面模式设计、日志记录的占位符功能以及与Log4J的结合使用。
转载链接：https://www.cnblogs.com/aspirant/p/10484346.html
阿里巴巴的代码规范中 建议使用slf4j而不是 log4j;
slf4j使用了门面模式，
二) 日志规约
1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，
有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
【点评】规则好，未严格遵循
参考：点评阿里JAVA手册之异常日志（异常处理 日志规约 ）
原因：
参考：为什么使用 SLF4J 而不是 Log4J 来做 Java 日志
每个Java开发人员都知道日志记录对Java应用的重要性，尤其是对服务端应用，而且其中许多人都已经熟悉了各种记录日志的库，比如java.util.logging,Apache的log4j,logback，然而如果你不知道SLF4J，java的简单记录日志的设计的话 ，那么到了学习并在你的项目中使用它的时候了。在这篇Java文档里，我们将学习为什么使用SLF4J比使用log4j或者java.util.logging更好。从我写 Java开发人员的10个记录日志的技巧 算起已经过去了很长一段时间了。我不记得我所写的有关日志记录的任何事情了。无论如何，让我们回归到这个主题上来，与所有提到的这些日志记录库相比，SLF4J与它们之间有一个主要的区别。SLF4J或者说是Java的简单记录日志设计没有真正地实现日志记录，相反它只是一个允许你使用任何处于后端的日志记录库的 抽象层 。如果你正在编写内部或者外部使用的API或者应用库的话，那么你真的不需要让使用你所编写的库的客户端还去选择日志库。假设项目已经使用了log4j，而且你包含一个名为Apache Active MQ的库，这个库还依赖于另一个日志记录库logback的话，那么你还需要包含它们，然而，如果Apache Active MQ使用了SLF4J的话，你可以继续使用你的日志记录库，而不需要痛苦地添加和维护新的日志记录框架。简短的说，SLF4J让你的代码独立于任何特定的日志记录API，这个好的想法尤其适合于公共的API开发人员。虽然日志记录库的抽象理念不是新的，而且Apache的commons logging日志记录库也是用了这个理念，不过现在SLF4J很快就会成为Java世界里标准的日志记录库。让我们看一些使用 SLF4J而不使用log4j,logback或者java.util.logging的理由。
宁愿使用SLF4J也不愿使用Log4J,logback和java.util.Logging
正如我前面所说，在你的代码中编写日志记录语句使用SLF4J的主要动机是让你的程序独立于任何特定的日志记录库，这些日志记录库可能需要与你现在配置不同的配置，而且还会引入更多令人头疼的维护问题。然而除了这个之外，SLF4J API还有一个让你使用SLF4J而不是用长期感兴趣的 Log4j 更让人信服的功能，也就是占位符功能，在代码中用{}来表示。占位符功能与 String的format()方法中 的%s非常相似，因为它在运行时刻才提取所提供的真正的字符串。这不仅缩减了代码中的许多字符串连接，而且减少了创建String对象所需要的资源。即便在你生产环境日志级别比如DEBUG和INFO级别的字符串连接可能不需要的时候，仍然可以起到同样的效果。由于 字符串是不可更改的 ，而且它们是在字符串池中创建的，这些字符串使用了 堆内存 ，当应用在生产环境中运行在ERROR级别的时候，字符串在大多数情况下就不是必须的，比如DEBUG语句里的字符串就不是必须的。通过使用SLF4J，你可以延迟字符串的创建到运行时刻，这意味着只有在需要字符串的时候才创建它。如果你已经使用了log4j,那么你已经熟悉把调试语句放入if()条件内的工作场景，而SLF4J占位符功能比log4j更适合这种场景。
下面是你用Log4j时的做法，当然这并不好玩而且它增加了不必要的公式化的代码，减少了代码的可读性。
| 1 2 3 |
|
而如果你使用SLF4J，你可以使用更简洁的格式达到同样的效果，如下:
| 1 |
|
在SLF4J中，我们不需要进行字符串拼接，不会导致使用临时字符串带来的消耗。相反，我们使用带占位符的模板消息来记录日志信息，并提供实际值作为参数。也许你会想，要是有多个参数该怎么办，你可以使用带参数版的日志方法，也可以通过Object数组传入。这确实是非常方便而且高效的记日志的方法。记住，在为日志信息产生最终的字符串之前，该方法会检查是否开启了特定的日志级别，这不仅降低了内存占用，而且预先减少了执行字符串拼接所消耗的CPU时间。下面的SLF4J日志方法的代码，来自于slf4j-log4j12-1.6.1.jar包里的Log4j的适配器类Log4jLoggerAdapter.
| 1 2 3 4 5 |
|
同样值得了解是，日志也会对应用程序的性能产生压力，大家通常宣扬的是只在生产环境中才强制记录日志。
如何使用SLF4J和Log4J来做日志
除了上面所说的好处，我认为还有个警告需要说一下，为了使用SLF4J你不仅需要进入SLF4J API Jar包，比如slf4j-api-1.6.1.jar，还需要引入协同工作的JAR包，具体是什么jar包则依赖于后端你使用了什么日志工具库。假如你想使用SLF4J，Simple Logging Facade for Java，还想使用Lo4J，那么你需要把下列jar包引入到你的classpath中，具体版本要视你使用的SLF4J和log4J版本而定， 比如：
slf4j-api-1.6.1.jar - JAR for SLF4J API
log4j-1.2.16.jar - JAR for Log4J API
slf4j-log4j12-1.6.1.jar - Log4J Adapter for SLF4J
如果你正在使用Maven来管理你的项目依赖，你可以只引入SLF4J JAR，然后maven会引入它所依赖的其它JAR包。为了使用Log4J和SLF4J，你可以在你项目的pom.xml中添加下列依赖：
| 1 2 3 4 5 6 7 8 9 10 11 |
|
顺便说一下，如果你对使用带参数版的日志方法感兴趣，那就需要引入SLF4J 1.7版本。
总结
总结这篇文章，我具有充分的理由的来选择SLF4J而不是直接选用Log4j, commons logging, logback 或者 java.util.logging。
1）在你的开源库或者私有库中使用SLF4J，可以使它独立于任何的日志实现，这就意味着不需要管理多个库和多个日志文件。你的客户端将会体会到这一点。
2）SLF4J提供了占位日志记录，通过移除对isDebugEnabled(), isInfoEnabled()等等的检查提高了代码的可读性。
3）通过使用日志记录方法，直到你使用到的时候，才会去构造日志信息（字符串），这就同时提高了内存和CPU的使用率。
4）做一个侧面的说明，越少的临时字符串，垃圾回收器就意味着越少的工作，这就意味着为你的应用程序提供更好的吞吐量和性能。
这些优势都只是冰山一角，当你开始使用SL4J并阅读它，你会学到更多的好处。我强烈建议，在java中任何新的代码开发，都应使用SLF4J而不是任何的日志API，包括log4J
这里借鉴了很多大牛们的观点和资料，参考网址：
1、http://www.cnblogs.com/ywlaker/p/6124067.html
2、http://www.cnblogs.com/xing901022/p/4149524.html
3、http://www.cnblogs.com/olmlo/p/3143468.html
4、http://www.open-open.com/lib/view/open1418652677495.html
5、http://www.cnblogs.com/eflylab/archive/2007/01/11/618001.html
一、slf4j介绍
SLF4J是为各种loging APIs提供一个简单统一的接口，从而使得最终用户能够在部署的时候配置自己希望的loging APIs实现。Logging API实现既可以选择直接实现SLF4J接口的loging APIs如： logback、SimpleLogger。也可以通过开发相应的来使用已有的API实现如Log4jLoggerAdapter、JDK14LoggerAdapter。
SLF4J 不依赖任何特殊的class loader机制，实际上，SLF4J 和已有日志实现的绑定是在编译时静态执行的，具体绑定工作是通过一个jar包实现的，使用时只要把相应的jar包（只有一个）放到类路径上即可.
在 SLF4J发行版本中包含了几个jar包，如slf4j-nop.jar, slf4j-simple.jar, slf4j-log4j12.jar, slf4j-log4j13.jar, slf4j-jdk14.jar and slf4j-jcl.jar等.SLF4J支持多个，比如NOP, Simple, log4j version 1.2, log4j version 1.3, JDK 1.4 logging, JCL and logback。
使用slf4j尽管很方便，但是让很多人搞不明白slf4j那么多包怎么用。其实slf4j原理很简单，他只提供一个核心slf4j api(就是slf4j-api.jar包)，这个包只有日志的接口，并没有实现，所以如果要使用就得再给它提供一个实现了些接口的日志包，比 如：log4j,common logging,jdk log日志实现包等，但是这些日志实现又不能通过接口直接调用，实现上他们根本就和slf4j-api不一致，因此slf4j又增加了一层来转换各日志实 现包的使用，当然slf4j-simple除外。其结构如下：
slf4j-api(接口层)|
各日志实现包的连接层( slf4j-jdk14, slf4j-log4j)|
各日志实现包
下面这个图更能说明其原理：
在这里还需要注意的是，连接层的jar包和实现的jar的版本要一致。
slf4j的构造是通过工厂类生存，我们调用接口时，接口的工厂会自动寻找恰当的实现，返回一个实现的实例给我服务。这些过程都是透明化的，用户不需要进行任何操作。
loging APIs的接口，
关于上述所述的“实现查找符合自己接口的实现类”，对于slf4j其实同通过加载器的方式自动来实现。
关于JVM加载器，可以参考下图理解：
二、slf4j具体使用
Logger logger = LoggerFactory.getLogger(name);
或者
Logger logger = LoggerFactory.getLogger(calss.class);
这样就可使用logger对象进行日志输出。
slf4j只提供了debug、warn、info、error等几个简单的接口，但由于slf4j只是接口，其具体实现是有对应的实现类完成。所以在在使用slf4j时都是和相应日志实现一起使用。
常用的使用有：slf4j+log4j、slf4j+Logback等
三、log4j介绍
Log4J是Apache的一个开放源代码的项目。通过使用Log4J，程序员可以控制日志信息输送的目的地，包括控制台，文件，GUI组件和NT事件记录器，也可以控制每一条日志的输出格式，或通过定义每一条日志信息的级别，更加细致地控制日志的生成过程。
Log4j的组成：
Log4j由三个重要的组成构成：日志记录器(Loggers)，输出端(Appenders)和日志格式化器(Layout)。
Logger：控制要启用或禁用哪些日志记录语句，并对日志信息进行级别限制：Appenders指定了日志将打印到控制台还是文件中;而Layout则控制日志信息的显示格式。
A).Logger对象的获得或创建：
Logger被指定为实体，由一个String类的名字识别。Logger的名字是大小写敏感的，且名字之间具有继承关系，子名用父名作为前缀，用点“.”分隔，例如x.y是x.y.z的父亲。
root Logger(根Logger)是所有Logger的祖先，它有如下属性：
1.它总是存在的。
2.它不可以通过名字获得。
root Logger可以通过以下语句获得：
public static Logger Logger.getRootLogger();
或：
public static Logger Logger.getLogger(Class clazz)
其中调用Logger.getLogger(Class clazz)是目前ogger对象最理想的方法。
B)日志级别
每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：
A：off 最高等级，用于关闭所有日志记录。
B：fatal 指出每个严重的错误事件将会导致应用程序的退出。
C：error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
D：warm 表明会出现潜在的错误情形。
E：info 一般和在粗粒度级别上，强调应用程序的运行全程。
F：debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
G：all 最低等级，用于打开所有日志记录。
上面这些级别是定义在org.apache.log4j.Level类中。Log4j只建议使用4个级别，优先级从高到低分别是error,warn,info和debug。通过使用日志级别，可以控制应用程序中相应级别日志信息的输出。例如，如果使用b了info级别，则应用程序中所有低于info级别的日志信息(如debug)将不会被打印出来。
package log4j;import org.apache.log4j.BasicConfigurator;import org.apache.log4j.Level;import org.apache.log4j.Logger;
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");
}
}
C）输出端Appender
Appender用来指定日志信息输出到哪个地方，可以同时指定多个输出目的地。Log4j允许将信息输出到许多不同的输出设备中，一个log信息输出目的地就叫做一个Appender。
每个Logger都可以拥有一个或多个Appender，每个Appender表示一个日志的输出目的地。可以使用Logger.addAppender(Appender app)为Logger增加一个Appender，也可以使用Logger.removeAppender(Appender app)为Logger删除一个Appender。
以下为Log4j几种常用的输出目的地。
a：org.apache.log4j.ConsoleAppender：将日志信息输出到控制台。
b：org.apache.log4j.FileAppender：将日志信息输出到一个文件。
c：org.apache.log4j.DailyRollingFileAppender：将日志信息输出到一个日志文件，并且每天输出到一个新的日志文件。
d：org.apache.log4j.RollingFileAppender：将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件。
e：org.apache.log4j.WriteAppender：将日志信息以流格式发送到任意指定地方。
f:：org.apache.log4j.jdbc.JDBCAppender：通过JDBC把日志信息输出到数据库中。
日志输出器，指定logger的输出位置
| 1 |
|
每种appender都有若干配置项，下面逐一介绍
ConsoleAppender（常用）
| 1 2 3 |
|
FileAppender
| 1 2 3 4 |
|
DailyRollingFileAppender（常用）
| 1 2 3 4 5 6 7 8 9 10 11 12 |
|
RollingFileAppender
| 1 2 3 4 5 6 |
|
日志格式化器Layout
有三种：
HTMLLayout：格式化日志输出为HTML表格形式：如下
SimpleLayout：以一种非常简单的方式格式化日志输出，它打印三项内容：级别-信息
指定logger输出内容及格式
| 1 |
|
layout有4种选择
| 1 2 3 4 |
|
layout也有配置项，下面具体介绍
HTMLLayout
| 1 2 |
|
PatternLayout（最常用的配置）
| 1 |
|
设置格式的参数说明如下
| 1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
例：INFO - info
PatternLayout:：根据指定的转换模式格式化日志输出，或者如果没有指定任何转换模式，就使用默认的转化模式格式。
下面的代码实现了SimpleLayout和FileAppender的程序
public static void main(String[] args) { Logger logger = Logger.getLogger(Log4jTest.class); SimpleLayout layout = new SimpleLayout(); //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"); logger.fatal("fatal"); }
Log4j的配置
配置Log4j环境就是指配置root Logger，包括把Logger为哪个级别，为它增加哪些Appender,以及为这些Appender设置Layout，等等。因为所有其他的Logger都是root Logger的后代，所以它们都继承了root Logger的性质。这些可以通过设置系统属性的方法来隐式地完成，也可以在程序中调用XXXConfigurator.configure()方法来显式地完成。有以下几种方式来配置Log4j。
A：配置放在文件里，通过环境变量传递文件名等信息，利用Log4j默认的初始化过程解析并配置。
B：配置放在文件里，通过应用服务器配置传递文件甸等信息，利用一个特定的Servlet来完成配置。
C：在程序中调用BasicConfigor.configure()方法。
D：配置放在文件里，通过命令行PropertyConfigurator.configure(args[])解析log4j.properties文件并配置Log4j。
下面对BasicConfigurator.configure()方法和PropertyConfigurator.config()方法分别进行介绍。
BasicConfigurator.configure()方法：
它使用简单的方法配置Log4j环境。这个方法完成的任务是：
1：用默认的方式创建PatternLayout对象p:
PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x-%m%n");
2：用p创建ConsoleAppender对象a，目标是System.out，标准输出设备：
ConsoleAppender a = new CpnsoleAppender(p,ConsoleAppender.SYSTEM_OUT);
3：为root Logger增加一个ConsoleAppender p;
rootLogger.addAppender(p);
4：把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");
四 log4j完整配置示例
介绍完了log4j.properties内容，我们来配置一些常用的日志输出吧
| 1 2 |
|
控制台console日志输出器
| 1 2 3 4 5 6 7 |
|
文件logFile日志输出器
| 1 2 3 4 5 6 7 8 |
|
滚动文件rollingFile日志输出器
| 1 2 3 4 5 6 7 8 9 10 |
|
定期滚动文件dailyFile日志输出器
| 1 2 3 4 5 6 7 8 9 |
|
五、log4j局部日志配置
以上介绍的配置都是全局的，整个工程的代码使用同一套配置，意味着所有的日志都输出在了相同的地方，你无法直接了当的去看数据库访问日志、用户登录日志、操作日志，它们都混在一起，因此，需要为包甚至是类配置单独的日志输出，下面给出一个例子，为“com.demo.test”包指定日志输出器“test”，“com.demo.test”包下所有类的日志都将输出到/log/test.log文件
| 1 2 3 4 5 |
|
也可以让同一个类输出不同的日志，为达到这个目的，需要在这个类中实例化两个logger
| 1 2 |
|
然后分别配置
| 1 2 3 4 5 6 7 8 9 10 11 12 |
|
六、slf4j与log4j联合使用
slf4j是什么？slf4j只是定义了一组日志接口，但并未提供任何实现，既然这样，为什么要用slf4j呢？log4j不是已经满足要求了吗？
是的，log4j满足了要求，但是，日志框架并不只有log4j一个，你喜欢用log4j，有的人可能更喜欢logback，有的人甚至用jdk自带的日志框架，这种情况下，如果你要依赖别人的jar，整个系统就用了两个日志框架，如果你依赖10个jar，每个jar用的日志框架都不同，岂不是一个工程用了10个日志框架，那就乱了！
如果你的代码使用slf4j的接口，具体日志实现框架你喜欢用log4j，其他人的代码也用slf4j的接口，具体实现未知，那你依赖其他人jar包时，整个工程就只会用到log4j日志框架，这是一种典型的门面模式应用，与jvm思想相同，我们面向slf4j写日志代码，slf4j处理具体日志实现框架之间的差异，正如我们面向jvm写java代码，jvm处理操作系统之间的差异，结果就是，一处编写，到处运行。况且，现在越来越多的开源工具都在用slf4j了
那么，怎么用slf4j呢？
首先，得弄到slf4j的jar包，maven依赖如下，log4j配置过程完全不变
| 1 2 3 4 5 |
|
然后，弄到slf4j与log4j的关联jar包，通过这个东西，将对slf4j接口的调用转换为对log4j的调用，不同的日志实现框架，这个转换工具不同
| 1 2 3 4 5 |
|
当然了，slf4j-log4j12这个包肯定依赖了slf4j和log4j，所以使用slf4j+log4j的组合只要配置上面这一个依赖就够了
最后，代码里声明logger要改一下，原来使用log4j是这样的
| 1 2 3 4 5 6 7 |
|
现在要改成这样
| 1 2 3 4 5 6 7 8 |
|
依赖的Logger变了，而且，slf4j的api还能使用占位符，很方便。
扫一扫
2336
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
