Log4j是Apache下的一款开源的日志框架,通过在项目中使用 Log4J,我们可以控制日志信息输出到控
制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式,通过定义日志的输出级别,可以
更灵活的控制日志的输出过程。方便项目的调试。
官方网站: http://logging.apache.org/log4j/1.2/
Log4j入门
1. 建立maven工程
2. 添加依赖
<dependencies> <!--log4j--> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.47</version> </dependency> </dependencies>
3. java代码
@Test public void testQuick() throws Exception { // 初始化配置信息,在入门案例中暂不使用配置文件 BasicConfigurator.configure(); Logger logger = Logger.getLogger(Log4jTest.class); logger.info("hello log4j"); // 日志级别 logger.fatal("fatal"); // 严重错误,一般会造成系统崩溃并终止运行 logger.error("error"); // 错误信息,不会影响系统运行 logger.warn("warn"); // 警告信息,可能会发生问题 logger.info("info"); // 运行信息,数据连接、网络连接、IO 操作等等 logger.debug("debug"); // 调试信息,一般在开发中使用,记录程序变量参数传递信息等等 logger.trace("trace"); // 追踪信息,记录程序所有的流程信息 }
日志结果:
0 [main] INFO com.topcheer.log4j.Log4jTest - hello log4j 1 [main] FATAL com.topcheer.log4j.Log4jTest - fatal 1 [main] ERROR com.topcheer.log4j.Log4jTest - error 1 [main] WARN com.topcheer.log4j.Log4jTest - warn 1 [main] INFO com.topcheer.log4j.Log4jTest - info 1 [main] DEBUG com.topcheer.log4j.Log4jTest - debug
4.日志级别:
每个Logger都被了一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分 为: fatal 指出每个严重的错误事件将会导致应用程序的退出。 error 指出虽然发生错误事件,但仍然不影响系统的继续运行。 warn 表明会出现潜在的错误情形。 info 一般和在粗粒度级别上,强调应用程序的运行全程。 debug 一般用于细粒度级别上,对调试应用程序非常有帮助。 trace 是程序追踪,可以用于输出程序运行中的变量,显示执行的流程。 还有两个特殊的级别: OFF,可用来关闭日志记录。 ALL,启用所有消息的日志记录。
Log4j组件
Log4J 主要由 Loggers (日志记录器)、Appenders(输出端)和 Layout(日志格式化器)组成。其中
Loggers 控制日志的输出级别与日志是否输出;Appenders 指定日志的输出方式(输出到控制台、文件
等);Layout 控制日志信息的输出格式。
4.2.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()方法获取。
但是,自log4j 1.2版以来, Logger 类已经取代了 Category 类。对于熟悉早期版本的log4j的人来说,
Logger 类可以被视为 Category 类的别名。
Appenders
Appender 用来指定日志输出到哪个地方,可以同时指定日志的输出目的地。Log4j 常用的输出目的地
有以下几种:
Layouts
布局器 Layouts用于控制日志输出内容的格式,让我们可以使用各种需要的格式输出日志。Log4j常用
的Layouts:
Layout的格式
在 log4j.properties 配置文件中,我们定义了日志输出级别与输出端,在输出端中分别配置日志的输出
格式。
Appender的输出
控制台,文件
# 指定 RootLogger 顶级父元素默认配置信息 # 指定日志级别=trace,使用的 apeender 为=console log4j.rootLogger = trace,console,dailyFile,rollingFile # 指定控制台日志输出的 appender log4j.appender.console = org.apache.log4j.ConsoleAppender # 指定消息格式 layout log4j.appender.console.layout = org.apache.log4j.PatternLayout # 指定消息格式的内容 log4j.appender.console.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n # %m 输出代码中指定的日志信息 # %p 输出优先级,及 DEBUG、INFO 等 # %n 换行符(Windows平台的换行符为 " ",Unix 平台为 " ") # %r 输出自应用启动到输出该 log 信息耗费的毫秒数 # %c 输出打印语句所属的类的全名 # %t 输出产生该日志的线程全名 # %d 输出服务器当前时间,默认为 ISO8601,也可以指定格式,如:%d{yyyy年MM月dd日 HH:mm:ss} # %l 输出日志时间发生的位置,包括类名、线程、及在代码中的行数。如:Test.main(Test.java:10) # %F 输出日志消息产生时所在的文件名称 # %L 输出代码中的行号 # %% 输出一个 "%" 字符 # 日志文件输出的 appender 对象 log4j.appender.file = org.apache.log4j.FileAppender # 指定消息格式 layout log4j.appender.file.layout = org.apache.log4j.PatternLayout # 指定消息格式的内容 log4j.appender.file.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n # 指定日志文件保存路径 log4j.appender.file.file = /logs/log4j.log # 指定日志文件的字符集 log4j.appender.file.encoding = UTF-8 # 按照文件大小拆分的 appender 对象 # 日志文件输出的 appender 对象 log4j.appender.rollingFile = org.apache.log4j.RollingFileAppender # 指定消息格式 layout log4j.appender.rollingFile.layout = org.apache.log4j.PatternLayout # 指定消息格式的内容 log4j.appender.rollingFile.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n # 指定日志文件保存路径 log4j.appender.rollingFile.file = /logs/log4j.log # 指定日志文件的字符集 log4j.appender.rollingFile.encoding = UTF-8 # 指定日志文件内容的大小 log4j.appender.rollingFile.maxFileSize = 1MB # 指定日志文件的数量 log4j.appender.rollingFile.maxBackupIndex = 10 # 按照时间规则拆分的 appender 对象 log4j.appender.dailyFile = org.apache.log4j.DailyRollingFileAppender # 指定消息格式 layout log4j.appender.dailyFile.layout = org.apache.log4j.PatternLayout # 指定消息格式的内容 log4j.appender.dailyFile.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n # 指定日志文件保存路径 log4j.appender.dailyFile.file = /logs/log433j.log # 指定日志文件的字符集 log4j.appender.dailyFile.encoding = UTF-8 # 指定日期拆分规则 log4j.appender.dailyFile.datePattern = '.'yyyy-MM-dd
测试代码
// 快速入门 @Test public void testQuick1() throws Exception { // 开启 log4j 内置日志记录 LogLog.setInternalDebugging(true); // 初始化配置信息,在入门案例中暂不使用配置文件 BasicConfigurator.configure(); // 获取日志记录器对象 Logger logger = Logger.getLogger(Log4jTest.class); // 日志记录输出 logger.info("hello log4j"); for (int i = 0; i < 10000; i++) { // 日志级别 logger.fatal("fatal"); // 严重错误,一般会造成系统崩溃并终止运行 logger.error("error"); // 错误信息,不会影响系统运行 logger.warn("warn"); // 警告信息,可能会发生问题 logger.info("info"); // 运行信息,数据连接、网络连接、IO 操作等等 logger.debug("debug"); // 调试信息,一般在开发中使用,记录程序变量参数传递信息等等 logger.trace("trace"); // 追踪信息,记录程序所有的流程信息 } // 再创建一个日志记录器对象 // Logger logger1 = Logger.getLogger(Logger.class); // logger1.fatal("fatal logger1"); // 严重错误,一般会造成系统崩溃并终止运行 // logger1.error("error logger1"); // 错误信息,不会影响系统运行 // logger1.warn("warn logger1"); // 警告信息,可能会发生问题 // logger1.info("info logger1"); // 运行信息,数据连接、网络连接、IO 操作等等 // logger1.debug("debug logger1"); // 调试信息,一般在开发中使用,记录程序变量参数传递信息等等 // logger1.trace("trace logger1"); // 追踪信息,记录程序所有的流程信息 }
数据库:
#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('itcast','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')
CREATE TABLE `log` ( `log_id` int(11) NOT NULL AUTO_INCREMENT, `project_name` varchar(255) DEFAULT NULL COMMENT '目项名', `create_date` varchar(255) DEFAULT NULL COMMENT '创建时间', `level` varchar(255) DEFAULT NULL COMMENT '优先级', `category` varchar(255) DEFAULT NULL COMMENT '所在类的全名', `file_name` varchar(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ', `thread_name` varchar(255) DEFAULT NULL COMMENT '日志事件的线程名', `line` varchar(255) DEFAULT NULL COMMENT '号行', `all_category` varchar(255) DEFAULT NULL COMMENT '日志事件的发生位置', `message` varchar(4000) DEFAULT NULL COMMENT '输出代码中指定的消息', PRIMARY KEY (`log_id`) );
自定义Logger
# 指定 RootLogger 顶级父元素默认配置信息 # 指定日志级别=trace,使用的 apeender 为=console log4j.rootLogger = trace # 自定义 logger 对象设置 log4j.logger.com.topcheer = info,console log4j.logger.org.apache = error,file
@Test public void testCustomLogger() throws Exception { // 自定义 com.topcheer Logger logger1 = Logger.getLogger(Log4jTest.class); logger1.fatal("fatal"); // 严重错误,一般会造成系统崩溃和终止运行 logger1.error("error"); // 错误信息,但不会影响系统运行 logger1.warn("warn"); // 警告信息,可能会发生问题 logger1.info("info"); // 程序运行信息,数据库的连接、网络、IO操作等 logger1.debug("debug"); // 调试信息,一般在开发阶段使用,记录程序的变量、参数等 logger1.trace("trace"); // 追踪信息,记录程序的所有流程信息 // 自定义 org.apache Logger logger2 = Logger.getLogger(Logger.class); logger2.fatal("fatal logger2"); // 严重错误,一般会造成系统崩溃和终止运行 logger2.error("error logger2"); // 错误信息,但不会影响系统运行 logger2.warn("warn logger2"); // 警告信息,可能会发生问题 logger2.info("info logger2"); // 程序运行信息,数据库的连接、网络、IO操作等 logger2.debug("debug logger2"); // 调试信息,一般在开发阶段使用,记录程序的变量、参数等 logger2.trace("trace logger2"); // 追踪信息,记录程序的所有流程信息 }
查看结果:
[FATAL ]0 com.topcheer.log4j.Log4jTest.testCustomLogger(Log4jTest.java:73) 2020-02-20 16:58:50.163 fatal [ERROR ]3 com.topcheer.log4j.Log4jTest.testCustomLogger(Log4jTest.java:74) 2020-02-20 16:58:50.166 error [WARN ]3 com.topcheer.log4j.Log4jTest.testCustomLogger(Log4jTest.java:75) 2020-02-20 16:58:50.166 warn [INFO ]3 com.topcheer.log4j.Log4jTest.testCustomLogger(Log4jTest.java:76) 2020-02-20 16:58:50.166 info