为什么要写日志?
1.在程序开发过程中,方便调试,并且方便发现程序运行时的错误信息。
2.在生产环境时,方便排除问题。
3.可以业务数据,以便后期对数据分析
实现方式
使用log4j,通过配置,将日志输出到控制台,文件,数据库。(因为该文章只是说明对log4j的使用,所有不涉及其它日志类库)
该项目使用的是maven项目,所以直接通过pom引入依赖包
<!-- 日志 -->
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
新增一个类,做为打印日志的测试
package com.kevin.log;
import org.apache.log4j.Logger;
/**
* @author kevin
* @version 1.0
* @description 将日志的各种级别输出到控制台与文件
* @createDate 2018/12/29
*/
public class Log4jDemo {
public static Logger logger = Logger.getLogger(Log4jDemo.class);
public static void main(String[] args) {
for (int i = 0; i < 10000; i++) {
// 日志的级别从低到高
// 很低的日志级别一般不会使用
logger.trace("logger的trace级别");
// 细粒度信息对调试应用非常有帮助,主要打印一些运行信息
logger.debug("logger的debug级别");
// 粗粒度突出强调应用程序的运行过程,打印感兴趣或者重要的信息
logger.info("logger的info级别");
// 表明会出现潜在错误的情形,有些信息不是错误信息,但也要给程序员一点提示
logger.warn("logger的warn级别");
// 指出虽然发生错误,但不影响运行,打印错误和异常信息,如果不想输出太多日志可以使用该级别
logger.error("logger的error级别");
// 每个严重的错误事件将会导致应用程序的退出,出现错误可以停止程序运行进行调试
logger.fatal("logger的fatal级别");
}
}
}
新增log4j.properties日志配置文件
1.将日志输出到控制台
#设置级别和目的地(这里可以设置多个目的地)
log4j.rootLogger=DEBUG,Console
#Console 输出到控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender
#灵活设置日志格式
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
#日志输出格式
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
控制台输出的内容
2.将日志文件追加到文件和控制台(这个的缺点,是一直追加到同一个文件中,最后文件会无比的大)
#设置级别和目的地(这里可以设置多个目的地)
log4j.rootLogger=DEBUG,Console,File
#Console 输出到控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender
#灵活设置日志格式
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
#日志输出格式
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
#输出到文件(一直输出到该文件中)
log4j.appender.File = org.apache.log4j.FileAppender
#输出日志文件路径
log4j.appender.File.File = E:\\log\\JavaBean_log\\File.log
#包含日志产生的时间、线程、类别等等信息
log4j.appender.File.layout = org.apache.log4j.TTCCLayout
#日志文件输出格式
log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
文件中的内容
3.输出日志到控制台和文件(根据设置的文件大小限定,达到限定大小则备份,指定备份数量,超出则覆盖)的日志配置
#3.输出日志到控制台和文件(根据设置的文件大小限定,达到限定大小则备份,指定备份数量,超出则覆盖)的日志配置
#设置级别和目的地(这里可以设置多个目的地)
log4j.rootLogger=DEBUG,Console,KEVIN
#Console 输出到控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender
#灵活设置日志格式
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
#日志输出格式
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
#输出到文件(根据设置的文件大小限定,达到限定大小则备份,指定备份数量,超出则覆盖)
log4j.appender.KEVIN = org.apache.log4j.RollingFileAppender
#输出文件路径
log4j.appender.KEVIN.File =E:\\log\\JavaBean_log\\RollingFile.log
#日志文件限定大小
log4j.appender.KEVIN.MaxFileSize=1MB
#日志文件备份数量上限
log4j.appender.KEVIN.MaxBackupIndex=10
#以HTML表格形式布局
log4j.appender.KEVIN.layout = org.apache.log4j.PatternLayout
#日志文件输出格式
log4j.appender.KEVIN.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
文件中的内容
4.输出日志到控制台和文件(每天生成一个日志文件)的日志配置
#设置级别和目的地(这里可以设置多个目的地)
log4j.rootLogger=DEBUG,Console,DailyRollingFile
#Console 输出到控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender
#灵活设置日志格式
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
#日志输出格式
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
#输出到文件(根据设置的日期格式,每天生成一个文件)
log4j.appender.DailyRollingFile = org.apache.log4j.DailyRollingFileAppender
#输出日志文件路径
log4j.appender.DailyRollingFile.File = E:\\log\\JavaBean_log\\DailyRollingFile.log
#日志文件生成周期,当前为每天生成一个文件
log4j.appender.DailyRollingFile.DatePattern = '.'yyyy-MM-dd_HH_mm
#灵活指定日志格式
log4j.appender.DailyRollingFile.layout = org.apache.log4j.PatternLayout
#日志文件输出格式
log4j.appender.DailyRollingFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n
日志文件内容
日志中输出格式,各种参数配置
%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”输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。
%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,”-”号指定左对齐。
%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。
%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边交远销出的字符截掉。
根据日期周期生成日志文件的参数
- ’.’yyyy-MM: 每月
- ’.’yyyy-ww: 每周
- ’.’yyyy-MM-dd: 每天
- ’.’yyyy-MM-dd-a: 每天两次
- ’.’yyyy-MM-dd-HH: 每小时
- ’.’yyyy-MM-dd-HH-mm: 每分钟
日志级别
// 日志的级别从低到高
trace:很低的日志级别一般不会使用
debug:细粒度信息对调试应用非常有帮助,主要打印一些运行信息
info:粗粒度突出强调应用程序的运行过程,打印感兴趣或者重要的信息
warn:表明会出现潜在错误的情形,有些信息不是错误信息,但也要给程序员一点提示
error:指出虽然发生错误,但不影响运行,打印错误和异常信息,如果不想输出太多日志可以使用该级别
fatal:每个严重的错误事件将会导致应用程序的退出,出现错误可以停止程序运行进行调试
log4j的配置文件
1. Log4j支持两种配置文件格式,一种是XML格式的文件,一种的proerties格式的文件,根据自己的爱好使用文件格式
2. log4j.rootLogger=[level],appenderName,appenderName....
level:是日志级别,优先级从高到低是fatal,error,warn,info,debug,trace
appenderName:指定日志输出的目的地,可以指定多个目的地。
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
3.appender的配置参数
(1).ConsoleAppender选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err:默认情况下是:System.out,指定输出控制台
(2).FileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
(3).DailyRollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
DatePattern=’.’yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下:
- ’.’yyyy-MM: 每月
- ’.’yyyy-ww: 每周
- ’.’yyyy-MM-dd: 每天
- ’.’yyyy-MM-dd-a: 每天两次
- ’.’yyyy-MM-dd-HH: 每小时
- ’.’yyyy-MM-dd-HH-mm: 每分钟
(4).RollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
Log4j提供的layout:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
关于Additity:
它是 子Logger 是否继承 父Logger 的 输出源(appender) 的标志位。具体说,默认情况下子Logger会继承父Logger的appender,也就是说子Logger会在父Logger的appender里输出。若是additivity设为false,则子Logger只会在自己的appender里输出,而不会在父Logger的appender里输出。