log4j 2.x使用说明


实验4要求生成日志,参考了一下网上的说明,感觉 log4j 应该会比较好,下面开始详细配置的使用教程
注意: 本文使用的log4j 2.x不能向下兼容1.x版本,比如org.apache.log4j.SimpleLayout在2.x中被移除

STEP 0. log4j基础知识

一个完整的日志系统包括Appender,Layout,Logger三部分,缺一不可

  • Layout 日志的类型
    包括CSV Layout, GELF Layout, HTML Layout, JSON Layout, Pattern Layout, RFC5424 Layout.其中HTML Layout产生html格式的日志,Pattern Layout产生格式化字符串内容的日志,本文主要使用这种格式,下面是Pattern Layout的简单使用方法:
参数(大小写敏感) 表示的意思
%m 日志内容
%M 输出当前的方法名
%C 输出当前的类名
%d{时间样式} 日志产生时间,时间样式由y,M,d,H,m,s,S组成,分别表示一位年,月,日,时,分,秒,毫秒.比如%d{yyyy.MM.dd HH:mm:ss}
%p 日志优先级(下面会讲到)
%l 日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java: 10 )
%n 换行符
%-20.30c 用法同C语言的printf

详细使用方法: Pattern Layout API

  • Appender 日志的输出端
    看名字就知道这个是用来添加到什么地方的(其实是添加到Logger里的),每个Appender有且仅有一个Layout,即只能有一个日志格式,而不同的Appender代表了不同的输出,可以是一个文件(FileAppender),也可以是标准输出(ConsoleAppender).
    Appender还有很多其他子类,这里不再赘述,详细使用方法:Appender API
    本文主要使用FileAppender,ConsoleAppender.
  • Logger 产生日志
    所在包:org.apache.log4j.Logger
    Logger对象不能通过new获得,只能通过Logger.getRootLogger()方法或者Logger.getLogger(balabala)(有三个重载版本,目前用法还不太清楚详细用法,而且第一个就暂时够用了)设置好配置文件后可以直接使用Logger.getRootLogger()来获得Logger.
    日志记别
    日志有7种级别,从高到低为:
级别 描述 生成方法
OFF 最高等级,用于关闭所有日志记录。 -
FATAL 指出每个严重的错误事件将会导致应用程序的退出。 logger.fatal(Object message)
ERROR 指出虽然发生错误事件,但仍然不影响系统的继续运行。 logger.error(Object message)
WARN 表明会出现潜在的错误情形。 logger.warn(Object message)
INFO 一般和在粗粒度级别上,强调应用程序的运行全程。 logger.info(Object message)
DEBUG 一般用于细粒度级别上,对调试应用程序非常有帮助。 logger.debug(Object message)
ALL 最低等级,用于打开所有日志记录。 -

以上都为org.apache.log4j.Logger包中的枚举类型
可以通过logger.setLevel(Level)方法来设置日志的最低等级,低于这个等级的日志不会被记录,也可以在配置文件中设置默认的日志记别
一个Logger可以添加多个Appender,可以在配置文件中添加,也可以用logger.addAppender()方法添加.Logger生成的日志会输出到所有的Appender.

STEP 1. 下载&配置

  1. 下载后解压文件夹apache-log4j-2.11.0-binLab4/lib/目录,打开Eclipse,refresh一下,然后设置Build Path,将apache-log4j-2.11.0-bin下所有的jar文件添加到libraries中 (Tips: 按住 shift 选择首尾两个文件)
  2. 我配置好了运行时 发生异常
Exception in thread "main" java.lang.ExceptionInInitializerError
Caused by: java.lang.ClassCastException: org.apache.logging.slf4j.SLF4JLoggerContext cannot be cast to org.apache.logging.log4j.core.LoggerContext

google之后发现在上一步移除log4j-to-slf4j-2.11.0.jar即可
附:参考链接

3.在src目录下新建Main.java文件,输入
import org.apache.log4j.Logger;
如果编译器不报错,说明配置成功。

  1. 在src(任意一个BuildPath)下新建一个log4j2.xml文件,该文件为log4j的配置文件,复制以下内容:
<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="info">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%m%n" />
        </Console>
        <File name="log" fileName="log/graph.log" append="false">  
            <PatternLayout pattern="%d{yyyy.MM.dd HH:mm:ss} %5p %C %M %m%n"/>  
        </File>  
    </Appenders>
    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="Console" />
            <AppenderRef ref="log" />
        </Root>
    </Loggers>
</Configuration>

如果不存在该文件,运行时就会在System.err输出

ERROR StatusLogger No Log4j 2 configuration file found. Using default configuration (logging only errors to the console), or user programmatically provided configurations. Set system property 'log4j2.debug' to show Log4j 2 internal initialization logging. See https://logging.apache.org/log4j/2.x/manual/configuration.html for instructions on how to configure Log4j 2

第一个名为ConsoleConsoleAppender(输出到标准输出)使用PatternLayout, 输出的日志格式为"%m%n"
第二个名为logFileAppender(输出的文件log/graph.log)也使用PatternLayout,输出的日志格式为"%d{yyyy.MM.dd HH:mm:ss} %5p %C %M %m%n",即时间 等级 日志内容 类名 方法名\n
Loggers标签里的代码将Consolelog两个Appender对象添加到Root中,因此产生的log不仅会在控制台上显示,也输出到log/graph.log文件中
下面结合程序来解释

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class Main {

    static Logger logger = Logger.getRootLogger();

    public static void main(String... args) {
        logger.setLevel(Level.INFO);    //可以去掉
        logger.info("this is an info");
        logger.warn("this is a warn");
        logger.error("this is an error");
        logger.fatal("this is a fatal");
    }

}

控制台输出:

this is an info
this is a warn
this is an error
this is a fatal

log/graph.log文件:

2018.05.19 16:06:32  INFO Main main this is an info
2018.05.19 16:06:32  WARN Main main this is a warn
2018.05.19 16:06:32 ERROR Main main this is an error
2018.05.19 16:06:32 FATAL Main main this is a fatal

STEP 2.使用

到此你已经完成了90%,如果SETP 1一切正常,就可以开始使用了.
新建一个Log类,添加public static属性的域logger

package log;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class Log {
    public static final Logger logger = Logger.getRootLogger();
    /*以下语句块可以删除*/
    static {
        logger.setLevel(Level.INFO);
    }
}

你还可以在static语句块内设置logger的其他属性,static public属性保证你可以在整个Project的所有地方生成日志


以上是我对log4j用法的说明,因为第一次写博客所以难免有错误之处.所以本人不保证任何一句话的正确性,如有错误之处还请指出.


参考链接:
http://logging.apache.org/log4j/2.x/manual/appenders.html
http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/SimpleLayout.html
https://blog.csdn.net/womeng2009/article/details/53510913
https://blog.csdn.net/u011781521/article/details/55002553
https://www.yiibai.com/log4j/log4j_patternlayout.html


本文禁止任何形式的转载

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

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 5,015评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,979评论 0 6
  • 一、Log4j简介 Log4j有三个主要的组件:Loggers(记录器),Appenders (输出源)和Layo...
    默默守护阅读 1,907评论 2 8
  • from:https://www.cnblogs.com/ITtangtang/p/3926665.html一、L...
    enshunyan阅读 3,282评论 0 0
  • Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的,它可接key...
    Alex_1799阅读 45,167评论 0 11