Log4j是apache公司开发的一款日志管理系统,可以高效的管理系统中出现的BUG或者各种信息,并且可以已文本的方式或者数据库存入的方式来记录数据
第一步:导入依赖
在pom.xml中导入Log4j依赖
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
第二步:创建数据库
create table error
(
Id int not null AUTO_INCREMENT Primary Key comment '主键id',
Log_Level varchar(100) not null comment '日志级别',
Log_Message varchar(500) not null comment '日志信息',
Log_Tim datetime DEFAULT CURRENT_TIMESTAMP comment '日志时间'
) engine = innodb
default charset = utf8;
第三步:配置log4j.properties配置文件
在Resources文件夹下创建一个log4j.properties文件
编写配置文件
# log4j 日志系统: 将日志内容插入到数据库
log4j.rootLogger=DEBUG, DB, console
# 指定Appender输出端
log4j.appender.DB=org.apache.log4j.jdbc.JDBCAppender
# 指定数据库连接池
log4j.appender.DB.URL=jdbc:mysql://localhost:3306/data
# 指定数据库驱动(注意区分5.7与8.0)
log4j.appender.DB.driver=com.mysql.cj.jdbc.Driver
# 指定数据库用户名
log4j.appender.DB.user=root
# 指定数据库密码
log4j.appender.DB.password=super197458A#
# 指定数据库SQL语句
log4j.appender.DB.sql=INSERT INTO errormessage(Log_Level,Log_Message) VALUES('%p','%m')
# 指定Layout日志格格式化器
log4j.appender.DB.layout=org.apache.log4j.PatternLayout
# 将日志输出到控制台
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}]-[%t]-[%F:%L]-[%p]-[%c]-%m%n
log4j.appender.console.encoding=UTF-8
第四步:在程序代码中将出现的BUG存入数据库
这是个测试类
package com.example.userinfoserver;
import org.apache.log4j.Logger;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class UserInfoServerApplicationTests {
// 导入Logger类
private static Logger logger = Logger.getLogger(UserInfoServerApplicationTests.class);
@Test
void TestDemo01() {
// 将把数据提报,并且存入数据库
logger.error("这是一个示例BUG");
}
}
运行测试类
控制台输出
数据库记录的数据
可以看见,控制台和数据库表中都记录了自己定义的错误提示
附带参数说明
日志级别
Log4J 在 org.apache.log4j.Level 类中定义了OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL七种日志级别:
日志级别 | 参数说明 |
---|---|
OFF | 最高日志级别,关闭左右日志 |
FATAL | 将会导致应用程序退出的错误 |
ERROR | 发生错误事件,但仍不影响系统的继续运行 |
WARN | 警告,即潜在的错误情形 |
INFO | 一般和在粗粒度级别上,强调应用程序的运行全程 |
DEBUG | 一般用于细粒度级别上,对调试应用程序非常有帮助 |
ALL | 最低等级,打开所有日志记录 |
注:一般只使用4个级别,优先级从高到低为 ERROR > WARN > INFO > DEBUG
Appender(输出端)
Appender 用来指定日志输出到哪个地方,可以同时指定日志的输出目的地。Log4j 常用的输出目的地有以下几种:
输出端类型 | 作用 |
---|---|
ConsoleAppender | 将日志输出到控制台 |
FileAppender | 将日志输出到文件中 |
DailyRollingFileAppender | 将日志输出到一个日志文件,并且每天输出到一个新的文件 |
RollingFileAppender | 将日志信息输出到一个日志文件,并且指定文件的尺寸,当文件大 小达到指定尺寸时,会自动把文件改名,同时产生一个新的文件 |
JDBCAppender | 把日志信息保存到数据库中 |
Layout(日志格式化器)
格式化器类型 | 作用 |
---|---|
HTMLLayout | 格式化日志输出为HTML表格形式 |
SimpleLayout | 简单的日志输出格式化,打印的日志格式为(info - message) |
PatternLayout | 最强大的格式化期,可以根据自定义格式输出日志,如果没有指定转换格式,就是用默认的转换格式 |
日志的输出格式
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 输出代码中的行号
%x 输出和当前线程相关的 NDC(嵌套诊断环境)
%% 输出一个 "%" 字符
可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如:
%5c 输出category名称,最小宽度是5,category<5,默认的情况下右对齐
%-5c 输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格
%.5c 输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不会有空格
%20.30c category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉