Log4j 配合 java 类的简单封装

 

以前用 java 做工程需要调试信息都是自己 System.out.println，虽然很早就知道 log4j，不过没认真研究过，一般拿简单的 .property 文件来配置，不过最近仔细看了一下 log4j 的源文件，发现人家 apache 早就不建议使用 .property 了，首选 .xml，于是再研究了一下 .xml 的配置，这里记一下备忘。

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <!-- Created by DavidHsing <DavidHsing@163.com>, on Oct.20 2009, pm --> <!-- %c 输出日志信息所属的类的全名 %d 输出日志时间点的日期或时间，默认格式为 ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss }，输出类似：2008-08-08 20:08:08 %f 输出日志信息所属的类的类名 %l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行 %m 输出代码中指定的信息，如log(message)中的message %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n” %p 输出优先级，即 DEBUG、INFO、WARN、ERROR、FATAL。如果是调用 debug() 输出的，则为 DEBUG，依此类推 %r 输出自应用启动到输出该日志信息所耗费的毫秒数 %t 输出产生该日志事件的线程名 --> <!-- appender: ConsoleAppender --> <appender name="log4j.ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} [%-5p] [%t] %C{2} (%F:%L) - %m%n" /> </layout> </appender> <!-- appender: FileAppender --> <appender name="log4j.FileAppender" class="org.apache.log4j.FileAppender"> <param name="File" value="${Log4jLogPath}/AppRunLog.log" /> <param name="Append" value="true" /> <param name="Encoding" value="UTF-8" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} [%-5p] [%t] %C{2} (%F:%L) - %m%n" /> </layout> </appender> <category name="org.apache.log4j.xml"> <priority value="debug" /> </category> <!-- =================================================================== --> <!-- Logger level: DEBUG, INFO, WARN, ERROR, FATAL, ALL, OFF --> <!-- Output internal SQL --> <logger name="java.sql.Connection"> <level value="DEBUG" /> </logger> <logger name="java.sql.PreparedStatement"> <level value="DEBUG" /> </logger> <!-- 设置总体的默认日志级别 --> <root> <level value="WARN" /> <appender-ref ref="log4j.ConsoleAppender" /> <appender-ref ref="log4j.FileAppender" /> </root> <!-- =================================================================== --> </log4j:configuration>

 

这个 xml 是建好了，不过由于在运行时需要配置 XML，而这个配置 log4j 又限定只能配置一次，所以最简单的办法，就是再次封装一下，写个类来配置和提供 Logger：

 package xxx.utilities; import java.io.*; import org.apache.log4j.*; import org.apache.log4j.helpers.*; import org.apache.log4j.spi.*; import org.apache.log4j.xml.*; /** * 通用 log4j 封装类 * 外部类调用 Log4jLogger.getLogger() 即可 * @author DavidHsing */ public class Log4jLogger { /** * 本类默认的配置文件是 log4j.xml, 位置是: * Web: ${WEB-INF}/config/log4j.xml * Jar: ${JarPath}/config/log4j.xml */ protected static final String THIS_CLASS_PATH = (UtilClass.getJarClassPath(Log4jLogger.class) != null && !UtilClass.getJarClassPath(Log4jLogger.class).trim().equals("")) ? UtilClass.getJarClassPath(Log4jLogger.class) : "."; public static final String DEFAULT_CONFIG_FILE = UtilClass.isRunningOnWeb() ? UtilClass.getWebRootPath() + "/WEB-INF/config/log4j.xml" : THIS_CLASS_PATH + "/config/log4j.xml"; //$NON-NLS-1$ //$NON-NLS-2$ public static final String DEFAULT_LOG_SAVEPATH = UtilClass.isRunningOnWeb() ? UtilClass.getWebRootPath() + "/WEB-INF/log" : THIS_CLASS_PATH + "/log"; //$NON-NLS-1$ //$NON-NLS-2$ public static final String DEFAULT_FILEAPPENDER_NAME = "log4j.FileAppender"; //$NON-NLS-1$ //-------------------------------------------------------------------------- static { if (!isLog4jConfigured()) { System.setProperty("Log4jLogPath", DEFAULT_LOG_SAVEPATH); if (!resetConfiguration()) { LogLog.error("Log4jLogger.static : Initialize log4j in static method faild!'"); } } } protected Log4jLogger() {} //-------------------------------------------------------------------------- @SuppressWarnings("unchecked") public static Logger getLogger(final Class clsClass) { if (!isLog4jConfigured() && !resetConfiguration()) { LogLog.error("Log4jLogger.getLogger() : Initialize log4j with Class faild!"); return null; } return LogManager.getLogger(clsClass.getName()); } public static Logger getLogger(final String sClassName) { if (!isLog4jConfigured() && !resetConfiguration()) { LogLog.error("Log4jLogger.getLogger() : Initialize log4j with String faild!"); return null; } return LogManager.getLogger(sClassName); } public static Logger getLogger(final String sClassName, final LoggerFactory lfLoggerFactory) { if (!isLog4jConfigured() && !resetConfiguration()) { LogLog.error("Log4jLogger.getLogger() : Initialize log4j with LoggerFactory faild!"); return null; } return LogManager.getLogger(sClassName, lfLoggerFactory); } public static Logger getRootLogger() { return LogManager.getRootLogger(); } //-------------------------------------------------------------------------- /** * 设置 Log4j FileAppender 文件日志输出路径 * @param sAppenderName : Log4j.xml 中的 FileAppender 名称, 默认 DEFAULT_FILEAPPENDER_NAME * @param sPathName : 可采用 Log4jLogger.DEFAULT_LOG_SAVEPATH + "/app20091110.log" 的形式以使用相对路径 * @return boolean */ synchronized public static boolean setFileAppenderPath(String sAppenderName, String sPathName) { if (sAppenderName != null && !sAppenderName.trim().equals("") && sPathName != null && !sPathName.trim().equals("")) { sPathName = sPathName.trim(); Appender l4jAppender = LogManager.getLoggerRepository().getRootLogger().getAppender(sAppenderName); if (l4jAppender != null && (l4jAppender instanceof FileAppender)) { FileAppender l4jFileAppender = (FileAppender)l4jAppender; l4jFileAppender.setFile(sPathName); l4jFileAppender.activateOptions(); return true; } } return false; } //-------------------------------------------------------------------------- /** * 设置 Log4j FileAppender 文件日志输出路径 * @param sAppenderName : Log4j.xml 中的 FileAppender 名称, 默认 DEFAULT_FILEAPPENDER_NAME * @param sPathName : 可采用 Log4jLogger.DEFAULT_LOG_SAVEPATH + "/app20091110.log" 的形式以使用相对路径 * @param bAppend : 日志是否为追加模式 * @return boolean */ synchronized public static boolean setFileAppenderPath(String sAppenderName, String sPathName, boolean bAppend) { if (sAppenderName != null && !sAppenderName.trim().equals("") && sPathName != null && !sPathName.trim().equals("")) { sPathName = sPathName.trim(); Appender l4jAppender = LogManager.getLoggerRepository().getRootLogger().getAppender(sAppenderName); if (l4jAppender != null && (l4jAppender instanceof FileAppender)) { FileAppender l4jFileAppender = (FileAppender)l4jAppender; try { l4jFileAppender.setFile(sPathName, bAppend, l4jFileAppender.getBufferedIO(), l4jFileAppender.getBufferSize()); } catch (IOException ioex) { LogLog.error("Log4jLogger.setFileAppenderPath() : IOException: PathName = '" + sPathName + "'", ioex); return false; } l4jFileAppender.activateOptions(); return true; } } return false; } //-------------------------------------------------------------------------- /** * 判断 Log4j 是否被初始化 * 依据 System.getProperty("Log4jLogPath"); */ synchronized public static boolean isLog4jConfigured() { String sLog4jLogPath = System.getProperty("Log4jLogPath"); //$NON-NLS-1$ return (sLog4jLogPath != null && !sLog4jLogPath.trim().equals("")); } //-------------------------------------------------------------------------- /** * 重置为默认配置 */ synchronized public static boolean resetConfiguration() { File feConfigFile = new File(DEFAULT_CONFIG_FILE); if (feConfigFile.exists() && feConfigFile.isFile() && feConfigFile.canRead()) { if (DEFAULT_CONFIG_FILE.trim().toLowerCase().endsWith(".xml")) //$NON-NLS-1$ { DOMConfigurator.configure(DEFAULT_CONFIG_FILE); } else if (DEFAULT_CONFIG_FILE.trim().toLowerCase().endsWith(".properties")) //$NON-NLS-1$ { PropertyConfigurator.configure(DEFAULT_CONFIG_FILE); } return true; } return false; } }

 

这样，在调用的时候就不需要配置了，直接获取 Logger 并输出就 OK 了。

注意最好将 .xml 放到这个 java 类所在的同一目录（当然也可以通过在上述类里面指定路径）。

代码：

package xxx; import org.apache.log4j.*; public class TestLog4j { protected static Logger l4jLogger = Log4jLogger.getLogger(TestLog4j.class); //测试代码 l4jLogger.error("这里是 DavidHsing 的 log4j 测试。"); }

 

这样就可以正常的运行了。

不过最上面的 xml 只是个例子，真正要研究的话还有很多内容，比如按事件级别分别输出到不同地方等等，总之，log4j 是个很强大而且高效的东东，值得认真研究一下。

 

另附：

Log4j 的 properties 的配置方式：

log4j.rootLogger = INFO, ConsoleAppender # ConsoleAppender log4j.appender.ConsoleAppender = org.apache.log4j.ConsoleAppender log4j.appender.ConsoleAppender.Threshold = WARN log4j.appender.ConsoleAppender.Target = System.out log4j.appender.ConsoleAppender.Encoding = UTF-8 log4j.appender.ConsoleAppender.layout = org.apache.log4j.PatternLayout log4j.appender.ConsoleAppender.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} [%-5p] [%t] %C{2} (%F:%L) - %m%n # Output internal SQL log4j.logger.java.sql.Connection = ConsoleAppender log4j.logger.java.sql.PreparedStatement = ConsoleAppender

 

 

参考文献：

1、Apache Logging Project Homepage: http://logging.apache.org

2、http://wiki.apache.org/logging-log4j/Log4jXmlFormat