1.声明常量:
static Logger log = Logger.getLogger(TestLog.class.getName());
2.配置文件:
log4j支持xml和properties两套配置文件,推荐使用properties。
3.配置方法:
1.日志开关:配置根 Logger,其语法为:
log4j.rootLogger=debug,appender1,appender2,appender3...
eg:log4j.rootLogger=debug,appender1
2.日志输出器:
log4j.appender.appenderName = Log4j 提供的 appender 类
log4j.appender.appenderName.属性名 = 属性值
eg:
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
log4j.appender.appender1.ImmediateFlush=true
log4j的appender类有5个值:
org.apache.log4j.ConsoleAppender;(控制台)
org.apache.log4j.FileAppender;(文件)
org.apache.log4j.DailyRollingFileAppender;(每天一个日志文件)
org.apache.log4j.RollingFileAppender;(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
ConsoleAppender的属性:
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是 true,意谓着所有的消息都会被立即输出。
Target=System.err:默认情况下是:System.out,指定输出控制台
FileAppender的属性:
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是 true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到 mylog.txt 文件。
Append=false:默认值是 true,即将消息增加到指定文件中,false 指将消息覆盖指定的文件内容。
DailyRollingFileAppender的属性:
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是 true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到 mylog.txt 文件。
Append=false:默认值是 true,即将消息增加到指定文件中,false 指将消息覆盖指定的文件内容。
DatePattern=''.''yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。
当然也可以指定按月、周、天、时和分。即对应的格式如下:
1)''.''yyyy-MM: 每月
2)''.''yyyy-ww: 每周
3)''.''yyyy-MM-dd: 每天
4)''.''yyyy-MM-dd-a: 每天两次
5)''.''yyyy-MM-dd-HH: 每小时
6)''.''yyyy-MM-dd-HH-mm: 每分钟
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:指定可以产生的滚动文件的最大数。
org.apache.log4j.WriterAppender的属性:
待查询。。。。
3.日志信息格式器
log4j.appender.appenderName.layout = Log4j 提供的 layout 类
log4j.appender.appenderName.layout.属性 = 值
eg:
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
log4j.appender.appender1.layout.ConversionPattern=%d{ABSOLUTE}%-5p[%c]%m%n
Log4j的layout值有4个:
org.apache.log4j.HTMLLayout(以 HTML 表格形式布局) ,
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
HTMLLayout的属性:
LocationInfo=true:默认值是 false,输出 java 文件名称和行号
Title=my app file: 默认值是 Log4J Log Messages.
PatternLayout的属性:
ConversionPattern=%m%n :指定怎样格式化指定的消息。
XMLLayout的属性:
LocationInfo=true:默认值是 false,输出 java 文件和行号
Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息,打印参数如下:
og4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
这里需要说明的就是日志信息格式中几个符号所代表的含义:
-X 号: X 信息输出时左对齐;
%p: 输出日志信息优先级,即 DEBUG,INFO,WARN,ERROR,FATAL,
%d: 输出日志时间点的日期或时间,默认格式为 ISO8601,也可以在其后指定格式,
比如: %d{yyyy MM 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 字符,就从左边交
远销出的字符截掉
4.配置案例:
log4j.rootLogger=INFO,consoleAppender,logfile,MAIL
log4j.addivity.org.apache=true
#ConsoleAppender,控制台输出
#FileAppender,文件日志输出
#SMTPAppender,发邮件输出日志
#SocketAppender,Socket 日志
#NTEventLogAppender,Window NT 日志
#SyslogAppender,
#JMSAppender,
#AsyncAppender,
#NullAppender
#文件输出:RollingFileAppender
#log4j.rootLogger = INFO,logfile
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.logfile.Threshold=INFO
# 输出以上的 INFO信息
log4j.appender.logfile.File=INFO_log.html
#保存 log 文件路径
log4j.appender.logfile.Append=true
# 默认为 true,添加到末尾,false 在每次启动时进行覆盖
log4j.appender.logfile.MaxFileSize=1MB
# 一个 log 文件的大小,超过这个大小就又会生成 1个日志 # KB ,MB,GB
log4j.appender.logfile.MaxBackupIndex=3
# 最多保存 3个文件备份
log4j.appender.logfile.layout=org.apache.log4j.HTMLLayout
# 输出文件的格式
log4j.appender.logfile.layout.LocationInfo=true
#是否显示类名和行数
log4j.appender.logfile.layout.Title=title:\u63d0\u9192\u60a8\uff1a\u7cfb\u7edf
#html 页面的 < title >
############################## SampleLayout ####################################
# log4j.appender.logfile.layout = org.apache.log4j.SampleLayout
############################## PatternLayout ###################################
# log4j.appender.logfile.layout = org.apache.log4j.PatternLayout
# log4j.appender.logfile.layout.ConversionPattern =% d % p [ % c] - % m % n % d
############################## XMLLayout #######################################
# log4j.appender.logfile.layout = org.apache.log4j.XMLLayout
# log4j.appender.logfile.layout.LocationInfo = true #是否显示类名和行数
############################## TTCCLayout ######################################
# log4j.appender.logfile.layout = org.apache.log4j.TTCCLayout
# log4j.appender.logfile.layout.DateFormat = ISO8601
#NULL, RELATIVE, ABSOLUTE, DATE or ISO8601.
# log4j.appender.logfile.layout.TimeZoneID = GMT - 8 : 00
# log4j.appender.logfile.layout.CategoryPrefixing = false ##默认为 true 打印类别名
# log4j.appender.logfile.layout.ContextPrinting = false ##默认为 true 打印上下文信息
# log4j.appender.logfile.layout.ThreadPrinting = false ##默认为 true 打印线程名
# 打印信息如下:
#2007-09-13 14:45:39 ,765[http-8080-1] ERROR com.poxool.test.test-error 成功关闭链接
###############################################################################
#每天文件的输出:DailyRollingFileAppender
#log4j.rootLogger = INFO,errorlogfile
log4j.appender.errorlogfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorlogfile.Threshold = ERROR
log4j.appender.errorlogfile.File = ../logs/ERROR_log
log4j.appender.errorlogfile.Append = true
#默认为 true,添加到末尾,false 在每次启动时进行覆盖
log4j.appender.errorlogfile.ImmediateFlush = true
#直接输出,不进行缓存
# ' . ' yyyy - MM: 每个月更新一个 log日志
# ' . ' yyyy - ww: 每个星期更新一个 log日志
# ' . ' yyyy - MM - dd: 每天更新一个 log日志
# ' . ' yyyy - MM - dd - a: 每天的午夜和正午更新一个 log日志
# ' . ' yyyy - MM - dd - HH: 每小时更新一个 log日志
# ' . ' yyyy - MM - dd - HH - mm: 每分钟更新一个 log日志
log4j.appender.errorlogfile.DatePattern = ' . ' yyyy - MM - dd ' .log '
#文件名称的格式
log4j.appender.errorlogfile.layout = org.apache.log4j.PatternLayout
log4j.appender.errorlogfile.layout.ConversionPattern =%d %p [ %c] - %m %n %d
#控制台输出:
#log4j.rootLogger = INFO,consoleAppender
log4j.appender.consoleAppender = org.apache.log4j.ConsoleAppender
log4j.appender.consoleAppender.Threshold = ERROR
log4j.appender.consoleAppender.layout = org.apache.log4j.PatternLayout
log4j.appender.consoleAppender.layout.ConversionPattern =%d %-5p %m %n
log4j.appender.consoleAppender.ImmediateFlush = true
# 直接输出,不进行缓存
log4j.appender.consoleAppender.Target = System.err
# 默认是 System.out 方式输出
#发送邮件:SMTPAppender
#log4j.rootLogger = INFO,MAIL
log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold = INFO
log4j.appender.MAIL.BufferSize = 10
log4j.appender.MAIL.From = yourmail@gmail.com
log4j.appender.MAIL.SMTPHost = smtp.gmail.com
log4j.appender.MAIL.Subject = Log4J Message
log4j.appender.MAIL.To = yourmail@gmail.com
log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern =%d - %c -%-4r [%t] %-5p %c %x - %m %n
#数据库:JDBCAppender
log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.DATABASE.URL = jdbc:oracle:thin:@ 210.51 . 173.94 : 1521 :YDB
log4j.appender.DATABASE.driver = oracle.jdbc.driver.OracleDriver
log4j.appender.DATABASE.user = ydbuser
log4j.appender.DATABASE.password = ydbuser
log4j.appender.DATABASE.sql = INSERT INTO A1 (TITLE3) VALUES ( ' %d - %c %-5p %c %x - %m%n ' )
log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout
log4j.appender.DATABASE.layout.ConversionPattern =% d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
#数据库的链接会有问题,可以重写 org.apache.log4j.jdbc.JDBCAppender 的 getConnection()
#使用数据库链接池去得链接,可以避免 insert 一条就链接一次数据库
5.程序调用:
5.1 得到记录器:
使用 Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
public static Logger getLogger( String name)
通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。
Name 一般取本类的名字,比如:
static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName());
5.2读取配置文件
当获得了日志记录器之后,第二步将配置Log4j环境,其语法为:
BasicConfigurator.configure (): 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用
Java 的特性文件编写的配置文件。
DOMConfigurator.configure(String filename) :读取 XML 形式的配置文件。
5.3插入记录信息(格式化日志信息)
当上两个必要步骤执行完毕,您就可以轻松地使用不同优先级别的日志记录语句插入
到您想记录日志的任何地方,其语法如下:
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
5.4 注意事项
Logger 的命名规则:
Logger 由一个 String 类的名字识别,logger 的名字是大小写敏感的,且名字之间
具有继承的关系,子名 有父名作为前缀,用点号.分隔。如:x.y 是 x.y.z 的父亲。