log4j2 pattern详解

最新推荐文章于 2024-08-24 02:28:15 发布
最新推荐文章于 2024-08-24 02:28:15 发布
阅读量1.4w 收藏 17
点赞数 4
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yu870646595/article/details/88743033
版权 
				版权声明：本文为博主http://blog.csdn.net/zhu19774279原创文章，未经博主允许不得转载。					https://blog.csdn.net/zhu19774279/article/details/41577415				</div>
							            <link rel="stylesheet" href="https://csdnimg.cn/release/phoenix/template/css/ck_htmledit_views-f57960eb32.css">
					<div class="htmledit_views" id="content_views">

首先声明本文并不教您怎么用log4j2，仅仅只对<PatternLayout>子节点进行说明。

要看懂本文需要对log4j2有一定的了解，至少能够知道<Appenders>、<Layouts>和<Loggers>的区别。

本文主要参考对象为log4j2官方手册：《Apache Log4j 2 v. 2.1 User's Guide》，但是鉴于官方手册的不少细节描述得并不是非常清楚，甚至还有错误，所以还希望大家自己多试验，毕竟如果官方文档有错误或写得不清楚，我也没办法。

---------------------------------------------这是一条分割线，以下是正文---------------------------------------------------

PatternLayout是最重要也是最常用的控制输出内容的节点，包括类名、时间、行号、日志级别、序号等都可以控制，同时还可以指定日志格式，可以使用正则表达式处理输出结果。

PatternLayout中包含的特殊字符包括\t,\n,\r,\f，用\\输出单斜线，用%%输出%。

下面是PatternLayout的参数

Parameter Name

Type

Description

charset

String

输出的字符集。如果没有指定，则使用系统默认的字符集输出。

pattern

String

 详见后面的pattern的表格

replace

RegexReplacement

替换部分输出中的String。这将会调用一个与RegexReplacement转换器相同的函数，不同的是这是针对整个消息的。

alwaysWriteExceptions

boolean

默认为true。总是输出异常，即使没有定义异常对应的pattern，也会被附在所有pattern的最后。设为false则不会输出异常。

header

String

可选项。包含在每个日志文件的顶部。

footer

String

可选项。包含在每个日志文件的尾部。

noConsoleNoAnsi

boolean

默认为false。如果为true，且System.console()是null，则不会输出ANSI转义码。


下面RegexReplacement参数

Parameter Name

Type

Description

regex

String

Java正则表达式

replacement

String

任何匹配正则规则，被正则替换的后值


下面是pattern属性具体描述（这个表格仅包括了我能看懂的部分，还有很多看不懂并且试验也不成功的部分我都没写。另外用于控制输出结果颜色的highlight和style我也没有写，实在是感觉平时意义不大）：

参数名

参数意义

详细描述

%c{参数}或%logger{参数}

输出logger的名称，即语句private static final Logger logger = LogManager.getLogger(App.class.getName())中App.class.getName()的值。也可以使用其他字符串。

如果不带参数，则输出完整的logger名称；如果参数是整数n（只支持正整数），则先将logger名称依照小数点(.)分割成n段，然后取右侧的n段；如果参数不是整数，则除了最右侧的一段，其他整段字符都用这个字符代替，保留小数点；不管怎么写，最右侧的一段都保持不变。默认不带参数，并输出logger的完整名称。注意：上面的说明写得很烂，但是官方文档写得就这么烂，而且还不完整，看不懂是必然的，还请看官自己多试验，才能有所领会。如果看官自己懒得试验又看不懂，只能建议不要加参数，直接%c输出完整值。

示例：

pattern表达式

logger名称

结果

%c{1}

org.apache.com.te.Foo

Foo

%c{2}

org.apache.com.te.Foo

te.Foo

%c{1.}

org.apache.com.te.Foo

o.a.c.t.Foo

%c{1.1.!}

org.apache.com.te.Foo

o.a.!.!.Foo

%c{.}

org.apache.com.te.Foo

….Foo

%C{参数}或%class{参数}

输出类名。注意，这个是大写C，上面是小写c。

参数规则与%c完全一样，请参见上面的说明。

%d{参数}{时区te{参数}{时区

输出时间。

第一个大括号数可以是保留关键字，也可以是text.SimpleDateFormat字符拼接而成。保留关键字有：DEFAULT,ABSOLUTE, COMPACT, DATE, ISO8601, ISO8601_BASIC。

第二个大括号中的参数是java.util.TimeZone.getTimeZone的值，可以设定时区。

示例：

pattern表达式

输出

%d{DEFAULT}

2012-11-02 14:34:02,781

%d{ISO8601}

2012-11-02T14:34:02,781

%d{ISO8601_BASIC}

20121102T143402,781

%d{ABSOLUTE}

14:34:02,781

%d{DATE}

02 Nov 2012

14:34:02,781

%d{COMPACT}

20121102143402781

%d{HH:mm:ss,SSS}

14:34:02,781

%d{dd MMM yyyy HH:mm:ss,SSS}

02 Nov 2012

14:34:02,781

%d{HH:mm:ss}{GMT+0}

18:34:02

%d{UNIX}

1351866842

%d{UNIX_MILLIS}

1351866842781

无

输出特殊字符

&, <, >, ”, ’全都要使用实体名称或实体编号替代，即

符号

实体名称

实体编号

&

&

&

< 

<

<

> 

>

>

“

"

"

‘

'

'

官方文档说pattern删除了\r和\n，但是经我测试可以使用，明显是官方文档的错误。

%F|%file

输出文件名

仅仅是文件名称，如Test.java，不包含路径名称

highlight{pattern}{style}

高亮显示结果

 

%l

输出完整的错误位置，如com.future.ourfuture.test.test.App.tt(App.java:13)

注意1：这个是小写的L。

注意2：使用该参数会影影响日志输出的性能。

%L

输出错误行号，如“13”

注意：使用该参数会影响日志输出的性能。

%m或%msg或%message

输出错误信息，即logger.error(String msg)中的msg

 

%M或%method

输出方法名，如“main”，“getMsg”等字符串

 

%n

换行符

根据系统自行决定，如Windows是”\r\n”，Linux是”\n”

%level{参数1}{参数2}{参数3}

参数1用来替换日志信息的级别，格式为：{level=label, level=label, …}，即使用label代替的字符串替换level。其中level为日志的级别，如WARN/DEBUG/ERROR/TRACE/INFO

参数2表示只保留前n个字符。格式为length=n，n为整型。但参数1中指定了label的字符串不受此参数限制

参数3表示结果是大写还是小写。参数1指定了label的字符串不受此参数限制。

示例：

输入

输出

%level{WARN=W, DEBUG=D, ERROR=E, TRACE=T, INFO=I}

logger.warn输出W, logger.debug输出D，其他依次类推

%level{ERROR=FSF, length=2, lowerCase=true}

logger.error会输出FSF，其他均只输出前两个字母，且小写，如wa/de/in/tr

%level{length=3}

所有都只输出前3个字符，如WAR/DEB /ERR/TRA/INF

%r或%relative

输出自JVM启动以来到log事件开始时的毫秒数

 

replace{pattern}{regex}{substitution}

将pattern的输出结果，按照正则表达式regex匹配后，使用substitution字符串替换

例如："%replace{%logger }{\.}{/}就是将所有%logger中的小数点(.)全部替换为斜杠，如果%logger是com.future.ourfuture.test.test.App则输出为com/future/ourfuture/test/test/App。pattern中可以写多个表达式，如%replace{%logger%msg%C}{\.}{/}%n

%sn或%sequenceNumber

自增序号，每执行一次log事件，序号+1，是一个static变量。

 

%t或%thread

创建logging事件的线程名

 

%u{RANDOM|TIME}或%uuid{RANDOM|TIME}

依照一个随机数或当前机器的MAC和时间戳来随机生成一个UUID

 

下面是pattern的对齐修饰：

对齐修饰，可以指定信息的输出格式，如是否左对齐，是否留空格等。

编写格式为在任何pattern和%之间加入一个小数，可以是正数，也可以是负数。如%10.20c表示对logger的信息进行处理。%-10.20m表示对message进行处理。

整数表示右对齐，负数表示左对齐；整数位表示输出信息的最小10个字符，如果输出信息不够10个字符，将用空格补齐；小数位表示输出信息的最大字符数，如果超过20个字符，则只保留最后20个字符的信息（注意：保留的是后20个字符，而不是前20个字符）。

下面是一些示例。

格式

是否左对齐

最小宽度

最大宽度

说明

%20

右对齐

20

无

右对齐，不足20个字符则在信息前面用空格补足，超过20个字符则保留原信息

%-20

左对齐

20

无

左对齐，不足20个字符则在信息后面用空格补足，超过20个字符则保留原信息

%.30

不对齐

无

30

如果信息超过30个字符，则只保留最后30个字符

%20.30

右对齐

20

30

右对齐，不足20个字符则在信息前面用空格补足，超过30个字符则只保留最后30个字符

%-20.30

左对齐

20

30

左对齐，不足20个字符则在信息后面用空格补足，超过30个字符则只保留最后30个字符



情非得已1991
关注
专栏目录
spring-boot-starter-log4j2
09-25
四、Log4j2配置详解 1. 日志级别：Log4j2支持TRACE、DEBUG、INFO、WARN、ERROR、FATAL和OFF七个级别。通过配置文件，可以设置全局日志级别，也可以针对特定类或包设置不同级别。 2. Appenders：Appender是日志输出...
vim ctags学习笔记
雪夜的博客
10-19 260
vim ctags安装ctagstags文件生成tags文件导入tags文件ctags使用在vim命令行模式下在vim普通模式下针对多个项目的tags设置 安装ctags 解压：#tar xvf ctags-xx.tar.gz 配置Makefle: ./configure 编译&安装：#make & make install tags文件 tags文件包含了用#define定义的宏、函数的定义和声明、变量、类、结构体、枚举、联合及其成员变量及函数 tags文件没有包含函数使用信息，
log4j2<PatternLayout>子节点浅析
zhu19774279的专栏
11-28 1万+
首先声明本文并不教您怎么用log4j2，仅仅只对子节点进行说明。 要看懂本文需要对log4j2有一定的了解，至少能够知道、和的区别。 本文主要参考对象为log4j2官方手册：《Apache Log4j 2 v. 2.1 User's Guide》，但是鉴于官方手册的不少细节描述得并不是非常清楚，甚至还有错误，所以还希望大家自己多试验，毕竟如果官方文档有错误或写得不清楚，我也没办法。 ----
【log4j2】springboot使用log4j2详细配置
最新发布
weixin_41378047的博客
08-24 351
本文主要讲解：1、一个日志配置文件如何拆分2、不同服务的日志如何划分3、日志如何滚动4、日志过期策略5、异步日志1、日志拆分日志配置文件拆分,例如以下完整的日志配置文件 登录后复制 <?xml version="1.0" encoding="UTF-8"?> <configuration status...
Log4j2进阶使用(Pattern Layout详细设置)
BigManing的博客
09-14 4853
1.进阶说明 通过配置Layout打印格式化的日志， Log4j2支持很多的Layouts： CSV GELF HTML JSON Pattern Serialized Syslog XML YAML 本文仅介绍Pattern Layouts的详细使用。 本文基于Log4j2基本使用入门。 请先参考上面的基本使用入门。 2.Pattern Layouts Pattern Layouts是一个灵活的布局， 是最常用的日志格式配置。 该类的目标是格式化一个日志事件并返回结果， 结果的格式取决于转换模式。 转换模
Log4j2的PatternLayout详解
张紫娃的博客
01-30 1631
是一种布局策略（Layout），用于定义日志消息的输出格式。
3、log4j2的pattern
weixin_43472934的博客
01-16 515
%d{HH:mm:ss.SSS} ，表示输出到毫秒的时间 %t，输出当前线程名称 %-5level，输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0 %logger，输出logger名称，因为Root Logger没有名称，所以没有输出 %msg，日志文本 %n，换行 %F，输出所在的类文件名，如Client.java %L，输出行号 %M，输出所在方法名 %l，输出语句所在的行数, 包括类名、方法名、文件名、行数 ...
log4j2入门（三） PatternLayout输出格式详解
热门推荐
09-22 3万+
摘要 本节介绍Log4j的输出格式的详细说明1、PatternLayout参数charset ##指定字符集 pattern ##指定格式 alwaysWriteExceptions ##默认为true，输出异常 header ##可选项。包含在每个日志文件的顶部 footer ##可选项。包含在每个日志文件的尾部。2、pattern属性参数格式描述######### 常见参数 #########
log4j2动态修改日志级别及拓展性使用详解
08-26
log4j2动态修改日志级别及拓展性使用详解 log4j2是一个流行的Java日志记录库，提供了许多强大的功能，包括动态修改日志级别和拓展性使用。下面将详细介绍log4j2动态修改日志级别及拓展性使用。 一、log4j2动态修改...
SpringBoot框架配置log4j和log4j2的配置代码
11-29
Log4j和Log4j2是两种广泛使用的Java日志框架，它们提供了灵活的日志配置和高性能的日志处理能力。本文将详细介绍如何在SpringBoot项目中配置Log4j和Log4j2。 ### SpringBoot与Log4j Log4j是Apache的一个开源项目，...
Spring Boot Log4j2的配置使用详解
08-30
Spring Boot Log4j2 的配置使用详解 本文主要介绍了 Spring Boot 中 Log4j2 的配置使用详解，包括 Log4j2 的导入、配置文件的创建、 appenders 的配置等内容。 Log4j2 简介 Log4j2 是 Apache Log4j 的升级版本，...
log4j2demo
12-03
**日志框架Log4j2详解** 在Java开发中，日志记录是不可或缺的一部分，它帮助开发者追踪程序运行状态、定位错误和调试代码。Log4j2是Apache组织推出的一个强大的、灵活的日志记录框架，它是Log4j的升级版，提供了更...
记录一次配置log4j2中PatternLayout的pattern模版含义
ore_fila的博客
12-07 813
这里的value【%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%logger{50}:%L] [%X{X-B3-TraceId},%X{X-B3-SpanId}] - %msg%n】含义具体如下。${LOG_PATTERN}为自定义的变量，在项目中的配置如下。在appenders中配置控制台输出格式，增加了过滤内容。前提：当在配置log4j2时，需要配置输出日志的格式。
Log4j2 之Patterns配置
weixin_30840253的博客
10-22 1274
Log4j2 之Patterns配置 参见https://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout PatternLayout Parameters Parameter NameTypeDescription charset String The character set to ...
Log4j 2.x--Pattern Layout配置详解及示例
penriver的博客
05-08 9002
目前大部分项目都是使用slf4j+log4j作为日志框架 Pattern Layouts是一个灵活的布局，是最常用的日志格式配置。本文针对Pattern Layout中的pattern string的常见配置进行梳理 目录 1. 简单示例 1.1. 配置 1.2. 日志输出 1.3. 配置解释 1.3. 测试代码 2.PatternLayout参数 2.1 c{precision} 2.2. %d{pattern} 2.3. 格式对齐 2.4L和l属性的区别 参考 1. 简单..
Log4j输出格式控制--log4j的PatternLayout参数含义以及详细配置
学习 记录 总结 分享
06-25 1111
https://blog.csdn.net/hello_word2/article/details/79295344 列了这么多，举几个实际的例子吧，比如log4j.properties的内容为： 那么一个可能的输出是：12 Oct 2005 22:23:30,117 0 [main] INFO MyApp - Entering application.…… 12 Oct 2005 22:23:30,162 45 [main] INFO MyApp - Exiting application.摘自：http
log4j2通过PatternLayout参数实现日志敏感字段脱敏
无名丶任性
07-13 4089
1、首先了解一下 正则表达式：.*，.*?，.+?的匹配方式 public static void main(String[] args) { String content ="hello world"; String param1 = ".*"; String param2 = "hell.*?o"; String param3 = "hel.+?l"; Pattern p1 = Pattern.compile(para
J2SE - Log4j日志Pattern配置说明
袭冷
01-10 1220
一、日志格式 log4j.appender.logfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%15.15t] %36.36c:%-4.4L - %m%n %d{yyyy-MM-dd HH:mm:ss.SSS} ：指定日期的格式 %5p ：指定日志级别最小宽度为5且右对齐(不足时左补空) ...
log4j2.properties配置详解
06-28
### 回答1： log4j2.properties是log4j2日志框架的配置文件，用于配置日志输出的格式、级别、目的地等信息。以下是log4j2.properties配置文件的详解： 1. 配置日志输出的级别 log4j2.rootLogger.level=INFO 这行代码表示设置根日志记录器的级别为INFO，即只输出INFO级别及以上的日志信息。可以根据需要设置为DEBUG、WARN、ERROR等级别。 2. 配置日志输出的目的地 log4j2.appender.console.type=Console log4j2.appender.console.name=STDOUT log4j2.appender.console.layout.type=PatternLayout log4j2.appender.console.layout.pattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n 这几行代码表示将日志输出到控制台，输出格式为时间、线程、级别、类名、日志信息。可以根据需要将日志输出到文件、数据库等目的地。 3. 配置日志输出的格式 log4j2.appender.console.layout.pattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n 这行代码表示设置日志输出的格式为时间、线程、级别、类名、日志信息。可以根据需要自定义日志输出的格式。 4. 配置日志输出的文件名和路径 log4j2.appender.file.type=File log4j2.appender.file.name=FILE log4j2.appender.file.fileName=logs/app.log log4j2.appender.file.layout.type=PatternLayout log4j2.appender.file.layout.pattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n 这几行代码表示将日志输出到文件logs/app.log中，输出格式为时间、线程、级别、类名、日志信息。可以根据需要自定义日志输出的文件名和路径。 5. 配置日志的滚动策略 log4j2.appender.file.type=RollingFile log4j2.appender.file.name=FILE log4j2.appender.file.fileName=logs/app.log log4j2.appender.file.filePattern=logs/app-%d{yyyy-MM-dd}.log log4j2.appender.file.layout.type=PatternLayout log4j2.appender.file.layout.pattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n log4j2.appender.file.policies.type=Policies log4j2.appender.file.policies.time.type=TimeBasedTriggeringPolicy log4j2.appender.file.policies.time.interval=1 这几行代码表示配置日志的滚动策略为按时间滚动，每天生成一个新的日志文件。可以根据需要配置按文件大小滚动等策略。 以上是log4j2.properties配置文件的详解，可以根据需要自定义配置文件来满足日志输出的需求。 ### 回答2： log4j2是一个帮助开发者记录和排查问题的Java日志组件。它使用配置文件来记录不同级别日志，通过配置的不同级别可以把日志信息输出到不同的位置，方便对代码进行调试和日志分析。log4j2的配置文件是log4j2.properties，下面详细讲解该配置文件的各个属性。 1.日志级别： log4j2.properties配置文件中，我们可以通过设置不同级别（trace,debug,info,warn,error,fatal）来记录不同情况下产生的日志信息。默认情况下，log4j2只会记录warn以上级别的日志信息。 2.日志输出位置： 指定日志输出的位置，可以输出到控制台、文件、Redis等位置。输出到文件需要指定文件名称和路径，这样可以便于管理和分析，同时在日志数量较多时也可以有效减小文件尺寸。 3.日志信息格式： 日志信息格式主要包括时间、线程、日志级别、类名和日志信息等方面。在log4j2.properties配置文件中，我们可以通过指定输出格式化模板来实现自定义输出格式，同时还可以添加特定的信息，如调用者信息，来便于排查问题。 4.日志信息输出策略： 在配置文件中，我们也可以设置日志输出策略来控制日志信息的输出频率和大小，包括指定日志文件个数、日志文件大小、日志滚动周期、压缩文件等。 总之，在配置log4j2.properties配置文件时，需要根据具体情况设置不同的日志级别、输出位置、信息格式等内容，从而更好地记录和分析日志，有效地定位问题并优化代码性能。 ### 回答3： log4j2.properties是log4j2日志框架的配置文件，可以通过该配置文件设置日志的输出等级、输出目的地、格式等内容。下面对log4j2.properties的配置进行详解。 1. 配置日志级别 通过设置日志级别，可以控制哪些日志需要输出，哪些不需要输出。log4j2支持的日志级别有：trace、debug、info、warn、error、fatal。 log4j2.rootLogger.level=info 该配置表示设置根日志的日志级别为info。 log4j2.logger.com.example=debug 该配置表示设置com.example包下的所有日志级别为debug。 2. 配置输出目的地 日志的输出目的地可以是控制台、文件、数据库等。下面分别介绍几种输出目的地的配置方式。 2.1 输出到控制台： log4j2.appender.console.type=Console log4j2.appender.console.name=STDOUT 以上两行配置表示将日志输出到控制台，其中type=Console表示输出类型为控制台，name=STDOUT表示输出方式为标准输出。 2.2 输出到文件： log4j2.appender.file.type=File log4j2.appender.file.name=File log4j2.appender.file.fileName=/logs/app.log log4j2.appender.file.layout.type=PatternLayout log4j2.appender.file.layout.pattern=%d{yyyy-MM-dd HH:mm:ss} %p [%t] %c{6} - %m%n 以上配置表示将日志输出到logs文件夹下的app.log文件中，layout.pattern用来设置输出的日志格式。 2.3 输出到数据库： log4j2.appender.db.type=JDBC log4j2.appender.db.name=DB log4j2.appender.db.tableName=t_logs log4j2.appender.db.columnList=logger,message log4j2.appender.db.username=root log4j2.appender.db.password=root log4j2.appender.db.driverClassName=com.mysql.jdbc.Driver log4j2.appender.db.url=jdbc:mysql://localhost:3306/test 以上配置表示将日志输出到数据库中。其中tableName表示日志表名，columnList表示要插入的列名，username和password表示数据库的用户名和密码，driverClassName表示数据库驱动名，url表示数据库连接地址。 3. 配置输出格式 可以通过PatternLayout的pattern属性来配置日志的输出格式。常用的格式符有： %d 输出日志日期时间 %p 输出日志级别 %c 输出日志器名称 %m 输出日志信息 %n 输出平台独立的换行符 %r 输出自应用启动到输出该log信息耗费的毫秒数 %t 输出产生该日志事件的线程名称 %L 输出产生该日志事件的代码处所在文件的行号 例如： log4j2.appender.console.layout.type=PatternLayout log4j2.appender.console.layout.pattern=%d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n 该配置表示输出日志的格式为：日期时间、日志级别、线程名、日志器名称、当前代码行号、日志信息。其中%-5p表示输出日志级别，占5个字符宽度，左对齐。%c{1}表示输出日志器名称，仅输出最后一个点后面的内容。%L表示输出当前代码所在行号。 以上就是log4j2.properties配置的详解。通过灵活配置该文件，可以实现灵活管理和控制日志输出的行为。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值