`
dyy_gusi
  • 浏览: 209429 次
  • 性别: Icon_minigender_1
  • 来自: 武汉
社区版块
存档分类
最新评论

Log4j使用说明

阅读更多

Log4j使用说明

 

第一部分:Log4j解释和使用演示

     Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

    那么如何使用log4j为我们记录日志信息呢?只需要两个步骤,就可以灵活的完成日志记录到指定的地方。

    第一步:配置log4j文件,这里有两种配置格式,一种是使用properties文件中的键值对方式,另一种是使用xml。一般都使用log4j.properties文件配置。在纯Java项目中,将这个文件放在src下面就可以了。下面是log4j.properties文件:在后面详细解释这个配置文件

#配置根日志

log4j.rootLogger=trace,Console

log4j.appender.Console = org.apache.log4j.ConsoleAppender

log4j.appender.Console.Target = System.out

log4j.appender.Console.layout = org.apache.log4j.PatternLayout

log4j.appender.Console.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %l <%p> %m%n

 

#配置特定包下的日志

log4j.logger.com.swu.gusi=debug,A1

log4j.appender.A1 = org.apache.log4j.ConsoleAppender

log4j.appender.A1.Target = System.out

log4j.appender.A1.layout = org.apache.log4j.PatternLayout

log4j.appender.A1.layout.ConversionPattern = A1:%d{yyyy-MM-dd HH:mm:ss} %l <%p> %m%n

 

    第二步:在程序代码中使用logger对象记录日志信息到指定的地方。

package com.swu.gusi;

import org.apache.log4j.Logger;

public class Log4jTest {
	// 得到一个logger对象,用以写日志
	static Logger logger = Logger.getLogger(Log4jTest.class);

	public static void main(String[] args) {
		// logger.setLevel(Level.ERROR);
		logger.fatal("[fatal message]");

		logger.error("[error message]");

		logger.warn("[warn message]");

		logger.info("[info message]");

		logger.debug("[debug message]");

		logger.trace("[trace message]");

		System.out.println("hello wrold");
	}
}

 

 

输出信息:

A1:2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:11) <FATAL> [fatal message]

2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:11) <FATAL> [fatal message]

A1:2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:13) <ERROR> [error message]

2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:13) <ERROR> [error message]

A1:2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:15) <WARN> [warn message]

2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:15) <WARN> [warn message]

A1:2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:17) <INFO> [info message]

2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:17) <INFO> [info message]

A1:2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:19) <DEBUG> [debug message]

2014-09-20 19:08:06 com.swu.gusi.Log4jTest.main(Log4jTest.java:19) <DEBUG> [debug message]

hello wrold

 

第二部分:log4j配置解释

    配置文件的作用总结就是:告诉Log4J 把什么样的信息、以什么样的格式、输出到什么地方。这样就可以很灵活的修改日志的输出格式,位置等等。

    Log4j主要由3部分组成:Loggers(记录器),Appenders (输出源)和Layouts(布局),这里可简单理解为日志类别,日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别,并可以在运行时控制日志输出的样式和位置。下面对三个组件分别进行说明:

1、loggers 这里表示日志记录的级别,这里从高到低的级别是fatal>error>warn>info>debug>trace.分别用来指定这条日志信息的重要程度。log4j对logger级别的使用是如果设置的级别为level1,那么所有的比level1高的日志信息将显示,但是比level1低的级别日志信息将被屏蔽掉不显示,比如设置级别为warn级别,那么fatal和error以及warn级别的日志信息将输出,但是info和dubug级别的日志信息被屏蔽掉将不会输出。这个基本是配置在log4j.proterites文件中,当然也可在程序中设计这个级别。语法如下:

#配置根路径logger,所有的包路径下的日志都会使用这个logger

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

#配置packagePath路径下logger,只有packagePath路径下的日志才会使用这个logger

log4j.logger.packagePath=[level],appenderName1,appenderName2,...

    我们可以配置一个公用的根路径的logger,也可以给不同的包路径下配置不同的logger。[level]表示日志记录级别,就是上面说到的fatal或者error等级别。后面的appenderName都是appender,这个可以配置多个不同的appender,表示需要将日志输出到不同的位置。appenderName这个名字是可以随便写的,只要在之后的配置中相同就可以,下面将会说明appender的配置。具体配置logger示例如下:

#配置logger的级别为info,同时配置输出到Consele和File两个appender

log4j.rootLogger = info , Console,File

2、appenders 这里表示日志记录输出位置,我们输出到控制台、文件、甚至是自己写的输出到指定位置等等。语法如下:

#配置appender对应的输出位置

log4j.appender.appenderName = fully.qualified.name.of.appender.class

#配置N个不同的可选参数信息,每一个appender的可选参数配置可能不同

log4j.appender.appenderName.option1 = value1

log4j.appender.appenderName.option = valueN

    这里只需要指定对应appender的全类名,然后再配置这个appender的一些其他的信息即可。这里配置一个appender的其他信息的时候,可以配置多个不同的其他信息,比如配置输出到文件的时候需要配置文件的位置,书写方式等等信息。具体配置appender示例如下:

#首先配置logger

log4j.rootLogger = info , console,file

#接着配置分别两个appender:console和file

log4j.appender.console=org.apache.log4j.ConsoleAppender 

#配置Console的其他可选信息

log4j.appender.console.Target = System.out

#配置File的appender和上面的基本相同,只是有写自己的可选配置不同

log4j.appender.file =org.apache.log4j.FileAppender

#配置File的书写方式是追加在文件末尾还是覆盖重写,默认是追加的方式

log4j.appender.file.Append=false

#配置File输出文件的文件位置

log4j.paaender.file.File=C:/logFile.txt

    上面的详细配置示例是用到了控制台可文件,当然还有其他各种各种的appender供我们使用:

appender的类全名 appender下的选项参数配置

org.apache.log4j.ConsoleAppender

(输出到控制台)

Threshold=WARN:指定日志消息的输出最低层次

ImmediateFlush=true:表示有消息立即输出,默认是true

Target=Syste.err:输出到控制台,默认是System.out

org.apache.log4j.FileAppender

(输出到文件)

Threshold=INFO

ImmediateFlust=false

File=C:/log.txt:输出文件位置

Append=false:是否一追加的方式写到文件,默认是true

org.apache.log4j.DailyRollingFileAppender

(按时间设置产生一个日志文件)

Threshold=INFO

ImmediateFlust=false

File=C:/log.txt:输出文件位置

Append=false:是否一追加的方式写到文件,默认是true

DatePattern='.'yyyy-MM-dd:每天滚动产生一个日志文件

(还有其他格式:'.'yyyy-MM;'.'yyyy-ww每周;等等)

org.apache.log4j.RollingFileAppender

(安日志内容大小尺寸产生一个新日志文件)

当日志文件达到指定大小的时,产生一个新的临时文件,当临时文件的数量达到指定数量时,产生一个完整的日志文件

Threshold=INFO

ImmediateFlust=false

File=C:/log.txt:输出文件位置

Append=false:是否一追加的方式写到文件,默认是true

MaxFileSize=100KB:临时文件最大尺寸,后缀可以是KB, MB 或者是 GB
MaxBackupIndex=2:指定可以产生的滚动文件的最大数 

org.apache.log4j.WriterAppender

(将日志信息以stream的形式输出到指定的位置)

上面介绍的几种appender其实都是WriterAppender的子类

    上面的表格中只是列出了一些比较常用的appender和对应的appender的一些基本常用的可选配置信息,apache还给我们提供了很多其他的appender,下图可以看见所有appender。

 

3、layouts 这里是表示输出的格式布局,可以以html形式,自己指定的灵活布局,包含日志信息级别和信息字符串,包换日产生时间线程类别信息等等格式。语法如下:

#配置appender的layout

 log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 

#配置layout的参数选项配置信息,每一个layout的可选参数配置可能不同

log4j.appender.appenderName.option1 = value1

 

    我们首先给appender指定一个layout,就是给layout指定一个类。然后给这个layout配置需要的参数信息。具体的layout配置示例如下:

#首先配置logger

log4j.rootLogger = info , console,file

#接着配置分别两个appender:console和file

log4j.appender.console=org.apache.log4j.ConsoleAppender 

#配置Console的其他可选信息

log4j.appender.console.Target = System.out

#配置consloe的layout

log4j.appender.console.layout=layout=org.apache.log4j.PatternLayout 

#配置layout的可选参数,自定义样式

log4j.appender.console.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n 

#配置File的appender和上面的基本相同,只是有写自己的可选配置不同

log4j.appender.file =org.apache.log4j.FileAppender

#配置File的书写方式是追加在文件末尾还是覆盖重写,默认是追加的方式

log4j.appender.file.Append=false

#配置File输出文件的文件位置

log4j.paaender.file.File=C:/logFile.txt

#配置file的layout

log4j.appender.file.layout=org.apache.log4j.HTMLLayout 

log4j.appender.file.layout.Title=testTitle

    ​上面只是用到了Pattrenlayout和HTMLLayout,还有一些其他的layout供我们使用:

​layout类全名 layout下的参数配置

org.apache.log4j.PatternLayout

(可灵活的指定布局模式)

ConVersionPattren=%m%n:指定怎样的格式化指定的消息,

后面会详细说明各个字母含义

org.apache.log4j.SimpleLayout

(包含日志信息的级别和信息字符串)

 

org.apache.log4j.TTCCLayout

(包含日志产生时间,线程,类别等信息)

 

org.apache.log4j.HTMLLayout

(以HTML表格是形式布局模式)

LocationInfo=true:输出Java文件名称和行号,默认是false

Title=testTitle:Html标题,默认是Log4j Log Message

    ​ConversionPattern的各个参数说明:

-: 信息输出时左对齐;
 %p: 输出日志信息级别,即DEBUG,INFO,WARN,ERROR,FATAL,
 %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,

比如:%d{yyy MM dd HH:mm:ss}
 %r: 输出自应用启动到输出该log信息耗费的毫秒数
 %c: 输出日志信息所属的类目,通常就是所在类的全名
 %t: 输出产生该日志事件的线程名
 %l: 输出日志事件的发生位置,相当于%c.%m(%f:%l)的组合,

包括类名、发生的线程,以及在代码中的行数。举例:Log4jTest.main(Log4jTest.java:10)
 %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
 %%: 输出一个"%"字符
 %f: 输出日志消息产生时所在的文件名称
 %l: 输出代码中的行号
 %m: 输出代码中指定的消息,产生的日志具体信息
 %n: 输出一个回车换行符,Windows平台为"\r\n",Unix平台为"\n"输出日志信息换行
 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
 1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。
 2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,"-"号指定左对齐。
 3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。
 4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边超出的字符截掉。 

     ​上面的表格中只是列出了一些比较常用的layout和对应的layout的一些基本常用的可选配置信息,apache还给我们提供了很多其他的layout,下图可以看见所有apache提供的layout。

 

 

第三部分:程序使用Log4j记录日志

    ​上面已经配置好了log4j的properties配置文件,我们在Java程序中按照一下步骤操作就可以:

1、建立Logger实例

// 得到一个logger对象,用以写日志

static Logger logger = Logger.getLogger(Log4jTest.class);

2、读取配置文件

    ​有3中读取方式,如果我么不写,默认读取classpath下的log4j.properties文件配置logger。

BasicConfigurator.configure(); 默认使用输出控制台
PropertyConfigurator.configure(String configFilename); 读取properties文件的配置信息
DOMConfigurator.configure(Stirng filename); 读取xml文件的配置信息

3、在需要的地方插入日志信息

//致命错误

logger.fatal("[fatal message]");

//错误信息

logger.error("[error message]");

//警告信息

logger.warn("[warn message]");

//一般信息

logger.info("[info message]");

//调试信息

logger.debug("[debug message]");

//跟踪信息

logger.trace("[trace message]");

    ​

    ​至此,终于说完了log4j的一些基本使用方法,其实log4j还很强大,如果需要,可以查看官方文档。

每天进步一点点,日后必能成大神!加油。
 

  • 大小: 17.6 KB
  • 大小: 54 KB
1
3
分享到:
评论

相关推荐

    Log4j使用说明文档

    Log4j 是一款广泛使用的Java日志框架,由Apache软件基金会的Jakarta项目开发。它提供了灵活的日志记录功能,允许开发者在不修改代码的情况下控制日志信息的输出,极大地提高了开发效率和维护性。Log4j 包含了丰富的...

    log4j 使用说明 很信息

    ### Log4j 使用说明详解 #### 一、Log4j简介 **1.1 Log4j是什么?** Log4j是Apache的一个开源项目,它提供了一种强大的日志记录功能,使得开发人员能够轻松地控制日志信息的输出目的地、格式以及级别。这包括但不...

    Log4J完整说明和配置

    ### Log4J完整说明与配置解析 #### 一、Log4J简介 Log4J是Apache的一个开源项目,用于提供灵活的日志记录功能。通过它,开发者能够控制日志信息的输出级别、输出目的地(控制台、文件等)、格式化方式等。本文将...

    Log4j2、Fastjson、Log4j的BurpSuite插件亲测有效

    Log4j、Log4j2和Fastjson的安全性问题在过去曾引起广泛关注,例如Log4j2的CVE-2021-44228(也被称为Log4Shell漏洞),这是一个远程代码执行漏洞,影响了许多使用Log4j2的系统。这个插件可能就是为了检测和利用这些...

    Log4j配置说明.rar,Log4j配置说明.rar

    Log4j配置说明.rarLog4j配置说明.rarLog4j配置说明.rarLog4j配置说明.rar,Log4j配置,Log4j Log4j配置说明.rarLog4j配置说明.rarLog4j配置说明.rarLog4j配置说明.rar,Log4j配置,Log4j

    新版本与旧版本log4j.jar包下载,附使用说明----.zip

    5. **使用说明.txt**: 这份文档很可能是对如何在项目中配置和使用log4j.jar的指导,可能包含配置文件的创建、日志级别的设置、输出格式的定制以及如何在IDEA中引入log4j等内容。阅读这份说明可以帮助开发者快速上手...

    log4j包的使用说明及api帮助文档

    **log4j包的使用说明及API帮助文档** 在Java编程中,日志记录是必不可少的一个环节,它有助于开发者跟踪程序运行状态,定位错误和调试问题。Log4j是一款广泛使用的开源日志记录框架,由Apache软件基金会开发,提供...

    log4j 1.2.15

    **Apache Log4j 1.2.15:经典日志框架详解** Apache Log4j是Java编程语言中广泛使用的日志记录库,它在软件开发中扮演着...在提供的`log4j使用说明.doc`文档中,应该会有更多关于如何具体配置和使用Log4j的详细指导。

    log4j详细配置说明

    ### Log4j 详细配置说明 #### 一、Log4j 简介与特性 在当前强调可重用组件的软件开发环境中,Apache 的 Log4j 为开发者提供了强大的日志管理工具。Log4j 不仅开源免费,还具备高度的灵活性与可配置性,支持多种...

    log4j_jar包跟教程说明

    Log4j是Apache组织提供的一款广泛使用的开源日志框架,适用于各种Java应用程序。本教程将深入探讨Log4j的基本概念、配置及使用方法。 1. **Log4j简介** - Log4j是一个轻量级的日志记录工具,具有强大的可配置性和...

    log4j使用详细方法

    本文将详细介绍Log4j的配置方法、使用实例以及相关说明,旨在帮助读者快速掌握这一实用工具。 **一、Log4j的核心组件** 1. **Logger**: 日志记录器,负责实际的日志输出,可以根据不同的级别(DEBUG, INFO, WARN, ...

    log4j-API-最新稳定版本log4j-1.2.17

    **标题与描述解析** 标题提及的是"log4j-API-最新稳定版本log4j-1.2.17",这表明我们关注的是日志框架...对于使用Log4j的开发者来说,理解和掌握API的各个方面至关重要,以实现有效的日志管理并优化应用程序的监控。

    log4j-to-slf4j-2.17.1-API文档-中文版.zip

    赠送jar包:log4j-to-slf4j-2.17.1.jar; 赠送原API文档:log4j-to-slf4j-2.17.1-javadoc.jar; 赠送源代码:log4j-to-slf4j-2.17.1-sources.jar; 赠送Maven依赖信息文件:log4j-to-slf4j-2.17.1.pom; 包含翻译后...

    log4j集成syslog配置说明

    log4j作为Java应用中广泛使用的日志框架,其强大的日志处理能力得到了业界的认可。而syslog作为一种标准化的日志传输协议,被众多系统用于集中管理和分析日志信息。将log4j与syslog结合使用,可以实现更高效、更灵活...

    Log4j日志配置说明,Log4j日志配置说明

    本示例中使用的是 `log4j-1.2.8.jar` 这个版本。将其复制到项目中的 `WEB-INF\lib` 目录下。这一步是将 Log4j 库集成到项目中的第一步,确保项目可以正确引用 Log4j 的类。 ##### 2. 创建初始化 Servlet 接下来,...

    如何使用log4j详细说明

    log4j 使用的详细说明教程,新手快下。。

    log4j配置使用说明及JAR包

    压缩包中的"**log4j配置说明及所需jar包**"包含了Log4j的库文件,包括`log4j.jar`和其他可能的依赖。确保将这些JAR包添加到项目的类路径(Classpath)中,这样你的程序才能正确识别并使用Log4j。 **四、代码示例** ...

    Log4j 2.0 使用说明

    Log4j 2.0 是一个广泛使用的日志记录框架,尤其在Java应用程序中,它提供了灵活的日志配置和高性能的特性。相比Log4j 1.x,2.0 版本引入了许多改进和新功能,包括性能优化、更丰富的API、动态配置以及对XML和JSON...

    log4j所依赖jar包

    Log4j是一个广泛使用的Java日志框架,由Apache软件基金会开发。它为应用程序提供了一种灵活的日志记录机制,使得开发者能够控制日志信息的输出格式、级别以及目的地。在Java应用程序中,日志功能是必不可少的,因为...

Global site tag (gtag.js) - Google Analytics