日志框架学习-log4j


1. 日志框架

JUL(java util logging)、logback、log4j、log4j2
JCL(Jakarta Commons Logging)、slf4j( Simple Logging Facade for Java)

  • 日志门面
    JCL、slf4j
  • 日志实现
    JUL、logback、log4j、log4j2

2. log4j学习

2.1 基础

  1. 依赖关系

    
    	log4j
    	log4j
    	1.2.17
    
    
  2. 日志级别

    • 每个Logger都被了一个日志级别(log level),用来控制日志信息的输出。
    • 日志级别从高到低分为:
      • fatal 指出每个严重的错误事件将会导致应用程序的退出。
      • error 指出虽然发生错误事件,但仍然不影响系统的继续运行。
      • warn 表明会出现潜在的错误情形。
      • info 一般和在粗粒度级别上,强调应用程序的运行全程。
      • debug 一般用于细粒度级别上,对调试应用程序非常有帮助。
      • trace 是程序追踪,可以用于输出程序运行中的变量,显示执行的流程。
    • 还有两个特殊的级别:
      • OFF,可用来关闭日志记录。
      • ALL,启用所有消息的日志记录。

    注:一般只使用4个级别,优先级从高到低为 ERROR > WARN > INFO > DEBUG

2.2 log4j组件

log4j:主要由Loggers(日志记录器)、Appenders(输出端)和 Layout(日志格式化器)组成。其中Loggers 控制日志的输出级别与日志是否输出;Appenders 指定日志的输出方式(输出到控制台、文件等);Layout 控制日志信息的输出格式。

  1. Loggers

日志记录器,负责收集处理日志记录,实例的命名就是类“XX”的full quailied name(类的全限定名),Logger的名字大小写敏感,其命名有继承机制:例如:name为org.apache.commons的logger会继承name为org.apache的logger。

Log4J中有一个特殊的logger叫做“root”,他是所有logger的根,也就意味着其他所有的logger都会直接或者间接地继承自root。root logger可以用Logger.getRootLogger()方法获取。

  1. Appenders

Appender 用来指定日志输出到哪个地方,可以同时指定日志的输出目的地。Log4j 常用的输出目的地有以下几种:

输出端类型 作用
ConsoleAppender 将日志输出到控制台
FileAppender 将日志输出到文件中
DailyRollingFileAppender 将日志输出到一个文件,并且每天输出到一个新的文件
RollingFileAppender 将日志信息输出到一个日志文件,并且指定文件的尺寸,当文件大小达到指定尺寸时,会自动把文件改名,同时产生一个新的文件
JDBCAppender 把日志信息保存到数据库中
  1. Layout

布局器 Layouts用于控制日志输出内容的格式。Log4j常用的Layouts:

格式化器类型 作用
HTMLLayout 格式化日志输出为HTML表格形式
SimpleLayout 简单的日志输出格式化,打印的日志格式为(info - message)
PatternLayout 最强大的格式化期,可以根据自定义格式输出日志,如果没有指定转换格式,就是用默认的转换格式

3.1 Layout格式

可在log4j.properties配置文件中,定义输出的格式:

 * log4j 采用类似 C 语言的 printf 函数的打印格式格式化日志信息,具体的占位符及其含义如下:
	%m 输出代码中指定的日志信息
	%p 输出优先级,及 DEBUG、INFO 等
	%n 换行符(Windows平台的换行符为 "\n",Unix 平台为 "\n")
	%r 输出自应用启动到输出该 log 信息耗费的毫秒数
	%c 输出打印语句所属的类的全名
	%t 输出产生该日志的线程全名
	%d 输出服务器当前时间,默认为 ISO8601,也可以指定格式,如:%d{yyyy年MM月dd日
	HH:mm:ss}
	%l 输出日志时间发生的位置,包括类名、线程、及在代码中的行数。如:
	Test.main(Test.java:10)
	%F 输出日志消息产生时所在的文件名称
	%L 输出代码中的行号
	%% 输出一个 "%" 字符

* 可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如:
	%5c 输出category名称,最小宽度是5,category<5,默认的情况下右对齐
	%-5c 输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格
	%.5c 输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不会有空格
	%20.30c category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉

2.3 log4j配置文件-log4j.properties

  • 基本配置
# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=debug,使用的 Appender为=mConsole
log4j.rootLogger=,mConsole

# 自定义 logger 对象设置
log4j.logger.cn.cup.edu = INFO,mConsole
log4j.logger.org.apache = error

#################################
# Console Appender
#################################
log4j.appender.mConsole=org.apache.log4j.ConsoleAppender
log4j.appender.mConsole.encoding=UTF-8
log4j.appender.mConsole.Threshold=debug
log4j.appender.mConsole.Target=System.out
log4j.appender.mConsole.layout=org.apache.log4j.PatternLayout
log4j.appender.mConsole.layout.ConversionPattern=[%p][%d{yyyy-MM-dd HH:mm:ss}][%l]%m%n
#################################

#################################
# File Appender
#################################
log4j.appender.mFile=org.apache.log4j.FileAppender
log4j.appender.mFile.encoding=UTF-8
log4j.appender.mFile.Threshold=debug
log4j.appender.mFile.file=/logs/log4j.log
log4j.appender.mFile.layout=org.apache.log4j.PatternLayout
log4j.appender.mFile.ConversionPattern=[%p][%d{yyyy-MM-dd HH:mm:ss}][%l]%m%n
#################################

#################################
# 按照文件大小拆分的 FileAppender 对象
#################################
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.encoding=UTF-8
log4j.appender.rollingFile.Threshold=debug
log4j.appender.rollingFile.file=/logs/log4j.log
#指定日志文件内容的大小
log4j.appender.rollingFile.maxFileSize = 1MB
#指定日志文件的数量
log4j.appender.rollingFile.maxBackupIndex=10
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%p][%d{yyyy-MM-dd HH:mm:ss}][%l]%m%n
#################################


#################################
# 按照时间规则拆分的 appender 对象
#################################
log4j.appender.dailyFile = org.apache.log4j.DailyRollingFileAppender
# 指定日志文件的字符集
log4j.appender.dailyFile.encoding=UTF-8
log4j.appender.dailyFile.Threshold=debug
# 指定消息格式 layout
log4j.appender.dailyFile.layout = org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.dailyFile.layout.conversionPattern =[%p][%d{yyyy-MM-dd HH:mm:ss}][%l]%m%n
# 指定日志文件保存路径
log4j.appender.dailyFile.file = /logs/log4j.log
# 指定日期拆分规则
log4j.appender.dailyFile.datePattern = '.'yyyy-MM-dd-HH-mm-ss
#################################

#################################
#mysql
#################################
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.jdbc.Driver
log4j.appender.logDB.URL=jdbc:mysql://localhost:3306/test
log4j.appender.logDB.User=root
log4j.appender.logDB.Password=root
log4j.appender.logDB.Sql=INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) \
  values('log4jTest','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')