Java Log 日志

更多 Java 基础知识方面的文章，请参见文集《Java 基础知识》

Java日志组件

Java 日志 API 由以下三个核心组件组成：
Loggers：Logger 负责捕捉事件并将其发送给合适的 Appender。
Appenders：也被称为 Handlers，负责将日志事件记录到目标位置。在将日志事件输出之前， Appenders 使用Layouts来对事件进行格式化处理。
Layouts：也被称为 Formatters，它负责对日志事件中的数据进行转换和格式化。Layouts 决定了数据在一条日志记录中的最终形式。

当 Logger 记录一个事件时，它将事件转发给适当的 Appender。然后 Appender 使用 Layout 来对日志记录进行格式化，并将其发送给控制台、文件或者其它目标位置。另外，Filters 可以让你进一步指定一个 Appender 是否可以应用在一条特定的日志记录上。在日志配置中，Filters 并不是必需的，但可以让你更灵活地控制日志消息的流动。

日志框架

1. java.util.logging

默认的 Java 日志框架。

2. 第三方框架

例如：

3. 抽象层开发包

例如：

诸如 SLF4J 这样的抽象层，会将你的应用程序从日志框架中解耦。
应用程序可以在运行时选择绑定到一个特定的日志框架（例如 java.util.logging、Log4j 或者 Logback），这通过在应用程序的类路径中添加对应的日志框架来实现。
如果在类路径中配置的日志框架不可用，抽象层就会立刻取消调用日志的相应逻辑。
抽象层可以让我们更加容易地改变项目现有的日志框架，或者集成那些使用了不同日志框架的项目。

《阿里巴巴Java开发手册（正式版）》 中提出：
应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

日志级别 Log Levels

Log levels provide a way to categorize and identify logs based on their severity. 日志级别用来确定日志的严重程度，它可以用来过滤日志事件或者将其发送给不同的 Appender。

java.util.logging 框架提供了如下的日志级别：

  • SEVERE (HIGHEST LEVEL)
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST (LOWEST LEVEL)

Loggers

创建新Logger

通过 Logger.getLogger() 方法创建新 Logger，这个方法接收一个 String 参数，用于指定 Logger 的名字。

  • 如果指定名字的 Logger 已经存在，那么只需要返回已经存在的 Logger；
  • 否则，程序会创建一个新 Logger。

通常情况下，一种好的做法是，我们在当前类下使用 class.getName() 作为新 Logger 的名字。

示例：
Logger logger = Logger.getLogger(MyClass.class.getName());

记录日志事件

logger.log() 方法除了日志消息以外，还需要一个日志级别作为参数：
logger.log(Level.WARNING, "This is a warning!");

大部分日志框架都针对输出特定级别日志提供了快捷方式。例如，下面语句的作用和上面语句的作用是一样的：
logger.warning("This is a warning!");

你还可以阻止 Logger 输出低于指定日志级别的消息。在下面的示例中，Logger 只能输出 等于或者高于 WARNING 级别的日志消息，并丢弃日志级别低于 WARNING的消息：
logger.setLevel(Level.WARNING);

Appenders

Appenders 将日志消息转发给期望的输出。它负责接收日志事件，使用 Layout 格式化事件，然后将其发送给对应的目标。
对于一个日志事件，我们可以使用多个 Appenders 来将事件发送到不同的目标位置。
例如，我们可以在控制台上显示一个简单的日志事件的同时，将其通过邮件的方式发送给指定的接收者。

增加 Appender

  • 如果使用 java.util.logging，你可以使用 logger.addHandler() 方法将 Appender 添加到 Logger 中。例如，下面的代码添加了一个新的 ConsoleHandler，它会将日志输出到控制台：
    logger.addHandler(new ConsoleHandler());
  • 使用配置文件：
    • 如果使用 java.util.logging，Appenders 会定义一个以逗号隔开的列表，下面的示例将日志事件输出到控制台和文件：
      handlers=java.util.logging.ConsoleHandler, java.util.logging.FileHandler
    • 如果使用 Log4j，可以通过 XML 形式：
<Console name="console" target="SYSTEM_OUT">
   <PatternLayout pattern="[%p] %t: %m%n" />
</Console>

Appenders类型

1. ConsoleAppender

它只是将日志消息显示到控制台上。许多日志框架都将其作为默认的 Appender，并且在基本的配置中进行预配置。

一个完整的 Log4j2 的配置文件如下所示：

<?xml version="1.0" encoding="UTF-8"?>
 <Configuration status="warn" name="MyApp">
   <Appenders>
     <Console name="MyAppender" target="SYSTEM_OUT">
       <PatternLayout pattern="%m%n"/>
     </Console>
   </Appenders>
   <Loggers>
     <Root level="error">
       <AppenderRef ref="MyAppender"/>
     </Root>
   </Loggers>
 </Configuration>

你也可以使用 Logback 实现完全一样的效果：

<configuration>
  <appender name="MyAppender" class="ch.qos.Logback.core.ConsoleAppender">
    <encoder>
      <pattern>%m%n</pattern>
    </encoder>
  </appender>
  <root level="error">
    <appender-ref ref="MyAppender" />
  </root>
</configuration>

2. FileAppenders

将日志记录写入到文件中，它负责打开、关闭文件，向文件中追加日志记录，并对文件进行加锁，以免数据被破坏或者覆盖。

Log4j 示例：

<Appenders>
  <File name="MyFileAppender" fileName="myLog.log" append="true" locking="true">
    <PatternLayout pattern="%m%n"/>
  </File>
</Appenders>

Logback 示例：

<appender name="FileAppender" class="ch.qos.Logback.core.FileAppender">
  <file>myLog.log</file>
  <append>true</append>
  <prudent>true</prudent>
  <encoder>
    <pattern>%m%n</pattern>
  </encoder>
</appender>

3. SyslogAppender

将日志记录发送给本地或者远程系统的日志服务。
syslog 是一个接收日志事件服务，这些日志事件来自操作系统、进程、其它服务或者其它设备。事件的范围可以从诊断信息到用户登录硬件失败等。syslog的事件按照设备进行分类，它指定了正在记录的事件的类型。

Log4j 示例：

<Appenders>
  <Syslog name="SyslogAppender" host="localhost" port="514" protocol="UDP" facility="Auth" />
</Appenders>

Logback 示例：

<appender name="SyslogAppender" class="ch.qos.Logback.classic.net.SyslogAppender">
  <syslogHost>localhost</syslogHost>
  <port>514</port>
  <facility>Auth</facility>
</appender>

4. 其它 Appender

例如，Log4j 中的 RollingFileAppender 扩展了 FileAppender，它可以在满足特定条件时自动创建新的日志文件；
SMTPAppender 会将日志内容以邮件的形式发送出去；
FailoverAppender 会在处理日志的过程中，如果一个或者多个 Appender 失败，自动切换到其他 Appender上。

如果想了解更多关于其他 Appender 的信息，可以查看 Log4j Appender参考 以及 Logback Appender参考。

Layouts

Layouts 将日志记录的内容从一种数据形式转换成另外一种。
日志框架为纯文本、HTML、syslog、XML、JSON、序列化以及其它日志提供了 Layouts。

例如，java.util.logging 提供了两种 Layouts：SimpleFormatter 和 XMLFormatter。

  • 默认情况下，ConsoleHandlers 使用 SimpleFormatter
  • 默认情况下，FileHandlers 使用 XMLFormatter

配置Layout

在 Log4j 和 Logback 中最常用的 Layouts 是 PatternLayout。它可以让你决定日志事件中的哪些部分需要输出，这是通过 转换模式 Conversion Pattern 完成的，转换模式在每一条日志事件的数据中扮演了占位符的角色。

例如，Log4j 默认的 PatternLayout 使用了如下转换模式：
PatternLayout pattern = "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"

%d{HH:mm:ss.SSS} 将日期转换成时、分、秒和毫秒的形式，%level 显示日志事件的严重程度，%C 显示生成日志事件的类的名字，%t 显示 Logger 的当前线程，%m 显示时间的消息，最后，%n 为下一个日志事件进行了换行。

改变Layouts

java.util.logging 中的示例代码如下：

Handler ch = new ConsoleHandler();
ch.setFormatter(new XMLFormatter());
logger.addHandler(ch);

转换模式 Conversion Patterns

Log4j 和 Logback 中的 PatternLayout 类都支持转换模式，它决定了我们如何从每一条日志事件中提取信息以及如何对信息进行格式化。

  • 消息 %m
  • 级别/严重程度 %p
  • 异常 %ex
  • 线程 %t
  • Logger %c
  • 方法 %M

一个 java.util.logging 完整的示例

Java 代码：

import java.util.logging.Logger;

public class LoggerTest {
    public static void main(String[] args) {
        Logger logger = Logger.getLogger(MyClass.class.getName());

        logger.finest("this is finest");
        logger.finer("this is finer");
        logger.fine("this is fine");
        logger.config("this is config");
        logger.info("this is info");
        logger.warning("this is a warning");
        logger.severe("this is severe");
    }
}

默认的 java.util.logging 配置：JRE_DIRECTORY/lib/logging.properties

handlers= java.util.logging.ConsoleHandler
.level= INFO

java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

java.util.logging.ConsoleHandler.level = INFO
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

因此默认输出如下：注意配置，只输出 等于或者高于 INFO 级别的日志消息

Feb 13, 2017 3:18:52 PM basic.LoggerTest main
INFO: this is info
Feb 13, 2017 3:18:52 PM basic.LoggerTest main
WARNING: this is a warning
Feb 13, 2017 3:18:52 PM basic.LoggerTest main
SEVERE: this is severe

自定义配置文件 logging.properties：

handlers=java.util.logging.FileHandler
.level= ALL

java.util.logging.FileHandler.pattern = logger_test.xml
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

运行参数：java LoggerTest -Djava.util.logging.config.file=logging.properties

因此输出到 XML 文件：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE log SYSTEM "logger.dtd">

-<log>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445252</millis>

<sequence>0</sequence>

<logger>basic.MyClass</logger>

<level>FINEST</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is finest</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>1</sequence>

<logger>basic.MyClass</logger>

<level>FINER</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is finer</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>2</sequence>

<logger>basic.MyClass</logger>

<level>FINE</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is fine</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>3</sequence>

<logger>basic.MyClass</logger>

<level>CONFIG</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is config</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>4</sequence>

<logger>basic.MyClass</logger>

<level>INFO</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is info</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>5</sequence>

<logger>basic.MyClass</logger>

<level>WARNING</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is a warning</message>

</record>


-<record>

<date>2017-02-13T15:37:25</date>

<millis>1486971445307</millis>

<sequence>6</sequence>

<logger>basic.MyClass</logger>

<level>SEVERE</level>

<class>basic.LoggerTest</class>

<method>main</method>

<thread>1</thread>

<message>this is severe</message>

</record>

</log>

引用：
Java日志终极指南
Java Logging Basics

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 159,015评论 4赞 362
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,262评论 1赞 292
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,727评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,986评论 0赞 205
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,363评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,610评论 1赞 219
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,871评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,582评论 0赞 198
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,297评论 1赞 242
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2赞 246
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1赞 260
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,385评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,035评论 3赞 236
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0赞 195
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2赞 274
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2赞 270

推荐阅读更多精彩内容

  • Log4j学习和总结
    在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,817评论 1赞 13
  • Log4j总结&学习
    在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,907评论 0赞 6
  • Log4J日志配置详解（转）
    from：https://www.cnblogs.com/ITtangtang/p/3926665.html一、L...
    enshunyan阅读 3,173评论 0赞 0
  • log4j配置
    一、Log4j简介 Log4j有三个主要的组件：Loggers(记录器)，Appenders (输出源)和Layo...
    默默守护阅读 1,863评论 2赞 8
  • java log日志如何使用与配置
    log日志的作用：基本可以分为2个 1、跟踪代码的运行轨迹。 2、输出调试信息 log的主要组成： 1、Logge...
    晏子小七阅读 5,905评论 0赞 1