LOG4J
Log4j是Apache下的一款开源的日志框架,通过在项目中使用 Log4J,我们可以控制日志信息输出到控 制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式,通过定义日志的输出级别,可以 更灵活的控制日志的输出过程。方便项目的调试。
官方网站: http://logging.apache.org/log4j/1.2/
案例演示
添加pom.xml
文件
<dependencies>
<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>
</dependencies>
测试方法
@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");
logger.debug("debug");
logger.trace("trace");
}
使用配置文件
在org.apache.log4j.LogManager
中,定义了默认的配置文件的命名log4j.properties
,log4j.xml
等
static public final String DEFAULT_CONFIGURATION_FILE = "log4j.properties";
static final String DEFAULT_XML_CONFIGURATION_FILE = "log4j.xml";
static final public String DEFAULT_CONFIGURATION_KEY="log4j.configuration";
static final public String CONFIGURATOR_CLASS_KEY="log4j.configuratorClass";
public static final String DEFAULT_INIT_OVERRIDE_KEY = "log4j.defaultInitOverride";
我们使用log4j.properties
,在resource
下创建文件
#日志的级别和输出端
log4j.rootLogger = trace,console
#控制台输出配置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.layout = org.apache.log4j.SimpleLayout
测试类
@Test
public void testConfig() throws Exception {
Logger logger = Logger.getLogger(Log4jTest.class);
logger.info("hello log4j");
logger.fatal("fatal");
logger.error("error");
logger.warn("warn");
logger.info("info");
logger.debug("debug");
logger.trace("trace");
}
日志的级别
日志级别从高到低分为
- fatal:指出每个严重的错误事件将会导致应用程序的退出。
- error:指出虽然发生错误事件,但仍然不影响系统的继续运行。
- warn:表明会出现潜在的错误情形。
- info:一般和在粗粒度级别上,强调应用程序的运行全程。
- debug:一般用于细粒度级别上,对调试应用程序非常有帮助。
- trace:是程序追踪,可以用于输出程序运行中的变量,显示执行的流程。
还有两个特殊的级别:
- OFF:可用来关闭日志记录
- ALL:启用所有消息的日志记录
注:一般只使用4个级别,优先级从高到低为ERROR>WARN>INFO>DEBUG
log4j组件
Log4J 主要由 Loggers (日志记录器)、Appenders(输出端)和 Layout(日志格式化器)组成。
- Loggers 控制日志的输出级别与日志是否输出
- Appenders 指定日志的输出方式(输出到控制台、文件 等)
- Layout 控制日志信息的输出格式。
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()
方法获取。
Appenders
Appender 用来指定日志输出到哪个地方,可以同时指定日志的输出目的地。Log4j 常用的输出目的地 有以下几种:
输出端类型 | 作用 |
---|
ConsoleAppender | 将日志输出到控制台 |
FileAppender | 将日志输出到文件中 |
DailyRollingFileAppender | 将日志输出到一个日志文件,并且每天输出到一个新的文件 |
RollingFileAppender | 将日志信息输出到一个日志文件,并且制定文件的尺寸,当文件大小达到制定尺寸时,会自动把文件改名,同时产生一个新的文件 |
JDBCAppender | 把日志信息保存到数据库中 |
Layouts
布局器 Layouts用于控制日志输出内容的格式,让我们可以使用各种需要的格式输出日志。Log4j常用的Layouts:
格式化器类型 | 作用 |
---|
HTMLLayout | 格式化日志输出为HTML表格形式 |
SimpleLayout | 简单的日志输出格式化,打印的日志格式为(info - message) |
PatternLayout | 最强大的格式化期,可以根据自定义格式输出日志,如果没有指定转换格式,就是用默认的转换格式 |
Layout的格式
在 log4j.properties 配置文件中,我们定义了日志输出级别与输出端,在输出端中分别配置日志的输出 格式。
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 输出代码中的行号 %% 输出一个 "%" 字符
可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如:
%5c 输出category名称,最小宽度是5,category<5,默认的情况下右对齐
%-5c 输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格
%.5c 输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不会有空格
%20.30c category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉
Appender的输出
控制台
在log4j.appender.Console=org.apache.log4j.ConsoleAppender
这个配置中,log4j.appender.Console
的Console
就是输出端的名字
#指定日志的输出级别与输出端
log4j.rootLogger=INFO,Console
# 控制台输出配置 log4j.appender.Console 的Console就是名字,对应上面的Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
文件输出
#指定日志的输出级别与输出端
log4j.rootLogger=INFO,A
# 文件输出配置
log4j.appender.A=org.apache.log4j.DailyRollingFileAppender
#指定日志的输出路径
log4j.appender.A.File=/Users/machoul/IdeaProjects/machoul-log-test/machoul-log4j-test/logger/logger.log
log4j.appender.A.Append=true
#使用自定义日志格式化器
log4j.appender.A.layout=org.apache.log4j.PatternLayout
#指定日志的输出格式
log4j.appender.A.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
#指定日志的文件编码
log4j.appender.A.encoding=UTF-8
数据库
#指定日志的输出级别与输出端
log4j.rootLogger=INFO,logDB
#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://172.16.140.130:3306/machoul_common_test
log4j.appender.logDB.User=machoul
log4j.appender.logDB.Password=machoul
log4j.appender.logDB.Sql=INSERT INTO sys_log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('pro-service-name','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')
需要添加mysql的驱动
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.30</version>
</dependency>
另外建表语句
CREATE TABLE `sys_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
修改配置
#指定日志的输出级别与输出端
#log4j.rootLogger=INFO,Console
# 自定义Logger
log4j.logger.com.machoul = info,A,Console
log4j.logger.org.apache = error,logDB,Console
添加测试类
@Test
public void testCustomLogger(){
Logger logger1 = Logger.getLogger(Log4jTest.class);
logger1.fatal("fatal");
logger1.error("error");
logger1.warn("warn");
logger1.info("info");
logger1.debug("debug");
logger1.trace("trace");
Logger logger2 = Logger.getLogger(Logger.class);
logger2.fatal("fatal");
logger2.error("error");
logger2.warn("warn");
logger2.info("info");
logger2.debug("debug");
logger2.trace("trace");
}
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)