org.apache.log4j.Logger详解（转自http://blog.youkuaiyun.com/anlina_1984/article/details/5313023）

最新推荐文章于 2024-07-01 13:05:14 发布
转载 最新推荐文章于 2024-07-01 13:05:14 发布 · 1.9k 阅读 · 0

本文详细介绍了Log4j配置文件的设置方法，包括配置根Logger、Appender输出目的地及Layout格式化等内容，并提供了多种应用场景实例。

文章摘抄转自http://blog.youkuaiyun.com/anlina_1984/article/details/5313023

配置文件 log4j.properties:

 Log4j 支持两种配置文件格式，一种是 XML 格式的文件，一种是 Java 特性文件（键 = 值 properties 文件）

 1 ） . 配置根 Logger ，其语法为： 
　　 log4j.rootLogger = [ level ] , appenderName, appenderName, …
　　其中， level 是日志记录的优先级，分为 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL 或者您定义的级别。 Log4j 建议只使用四个级别 ，优先级从高到低分别是 ERROR 、 WARN 、 INFO 、 DEBUG 。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了 INFO 级别，则应用程序中所有 DEBUG 级别的日志信息将不被打印出来 。 appenderName 就是指 B 日志信息输出到哪个地方。您可以同时指定多个输出目的地。

 2 ）配置日志信息输出目的地 Appender ，其语法为： 
　　 log4j.appender.appenderName = fully.qualified.name.of.appender.class. 其中， Log4j 提供的 appender 有以下几种： 
　　        1.org.apache.log4j.ConsoleAppender （控制台）， 
　　        2.org.apache.log4j.FileAppender （文件）， 
　　        3.org.apache.log4j.DailyRollingFileAppender （每天产生一个日志文件）， 
　　        4.org.apache.log4j.RollingFileAppender （文件大小到达指定尺寸的时候产生一个    新的文件） 
　　        5.org.apache.log4j.WriterAppender （将日志信息以流格式发送到任意指定的地方）

3) . 配置日志信息的格式（布局），其语法为： 
　　 log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　其中， Log4j 提供的 layout 有以 e 几种： 
　　        1.org.apache.log4j.HTMLLayout （以 HTML 表格形式布局）， 
　　        2.org.apache.log4j.PatternLayout （可以灵活地指定布局模式）， 
　　        3.org.apache.log4j.SimpleLayout （包含日志信息的级别和信息字符串）， 
　　        4.org.apache.log4j.TTCCLayout （包含日志产生的时间、线程、类别等等信息） 
　　 Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息 
　　 %p 输出优先级，即 DEBUG ， INFO ， WARN ， ERROR ， FATAL
　　 %r 输出自应用启动到输出该 log 信息耗费的毫秒数 
　　 %c 输出所属的类目，通常就是所在类的全名 
　　 %t 输出产生该日志事件的线程名 
　　 %n 输出一个回车换行符， Windows 平台为 “rn” ， Unix 平台为 “n”
　　 %d 输出日志时间点的日期或时间，默认格式为 ISO8601 ，也可以在其后指定格式，比如： %d{yyy MMM dd HH:mm:ss,SSS} ，输出类似： 2002 年 10 月 18 日 22 ： 10 ： 28 ， 921
　　 %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)


 3 、配置日志信息输出目的地，其语法为： 
　　   log4j.appender.appenderName = fully.qualified.name.of.appender.class  //
　　   "fully.qualified.name.of.appender.class" 可以指定下面五个目的地中的一个： 
          1.org.apache.log4j.ConsoleAppender （控制台） 
          2.org.apache.log4j.FileAppender （文件） 
          3.org.apache.log4j.DailyRollingFileAppender （每天产生一个日志文件） 
          4.org.apache.log4j.RollingFileAppender （文件大小到达指定尺寸的时候产生一个新的文件） 
          5.org.apache.log4j.WriterAppender （将日志信息以流格式发送到任意指定的地方） 
             1.ConsoleAppender 选项 
                    Threshold=WARN: 指定日志消息的输出最低层次。 
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。 
                    Target=System.err ：默认情况下是： System.out, 指定输出控制台 
              2.FileAppender 选项 
                    Threshold=WARN: 指定日志消息的输出最低层次。 
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。 
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。 
                    Append=false: 默认值是 true, 即将消息增加到指定文件中， false 指将消息覆盖指定的文件内容。 
            3.DailyRollingFileAppender 选项 
                    Threshold=WARN: 指定日志消息的输出最低层次。 
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。 
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。 
                    Append=false: 默认值是 true, 即将消息增加到指定文件中， false 指将消息覆盖指定的文件内容。 
                    DatePattern='.'yyyy-ww: 每周滚动一次文件 ，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下： 
                    1)'.'yyyy-MM: 每月 
                    2)'.'yyyy-ww: 每周  
                    3)'.'yyyy-MM-dd: 每天 
                    4)'.'yyyy-MM-dd-a: 每天两次 
                    5)'.'yyyy-MM-dd-HH: 每小时 
                    6)'.'yyyy-MM-dd-HH-mm: 每分钟 
            4.RollingFileAppender 选项 
                    Threshold=WARN: 指定日志消息的输出最低层次。 
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。 
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。 
                    Append=false: 默认值是 true, 即将消息增加到指定文件中， false 指将消息覆盖指定的文件内容。 
                    MaxFileSize=100KB: 后缀可以是 KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到 mylog.log.1 文件。 
                    MaxBackupIndex=2: 指定可以产生的滚动文件的最大数。

实际应用： 
　　 log4j.appender.A1=org.apache.log4j.ConsoleAppender // 这里指定了日志输出的第一个位置 A1 是控制台ConsoleAppender 　　 
　　 3 、配置日志信息的格式，其语法为： 
　　 A. log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
              "fully.qualified.name.of.layout.class" 可以指定下面 4 个格式中的一个： 
               1.org.apache.log4j.HTMLLayout （以 HTML 表格形式布局）， 
　　        2.org.apache.log4j.PatternLayout （可以灵活地指定布局模式）， 
　　        3.org.apache.log4j.SimpleLayout （包含日志信息的级别和信息字符串）， 
　　        4.org.apache.log4j.TTCCLayout （包含日志产生的时间、线程、类别等等信息） 
                   1.HTMLLayout 选项 
                      LocationInfo=true: 默认值是 false, 输出 java 文件名称和行号 
                      Title=my app file: 默认值是 Log4J Log Messages.
                   2.PatternLayout 选项 
                      ConversionPattern=%m%n : 指定怎样格式化指定的消息。 
                   3.XMLLayout  选项 
                      LocationInfo=true: 默认值是 false, 输出 java 文件和行号 
   实际应用： 
   　　 log4j.appender.A1.layout=org.apache.log4j.PatternLayout

         log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
           这里需要说明的就是日志信息格式中几个符号所代表的含义： 
　　          － X 号 : X 信息输出时左对齐； 
                   %p: 输出日志信息优先级，即 DEBUG ， INFO ， WARN ， ERROR ， FATAL,
                   %d: 输出日志时间点的日期或时间，默认格式为 ISO8601 ，也可以在其后指定格式，比如： %d{yyy MMM dd HH:mm:ss,SSS} ，输出类似： 2002 年 10 月 18 日 22 ： 10 ： 28 ， 921
                   %r: 输出自应用启动到输出该 log 信息耗费的毫秒数 
                   %c: 输出日志信息所属的类目，通常就是所在类的全名 
                   %t: 输出产生该日志事件的线程名 
                   %l: 输出日志事件的发生位置，相当于 %C.%M(%F:%L) 的组合 , 包括类目名、发生的线程，以及在代码中的行数。举例： Testlog4.main(TestLog4.java:10)
                   %x: 输出和当前线程相关联的 NDC( 嵌套诊断环境 ), 尤其用到像 java servlets 这样的多客户多线程的应用中。 
                   %%: 输出一个 "%" 字符 
                   %F: 输出日志消息产生时所在的文件名称 
                   %L: 输出代码中的行号 
                   %m: 输出代码中指定的消息 , 产生的日志具体信息 
                   %n: 输出一个回车换行符， Windows 平台为 "/r/n" ， Unix 平台为 "/n" 输出日志信息换行 
            可以在 % 与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如： 
                     1)%20c ：指定输出 category 的名称，最小的宽度是 20 ，如果 category 的名称小于 20 的话，默认的情况下右对齐。 
                     2)%-20c: 指定输出 category 的名称，最小的宽度是 20 ，如果 category 的名称小于 20 的话， "-" 号指定左对齐。 
                     3)%.30c: 指定输出 category 的名称，最大的宽度是 30 ，如果 category 的名称大于 30 的话，就会将左边多出的字符截掉，但小于 30 的话也不会有空格。 
                     4)%20.30c: 如果 category 的名称小于 20 就补空格，并且右对齐，如果其名称长于 30 字符，就从左边交远销出的字符截掉。

　　这里上面三个步骤是对前面 Log4j 组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行： 
　　 log4j.rootLogger=INFO,A1 ， B2
　　 log4j.appender.A1=org.apache.log4j.ConsoleAppender
　　 log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　 log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
  　　  
      4. # 当输出信息于回滚文件时

          log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   // 指定以文件的方式输出日志 
           log4j.appender.ROLLING_FILE.Threshold=ERROR 
           log4j.appender.ROLLING_FILE.File=rolling.log  // 文件位置 , 也可以用变量 ${java.home} 、 rolling.log
           log4j.appender.ROLLING_FILE.Append=true 
           log4j.appender.ROLLING_FILE.MaxFileSize=10KB  // 文件最大尺寸 
           log4j.appender.ROLLING_FILE.MaxBackupIndex=1  // 备份数 
           log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
           log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n  　　

 

  5. Log4j 比较全面的配置

 LOG4J 的配置之简单使它遍及于越来越多的应用中了： Log4J 配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了，

 log4j.rootLogger=DEBUG,CONSOLE,A1,im 
 log4j.addivity.org.apache=true

 # 应用于控制台

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
 log4j.appender.Threshold=DEBUG 
 log4j.appender.CONSOLE.Target=System.out 
 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

 # 应用于文件

 log4j.appender.FILE=org.apache.log4j.FileAppender 
 log4j.appender.FILE.File=file.log 
 log4j.appender.FILE.Append=false 
 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 # Use this layout for LogFactor 5 analysis

 # 应用于文件回滚

 log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 
 log4j.appender.ROLLING_FILE.Threshold=ERROR 
 log4j.appender.ROLLING_FILE.File=rolling.log  // 文件位置 , 也可以用变量 ${java.home} 、 rolling.log
 log4j.appender.ROLLING_FILE.Append=true       //true: 添加   false: 覆盖 
 log4j.appender.ROLLING_FILE.MaxFileSize=10KB   // 文件最大尺寸 
 log4j.appender.ROLLING_FILE.MaxBackupIndex=1  // 备份数 
 log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
 # 应用于 socket 
 log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 
 log4j.appender.SOCKET.RemoteHost=localhost 
 log4j.appender.SOCKET.Port=5001 
 log4j.appender.SOCKET.LocationInfo=true 
 # Set up for Log Facter 5 
 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 
 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n 
 # Log Factor 5 Appender 
 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 
 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

 # 发送日志给邮件

 log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
 log4j.appender.MAIL.Threshold=FATAL 
 log4j.appender.MAIL.BufferSize=10 
 www.wuset.com ">log4j.appender.MAIL.From=web@www.wuset.com 
 log4j.appender.MAIL.SMTPHost=www.wusetu.com 
 log4j.appender.MAIL.Subject=Log4J Message 
 www.wusetu.com ">log4j.appender.MAIL.To=web@www.wusetu.com 
 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 
 log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 # 用于数据库 
 log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 
 log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 
 log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 
 log4j.appender.DATABASE.user=root 
 log4j.appender.DATABASE.password= 
 log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n') 
 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n


 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 
 log4j.appender.A1.File=SampleMessages.log4j 
 log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j' 
 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

 # 自定义 Appender

 log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender

 log4j.appender.im.host = mail.cybercorlin.net 
 log4j.appender.im.username = username 
 log4j.appender.im.password = password 
 log4j.appender.im.recipient = corlin@cybercorlin.net

 log4j.appender.im.layout=org.apache.log4j.PatternLayout 
 log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 


使用poi的一个小坑，java.lang.NoSuchMethodError
qq_47469395的博客
02-17 4719
java.lang.NoSuchMethodError
SpringBoot 项目中使用Log4j2详细（避坑）
justlpf的专栏
02-11 2769
等名称的文件，如果都没有找到，则会按默认配置输出，也就是输出到控制台，也可以对配置文件自定义位置（需要在web.xml中配置），一般放置在src/main/resources根目录下即可。是对所有日志框架制定的一种规范、标准、接口，并不是一个框架的具体的实现，因为接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j、log2j配置文件可以是xml格式的，也可以是json格式的，尝试一些正常和错误的操作，以下为反馈的日志信息。springboot项目中需导入。
Apache Log4j_1.2.17 完整依赖包
04-03
Apache Log4j_1.2.17 完整依赖包，在jdk1.8.201中测试通过。使用教程https://www.tutorialspoint.com/springmvc/springmvc_log4j.htm
org.apache.log4j.Logger详解
热门推荐
anlina_1984的专栏
02-20 19万+
<!--v/:* {behavior:url(#default#VML);}o/:* {behavior:url(#default#VML);}w/:* {behavior:url(#default#VML);}.shape {behavior:url(#default#VML);}--> Normal 0 7.8 磅 0 2
org.apache.log4j.Logger 详解
白不懂黑的静的专栏
08-12 339
一篇对apache log4j讲解的很详细的文章，转载过来,感谢原作者： [b]原文章地址：http://blog.csdn.net/anlina_1984/article/details/5313023[/b] org.apache.log4j.Logger 详解 1. 概述 1.1. 背景 　　 　　在应用程序中添加日志记录总的来说基于三个目的 ：监视代码中变量的变...
log4j漏洞分析及总结
csd_ct的专栏
02-14 5万+
2021年12月8号爆出的log4j2的远程代码执行漏洞【cve-2021-44228】，堪称史诗级核弹漏洞，虽然过了这么久，大部分现网中的相关漏洞已经修复，但任然可以捡漏…,网上也有不少大佬和研究机构都对该漏洞做了分析和复盘，年前年后比较忙，一直没有好好的分析总结该漏洞，最近学习下刚好补上。 漏洞描述及影响 log4j是Apache的一个开源项目，是一个基于Java的日志记录框架。Log4j2是log4j的后继者，被大量用于业务系统开发，记录日志信息。很多互联网公司以及耳熟能详的公司的系统都在使用该框架。
Log4j中文精品教程详解与实践
结合其提供的 优快云 博客链接（https://kylee.blog.csdn.net/article/details/106241913），可以推断该教程不仅涵盖了基础使用，还可能涉及高级特性、最佳实践以及近年来备受关注的安全漏洞防范措施。 首先，从标题...
log4j2 xml配置文件详解
qq_43215592的博客
08-10 1922
日志显示格式： https://blog.csdn.net/ctubinanbowan/article/details/105374279 xml配置详解： https://blog.csdn.net/thekenofDIS/article/details/80439776
深入解析Apache Flume：定义、架构、原理、应用场景及常用命令
CloudJourney的博客
07-01 2102
Apache Flume 是一个分布式日志收集系统，专为高吞吐量的数据传输而设计。它提供了灵活的配置机制，支持多种数据来源和多种数据目标，能够可靠地将大量的日志数据从分布式数据源传输到集中存储系统。
Apache Flume介绍和使用
zhaoguowei的博客
11-15 1171
Apache Flume是什么 Flume是一个分布式、可靠、和高可用的海量日志采集、聚合和传输的系统，通常用于海量数据的实施采集和传输，如:海量日志数据。目前主要使用Flume-NG版本。 下面这张图是Flume的基础架构图： 外部数据源以特定格式向 Flume 发送 events (事件)，当 source 接收到 events 时，它将其存储到一个或多个 channel，channe 会一直...
org.apache.log4j.Logger
evilcry2012的专栏
06-11 1607
org.apache.log4j.Logger 博客分类：  java日志 log4jApache  这个是由Apache组织开发的，使用时需要导入log4j-1.*.jar这样的jar包。   1、java代码 Java代码   import org.apache.log4j.Logger;   public class Main
Log4j
qq_43310689的博客
10-13 689
文章目录一、Log4j1、Log4j入门简介学习2、入门实例2.1、新建项目2.2、添加属性文件2.3、设置日志内容2.4、输出结果3、Log4j基本使用方法4、定义配置文件在配置文件中使用Log4j在代码中使用Log4j 一、Log4j 日志是应用软件中不可缺少的部分，Apache的开源项目log4j是一个功能强大的日志组件,提供方便的日志记录。在apache网站：jakarta.apache.org/log4j 可以免费下载到Log4j最新版本的软件包。 1、Log4j入门简介学习 Log4j是Apac
[转载]org.apache.log4j.Logger详解
z5234032的专栏
09-24 462
转载地址：http://blog.csdn.net/anlina_1984/article/details/5313023 概述 1.1. 背景 　　 　　在应用程序中添加日志记录总的来说基于三个目的 ：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。
org.apache.log4j.Logger 详解
沈林楠的专栏
08-06 929
 Log4j 由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式 。日志信息的优先级从高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。 　 　 1 、定义配置文件 　　    其实您也
log4j详解与实战
程序员最佳实践
05-02 355
log4j是一个非常强大的log记录软件，下面我们就来看看在项目中如何使log4j。   首先当然是得到log4j的jar档，推荐使用1.2.X版，下载地址： http://logging.apache.org/log4j/1.2/download.html   我们先看一个最简单的示例： 【示例1】 项目结构： 【注：由于这里的多个项目公用一个jar档，我们可以创...
org.apache.logging.log4j.Logger.atDebug()Lorg/apache/logging/log4j/LogBuilder;
最新发布
09-03
<think> 我们被要求解释`org.apache.logging.log4j.Logger.atDebug()Lorg/apache/logging/log4j/LogBuilder;`，这实际上是Log4j 2.x中Logger接口的一个方法签名。 在Log4j 2.x中，`atDebug()`是Logger接口的一个方法，它返回一个`LogBuilder`对象。`LogBuilder`是一个流式接口，允许构建日志消息，特别是支持延迟构建消息（避免不必要的字符串连接）和带参数的日志记录。 ### 方法说明 - **方法签名**: `LogBuilder atDebug()` - **作用**: 返回一个`LogBuilder`实例，用于构建一条DEBUG级别的日志消息。 - **使用场景**: 当需要记录DEBUG级别的日志并且消息可能包含多个参数或者需要延迟构建消息时，使用`atDebug()`方法可以更高效地构建日志。 ### LogBuilder接口 `LogBuilder`提供了一系列方法，允许我们以流式的方式构建日志消息。主要方法包括： - `withLocation()`: 记录日志调用点的位置信息（类名、方法名、行号等）。 - `withThrowable(Throwable throwable)`: 设置与日志关联的异常。 - `log(CharSequence message)`: 记录一个简单的字符串消息。 - `log(String message, Object... params)`: 记录一个格式化消息，支持参数替换。 - `log(Supplier<?>... messageSuppliers)`: 使用Supplier延迟提供消息内容，避免不必要的字符串构建。 ### 使用示例 下面是一个使用`atDebug()`和`LogBuilder`的示例代码： ```java import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.LogBuilder; public class LogExample { private static final Logger logger = LogManager.getLogger(LogExample.class); public void logSomething() { // 使用atDebug()获取LogBuilder LogBuilder logBuilder = logger.atDebug(); // 只有当日志级别DEBUG可用时，才会执行后续操作 if (logBuilder.isEnabled()) { // 设置位置信息（可选） logBuilder.withLocation(); // 设置异常（如果有） Throwable throwable = new RuntimeException("Test Exception"); logBuilder.withThrowable(throwable); // 记录日志消息，使用参数 logBuilder.log("This is a debug message with parameters: {}, {}", "param1", 123); } } } ``` ### 代码解释 1. **获取LogBuilder**: 通过`logger.atDebug()`获取一个`LogBuilder`实例。注意，此时日志消息尚未构建。 2. **检查是否启用**: 使用`logBuilder.isEnabled()`判断DEBUG级别是否启用。这可以避免不必要的日志构建开销。 3. **设置位置信息**: 调用`withLocation()`方法，Log4j会记录日志调用的位置（类、方法、行号）。注意，这可能会对性能有轻微影响，因为需要获取堆栈信息。 4. **设置异常**: 如果有异常，可以通过`withThrowable()`方法设置。 5. **记录消息**: 最后调用`log()`方法，并提供消息和参数。消息可以是带占位符的字符串，参数会自动替换。 ### 延迟消息构建 使用`LogBuilder`的一个主要优点是支持延迟构建消息。例如： ```java logger.atDebug() .withThrowable(throwable) .log("User info: {}", () -> computeUserInfo()); ``` 这里，`computeUserInfo()`方法返回一个字符串，但只有当日志级别DEBUG启用时，才会调用该方法。这避免了在日志不输出时执行昂贵的计算。 ### 总结 `Logger.atDebug()`是Log4j 2.x提供的一个高级日志记录功能，它通过`LogBuilder`提供流式API，支持更灵活的日志构建，包括延迟构建和附加位置信息等。使用这种方式可以在需要时提高日志性能。 §§相关问题§§: 1. Log4j 2.x中还有哪些类似`atDebug()`的方法？ 2. `LogBuilder`接口还有哪些常用的方法？ 3. 在Log4j 2.x中，如何配置日志级别？ 4. 使用`withLocation()`方法有什么性能影响？如何避免？ </think> # Log4j `Logger.atDebug()` 方法详解 `org.apache.logging.log4j.Logger.atDebug()` 是 Log4j 2.x 日志框架中的核心方法，它提供了流畅的日志记录接口。以下是对该方法的详细分析和示例代码。 ## 方法签名解读 ```java LogBuilder atDebug(); ``` - **返回值**：`LogBuilder` 接口实例 - **作用**：返回一个用于构建 DEBUG 级别日志消息的日志构建器 - **特点**： - 提供流畅的 API 链式调用 - 支持延迟消息构造（避免不必要的字符串连接） - 允许添加额外上下文信息（标记、位置信息、异常等） - 支持条件日志记录（仅当日志级别启用时执行） ## LogBuilder 接口关键方法 | 方法 | 描述 | |------|------| | `withLocation()` | 添加日志位置信息（类、方法、行号） | | `withMarker(Marker)` | 添加日志标记 | | `withThrowable(Throwable)` | 添加异常堆栈信息 | | `log(CharSequence)` | 记录简单字符串消息 | | `log(String, Object...)` | 记录带参数的格式化消息 | | `log(Supplier<?>...)` | 使用 Supplier 延迟构建消息 | | `isEnabled()` | 检查当前日志级别是否启用 | ## 完整使用示例 ```java import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.Marker; import org.apache.logging.log4j.MarkerManager; import org.apache.logging.log4j.message.Message; public class Log4jAdvancedExample { private static final Logger logger = LogManager.getLogger(Log4jAdvancedExample.class); private static final Marker PERF_MARKER = MarkerManager.getMarker("PERFORMANCE"); private static final Marker SECURITY_MARKER = MarkerManager.getMarker("SECURITY"); public void processTransaction(Transaction transaction) { // 1. 基本使用 logger.atDebug() .log("Starting transaction processing: {}", transaction.getId()); // 2. 带位置信息的日志 logger.atDebug() .withLocation() .log("Transaction location logged: {}", transaction.getId()); // 3. 带标记的日志 logger.atDebug() .withMarker(PERF_MARKER) .log("Processing transaction: {}", transaction.getId()); // 4. 带异常的日志 try { validateTransaction(transaction); } catch (InvalidTransactionException e) { logger.atDebug() .withMarker(SECURITY_MARKER) .withThrowable(e) .log("Invalid transaction detected: {}", transaction.getId()); } // 5. 延迟消息构建（避免不必要的字符串连接） logger.atDebug() .log(() -> { // 只有在DEBUG启用时才执行 String details = generateDetailedReport(transaction); return "Transaction details: " + details; }); // 6. 条件日志记录（避免不必要的计算） if (logger.atDebug().isEnabled()) { // 只有在DEBUG级别启用时才会计算性能指标 PerformanceMetrics metrics = calculatePerformanceMetrics(); logger.atDebug() .withMarker(PERF_MARKER) .log("Performance metrics: {}", metrics); } } // 示例方法 private void validateTransaction(Transaction transaction) throws InvalidTransactionException { // 验证逻辑 } private String generateDetailedReport(Transaction transaction) { // 生成详细报告（成本较高） return "Detailed report..."; } private PerformanceMetrics calculatePerformanceMetrics() { // 计算性能指标（成本较高） return new PerformanceMetrics(); } // 示例类 static class Transaction { private String id; public Transaction(String id) { this.id = id; } public String getId() { return id; } } static class InvalidTransactionException extends Exception { public InvalidTransactionException(String message) { super(message); } } static class PerformanceMetrics { @Override public String toString() { return "Metrics{...}"; } } } ``` ## 性能优化技巧 ### 1. 避免不必要的字符串连接 ```java // 不好的做法（即使DEBUG禁用也会执行字符串连接） logger.debug("Value: " + expensiveOperation()); // 好的做法（仅在DEBUG启用时执行） logger.atDebug().log("Value: {}", () -> expensiveOperation()); ``` ### 2. 条件执行高成本操作 ```java if (logger.atDebug().isEnabled()) { // 仅在DEBUG启用时执行高成本操作 PerformanceData data = collectPerformanceData(); logger.atDebug().log("Performance: {}", data); } ``` ## Log4j 配置示例（log4j2.xml） ```xml <?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %marker %logger{36} - %msg%n"/> </Console> <File name="DebugFile" fileName="logs/debug.log"> <PatternLayout pattern="%d %-5p %marker [%t] %c{1} %L - %m%n"/> </File> </Appenders> <Loggers> <Root level="info"> <AppenderRef ref="Console"/> </Root> <!-- 为特定包启用DEBUG级别 --> <Logger name="com.example" level="debug" additivity="false"> <AppenderRef ref="DebugFile"/> <AppenderRef ref="Console"/> </Logger> </Loggers> </Configuration> ``` ## 重要注意事项 1. **位置信息性能**：`withLocation()` 会获取堆栈跟踪，性能开销较大，避免在性能关键路径使用 2. **标记使用**：合理使用标记可以更好地组织和过滤日志 3. **日志级别检查**：使用 `isEnabled()` 避免执行不必要的操作 4. **供应商延迟**：优先使用 `Supplier` 参数延迟消息构造 5. **格式化性能**：使用 `{}` 占位符比字符串连接更高效 ## 与旧版API的比较 | 特性 | 传统方法 | `atDebug()` 方法 | |------|----------|----------------| | 流畅API | ❌ 不支持 | ✅ 支持 | | 延迟消息构建 | ⚠️ 有限支持 | ✅ 完全支持 | | 异常位置信息 | ❌ 需要额外配置 | ✅ `withLocation()` | | 条件日志记录 | ️ 需要手动检查 | ✅ `isEnabled()` | | 标记支持 | ⚠️ 单独方法 | ✅ 链式调用 |
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值