Log in Java

The Simple Logging Facade for Java (SLF4J) serves as a simple facade or abstraction for various logging frameworks, such as java.util.logging, logback and log4j.

SLF4J是为java logging提供的接口,其具体实现有java.util.logging, logback和log4j。使用该接口,只需要导入library slf4j-api-1.7.21.jar。 log4j是apache提供的开源日志组件,而logback拥有更好的属性,用来取代log4j点日志组件,为slf4j的原生实现。

每种实现java.util.logging, logback 和 Apache log4j都可以单独使用或绑定slf4j使用。当开发通用软件时,最好使用绑定slf4j使用的方式,这样允许在后台使用任何一种实现,而不限定于某一种实现。而且,slf4j中提供{}占位符,省略字符串拼接以及生成字符串的开销。

logback相对于log4j点优势:1. 更快的实现,更少的内存使用;2. 经过更多的测试;3. logback-classic 为slf4j的native implement;4. 自动重载改动过的配置文件;5. 优雅地从I/O错误中恢复;6. RollingFileAppender能过自动压缩archived log files,异步实现,不影响logging;7. logbook支持conditional processing of configuration file,使用<if>,<else>,<then>等元素实现单个configuration file应用于不同环境;8. 可以更细粒度的指定不同人使用不同的log level;9. 指出exception发生时使用的lib version。更多参照

log4j的正常运行需要配置文件,可以是log4j.xml或log4j.properties。日志的输出级别:FATAL,ERROR,WARN,INFO,DEBUG 。样例参考

slf4j绑定logback的方法类似于log4j,<configuration>中包含各种<appender>,并在<root>中指定log level 以及使用的appender。样例参考

下面是对logback manual的知识总结。logback manual

logger优点:1. 分成不同log request level和logger level,使得在不同环境打印出不同的log信息,便于non-prod环境调试信息,以及prod环境打印较少的必要信息; 2. 有不同的appender,将log 信息输出到不同的destination; 3. log info使用{}的format,避免string拼接的开销。

使用logback-classic需要的jar包:slf4j-api.jar,logback-core.jar以及logback-classic.jar。logback的3个主要class:Logger, Appender, Layout.

当logback没有提供默认的配置文件时,logback会向root logger中添加ConsoleAppender。Appender可以理解为output destination,可以为console, files, Syslog, TCP Sockets, JMS and many more。用户也可以创建适合自己的Appender。

使用logger仅需3个步骤:1. 配置logback的配置文件; 2. 在需要打印log的类中用类名生成logger instance;3. 调用log instance的函数debug(), info(), warn(), error()来输出log信息到Appender。

Logging API相对于println的优势在于能够disable某些log statement的同时保留某些log statement。Logger的name大小写敏感并遵循层次命名规则(hierarchical name rule)。logger com.foo是logger com.foo.bar的父类。

Logger level: TRACE,DEBUG,INFO,WARN,ERROR。若logger没有定义log level,则使用最近的父类的log level。root logger的默认log level为DEBUG。每个logging request使用logger的函数info(),debug)来标示logging request的log level。当logging request的log level高于或等于logger level时,则该logging request被enabled。TRACE<DEBUG< INFO< WARN<ERROR

logback 环境的配置发生在程序初始化的过程中,倾向于通过读取配置文件的方式。

Appender:

logback允许将logging request输出到多个不同的destination,也称为appender,包括console,文件,远程server,database等。

下面的log request statement,不管debug有没有被enabled,都会有String拼接的开销。

logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));

而下面的log request statement,只有在debug被enabled时,才会用entry object替换其中的{}。

logger.debug("The entry is {}.", entry);

当log request中存在更多的参数时,可以使用object[]。

Object[] paramArray = {newVal, below, above};

logger.debug("Value {} was inserted between {} and {}.", paramArray);

可以通过将root logger的log level设置为Level.OFF来关闭logging。

logback配置自己的步骤:先后在classpath中寻找文件logback-test.xml,logback.groovy, logback.xml,若都没有找到,则使用BasicConfigurator来自动配置自己,将log输出到console。而且root logger的默认log level为DEBUG。

使用system property “logback.configurationFile” 可以设置默认的log back configuration file. 如: java -Dlogback.configurationFile=/path/to/config.xml MyApp1

将<configuration> element的debug属性设置为true使得log request始终打印status data: <configuration debug="true">。将scan属性设置为true,使得能够自动识别log configuration file的改动并自动重载,默认的自动扫描间隔是1分钟,可以通过scanPeriod来设置:<configuration scan="true" scanPeriod="30 seconds">

发生exception时,会打印stack trace,可以在stack trace中包含package info,包含函数所属的jar包及version信息,有助于识别version问题。但当exception频繁出现时,开销较大。package data默认时关闭的,可以通过<configuration packagingData="true">来打开。

配置文件<configuration>中包含0个或多个<appender>元素,紧跟着0个或多个<logger>元素,跟着最多一个<root>元素。<logger>元素必须有一个name属性,level属性为optional,可以为TRACE,DEBUG,INFO,WARN,ERROR,ALL or OFF,也可以设置为INHERITED 或 NULL表示从上层logger获取level。<logger>元素中可以有0个或多个<appender-ref>元素。<root>元素配置root logger,只有属性level,不能为INHERITED或NULL,<root>元素中也可以有0个或多个元素。

<appender>元素存在2个必需属性name和class,其中包含0个或1个<layout>元素,0个或多个<encoder>元素和0个或多个<filter>元素。

logger将向自己attached的appender及其父类的appender输出log。若设置logger的属性additivity为false,则不会向其父类输出log。

logger configuration file中底变量类似于unix shell,使用${}表示,并会用值替代。变量可以在configuration file中指定,如:<property name="USER_HOME" value="/home.xiangyuw " />或使用system property,如: java -DUSER_HOME="/home/xiangyuw". 当变量比较多时,最好从property file中获取,如:<property file="variables.properties" /> 。获取变量值时,先从local获取,之后context范围,之后system property,最后OS environment。也可以为变量设置default值,如:${color:-red}。

configuration file中可以使用条件语句:<if><then></then><else></else></if>。

我们可以在configuration file中使用元素<include>引入其他的configuration file。如:<include file="ado-configuration.xml" />。也可以使用resource和url等属性来引入:<include resource="*.xml" />,<include url="http://path/*.xml" />

现在看完configuration,后面的appender,继续参见logback manual.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,784评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,745评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,702评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,229评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,245评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,376评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,798评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,471评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,655评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,485评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,535评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,235评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,793评论 3 304
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,863评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,096评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,654评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,233评论 2 341

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,915评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,951评论 0 6
  • 在项目开发过程中,我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此...
    Java架构阅读 3,455评论 2 41
  • 写Java也有一段时间了,一直都有用slf4j log4j输出日志的习惯。但是始终都是抱着“拿来主义”的态度,复制...
    Minimumy阅读 1,371评论 1 7
  • Log Java日志:(slf4j、log4j、logback、common-logging ) slf4j 是规...
    年少懵懂丶流年梦阅读 17,483评论 1 11