log4j学习笔记

最新推荐文章于 2023-11-09 13:26:29 发布

coder-qi

最新推荐文章于 2023-11-09 13:26:29 发布

阅读量1.3k

点赞数

分类专栏： java java web 文章标签： java apache log4j 学习笔记日志

本文链接：https://blog.csdn.net/ricciozhang/article/details/23217863

版权

java 同时被 2 个专栏收录

30 篇文章 0 订阅

订阅专栏

java web

26 篇文章 0 订阅

订阅专栏

1. 日志的几个级别顺序为 DEBUG < INFO < WARN < ERROR < FATAL

debug ：可以放置一些调试相关的信息；
info ：可以放置一些基本的信息；
warn ：放置一些警告信息；
error ：放置一些错误信息，不会使程序停止，比如当程序读取到程序员配置的一些不正确的配置信息，以至于不得不使用硬编码所赋的默认值；
fatal ：致命错误信息，导致程序不能正常运行

2. log4j中日志等级的继承

子类的日志等级必须大于等于父类的日志等级，看下面的测试例子：

@Test
	public void testLoggerHierarchy(){
		
		BasicConfigurator.configure(); //这里配置一个基本的配置
		
		//Category cat = Category.getInstance(Log4jTest.class);
		//Category这个类已经废弃换成Logger
		//得到名字为"my.test.log4j"的日志实例
		Logger logger = Logger.getLogger("my.test.log4j");
	
		//设置等级为WARN，这里是硬编码，应该将此项配置到properties文件中
		logger.setLevel(Level.WARN);  //Level类存放表示等级的一些常量
		
		//得到名字为"my.test.log4j.Log4jTest"的日志实例
		Logger sLogger = Logger.getLogger(Log4jTest.class.getName());
		
		//sLogger 会继承包的日志等级，但是其能用的日志等级应该
		//等级应该大于等于包的日志等级，也就是其日志等级应该 >=WARN
		//下面写几个测试
		
		//这个不能显示 INFO < WARN
		sLogger.info("这是一个日志等级小于WARN等级的日志消息");
		
		//可以显示
		sLogger.warn("这个WARN级别的日志可以显示");
		
		//可以显示
		sLogger.error("ERROR级别的消息可以显示");
		
	}

运行结果为：运行结果：
0 WARN (my.test.log4j.Log4jTest:38) - 这个WARN级别的日子可以显示

10 ERROR (my.test.log4j.Log4jTest:41) - ERROR级别的消息可以显示

这里可以将

Logger logger = Logger.getLogger("my.test.log4j")作为静态字段放到类上，当类加载的时候就加载日志。

如果多次获取相同名字的日志，那么获取到的日志对象是同一个。

        Logger logger = Logger.getLogger("my.test.log4j");
	Logger logger2 = Logger.getLogger("my.test.log4j");

3. 关于输出源

log4j的appenders（输出源）的目标能是 console, files, GUI components, remote socket servers, JMS, NT Event Loggers, and remote UNIX Syslog daemons。输出源可以指定多个，
方法logger.addAppender(newAppender)能添加输出源,并且输出源能够叠加，能够继承祖先的所有输出源。例如，如果有loggerA，它的输出源是Console，那么它的孩子 LoggerB将会拥有输出源Console。当然这种叠加性是可以设置的，logger.setAdditivity(additive)能设置是否叠加，默认为true叠加，false：不叠加.root logger（根日志）没有附加的输出源。

4. 关于PatternLayout

这个可以对输出的消息进行格式化，就像c语言的printf函数的格式化输出一样，%r [%t] %-5p %c - %m%n，则会输出0 WARN (my.test.log4j.Log4jTest:38) - 格式化输出，相关的参数说明如下：

   * %t 线程名
   * %-5p 日志等级
   * %c 类名
   * %m 消息
   * %n 换行符
   * %F 简单类名

* %L 行号

5. 配置

BasicConfigurator.configure()能配置基本的log4j的配置，输出源为控制台，PatternLayout为：%r [%t] %-5p %c - %m%n。

PropertyConfigurator.configure(config)配置指定的配置文件，配置文件的格式可以是properties文件，xml文件，lcf文件，

有关properties文件的配置如下：

 # 配置rootLogger的相关信息，包括日志等级，输出源等
 log4j.rootLogger=INFO, stdout
 # 指定输出源的引用 
 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=%d %5p (%c:%L) %x - %m%n

 #定义指定名称的日志等级
 log4j.logger.com.test.log4j=FATAL

xml配置如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">

<log4j:configuration>

 <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
  <layout class="org.apache.log4j.PatternLayout">
   <param name="ConversionPattern"
    value="%d - %c -%-4r [%t] %-5p %x - %m%n" />
  </layout>
  
  <!--限制输出级别-->
  <filter class="org.apache.log4j.varia.LevelRangeFilter">
   <param name="LevelMax" value="ERROR"/>
   <param name="LevelMin" value="TRACE"/>
  </filter>
 </appender>
 
 <appender name="FILE" class="org.apache.log4j.FileAppender">
  <param name="File" value="C:/log4j1.log"/>
  <layout class="org.apache.log4j.PatternLayout">
   <param name="ConversionPattern"
    value="%d - %c -%-4r [%t] %-5p %x - %m%n" />
  </layout>
 </appender> 
 
 <appender name="DATABASE" class="org.apache.log4j.jdbc.JDBCAppender">
  <param name="URL" value="jdbc:oracle:thin:@192.168.0.59:1521:oanet"/>
  <param name="driver" value="oracle.jdbc.driver.OracleDriver"/>
  <param name="user" value="hdczoa"/>
  <param name="password" value="system"/>    
  <layout class="org.apache.log4j.PatternLayout">
   <param name="ConversionPattern"
    value="INSERT INTO hdczoa.LOG4J(stamp,thread, info_level,class,message) VALUES ('%d', '%t', '%p', '%c', %m)" />
  </layout>
 </appender>
 
 <!-- 发邮件（只有ERROR时才会发送！） -->
 <appender name="MAIL"
  class="org.apache.log4j.net.SMTPAppender">
  <param name="threshold" value="debug" />
  <!-- 日志的错误级别
   <param name="threshold" value="fatal"/>
  -->
  <!-- 缓存文件大小，日志达到512K时发送Email -->
  <param name="BufferSize" value="512" /><!-- 单位K -->
  <param name="From" value="test@163.com" />
  <param name="SMTPHost" value="smtp.163.com" />
  <param name="Subject" value="juyee-log4jMessage" />
  <param name="To" value="test@163.com" />
  <param name="SMTPUsername" value="test" />
  <param name="SMTPPassword" value="test" />
  <layout class="org.apache.log4j.PatternLayout">
   <param name="ConversionPattern"
    value="%-d{yyyy-MM-dd HH:mm:ss.SSS} [%p]-[%c] %m%n" />
  </layout>
 </appender>

 <appender name="ASYNC" class="org.apache.log4j.AsyncAppender">
  <param name="BufferSize" value="256" />
  <appender-ref ref="DATABASE" />
 </appender>
 
 <!--通过<logger></logger>的定义可以将各个包中的类日志输出到不同的日志文件中-->
 <logger name="com.litt2.log4j" additivity="false">   
        <level value="WARN" />   
        <appender-ref ref="CONSOLE" />   
    </logger>

 <!--通过<category></category>的定义可以将各个包中的类日志输出到不同的日志文件中-->
 <category name="my.test.log4j">   
    <level value="DEBUG" /> 
       <appender-ref ref="CONSOLE" />
       <appender-ref ref="MAIL" />
  </category>
 
 <root>
  <priority value="debug" />
  <appender-ref ref="CONSOLE" />
  <appender-ref ref="FILE" />
 </root>


</log4j:configuration>

另一个xml配置如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- ========================== 自定义输出格式说明================================ -->
	<!-- %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL -->
	<!-- #%r 输出自应用启动到输出该log信息耗费的毫秒数  -->
	<!-- #%c 输出所属的类目，通常就是所在类的全名 -->
	<!-- #%t 输出产生该日志事件的线程名 -->
	<!-- #%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” -->
	<!-- #%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921  -->
	<!-- #%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)  -->
	<!-- ========================================================================== -->
	
	<!-- ========================== 输出方式说明================================ -->
	<!--	Log4j提供的appender有以下几种:  -->
	<!-- org.apache.log4j.ConsoleAppender(控制台),  -->
	<!-- org.apache.log4j.FileAppender(文件),  -->
	<!-- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), -->
	<!-- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),  -->
	<!-- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)   -->
<!-- ========================================================================== -->
<!-- 输出到日志文件  -->
	<appender name="filelog_appender"
		class="org.apache.log4j.RollingFileAppender">
		<!-- 设置File参数：日志输出文件名 -->
		<param name="File" value="log/testlog4jxml_all.log" />
		<!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
		<param name="Append" value="true" />
		<!-- 设置文件大小 -->
		<param name="MaxFileSize" value="1MB" />
		<!-- 设置文件备份 -->
		<param name="MaxBackupIndex" value="10000" />
		<!-- 设置输出文件项目和格式 -->
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p (%c:%L)- %m%n" />
		</layout>
	</appender>

<!-- 输出到日志文件 每天一个日志  -->
	<appender name="filelog_daily" class="org.apache.log4j.DailyRollingFileAppender">   
	    <param name="File" value="log/daily.log" />   
        <param name="DatePattern" value="'daily.'yyyy-MM-dd'.log'" />   
        <layout class="org.apache.log4j.PatternLayout">   
        	<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] (%c:%L) - %m%n" />   
        </layout>   
  	</appender> 

<!-- 输出到控制台中 -->
	<appender name="console" class="org.apache.log4j.ConsoleAppender">
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern"
				value="%d{yyyy-MM-dd HH:mm:ss} %-5p: %m%n" />
			<!-- "%-5p: [%t] [%c{3}.%M(%L)] | %m%n" -->
		</layout>
	</appender>

<appender name="EMAIL_QQ" class="org.apache.log4j.net.SMTPAppender">
		<param name="Threshold" value="INFO"/>
		<param name="BufferSize" value="128" />
		<param name="SMTPHost" value="smtp.qq.com" />
		<param name="SMTPUsername" value="cjjvictory" />
		<param name="SMTPPassword" value="***" />
		<param name="From" value="cjjvictory@qq.com" />
		<param name="To" value="cjjvictory@gmail.com" />
		<param name="Subject" value="测试邮件发送" />
		<param name="LocationInfo" value="true" />
		<param name="SMTPDebug" value="true" />
		<layout class="org.cjj.log4j.extend.PatternLayout_zh">
			<param name="ConversionPattern" value="[%d{ISO8601}] %-5p %c %m%n"/>
		</layout>
	</appender>

<!--- 异步测试，当日志达到缓存区大小时候执行所包的appender -->
	<appender name="ASYNC_test" class="org.apache.log4j.AsyncAppender">   
     <param name="BufferSize" value="10"/>   
     <appender-ref ref="EMAIL_QQ"/>
   </appender>

 <!-- 设置包限制输出的通道 -->
	<category name="org.cjj" additivity="false">
               <!-- 日志输出级别，起码可以有5个级别，可以扩展自己的级别，邮件发送必须是ERROR级别不好用，所以最后自己扩展一个邮件发送级别 -->
		<level value="ERROR" />
		<appender-ref ref="filelog_daily" />
		<appender-ref ref="daily_appender" />
		<appender-ref ref="console" />
		<appender-ref ref="ASYNC_test" />
 </category>

</log4j:configuration>

6.关于NDC

NDC（Nested Diagnostic Context）和MDC（Mapped Diagnostic Context）是log4j种非常有用的两个类，它们用于存储应用程序的上下文信息（context infomation），从而便于在log中使用这些上下文信息。
NDC采用了一个类似栈的机制来push和pop上下文信息，每一个线程都独立地储存上下文信息。比如说一个servlet就可以针对每一个request创建对应的NDC，储存客户端地址等等信息。
当使用的时候，我们要尽可能确保在进入一个context的时候，把相关的信息使用NDC.push(message);在离开这个context的时候使用NDC.pop()将信息删除，甚至可以用NDC.clear()。另外由于设计上的一些问题，还需要保证在当前thread结束的时候使用NDC.remove()清除内存，否则会产生内存泄漏的问题。
存储了上下文信息之后，我们就可以在log的时候将信息输出。在相应的PatternLayout中使用”%x”来输出存储的上下文信息，下面是一个PatternLayout的例子：
%r [%t] %-5p %c{2} %x - %m%n
使用NDC最重要的好处就是，当我们想输出一些上下文的信息的时候，不需要让logger去寻找这些信息，而只需要在适当的位置进行存储，然后再配置文件中修改PatternLayout。