Java-日志Log4j

其他 2018-08-20 16:14:05 阅读次数: 0

序言

Log4j是帮助开发人员进行日志输出管理的API类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。Log4j除了可以记录程序运行日志信息外还有一重要的功能就是用来显示调试信息。
很多程序员经常会使用System.out.println语句输出某个变量值的方法进行调试。这样会带来一个非常麻烦的问题：一旦哪天程序员决定不要显示这些System.out.println的东西了就只能一行行的把这些语句注释掉。若哪天又需调试变量值，则只能再 一行行去掉这些注释恢复System.out.println语句。
使用log4j可以很好的处理类似情况：使用”DEBUG”等级输出会类似System.out.println，开发后期不需要输出调试时可以把等级根据需要调高，如调到”ERROR”等级，只有出错错误时才输出。

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度，比如使用DEBUG,则会包括前面3个，也就是全部都包括，使用INFO，则不包括DEBUG；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

1、入门实例

1.1、新建一个JAva工程，导入包log4j-1.2.17.jar，整个工程最终目录如下：
这里写图片描述
1.2、src同级创建并设置log4j.properties

### 设置###
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =E://logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

1.3、设置日志内容

package com.mucfc;
import org.apache.log4j.Logger;
/**
 *@author ShenBinWei
 *@2018年8月18日9:14:21
 */
public class Test {
    private static Logger logger = Logger.getLogger(Test.class);  

    /** 
     * @param args 
     */  
    public static void main(String[] args) {  
        // System.out.println("This is println message.");  

        // 记录debug级别的信息  
        logger.debug("This is debug message.");  
        // 记录info级别的信息  
        logger.info("This is info message.");  
        // 记录error级别的信息  
        logger.error("This is error message.");  
    }  

}

1.4、输出结果

（1）首先是控制台的信息
这里写图片描述
（2）再来看输出的文件
这里写图片描述
内容如下，发现已按照要求输出到对应的文档中去了。
这里写图片描述
这里写图片描述

2、配置实例

第一步：

　　加入log4j-1.2.8.jar(可以选择 log4j 的更高版本)到lib下。

第二步：

　　在 CLASSPATH 下建立log4j.properties，其内容如下所示：

log4j.rootCategory=INFO, stdout , R 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n

log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

log4j.logger.com.neusoft=DEBUG
log4j.logger.com.opensymphony.oscache=ERROR
log4j.logger.net.sf.navigator=ERROR
log4j.logger.org.apache.commons=ERROR
log4j.logger.org.apache.struts=WARN
log4j.logger.org.displaytag=ERROR
log4j.logger.org.springframework=DEBUG
log4j.logger.com.ibatis.db=WARN
log4j.logger.org.apache.velocity=FATAL

log4j.logger.com.canoo.webtest=WARN

log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
log4j.logger.org.hibernate=DEBUG
log4j.logger.org.logicalcobwebs=WARN

第三步：

　　根据自己的要求，相应的修改其中属性。

第四步：

　　在要输出日志的类中加入相关语句：定义属性，

static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo为相关的类

在相应的方法中，

if (logger.isDebugEnabled()){
    logger.debug(“System …..”);
}

属性说明

（1）log4j.rootCategory=INFO, stdout, R

　　此句为将等级为 INFO 的日志信息输出到 stdout 和 R 这两个目的地，stdout 和 R 的定义在下面的代码，可以任意起名。等级可分为 OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置 OFF 则不打出任何信息，如果配置为 INFO 这样只显示 INFO、WARN、ERROR 的 log 信息，而 DEBUG 信息不会被显示。

（2）log4j.appender.stdout=org.apache.log4j.ConsoleAppender

　　此句为定义名为 stdout 的输出端是哪种类型，可以是

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

（3）log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

　　此句为定义名为 stdout 的输出端的 layout 是哪种类型，可以是

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

（4）log4j.appender.stdout.layout.ConversionPattern = [QC] %p [%t] %C.%M(%L) | %m%n

　　如果使用 pattern 布局就要指定的打印信息的具体格式 ConversionPattern，打印参数如下：

%m 输出代码中指定的消息；
%M 输出打印该条日志的方法名；
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；
%r 输出自应用启动到输出该log信息耗费的毫秒数；
%c 输出所属的类目，通常就是所在类的全名；
%t 输出产生该日志事件的线程名；
%n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；
%l 输出日志事件的发生位置，及在代码中的行数；
[QC]是log信息的开头，可以为任意字符，一般为项目简称。

5）log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

　　此句与第 3 行一样。定义名为R的输出端的类型为每天产生一个日志文件。

（6）log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log

　　此句为定义名为 R 的输出端的文件名为D:\Tomcat 5.5\logs\qc.log可以自行修改。

（7）log4j.appender.R.layout=org.apache.log4j.PatternLayout

　　与第 4 行相同。

（8）log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

　　与第 5 行相同。

（9）log4j.logger.com. neusoft =DEBUG

　　指定 com.neusoft 包下的所有类的等级为 DEBUG。可以把 com.neusoft 改为自己项目所用的包名。

（10）log4j.logger.com.opensymphony.oscache=ERROR
（11）log4j.logger.net.sf.navigator=ERROR

　　这两句是把这两个包下出现的错误的等级设为 ERROR，如果项目中没有配置 EHCache，则不需要这两句。

（12）log4j.logger.org.apache.commons=ERROR
（13）log4j.logger.org.apache.struts=WARN

　　这两句是 struts 的包。

（14）log4j.logger.org.displaytag=ERROR

　　这句是 displaytag 的包。（QC 问题列表页面所用）

（15）log4j.logger.org.springframework=DEBUG

　　此句为 Spring 的包。

（16）log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
（17）log4j.logger.org.hibernate=DEBUG

　　此两句是 hibernate 的包。

以上这些包的设置可根据项目的实际情况而自行定制。

3、属性详解

3.1 定义配置文件

Log4j 支持两种配置文件格式，一种是XML（标准通用标记语言下的一个应用）格式的文件，一种是Java特性文件log4j.properties（键=值）。

下面将介绍使用log4j.properties文件作为配置文件的方法:

① 配置根 Logger

　　Logger 负责处理日志记录的大部分操作，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为 OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 或者自定义的级别。Log4j 建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了 INFO 级别，只有等于及高于这个级别的才进行处理，则应用程序中所有 DEBUG 级别的日志信息将不被打印出来。ALL，打印所有的日志；OFF，关闭所有的日志输出。 appenderName，就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

② 配置日志信息输出目的地 Appender

　　Appender 负责控制日志记录操作的输出。其语法为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN

这里的 appenderName 为在 ① 里定义的，可任意起名。其中，Log4j 提供的 appender 有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender，定义一个名为 stdout 的输出目的地，ConsoleAppender 为控制台。

③ 配置日志信息的格式（布局）Layout

　　Layout 负责格式化 Appender 的输出，其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN

其中，Log4j 提供的 Layout 有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

3.2 格式化日志

　　Log4J 采用类似 C 语言中的printf函数的打印格式格式化日志信息，打印参数如下：

%m 输出代码中指定的消息；
%M 输出打印该条日志的方法名；
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；
%r 输出自应用启动到输出该log信息耗费的毫秒数；
%c 输出所属的类目，通常就是所在类的全名；
%t 输出产生该日志事件的线程名；
%n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；
%l 输出日志事件的发生位置，及在代码中的行数。

在代码中，我们在需要输出日志信息的类中做如下的三个工作：

（1）导入所有需的commons-logging类：

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

（2）在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员：

private final Log log = LogFactory.getLog(getClass());

LogFactory.getLog()方法的参数使用的是当前类的 class。

（3）使用org.apache.commons.logging.Log类的成员方法输出日志信息：

if (log.isDebugEnabled()){
    log.debug("20");
}
if (log.isInfoEnabled()){
    log.info("15");
}
if (log.isWarnEnabled()){
    log.warn("11");
}
if (log.isErrorEnabled()){
    log.error("20");
}
if (log.isFatalEnabled()){
    log.fatal("1314");
}

4、 应用记录器

任何一个记录器的使用都有两个步骤：

（1）在配置文件中定义相应的记录器，记录器格式有两种，分别为

第一种，定义根记录器的格式为

log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN

第二种，定义一个非根记录器的格式为

log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN
……
log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN

我们可以定义任意个非根记录器。

（2）在代码中调用 Logger 类的取得记录器方法取得相应的记录器对象。要取得根记录器对象可通过Logger.getRootLogger()函数，要取得非根记录器可通过Logger.getLogger()函数。

5、在Web项目中使用Log4j的实例

https://blog.csdn.net/luohai859/article/details/52250807。

猜你喜欢

转载自blog.csdn.net/weixin_39190897/article/details/81867332
今日推荐
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
火速冲上 GitHub 热榜 —— 开源编程语言、框架哪有这么可爱？
北京人形机器人创新中心发布全球首个纯电驱拟人奔跑的全尺寸人形机器人“天工”
LFOSSA 源来如此公开课 | 掌握云原生未来：CNCF 认证全面攻略与备考秘籍
国产云输入法——仅华为无云端数据上传安全问题
开源日报 | 工业开源项目OGG 1.0；姐姐，你要和我一起配置火狐吗；苹果AI遥遥落后？Fedora 40
周排行
购置笔记本常识
从源码看Spring Security之采坑笔记（Spring Boot篇）
大数据学习——高可用配置案例
如何避免选择不专业的建站公司?
Euclid's Game HDU - 1525（博弈）
面试笔记（六）---Js实现eventHandler
Windows 实例搭建的 FTP 在外网无法连接和访问
设计模式 : 桥接模式
USB 设备驱动开发之几个重要结构体分析
14-p14_sqrt求平方根
每日归档
更多
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)
2024-04-24(36)
2024-04-23(26)
2024-04-22(39)
2024-04-21(0)
2024-04-20(6)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022