【Java.ThirdParty】日志——Log4j——1——配置及使用
Log4j 1.x
Log4j配置文件的加载
默认加载方式
若系统中未显式的指定配置文件，则Logj4默认会加载log4j.xml和log4j.properties文件。
当系统调用Log4j的LoggerFactory.getLogger()方法时，调用栈如下：
在LogManager.<client>即静态块的初始块中，若系统中未定义log4j.configuration属性，则Log4j首先尝试加载log4j.xml，若加载失败，再尝试加载log4j.properties。
具体的加载方法在Loader.getResource()中，该方法首先尝试使用当前线程上下文中的ClassLoader去加载配置文件（log4j.xml或log4j.properties），若失败再使用加载Log4j的ClassLoader尝试加载资源，最后使用加载系统类的ClassLoader去加载资源。
使用默认加载方式时，需要将配置文件log4j.xml或log4j.properties放到对应ClassLoader的ClassPath中去，文件名不能使用自定义的名称。
显式加载方式
显式指定文件路径进行加载：
public class TestLog4j{
public static void main(String[] args){
PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );
Logger logger = Logger.getLogger(TestLog4j. class );
logger.debug( " debug " );
logger.error( " error " );
}
}
Spring中的加载方式
Log4j的配置
Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。
log4j.properties配置
基本格式如下：
#配置根Logger log4j.rootLogger=[ level ],appenderName1,appenderName2,... ... #配置日志信息输出目的地Appender X log4j.appender.appenderNameX=fully.qualified.name.of.appender.class log4j.appender.appenderNameX.option1=value1 ... ... log4j.appender.appenderNameX.optionN=valueN #配置日志信息的格式（布局） log4j.appender.appenderNameX.layout=fully.qualified.name.of.layout.class log4j.appender.appenderNameX.layout.option1=value1 ... ... log4j.appender.appenderNameX.layout.optionN=valueN ... ... ... ...
- [level] —— 日志输出级别，共有5级：
- FATAL (0)
- ERROR (3) 为严重错误 主要是程序的错误
- WARN (4) 为一般警告，比如session丢失
- INFO (6) 为一般要显示的信息，比如登录登出
- DEBUG (7) 为程序的调试信息
- Appender —— 日志输出目的地，Log4j提供的Appender有：
- org.apache.log4j.ConsoleAppender（控制台）
- org.apache.log4j.FileAppender（文件）
- org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
- org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
- org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
- Layout —— 日志输出格式，Log4j提供的常用Layout有：
- org.apache.log4j.HTMLLayout（以HTML表格形式布局），
- org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
- org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
- org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
- Appender支持的选项 —— appender的选项可以通过查看对应appdender类的setterXXX，getterXXX函数得到，常用的选项如下：
- ConsoleAppender.Option:
- Threshold=DEBUG —— 指定日志消息的输出最低层次
- ImmediateFlush=true —— 默认值是true,意谓着所有的消息都会被立即输出
- Target=System.err —— 默认情况下是：System.out,指定输出控制台
- FileAppender.Option
- Threshold=DEBUF —— 指定日志消息的输出最低层次
- ImmediateFlush=true —— 默认值是true,意谓着所有的消息都会被立即输出
- File=mylog.txt —— 指定消息输出到mylog.txt文件
- Append=false —— 默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容
- RollingFileAppender.Option
- MaxFileSize=100KB —— 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件
- MaxBackupIndex=2 —— 指定可以产生的滚动文件的最大数
- ConsoleAppender.Option:
- Appender.layout支持的选项 —— layout支持的选项可以通过查看对应layout类的setterXXX，getterXXX函数得到，常用的选项如：
ConversionPattern，例如：log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
Log4j日志输出格式类似C语言中printf()函数打印格式化信息。
日志信息格式中的符号含义如下：
- -X号: X信息输出时左对齐；
- %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"输出日志信息换行
- 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
- 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.properties：
log4j.rootLogger=INFO, stdout log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Sl4jLog4jTestingApp {
public static final Logger logger = LoggerFactory.getLogger(Sl4jLog4jTestingApp.class);
public static void main(String[] args){
logger.debug("debug!!!");
logger.info("info!!!");
logger.warn("warn!!!");
logger.error("error!!!");
}
}
Output：
INFO [main] (Sl4jLog4jTestingApp.java:13) - info!!! WARN [main] (Sl4jLog4jTestingApp.java:14) - warn!!! ERROR [main] (Sl4jLog4jTestingApp.java:15) - error!!!
log4j.xml配置
为不同的包或类设置独立的Logger
在配置文件 - log4j.properties 中按包名-package 或类 - class 名来定义Logger,在程序中按类名取Logger:
定义：
log4j.rootLogger =debug, stdout
log4j.logger.com.mypkg =debug, base
log4j.logger.com.mypkg.db =info, db
log4j.logger.com.mypkg.mail =debug, mail
#stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5r [%5p][%c{2}] %m%n
#base
log4j.appender.base=org.apache.log4j.RollingFileAppender
log4j.appender.base.File=system.log
log4j.appender.base.Append=true
log4j.appender.base.MaxFileSize=1MB
log4j.appender.base.MaxBackupIndex=1
log4j.appender.base.layout=org.apache.log4j.PatternLayout
log4j.appender.base.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] - %m%n
#db
log4j.appender.db=org.apache.log4j.FileAppender
log4j.appender.db.File=db.log
log4j.appender.db.Append=true
log4j.appender.db.layout=org.apache.log4j.PatternLayout
log4j.appender.db.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] - %m%n
#mail
log4j.appender.mail=org.apache.log4j.FileAppender
log4j.appender.mail.File=mail.log
log4j.appender.mail.Append=true
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] - %m%n
#
log4j.additivity.com.mypkg=false
log4j.additivity.com.mypkg.db=false
log4j.additivity.com.mypkg.mail=false
使用 - 正常使用：
package com.mypkg;
public class Class1
{
private static Logger logger = Logger.getLogger(Class1.class);
...
if(logger.isDebugEnabled())
logger.debug("debug info");
...
}
package com.mypkg.db;
public class Class2
{
private static Logger logger = Logger.getLogger(Class2.class);
...
if(logger.isDebugEnabled())
logger.debug("debug info");
...
}
package com.mypkg.mail;
public class Class3
{
private static Logger logger = Logger.getLogger(Class3.class);
...
if(logger.isDebugEnabled())
logger.debug("debug info");
...
}
- com.mypkg.mail下的类(Class3)的日志就会记入mail.log
- com.mypkg.db下的类(Class2)的日志就会记入db.log
- com.mypkg下的类(Class1)及类似com.mypkg.pkg1这样的未定义相应Logger的包下的类(com.mypkg.pkg1.Class4)的日志就会记入system.log
- com.mypkg以外的类(com.pkg1.Class5)的日志就会记录到rootLogger，即输出到控制台
还可以为指定类配置一个logger，如为类com.mypkg.db.ConnectionPool配置一个logger：
log4j.logger.com.mypkg.db.ConnectionPool=debug,pool
log4j.appender.pool=org.apache.log4j.FileAppender
log4j.appender.pool.File=pool.log
log4j.appender.pool.Append=true
log4j.appender.pool.layout=org.apache.log4j.PatternLayout
log4j.appender.pool.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] - %m%n
log4j.additivity.com.mypkg.db.ConnectionPool=false
这样一来，ConnectionPool类的日志就会记入pool.log，不会记入db.log。
Log4j 2.x