Log4j用于日志记录,有两个版本,一个是老版本Log4j 1.x
,这里写的是新版本Apache Log4j 2
的使用
使用
- Gradle 内添加依赖
dependencies {
compile group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.11.0'
compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.11.0'
}
编写配置文件
应用程序中使用
static Logger log =LogManager.getLogger();//默认以所在类名称作为logger名称,可以在配置文件中指定特定名称的日志属性
log.debug(Object);
org.apache.logging.log4j.Level
用来表明消息的优先级,ALL输出全部log,OFF不输出
ALL < Trace < Debug < Info < Warn < Error < Fatal < OFF
框架中有两种类型的对象:
Core Objects
Logger:捕获日志信息
Layout:设定格式
Appender:指定日志信息的输出位置(console,files,sockets等)
Support Objects
Level:设定等级OFF, FATAL, ERROR, WARN,INFO,DEBUG, ALL
Filter:分析过滤日志
ObjectRenderer:把对象作为日志时,输出字符串的方式
LogManger:管理日志框架,读取初始化配置信息
配置
可以通过文件配置,也可以通过程序配置,通常使用配置文件
如果没有配置,会使用默认配置,由DefaultConfiguration
类提供,等价于下下配置文件
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
使用配置文件时,Log4j的ConfigurationFactory
支持property,JSON,YAML和XML文件配置,它会在classpath下查找文件对应的文件名称,例如log4j2.properties
,log4j2.xml
,通常将配置文件放在scr/resouces
目录下
Log4j property文件配置
log4j.rootLogger=info, stdout
### stdout appender 设定 ###
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{ABSOLUTE} %5p - %m%n
### 设置特定package的日志输出级别和appender###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug
配置根Logger
定义log4j支持的日志级别及输出目的地
log4j.rootLogger = [ level ] , appenderName, appenderName, …
level 是日志记录的优先级
appenderName指定日志信息输出的目的地,可以定义多个
配置输出目的地 Appender
输出到文件
# 定义文件路径
log = /usr/home/log4j
log4j.rootLogger = DEBUG, FILE
#定义appender
log4j.appender.FILE=org.apache.log4j.FileAppender
#设定文件名称
log4j.appender.FILE.File=${log}/log.out
#设定布局
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.conversionPattern=%m%n
log4j.appender.FILE.ImmediateFlush=true
log4j.appender.FILE.Threshold=debug
log4j.appender.FILE.Append=false
输出到控制台
...appender名称为stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out //或者System.err
log4j.appender.stdout.Threshold=WARN //日志消息的输出门限,低于则不输出
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout //设定格式
log4j.appender.stdout.layout.ConversionPattern=%d{HH:mm:ss.SSS} %-5p %c{1}:%L - %m%n
布局 Layout
指定输出格式,例如PatternLayout
,XmlLayout
,JsonLayout
等
PatternLayout 格式
转换字符 | 含义 |
---|---|
%c | 输出日志事件所在的目录(类名),全名为"a.b.c" %c{2}输出类名 "b.c" |
%d | 用于输出时间 %d{HH:mm:ss,SSS} 或者 %d{dd MMM yyyy HH:mm:ss,SSS} |
%L | 请求输出日志的代码行号 |
%m | 输出代码中指定的消息 |
%n | 输出一个平台相关的换行符 |
%p | 输出日志信息优先级 |
%t | 线程名 |
%-5p | 左对齐,最小宽度为5,输出日志等级 |
Log4j2 property配置文件
根据属性层级,逐级配置即可,具体属性Configuration说明
最外层的可以是status
,name
,appender
,filter
,loger
等,示例如下:
status = error
dest = err
name = PropertiesConfig
property.filename = target/rolling/rollingtest.log
filter.threshold.type = ThresholdFilter
filter.threshold.level = debug
appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %m%n
appender.console.filter.threshold.type = ThresholdFilter
appender.console.filter.threshold.level = error
appender.rolling.type = RollingFile
appender.rolling.name = RollingFile
appender.rolling.fileName = ${filename}
appender.rolling.filePattern = target/rolling2/test1-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d %p %C{1.} [%t] %m%n
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 2
appender.rolling.policies.time.modulate = true
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.rolling.policies.size.size=100MB
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.max = 5
logger.rolling.name = com.example.my.app
logger.rolling.level = debug
logger.rolling.additivity = false
logger.rolling.appenderRef.rolling.ref = RollingFile
rootLogger.level = info
# 对应appender.console
rootLogger.appenderRef.stdout.ref = STDOUT
SLF4j
SLF4J(Simple logging Facade for Java)是各种日志框架(例如java.util.logging,logback,log4j)的简单抽象,最终在部署时插入所需的日志框架
简单使用:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
String name = "abc"
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World, {}", name);
}
}
使用{}
作为占位符,左右花括号之间没有其他字符
- 避免不输出时,构造参数引发计算,例如
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
- 本质上是使用两次判断logger是否开启
if(logger.isDebugEnabled()) {
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
}
如果使用SLF4J绑定log4j,使用三个库,slf4j本身,slf4j到log4j的适配器,log4j本身
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.16</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.16</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
如果绑定到log4j2,log4j-slf4j-impl
内部包含所有需要的依赖
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>2.11.0</version>
</dependency>