Log4j 和 Slf4j 的介绍和使用
1. 是什么
Log4j是Apache的一个开源、轻量级、用于日志管理的框架。
2. 干什么
主要用来进行日志记录的管理
通过使用Log4j,我们可以
- 控制日志信息输送的目的地: 控制台、文件等;
- 控制每一条日志的输出格式;
- 控制每一条日志信息的优先级别,我们能够更加细致地控制日志的生成过程。
3. 组成
主要由三个部分组成:
- 日志信息的输出格式
- 日志信息的优先级别
- 日志信息的输出目的地
4. 日志级别
Log4j有如下级别: 【 OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL 】
A:off 最高等级,用于关闭所有日志记录。
B:fatal 指出每个严重的错误事件将会导致应用程序的退出。
C:error 指出虽然发生错误事件,但仍然不影响系统的继续运行。
D:warm 表明会出现潜在的错误情形。
E:info 一般和在粗粒度级别上,强调应用程序的运行全程。
F:debug 一般用于细粒度级别上,对调试应用程序非常有帮助。
G:all 最低等级,用于打开所有日志记录。
一般只使用ERROR > WARN > INFO > DEBUG (优先级别从高到低)。
注: 只要大于等于指定的控制级别,就可以输出。
5. 输出源
Log4j允许日志请求被输出到多个输出源(如控制台,文件),一个输出源被称作一个Appender.
6. 常见Appender:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
7. 布局
布局Layout就是输出信息的格式。
常见Layout:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
上面对Log4j做了简要的介绍,下面通过配置文件的格式实例来讲解上面所述的概念:
1. 配置文件
# 配置根Logger (设置日志的级别和Appender Name,appenderName1 可自己命名,但要与下多个appenderName 相同)
log4j.rootLogger = [ level ], appenderName1 , appenderName2 , …
# 配置日志信息输出目的地Appender (设置到控制台还是文件,appenderName 与上述appenderName 对应一致)
log4j.appender.appenderName = fully.qualified.name.of.appender.class (如: org.apache.log4j.ConsoleAppender)
log4j.appender.appenderName.option1 = value1
log4j.appender.appenderName.option2 = value2
…
log4j.appender.appenderName.optionN = valueN
# 配置日志信息的格式(布局) (设置输出的日志格式)
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class (如:org.apache.log4j.PatternLayout)
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
上述文件中
* [level] 是日志输出级别,常用如上所述:ERROR > WARN > 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(将日志信息以流格式发送到任意指定的地方)
Layout:日志输出格式,Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)打印参数 : Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,如下:
%m 输出代码中指定的消息
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目,通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n”
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss , SSS},输出类似:2002年10月18日 22 : 10 : 28 , 921
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java: 10 )通过上述讲解可知:
- 每个Appender都要引用自己的Layout;
- 每个Logger都可以指定一个级别,同时引用多个Appender;
- 一个Appender可同时被多个Logger引用
二、Log4j 的 HelloWorld
加入jar包Apache的Log4j;
src下添加配置文件log4j.properties:
### 设置(D,E自己命名的,与倒数一二模块的appenderName要对应相同) log4j.rootLogger = debug,stdout,D,E ### 输出信息到控制抬 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 = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n ### Log4j只建议使用4个级别,优先级从高到低分别是error > warn > info > debug。 ### 输出DEBUG 级别以上的日志到=E://logs/error.log ### log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = D://logs/log.log log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG # 日志格式 log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n ### 只输出ERROR级别以上的日志到D://logs/error.log log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File =D://logs/error.log log4j.appender.E.Append = true log4j.appender.E.Threshold = ERROR # 日志格式 log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
3 测试:
package com.wgs.logtest; import org.apache.log4j.Logger; public class LogTest { private static final Logger logger = Logger.getLogger(LogTest.class); public static void main(String[] args) { for(int i = 0; i < 999; i++){ // 记录debug级别的信息 logger.debug("This is debug message:" + i); // 记录info级别的信息 logger.info("This is info message:" + i); // 记录error级别的信息 logger.error("This is error message:" + i); // 记录warn级别的信息 logger.warn("This is error message:" + i); } } }
4 输出:
控制台:
本地文件夹:
三 Spring项目中使用Log4j
1 pom.xml中引入依赖:
<!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
2 resources下添加log4j.properties文件:
# 配置根Logger: 可定义日志级别,以及下面每个操作appender name 如stdout, index(接口)都要在此类似注册下才能使用对应模块的功能 log4j.rootLogger=INFO, DEBUG, stdout, index # stdout : 输出信息到控制台 log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target = System.out #配置日志信息的格式(布局) log4j.appender.stdout.layout=org.apache.log4j.PatternLayout %p:输出优先级,即DEBUG,INFO,WARM,ERROR,FATAL # 输出 如 2017年5月2日 INFO index start ... log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p]%m%n # index接口日志 log4j.logger.index=INFO, index log4j.appender.index=org.apache.log4j.RollingFileAppender log4j.appender.index.File=D://logs/indexController.log log4j.appender.index.MaxFileSize=1MB log4j.appender.index.MaxBackupIndex=100 #配置日志信息的格式(布局) log4j.appender.index.layout=org.apache.log4j.PatternLayout log4j.appender.index.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %m%n
3 测试:
package com.wgs.Log4jTest.controller; import org.apache.log4j.Logger; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; /** * Created by wanggenshen_sx on 2017/5/2. */ @Controller public class IndexController { private static final Logger logger = Logger.getLogger(IndexController.class); @RequestMapping(path = {"/", "/index"}, method = {RequestMethod.GET, RequestMethod.POST}) public String index(){ for(int i = 0; i < 100; i++){ logger.info("This is index 接口的INFO 消息 :" + i); } return "index"; } }
4 显示
chrome中输入localhost:8080/index后,
控制台显示:
文件:
如何在log4j中为某个类的具体方法配置其日志输出?
**#省略根,只设置特定包的级别和目的地** log4j.logger.com.wgs.Log4jTestlog4j=debug,appender1 log4j.logger.com.wgs.Log4jTestlog4j.IndexController=info,appender2
四、slf4j简介和使用
是什么
slf4j 并不是一种具体的日志系统,而是为各种日志 APIs 提供一个简单统一的接口,从而使得用户能够在部署的时候配置自己所想使用的日志API。
即在开发中统一按照slf4j的API进行开发,在部署时选择不同的日志系统包即可自动转换到不同的日志系统上。由上图可以这样理解:slf4j只是一个外壳,内部的具体实现都是使用的具体的日志API.
比如:开发中使用的是JDK自带的日志系统,则只需slf4j-api
和slf4j-jdk12
两个jar包;如果不想使用JDK自带的日志系统想换成Log4j,即可将slf4j-jdk12
换成slf4j-log4j12
即可,代码不用改动(代码中都是用到的slf4j的API)。如何用
1 MAVEN引入依赖:
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.6.4</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.6.4</version> </dependency>
2 Java中使用:
在类中获得Logger对象:
private static final Logger logger = LoggerFactory.getLogger(Test.class);
输出日志信息:
logger.error("日志信息 ");
可以使用占位符:
logger.info("{} is {}", "new String[]{"x", "y"}");
</div> <link href="https://csdnimg.cn/release/phoenix/mdeditor/markdown_views-258a4616f7.css" rel="stylesheet"> </div> </article>