一,Log4j三个主要组件
Log4j有三个主要的组件/对象:
-
Loggers(记录器):日志类别
-
Appenders(输出源):日志要输出的地方
-
Layouts(布局):日志以何种形式输出
每条日志语句都要设置一个等级(DEUG、INFO、WARN、ERROR和FATAL),其中DEBUG<INFO<WARN<ERROR<FATAL
。fatal等级最高对应调试信息 一般信息 警告信息 错误信息 严重错误信息
。
1.1 Loggers
在设置日志输出位置的时候,会给那个位置设置一个级别,只有大于等于那个级别的日志才会打印输出到指定位置。 例如:某个Loggers(日志输出位置的等级记录器)级别设定为INFO,则INFO、WARN、ERROR和FATAL级别的日志信息都会输出到那个文件,而级别比INFO低的DEBUG则不会输。
1.2 Appenders
禁用和使用日志请求只是Log4j的基本功能,Log4j日志系统还提供许多强大的功能,比如允许把日志输出到不同的地方,如控制台 (Console)、文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。 常使用的类如下:
org.apache.log4j.ConsoleAppender
(控制台)org.apache.log4j.FileAppender
(文件)org.apache.log4j.DailyRollingFileAppender
(每天产生一个日志文件)org.apache.og4j.RollingFileAppender
(文件大小到达指定尺寸的时候产生一个新的文件)org.apache.log4j.WriterAppender
(将日志信息以流格式发送到任意指定的地方)
**基本上可以满足我们的日常需求,当然如果你的需求比较特殊,可以自己实现Appender输出路径。**只需要定义一个类,实现Appender接口就可以了。Appender接口中定义了一系列记录日志的方法,按照自己的规则实现这些方法即可
1.3 Layouts
用户可以根据自己的喜好格式化自己的日志输出,Layouts提供四种日志输出样式,如根据HTML样式、自由指定样式、包含日志级别与 信息的样式和包含日志时间、线程、类别等信泌的样式。 常使用的类如下:
org.apache.og4j.HTMLLayout
(以HTML表格形式布局)org.apache.log4j.PatternLayout
(可以灵活地指定布局模式)org.apache.log4j.SimpleLayout
(包含日志信息的级别和信息字符串)org.apache.log4j.TTCCLayout
(包含日志产生的时间、线程、类别等信息)
二,Log4j快速入门
在实际应用中,要使Log4j在系统中运行必须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。 Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties属性文件,配置文件详解在下面使用部分说明。
-
导包
<dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.14</version> </dependency>
-
创建配置文件:log4j.properties文件或logback.xml
将文件放到resources目录下
# 根目录设置-日志输出级别:debug,输出的位置:stout控制台,D文件 log4j.rootLogger=INFO, stdout,D ### 输出信息到控制台 ### log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.target=System.out # 使用指定格式输出 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n ### 输出到文件 ### log4j.appender.D=org.apache.log4j.FileAppender log4j.appender.D.File=./logs/log.log # 输出到文件是否可以追加 log4j.appender.D.Append=true # 日志级别 log4j.appender.D.Threshold=INFO # 使用指定格式输出 log4j.appender.D.layout=org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
-
在代码中使用Log4j
package com.ruoyi.springbootdemo; import org.apache.log4j.Logger; import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; @SpringBootTest class SpringBootDemoApplicationTests { @Test void test() { Logger logger = Logger.getLogger(SpringBootDemoApplicationTests.class); logger.info("info"); logger.debug("debug"); logger.error("error"); } }
三,配置文件详解
-
示例
log4j.rootLogger=INFO,A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
-
配置根目录语法
log4j.rootLogger=[日志级别],appender1的名字,appender2的名字...
-
配置日志信息输出目的地Appender
log4j.appender.appender的名字=appender的类型 log4j.appender.appender的名字.选项=值
Log4j提供的appender有:
-
org.apache.log4j.ConsoleAppender
:(控制台)控制台的选项有:
Threshold=WARN
:指定日志消息输出的最低层次ImmediateFlush=true
:默认true,意味着所有消息都会立即被输出Target=System.err
:默认情况是System.out,指定输出控制台
-
org.apache.log4j.FileAppender
(文件)文件的选项有:
Threshold=WARN
:指定日志消息输出的最低层次ImmediateFlush=true
:默认true,意味着所有消息都会立即被输出File=mylog.txt
:指定输出到my.log文件Append=false
:默认是true,即将消息追加到文件,false指将消息覆盖指定文件内容
-
org.apache.log4j.DailyRollingFileAppender
(每天产生一个日志文件)DailyRollingFileAppender选项:
-
Threshold=WARN
:指定日志消息输出的最低层次 -
ImmediateFlush=true
:默认true,意味着所有消息都会立即被输出 -
File=mylog.txt
:指定输出到my.log文件 -
Append=false
:默认是true,即将消息追加到文件,false指将消息覆盖指定文件内容 -
DatePattern
='.'yyyy-ww:每周生成一个新文件其他写法:
- '.'yyyy-MM:每月
- '.'yyyy-ww:每周
- '.'yyyy-MM-dd:每天
- '.'yyyy-MM-dd-a:每天两次
- '.'yyyy-MM-dd-HH:每小时
- '.'yyyy-MM-dd-HH-mm:每分钟
-
-
org.apache.og4j.RollingFileAppender
(文件大小到达指定尺寸的时候产生一个新的文件)RollingFileAppender选项:
-
Threshold=WARN
:指定日志消息输出的最低层次 -
ImmediateFlush=true
:默认true,意味着所有消息都会立即被输出 -
File=mylog.txt
:指定输出到my.log文件 -
Append=false
:默认是true,即将消息追加到文件,false指将消息覆盖指定文件内容 -
maxFileSize=100KB
,后缀可是KB,MB,GB.在日志大小达到该大小时,自动滚动,即将原来的内容移动到mylog.log.1文件 -
maxBackupIndex=2
:指定可产生的滚动文件的最大数量
-
-
配置日志信息的布局语法:
log4j.appender.appenderName.layout=布局类型 log4j.appender.appenderName.layout.ConversionPattern=输出格式语法
Log4j提供的Layout值有:
org.apache.log4j.HTMLLayout
(以HTML表格形式布局)org.apache.log4j.PatternLayout
(可以灵活地指定布局模式)org.apache.log4j.SimpleLayout
(包含日志信息的级别和信息字符串)org.apache.log4j.TTCCLayout
(包含日志产生的时间、线程、类别等信息)
-
输出格式设置
总结:编写配置文件流程
- 在根目录设置logger名
- 设置appender
- 设置输出格式layout
-