欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Log4j.1.2.14 学习笔记【10月4日更新】 博客分类: JavaLog4j Log4j日志

程序员文章站 2024-03-18 08:23:40
...

 

Log4j学习笔记 2011年10月02日 环境 MyEclipse 9.0 SSH2 框架 log4j-1.2.14.jar

 


引言:

 

 目前我使用Log4j的主要目的是在SSH2框架环境下进行开发时记录一些信息便于分析问题。

 

 由于Hibernate3框架中自带了log4j-1.2.14.jar所以导入jar包的步骤略。

 

 Log4j在程序中主要通过3步来使用:
 
  1.得到日志记录器,对于根记录器通过getRootLogger()函数来得到他,
    对于其他记录器则通过Logger类的静态函数getLogger(String name)来得到。

 

  2.读取配置文件,在得到日志记录器后第2步就是要配置Log4j运行环境,
    Log4j的环境可以通过程序来配置,如果没有做任何配置他会使用其默认配置。
   
    更加灵活的方式是使用配置文件来配置Log4j,
    目前配置文件有2种方式,一种是使用key=value的JAVA属性格式,另外一种是XML文件。

 

 在程序中加载配置文件的两种方式:

 

  1.使用PropertyConfigurator.configure(String configFileName)
    读取使用key=value方式编写的配置文件来设置log4j的运行环境。

 

  2.使用DOMConfigurator.configure(String filename)
    读取XML格式的配置文件来设置Log4j的运行环境。

 

 

---------------------------------------我是华丽的分割线-------------------------------------------

 


先来个基于SSH的Log4j:“HelloWorld”:

 

 一、被记录日志的类

 

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

/**
 * @author Maxpin on 2011-10-03
* 
* 用户信息Biz接口实现类
*/
public class UserinfoBizImpl implements UserinfoBiz {

	//得到日志记录器
	private final Log logger = LogFactory.getLog(getClass());

	/**
	* 用户登录
	*/
	public Userinfo login(String loginId, String loginPwd) {
		Userinfo user = null;
		try {
			user = userDao.findUserinfoByLoginid(loginId);
			//写入日志信息info级别
			logger.info(user.getUsername()+"登录了系统");
		} catch (Exception e) {
			logger.error("用户登陆时出现异常!");
			//写入日志信息error级别
			e.printStackTrace();
		}
		return user;
	}
}

 

 

 二、配置文件有两种配置的方式

 

  1)直接在项目的src目录下新建一个log4j.properties文件

 

  log4j.rootLogger = info,stdout,rolling_File

 

  log4j.appender.stdout = org.apache.log4j.ConsoleAppender
  log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
  log4j.appender.stdout.layout.ConversionPattern = %d %p [%c] - %m%n

 

  log4j.appender.rolling_File = org.apache.log4j.RollingFileAppender
  log4j.appender.rooling_File.Threshold = ERROR
  log4j.appender.rolling_File.File = F:/MyEclipse 9/logs/log4jwebpro/logs.log
  log4j.appender.rooling_File.Append = true
  log4j.appender.rooling_File.MaxFileSize = 10KB
  log4j.appender.rooling_File.MaxBackupIndex = 10
  log4j.appender.rolling_File.layout = org.apache.log4j.PatternLayout
  log4j.appender.rolling_File.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} - %l - %m%n

 

 ##Hibernate log begin##
  log4j.logger.org.hibernate=info
  log4j.logger.org.hibernate.SQL=debug
  log4j.logger.org.hibernate.HQL=debug
  ##Hibernate log end##

 

  ---------------------------------------------------------------------------------

 

  2)使用spring的的配置

 

<context-param> 
	<param-name>log4jConfigLocation</param-name> 
	<!--log4j的配置文件的文件名不能为"log4j.properties",而要改为别的名字,要不然报异常-->
	<param-value>WEB-INF/log4jXXX.properties</param-value> 
</context-param> 
<context-param> 
	<param-name>log4jRefreshInterval</param-name> 
	<param-value>60000</param-value> 
</context-param> 
<!-- 需要添加spring-web.jar包,否则用发生错误信息 -->
<listener> 
	<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> 
</listener> 

 

 

  ---------------------------------------我是华丽的分割线-------------------------------------------

 


/*************************************************************************************************
 * 需补充关键词:
 * ① Logback URL: http://logback.qos.ch
 * ② SLF4J URL: http://www.slf4j.org/
 * ③ commons-logging log4j jdk_log 三者之间的关系,以及部分配合使用的方法
 * ④ 练习中的配置文件存在遗留问题,当日志文件大于10KB后不创建新的日志文件记录(以解决看文章最后)
 ************************************************************************************************/

 


1、什么是Log4j?

 

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

 

2、Log4j作用:

 

 Log4j可以帮助调试(有时候debug是发挥不了作 用的)和分析

 

3、Log4j官方网站:

 

 要了解更详细的内容:http://logging.apache.org/log4j

 

4、三个主要的组件:

 

 Logger  (记录器)

 

  Log4j 允许开发人员定义多个Logger,每个Logger拥有自己的名字,Logger之间通过名字来表明隶属关系。
  有一个Logger称为Root,它永远存在,且不能通过名字检索或引用,
  可以通过Logger.getRootLogger()方法获得,其它Logger通过 Logger.getLogger(String name)方法。

 

 Appender (存储器)

 

  Appender则是用来指明将所有的log信息存放到什么地方,
  Log4j中支持多种appender,如 console、files、GUI components、NT Event Loggers等,
  一个Logger可以拥有多个Appender,也就是你既可以将Log信息输出到屏幕,同时存储到一个文件中。
 
 Layout  (布局器)

 

  Layout的作用是控制Log信息的输出方式,也就是格式化输出的信息。


5、Log4j功能优点
 
 1)日志可以按类别分组分别配置

 

  Log4j允许设置多个记录器,每个记录器记录一类日志。 

 

 2)输出的信息级别可以灵活配置

 

  级别优先级由高到低依次是:OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE 、ALL
  Log4j建议只使用四个级别,优先级从高到低分别是:ERROR、WARN、INFO、DEBUG
  只有优先级高于或等于设定级别的日志信息才被输出到日志文件

 

  默认情况下,会继承父记录器的级别

 

  也可以单独设置该记录器的级别

 

 3)存储器Appender 位置可以灵活配置

 

  可以是:org.apache.log4j.ConsoleAppender(控制台)
  可以是:org.apache.log4j.FileAppender(文件)
  可以是:org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
  可以是:org.apache.log4j.RollingFileAppender(让文件大小到达指定尺寸的时候产生一个新的文件)
  可以是:org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
  可以是:org.apache.log4j.jdbc.JDBCAppender(数据库)
  可以是:org.apache.log4j.net.SMTPAppender(邮件)

 

  默认情况下,会继承所有父记录器的输出源,直到根记录器。

 

  也可以设置 log4j.additivity.记录器名 = false ,来截断对 所有父记录器输出源的继承

 

  也可以设置多个输出源

 

 4)可以为输出源设置布局器
  
  log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class


  1.org.apache.log4j.HTMLLayout(以HTML表格形式布局),
  2.org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
  3.org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
  4.org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
  5.org.apache.log4j.xmlXMLLayout---以一系列定义在log4j中的<log4j:event>元素组成。


  log4j.appender.appenderName.layout.ConversionPattern=%-4r %-5p %d %c  %m%n

 

    日志信息格式中几个符号所代表的含义:

 

  -X号: X信息输出时左对齐;

 
  %p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL,
  %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比 如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921
  %r: 输出自应用启动到输出该log信息耗费的毫秒数
  %c: 输出日志信息所属的类目,通常就是所在类的全名
  %t: 输出产生该日志事件的线程名
  %l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线 程,以及在代码中的行数。举例:Testlog4.main (TestLog4.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字符, 就从左边较远输出的字符截掉。


 5)Log4j性能优点

 

  为了提高效率,在记录日志前, 可以对该日志级别是否打开做一个判断。


---------------------------------------我是华丽的分割线-------------------------------------------

 

下面是网上一个比较全面的配置文件:

 

实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。

 

择其一二使用就够用了


log4j.rootLogger=DEBUG,CONSOLE,A1,im

 

log4j.addivity.org.apache=true 

 

#输出到控制台
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender(指定输出到控制台)
log4j.appender.Threshold=DEBUG(指定输出类别)
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout(指定输出布局)
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n(指定输出格式)


#输出到文件
   log4j.appender.FILE=org.apache.log4j.FileAppender(指定输出到文件)
   log4j.appender.FILE.File=file.log(指定输出的路径及文件名)
   log4j.appender.FILE.Append=false
   log4j.appender.FILE.layout=org.apache.log4j.PatternLayout(指定输出的布局)
   log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n(指定输出的格式)


#输出到文件(轮换"日志文件",当日志文件达到指定大小时,该文件就被关闭并备份,然后创建一个新的日志文件)
  log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender(指定输出到文件)
  log4j.appender.ROLLING_FILE.Threshold=ERROR(指定输出类别)
  log4j.appender.ROLLING_FILE.File=rolling.log(指定输出的路径及文件名)
  log4j.appender.ROLLING_FILE.Append=true
  log4j.appender.ROLLING_FILE.MaxFileSize=10KB(指定输出到文件的大小)
  log4j.appender.ROLLING_FILE.MaxBackupIndex=1
  log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout(指定采用输出布局)
  log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n(指定采用输出格式)


#输出到Socket
log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender(指定输出到Socket)
log4j.appender.SOCKET.RemoteHost=localhost(远程主机)
log4j.appender.SOCKET.Port=5001(远程主机端口)
log4j.appender.SOCKET.LocationInfo=true
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout(布局)
   log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE} [DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m

%n%n(输出格式)

#输出到邮件
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender(指定输出到邮件)
log4j.appender.MAIL.Threshold=FATAL
log4j.appender.MAIL.BufferSize=10
log4j.appender.MAIL.From=chenyl@hollycrm.com(发件人)
log4j.appender.MAIL.SMTPHost=mail.hollycrm.com(SMTP服务器)
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.To=chenyl@hollycrm.com(收件人)
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout(布局)
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n(格式)

#输出到数据库
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender(指定输出到数据库)
log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test(指定数据库URL)
log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver(指定数据库driver)
log4j.appender.DATABASE.user=root(指定数据库用户)
log4j.appender.DATABASE.password=root(指定数据库用户密码)
log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')(组织SQL语句)
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout(布局)
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n(格式)

 

#自定义Appender

log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender

log4j.appender.im.host = mail.cybercorlin.net

log4j.appender.im.username = username

log4j.appender.im.password = password

log4j.appender.im.recipient = corlin@cybercorlin.net

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

log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 

 

---------------------------------------我是华丽的无所不在的分割线-------------------------------------------

 

遗留问题已解决:

 

更改了一下RollingFileAppender的名字rolling_File

 

问题写法:log4j.rootLogger = info,stdout,rolling_File

 

解决方案:log4j.rootLogger = info,stdout,rollFile

 

 

不知道具体是不是名字有冲突,总之问题解决了。。。

 

 

 

日志类别补充


有时我们需要对某个特定的部分指定有别于根类别的日志类别,可以指定某个包的优先级

如:
  log4j.category.com.neusoft.mbip.dm.util=ERROR

其中com.neusoft.mbip.dm.util为我们需要特别指定日志类别的部分。
  
  或者可以指定输出文件的优先级
  log4j.appender.Errorlog.Threshold=ERROR
  


log4j.xml 配置补充

 

<?xml version="1.0" encoding="GB2312" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="org.zblog.all" class="org.apache.log4j.RollingFileAppender">
<!-- 设置通道ID:org.zblog.all和输出方式:org.apache.log4j.RollingFileAppender -->
    <param name="File" value="E:/study/log4j/all.output.log" /><!-- 设置File参数:日志输出文件名 -->
    <param name="Append" value="false" /><!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%p (%c:%L)- %m%n" /><!-- 设置输出文件项目和格式 -->
    </layout>
</appender>
<appender name="org.zblog.zcw" class="org.apache.log4j.RollingFileAppender">
    <param name="File" value="E:/study/log4j/zhuwei.output.log" />
    <param name="Append" value="true" />
    <param name="MaxFileSize" value="10240" /> <!-- 设置文件大小 -->
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
    </layout>
</appender>
<logger name="zcw.log"> <!-- 设置域名限制,即zcw.log域及以下的日志均输出到下面对应的通道中 -->
    <level value="debug" /><!-- 设置级别 -->
    <appender-ref ref="org.zblog.zcw" /><!-- 与前面的通道id相对应 -->
</logger>
<root> <!-- 设置接收所有输出的通道 -->
    <appender-ref ref="org.zblog.all" /><!-- 与前面的通道id相对应 -->
</root>
</log4j:configuration>

 

相关标签: Log4j 日志