log4j与slf4j、logback比较
而log4j slf4j logback就是目前主流的日志框架。但后两者效率高是第一个。推荐使用:slf4j 或者 logback(spring-boot默认日志实现)
- log4j是apache实现的一个开源日志组件。(Wrapped implementations)
- logback同样是由log4j的作者设计完成的,拥有更好的特性,用来取代log4j的一个日志框架。是slf4j的原生实现。(Native implementations)
上图可以看到应用程序对日志框架的调用关系。应用程序调用slf4j api,而日志的输出最终是由底层的日志框架来实现的。这张图也提现了log4j和logback的不同。-
logback是直接实现了slf4j的接口,是不消耗内存和计算开销的。
-
而log4j不是对slf4j的原生实现,所以slf4j api在调用log4j时需要一个适配层。
总结:
- slf4j是java的一个日志门面,实现了日志框架一些通用的api,log4j和logback是具体的日志框架。
- 他们可以单独的使用,也可以绑定slf4j一起使用。
- 单独使用。分别调用框架自己的方法来输出日志信息。
- 绑定slf4j一起使用。调用slf4j的api来输入日志信息,具体使用与底层日志框架无关(需要底层框架的配置文件)
级别Loggers
Loggers组件在此系统中被分为五个级别:DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的。
DEBUG Log4j有一个规则:假设Loggers级别为P,如果在Loggers中发生了一个级别Q比P高,则可以启动,否则屏蔽掉。比如:你定义的级别是info,那么error和warn的日志可以显示而比他低的debug信息就不显示了,其语法表示为:
- org.apache.log4j.ConsoleAppender(控制台)
- org.apache.log4j.FileAppender(文件)
- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
配置时使用方式为:
- log4j.appender.appenderName = fully.qualified.name.of.appender.class
- log4j.appender.appenderName.option1 = value1
- ......
- log4j.appender.appenderName.option = valueN
这样就为日志的输出提供了相当大的便利。
1.ConsoleAppender选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err:默认情况下是:System.out,指定输出控制台
2.FileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
3.DailyRollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。
即对应的格式如下: 1)'.'yyyy-MM: 每月
2)'.'yyyy-ww: 每周
3)'.'yyyy-MM-dd: 每天
4)'.'yyyy-MM-dd-a: 每天两次
5)'.'yyyy-MM-dd-HH: 每小时
6)'.'yyyy-MM-dd-HH-mm: 每分钟
4.RollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
布局Layouts
有时用户希望根据自己的喜好格式化自己的日志输出.Log4j可以在Appenders的后面附加Layouts来完成这个功能。
Layouts提供了 四种日志输出样式,
如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式等等。 其语法表示为:
- org.apache.log4j.HTMLLayout(以HTML表格形式布局),
- org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
- org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
- org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
配置时使用方式为:
- log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class
- log4j.appender.appenderName.layout.option1 = value1
- log4j.appender.appenderName.layout.option = valueN
1.HTMLLayout 选项
LocationInfo=true:默认值是false,输出java文件名称和行号 Title=my app file: 默认值是 Log4J Log Messages.
2.PatternLayout 选项
ConversionPattern=%m%n :指定怎样格式化指定的消息。
3.XMLLayout 选项
LocationInfo=true:默认值是false,输出java文件和行号 实际应用:
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
这里需要说明的就是日志信息格式中几个符号所代表的含义:
-X号: X信息输出时左对齐;
%p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL,
%d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921
%r: 输出自应用启动到输出该log信息耗费的毫秒数 %c: 输出日志信息所属的类目,通常就是所在类的全名 %t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 %%: 输出一个"%"字符
%F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符,Windows平台为"\r\n",Unix平台为"\n"输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。
2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,"-"号指定左对齐。
3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边交远销出的字符截掉。
这里上面三个步骤是对前面Log4j组件说明的一个简化;下面给出一个具体配置例子,在程序中可以参照执行:
log4j.rootLogger=INFO,A1,B2
log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
Log4j手动读取配置文件
log4j中配置日志文件存放的位置不一定在src下面,即根目录下。这个时候我们需要解决如何加载配置文件的问题。在log4j1.x中解决的方法就比较多了。如:PropertyConfigurator.configure();和DOMConfigurator.configure ();这两种方法读取。而在log4j2.x当中,这两个类都已经不存在了。这个时候我们该如何去加载配置文件呢?
答案也很简单,就是log4j2.x的版本给我提供了ConfigurationSource和Configurator这两个类。我们可以使用它们进行手动的加载任意位置的配置文件信息。
我就主要介绍三种方法:log4j 2读取配置文件的三种方法。
log4j 2读取的配置文件可以分为三类:src下的配置文件、绝对路径的配置文件、相对路径的配置文件。我们一一给例子。直接看代码:
import java.io.File;
import java.io.FileInputStream;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.ConfigurationSource;
import org.apache.logging.log4j.core.config.Configurator;
/**
* log4j 2读取配置文件
* log4j 2读取的配置文件可以分为三类:src下的配置文件、绝对路径的配置文件、相对路径的配置文件
*/
public class Log4jConfigTest {
private static Logger logger = LogManager.getLogger(Log4jConfigTest.class);
public static void main(String[] args) {
test0();
System.out.println("===============================");
test1();
System.out.println("===============================");
test2();
}
/**
* 第一类 加载src下的配置文件
* @author:spinach
* @date:2018年4月22日上午11:37:59
*/
public static void test0() {
// src下的配置文件会默认的被log4j的框架加载,我们就不显示的加载了
// 直接测试
logger.info("我打印了.......");
logger.trace("trace...");
logger.debug("debug...");
logger.info("info...");
logger.warn("warn...");
logger.error("error...");
logger.fatal("fatal...");
}
/**
* 第二类 绝对路径的配置文件
* @author:spinach
* @date:2018年4月22日上午11:38:04
*/
public static void test1() {
// 这是需要手动的加载
ConfigurationSource source;
String logPath = "D:/log4j.properties";
try {
// 方法1 使用 public ConfigurationSource(InputStream stream) throws IOException 构造函数
source = new ConfigurationSource(new FileInputStream(logPath));
// 方法2 使用 public ConfigurationSource(InputStream stream, File file)构造函数
File config = new File(logPath);
//source = new ConfigurationSource(new FileInputStream(config), config);
// 方法3 使用 public ConfigurationSource(InputStream stream, URL url) 构造函数
//source = new ConfigurationSource(new FileInputStream(logPath), new File(logPath).toURL());
// source.setFile(new File("D:\log4j2.xml"));
// source.setInputStream(new FileInputStream("D:\log4j2.xml"));
Configurator.initialize(null, source);
Logger logger = LogManager.getLogger(ConfigTest.class.getName());
test0();
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 第三类 相对路径的配置文件加载
* @author:spinach
* @date:2018年4月22日上午11:38:10
*/
public static void test2() {
// 这里需要注意路径中不要出现中文和空格,如果存在中文,请使用url转码
ConfigurationSource source;
String logPath = "src/main/resources/log4j.properties";
try {
// 方法1 使用getResource()
source = new ConfigurationSource(new FileInputStream(new File(logPath)));
Configurator.initialize(null, source);
// 方法2 使用System.getProperty
String config = System.getProperty("user.dir");
source = new ConfigurationSource(new FileInputStream(config +"/"+ logPath));
Configurator.initialize(null, source);
test0();
} catch (Exception e) {
e.printStackTrace();
}
}
}
log4j 1加载方式:
public void initLog4j() {
String time = "【" + DatetimeUtils.format(System.currentTimeMillis(), "yyyy-MM-dd HH:mm:ss") + "】";
System.out.println(time + "开始初始化log4j...");
ConfigurationSource source = new ConfigurationSource(new FileInputStream("D:\\log4j2.xml"));
DOMConfigurator.configure(confPath + "/log4j.xml");
LOGGER.info("log4j初始化成功...");
}
log4j.properties
### set log levels ###
log4j.rootLogger = INFO,C
### Output to the console ###
log4j.appender.C = org.apache.log4j.ConsoleAppender
log4j.appender.C.Target = System.out
log4j.appender.C.layout = org.apache.log4j.PatternLayout
log4j.appender.C.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%p] %c{2}:%L %m%n
#log4j.logger.org.hibernate.cache=debug
### SQL ###
#log4j.logger.java.sql.Connection=debug
#log4j.logger.java.sql.PreparedStatement = debug
#log4j.logger.java.sql.Statement = debug
#log4j.logger.java.sql.ResultSet =debug
#log4j.logger.com.ibatis=DEBUG
#log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG
#log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG
#log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
log4j.logger.com.spinach.business=DEBUG
### Save infos to log file ###
log4j.appender.I = org.apache.log4j.DailyRollingFileAppender
log4j.appender.I.encoding=UTF-8
log4j.appender.I.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-info.log
log4j.appender.I.DatePattern = '.'yyyy-MM-dd
log4j.appender.I.MaxFileSize=50MB
log4j.appender.I.MaxBackupIndex=10
log4j.appender.I.Append = true
log4j.appender.I.Threshold = DEBUG
log4j.appender.I.layout = org.apache.log4j.PatternLayout
log4j.appender.I.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%p] %l%m%n%n
### Save debugs to log file ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.encoding=UTF-8
log4j.appender.D.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-debug.log
log4j.appender.D.DatePattern = '.'yyyy-MM-dd
log4j.appender.D.MaxFileSize=50MB
log4j.appender.D.MaxBackupIndex=10
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} [%p] %l%m%n%n
### Save errors to a log file ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.encoding=UTF-8
log4j.appender.E.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-error.log
log4j.appender.E.DatePattern = '.'yyyy-MM-dd
log4j.appender.E.MaxFileSize=50MB
log4j.appender.E.MaxBackupIndex=10
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} [%p] %l%m%n%n
#log4j.logger.org.hibernate.SQL=debug