java日志管理

最新推荐文章于 2024-07-14 00:57:23 发布

认真的学生

最新推荐文章于 2024-07-14 00:57:23 发布

阅读量1.2w

点赞数 8

分类专栏： javaEE 文章标签： logging log4j java

本文链接：https://blog.csdn.net/u013473691/article/details/52708509

版权

javaEE 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

在java开发中，日志系统是java项目中必不可少的组成部分。日志可以帮助我们快速的定位问题，记录程序运行过程中的情况，以便项目的监控和优化。我们在日常开发中主要使用的java日志框架组件是：log4j、SLF4J、Commons Logging

日志级别一般分为7个打印级别（不同的日志框架组件可能打印的日志级别区别不大）：

OFF-关闭所有日志；

FATAL-记录严重的错误，并且会导致应用程序退出；

ERROR-记录严重的错误，但不会影响程序的运行；

WARN-记录警告；

INFO-记录程序中比较有意义的信息；

DEBUG-记录程序中的细节信息；

ALL-记录所有的日志；

package logging;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogTest {
	
	private static Logger logger = LoggerFactory.getLogger(LogTest.class);

	public static void main(String[] args) {
		logger.trace("trace.......");
		logger.debug("debug.......");
		logger.info("info.......");
		logger.warn("warn.......");
		logger.error("error.......");
		String exception = "exception";
		String excepDesc = "exception desc";
		String[] err = {"error", "error desc"};
		//提供了占位符"{}"，使书写布局更加灵活。占位符减少了日志信息中字符串的拼接，减少了内存和cpu的性能消耗。
		logger.info("problem: {}", exception);
		logger.info("problem: {},{}", exception, excepDesc);
		logger.info("problem: {},{}", err);
	}
}

因为没有配置文件，log日志会默认在控制台输出结果：

12:11:49.888 [main] DEBUG logging.LogTest - debug.......
12:11:49.905 [main] INFO  logging.LogTest - info.......
12:11:49.906 [main] WARN  logging.LogTest - warn.......
12:11:49.906 [main] ERROR logging.LogTest - error.......
12:11:49.906 [main] INFO  logging.LogTest - problem: exception
12:11:49.908 [main] INFO  logging.LogTest - problem: exception,exception desc
12:11:49.909 [main] INFO  logging.LogTest - problem: error,error desc

下面就讲一下日志的配置文件logback.xml。

由以上的代码可知，配置文件有一个根节点<configuration></configuration>，根节点有三个属性scan，scanPeriod，debug。

1、scan：当此属性设置为true时，配置文件发生改变时，将会重新加载该配置文件。默认值是true。

2、scanPeriod：设置监测配置文件是否发生改变的时间间隔。当scan为true时该属性才会生效。默认的时间间隔是60000毫秒。

3、debug：此属性设置为true时，会打印出logback内部日志信息，这个属性默认为false。建议不要开启，因为会打印很多无用日志，影响对项目的观察。

下图是<configuration>标签中包含的标签：

1、<contextName>：每个logger都关联到logger上下文，默认上下文的名称是“default”。但可以使用此标签设置为其他名字，用于区分不同应用程序的记录。一旦设置，不允许更改。

2、<property>用来定义变量值的标签，此标签有两个属性，name（变量的名称）和value（变量定义的值），通过这个标签定义的变量可以通过“${}”应用到其他标签中。

－X: X信息输出时左对齐   
%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,   
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2011-10-18 22:10:28,921   
%r: 输出自应用启动到输出该log信息耗费的毫秒数   
%c: 输出日志信息所属的类目，通常就是所在类的全名   
%t: 输出产生该日志事件的线程名   
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。   
%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字符，就从左边交远销出的字符截掉  
       
log4j.rootLogger=warn,myconsole,errinfo  
  
#输出到控制台的日志  
log4j.appender.myconsole=org.apache.log4j.ConsoleAppender  
log4j.appender.myconsole.layout=org.apache.log4j.PatternLayout  
#log4j.appender.myconsole.Threshold=warn  
log4j.appender.myconsole.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %5p [%t] (%F:%L) - %m%n  
  
#输出到文件的异常日志文件  
log4j.appender.errinfo=org.apache.log4j.FileAppender  
log4j.appender.errinfo.File=D:/ERROR.LOG  
log4j.appender.errinfo.Threshold =ERROR  
log4j.appender.errinfo.layout=org.apache.log4j.PatternLayout  
log4j.appender.errinfo.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %5p [%t] (%F:%L) - %m%n

3、<timestamp>：获取时间戳，有两个属性key（标识标签的名字，可以理解为变量名）和datePattern（设置将解析配置文件的时间转换成字符串，符合java.txt.SimpleDateFormat的格式）。

4、<logger>：用来设置某一个包或者某一个具体类的日志打印级别，以及指定<appender>。<logger>有三个属性：name、level和additivity。

（1）name：用来指定需要设置的包或者类的名称；

（2）level：用来设置打印级别，TRACE，DEBUG，INFO，WARN，ERROR，ALL，OFF，还有INHERITED或者NULL（代表强制执行上级的级别），如果没有设置level，那么logger将会继承上级的级别。

（3）additivity：是否向上级logger传递打印信息默认是true。

<logger>可以包含0个或多个<appender-ref>元素，标识<appender>会添加到该<logger>。

5、<root>：相当于"根<logger>"，只有一个level属性，没有INHERITED或者NULL，默认为debug。

6、<appender>：是负责写日志的组件。有两个属性name（appender名称）和class（appender的全限定名）。

appender的全限定名。

（1）、ConsoleAppender：把日志添加到控制台，有两个子节点<encoder>（对日志进行格式化）和<target>（System.out或者System.err，默认是System.out）；

（2）、FileAppender：把日志添加到文件，其子节点有

<file>（被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在，会自动创建）、

<append>（如果是true，日志被追加到文件结尾，如果是false，清空现存文件，默认是true）、

<encoder>（格式化）

<prudent>（如果是true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是false）。

（3）、RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。其子节点有：

<file>（被写入的文件名）

<rollingPolicy>（当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名）

rollingPolicy：（1）、TimeBaseRollingPolicy：最常用的滚动策略，它根据时间来指定滚动策略，既负责滚动也负责触发滚动。其子节点有：

<fileNamePattern>：必要节点，包含文件名及“%d”转换符（可以按照SimpleDateForm格式来表示时间，例如：%d{yyyyMM}），

（2）、RollingFilePolicy:它的file子节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次。“/”和“\”会被作为文件分割符。

<maxHistory>：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件时，那些为了归档而创建的目录也会被删除。

（3）、FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略。其子节点如下：

<minIndex>：窗口索引最小值。

<maxIndex>：窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置成12。

<fileNamePattern>：必须包含“%i”，例如：假设最小值和最大值分别为1和2，命名模式为mylog%i.log，会产生归档文件mylog1.log和 mylog2.log。还可以指定文件压缩选项，例如：mylog%i.log.gz或者mylog%i.log.zip。

<triggeringPolicy>（通知RollingFileApender何时启动滚动）

（1）、triggeringPolicy：

a、SizeBasedTriggeringPolicy：查看当前活动文件的大小，如果超过指定大小会通知。

b、RollingFileAppender：触发当前活动文件滚动。只有一个节点：

<maxFileSize>：这时活动文件的大小，默认为10MB。

<prudent>（当为true时，不支持FixedWindowRollingPolicy。支持TimeBaseRollingPolicy，但是有两个限制，1、不支持也不允许文件压缩，2、不能设置file属性，必须留空）。

<encoder>：负责两件事，一是把日志信息转化为字节数组，二是把字节数据写入到输出流。目前PatternLayoutEncoder是唯一有用的且默认的encoder，有一个<pattern>节点，用来设置日志的输入格式。使用“%”加转换符的方式，如果要输出“%”，必须要用“\”对“\%“进行转义。

pattern里的转换符说明：

c {length }
lo {length }
logger {length }

输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result

%logger	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar
%logger{0}	mainPackage.sub.sample.Bar	Bar
%logger{5}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{10}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{15}	mainPackage.sub.sample.Bar	m.s.sample.Bar
%logger{16}	mainPackage.sub.sample.Bar	m.sub.sample.Bar
%logger{26}	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar

C {length }
class {length } 输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。

contextName
cn 输出上下文名称。

d {pattern }
date {pattern }

输出日志的打印日志，模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result

%d	2006-10-20 14:06:49,812
%date	2006-10-20 14:06:49,812
%date{ISO8601}	2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS}	14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS}	20 oct. 2006;14:06:49.812

F / file 输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题。

caller{depth}caller{depth, evaluator-1, ... evaluator-n}

输出生成日志的调用者的位置信息，整数选项表示输出信息深度。

例如， %caller{2} 输出为：

0    [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如， %caller{3} 输出为：

16   [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2   at mainPackage.ConfigTester.main(ConfigTester.java:38)

L / line 输出执行日志请求的行号。尽量避免使用，除非执行速度不造成任何问题。

m / msg / message

输出应用程序提供的信息。

M / method 输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题。

n 输出平台先关的分行符“\n”或者“\r\n”。

p / le / level 输出日志级别。

r / relative 输出从程序启动到创建日志记录的时间，单位是毫秒

t / thread 输出产生日志的线程名。

replace(p ){r, t}

p 为日志内容，r 是正则表达式，将p 中符合r 的内容替换为t 。

例如， "%replace(%msg){'\s', ''}"