Log4j
概述
Log4j 是一个使用 Java 语言编写的,可靠、快速、灵活的日志框架(API),使用 Apache Software License 授权。
它被移植到 C、C++、C#、Perl、Python、Ruby 和 Eiffel 语言中。Log4j 是高度可配置的,在运行期使用外部的配置文件对其进行配置。它按照优先级别记录日志,并可将日志信息定向输出到各种介质,比如数据库、文件、控制台、Unix Syslog等。
Log4j的历史
始于 1996 年,作为记录E.U. SEMPER (Secure Electronic Marketplace for Europe)项目跟踪信息的 API。
经过大量的完善和蜕变,最初的 API 终于演进为 Log4j,一个在 Java 社区流行的日志类库。该类库使用 Apache Software License 授权,该授权是经开源促进协会认证的、完整的开源协议。
最新版本的 Log4j,连同其代码、类文件和文档可通过 http://logging.apache.org/log4j/ 获取。
Log4j的功能
- 线程安全。
- 速度优化。
- 基于命名的 logger 层次。
- 每个 logger 支持多种输出 appender。
- 支持国际化。不受限于预定义好的设施。
- 日志记录行为可在运行期通过配置文件设置。
- 设计之初就考虑了处理 Java 异常。
- 使用多个日志级别:ALL、TRACE、DEBUG、INFO、WARN、ERROR、FATAL。
- 通过扩展 Layout 类可轻松改变输出日志的格式。
- 输出日志的目的和策略可通过实现 Appender 接口改变。
- 失败即停止。虽然 Log4j 努力做到最好,但不保证每一条日志都能发送到指定目的地。
架构
Log4j API 采用分层架构,每一层有不同的对象,完成不同的任务。这种分层架构让设计变得灵活,且易于日后扩展。
Log4j 里分两种类型的对象
- 核心对象:这是框架必需的对象,使用框架时必需用到它们。
- 支持对象:这是框架的可选对象,它们支持核心对象做一些额外的,但并不重要的任务。
核心对象
核心对象包括以下三种类型:
Logger对象
Logger对象位于最上一层,该对象负责获取日志信息,并存储于一个分层的命名空间之中。
Appender对象
该对象位于分层架构中的较低一层,Appender 对象负责将日志信息发布到不同目的地,比如数据库、文件、控制台、Unix Syslog 等
Layout对象
Layout层提供了用于格式化日志信息的对象,在发布日志信息之前,它为 appender 对象提供支持。
支持对象
- Level 对象:定义了日志信息的粒度和优先级。API 定义了七种级别:OFF、DEBUG、INFO、ERROR、WARN、FATAL、ALL。
- Filter对象:用于分析日志信息,进而决定该条日志是否被记录。
一个 Appender 对象可对应多个 Filter 对象,当日志信息传给 Appender 对象时,与其关联的所有 Filter 对象需要判断是否将日志信息发布到目的地。
- ObjectRenderer对象:负责为传入日志框架的不同对象提供字符串形式的表示,Layout 对象使用该对象来准备最终的日志信息。
- LogManager对象:管理日志框架,它负责从系统级的配置文件或类中读取初始配置参数。
Appender是Log4j里面最核心最重要的类,Apache Log4j 提供的 Appender 对象主要负责将日志信息打印至不同目的地,比如控制台、文件、网络套接字、NT 事件日志等。每个Appender对象都有不同的属性,这些属性决定了该对象的行为。
属性 | 描述 |
---|---|
layout | Appender 使用 Layout 对象和与之关联的模式来格式化日志信息 |
target | 目的地可以是控制台、文件,或依赖于 appender 的对象。 |
level | 级别用来控制过滤日志信息。 |
threshold | Appender 可脱离于日志级别定义一个阀值级别,Appender 对象会忽略所有级别低于阀值级别的日志。 |
filter | 对象可在级别基础之上分析日志信息,来决定 Appender 对象是否处理或忽略一条日志记录。通过在配置文件中使用如下方法,将 Appender 对象添加至 Logger 对 |
实例
配置需求
- 定义根日志级别为 DEBUG,并将名为 FILE 的 appender 添加其上。
- appender FILE 定义为 org.apache.Log4j.FileAppender,它将日志写入 log 目录下一个名为 log.out 的文件中。
- layout 被定义为 %m%n,即打印出来的日志信息末尾加入换行。
Log4j 支持 Unix 风格的变量替换,比如 ${variableName}
配置文件
Log4j.propertis文件内容
# Define the root logger with appender file
log=/user/document/log
Log4j.rootLogger = DEBUG, FILE
Log4j.appender.FILE=org.apache.Log4j.FileAppender
Log4j.appener.FILE.File= ${log}/log.out
Log4j.appender.FILE.layout=org.apache.Log4j.PatternLayout
Log4j.appender.FILE.layout.conversionPattern=%m%n
通过XML配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE Log4j:configuration SYSTEM "Log4j.dtd">
<Log4j:configuration>
<appender name="FILE" class="org.apache.Log4j.FileAppender">
<param name="file" value="${log}/log.out"/>
<layout class="org.apache.Log4j.PatternLayout">
<param name="conversionPattern" value="%m%n"/>
</layout>
</appender>
<logger name="Log4j.rootLogger" additivity="false">
<level value="DEBUG"/>
<paaender-ref ref="FILE"/>
</logger>
</log4j:configuration>
Loging方法
Logger 类提供了很多方法用来处理日志,Logger 类不允许初始化一个新的实例,但提供了两个静态方法用来获取 Logger 对象:
- public static Logger getRootLogger();
- public static Logger getLogger(String name);
第一个方法返回应用实例没有名字的根日志。
其他有名字的 Logger 对象通过传入日志的名字,调用第二个方法获得。日志的名字是传入的任何字符串,通常为类名或包名。
附录
以上为笔记主要记录点,很多东西没有提及,详细文档信息等进入Log4j官网获取.
PatternLayout
- 模式转换字符
- 格式修饰符
参考极客学院有关Log4j资料整理所得。