Log4j使用总结

最新推荐文章于 2022-02-11 17:05:43 发布
最新推荐文章于 2022-02-11 17:05:43 发布
阅读量1.2k 收藏 2
点赞数
分类专栏： JAVA 文章标签： log4j
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xby1993/article/details/23610759
版权

基本使用：

  • 配置
  • 代码中使用
  • 日志文件输出路径配置方式。
  • 补充知识点
  • 配置文件总结示例


Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。

日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度；

日志信息的输出目的地指定了日志将打印到控制台还是文件或数据库或email或其他等中；

而输出格式则控制了日志信息的显示内容。

1.定义配置文件：（支持xml或properties格式、）


1.1配置根Logger，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。

Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

1.2.配置日志信息输出目的地Appender，其语法为

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.option = valueN

其中，Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），

org.apache.log4j.FileAppender（文件），

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件并可支持保存文件索引的最大数及最多的日志文件数。），

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）


1.3配置日志信息的格式（布局），其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

log4j.appender.appenderName.layout.option1 = value1

…

log4j.appender.appenderName.layout.option = valueN

其中，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）


2、在代码中使用log4j

2.1:读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。log4j.properties

PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。

DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

2.2.得到记录器

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)，

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;

2.3插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;

Logger.info ( Object message ) ;

Logger.warn ( Object message ) ;

Logger.error ( Object message ) ;


2.4在Servlet中的使用：

配置一个单独的Servlet用于随着webapp的初始化初始化日志配置：


<servlet>

   <servlet-name>log4j-init</servlet-name>

   <servlet-class>com.foo.Log4jInit</servlet-class>

   <init-param>

     <param-name>log4j-init-file</param-name>

     <param-value>WEB-INF/classes/log4j.lcf</param-value>

   </init-param>

   <load-on-startup>1</load-on-startup>

 </servlet>



public class Log4jInit extends HttpServlet {

 public

 void init() {

   String prefix =  getServletContext().getRealPath("/");

   String file = getInitParameter("log4j-init-file");

   // if the log4j-init-file is not set, then no point in trying

   if(file != null) {

     PropertyConfigurator.configure(prefix+file);

   }

 }

注意：以上使用部分仅作为了解，一般在实际项目中很少直接使用Log4j的API来操作，我们一般通过日志系统抽象层来面向接口一致地编程，例如SLF4J，commons logging.


关于设置文件路径的补充：

设置日志文件的路径大体有以下三种方式：

1.使用既定环境遍历如tomcat的${catalina.home}:

log4j.appender.R.File=${CATALINA_HOME}/example.log不过这种方式不便于移植，

2.覆盖RollingFileAppender的setFile方法，麻烦。

3.在加载log4j.properties文件之前配置Systemt.setProperty("log_path",log_path);推荐

高优先级、自启动的Servlet里(比如前面讲过的Log4jInitServlet)获得应用的发布目录，这是很容易得到的，

比如String home = servletContext.getRealPath("/");然后调用System.setPropertity("web_home",home),“web_home”名字可以随意。

则log4j.properties里的配置为：log4j.appender.R.File=${web_home}/logs/log.log.则日志会输出到web应用发布目录里的logs目录里。

<servlet>

<servlet-name>log4j-init</servlet-name>

<servlet-class>Log4jInit</servlet-class>

<init-param>

<param-name>log_path</param-name>

<param-value>logs</param-value>避免硬编码确定日志文件父目录。

</init-param>

        <load-on-startup>0</load-on-startup>

</servlet>

public class Init extends HttpServlet {

public void init(ServletConfig config) {

     String path=config.getServletContext().getRealPath("/");

    String path=path+config.getInitParameter("log_path");

    System.setProperty("log_path",path);

  }

}

log4j.properties文件中的配置为：

log4j.appender.R.File=${log_path}/log.log.


4.动态确定日志文件位置，这样需要通过编码操作RollingFileAppender。除非必须这么做，一般我们没有太大必要。

static{

       Appender appender = logger.getAppender("RING");

       if(appender instanceof FileAppender){

           FileAppender fappender = (FileAppender)appender;

           if(!fappender.getFile().startsWith("App1")){

               fappender.setFile("App1"+fappender.getFile());

               fappender.activateOptions();

           }

       }

通过调用appender的activateOptions方法来激活针对appender的修改，之后的日志就记录在新的日志文件中了。

3. 关于RollingFileAppender:的几点补充：

举例：


log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.

log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender

log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB #指定单个日志文件最大大小，超出这个大小就会Rolling为example.log.1

# Keep one backup file

log4j.appender.R.MaxBackupIndex=1//指定最大日志索引example.log.1

log4j.appender.R.Append=true //true:添加 false:覆盖  

#log4j.appender.R.MaxFileSize=10KB //文件最大尺寸  

#log4j.appender.R.MaxBackupIndex=1 //备份数  


log4j.appender.R.layout=org.apache.log4j.PatternLayout

log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n



关于PatternLayout的几点补充


格式

%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 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(Test Log4.java:10) 


%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中


可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式



一般比较常用的是：%p,%m,%t,%d,%l,%n，%x


例如log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %-5p ] - %-5l- %-5x - %-5m%n

关于FileAppender的补充：


log4j.appender.FILE.Append=true//是否追加



4. 关于其他输出目的地的说明示例：


log4j.rootLogger=DEBUG,CONSOLE,A1,im  

# 应用于控制台  

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  

# 应用于文件回滚  

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  

log4j.appender.MAIL.From=web@www.wuset.com  

log4j.appender.MAIL.SMTPHost=www.wusetu.com  

log4j.appender.MAIL.Subject=Log4J Message  

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  

#自定义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  




参考：https://www.ibm.com/developerworks/cn/java/l-log4j/


http://www.cnblogs.com/licheng/archive/2008/08/23/1274566.html

http://kdboy.iteye.com/blog/208851


小小懒羊羊
关注
专栏目录
log4j的真正使用方式
11-30
参考博客：http://blog.csdn.net/gaohuanjie/article/details/53403947
Log4j的使用总结！（用于收藏救急用）
Chris
02-01 242
1 关于log4j的文章---粗略看了一遍，不错！    出处给忘了好像是下面这个：     http://dev2dev.bea.com.cn/bbs/servlet/D2DServlet/download/124-14026-77822-650/深入学习Log4J.pdf  深入学习Log4J   李翔   内容:   一,Log4J配置文件的学习   二,Log4J数据库   三,Log4...
log4j详解
shady_beat_you的专栏
08-23 449
第一步：加入log4j-1.2.8.jar到lib下。 第二步：在CLASSPATH下建立log4j.properties。内容如下： 1 log4j.rootCategory=INFO, stdout , R 2 3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender 4 log4j.appender.stdout.layout
Log4j日志级别以及在R中的使用
李松雨的专栏
04-11 2472
log4j是apache基金会的一个项目,日志记录器(Logger)是日志处理的核心组件,log4j具有7种级别(Level). DEBUG Level: 指出细粒度信息事件对调试应用程序是非常有帮助的,就是输出debug的信息. INFO level: 表明消息在粗粒度级别上突出强调应用程序的运行过程,就是输出提示信息. WARN level: 表明会出现潜在错误的情形,就是显示警告信息. ERR
Log4j使用总结.doc
09-04
总结来说，Log4j是Java开发中不可或缺的工具，它提供了一种灵活、可配置的方式来管理和记录应用的日志信息，帮助开发者进行调试、故障排查和性能分析。通过合理配置和使用，可以大大提高开发和运维效率。
log4j使用总结
12-20
Log4j 使用总结 Log4j 是 Apache 的一个开放源代码项目，通过使用 Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI 组件、甚至是套接口服务器、NT 的事件记录器、UNIX Syslog 守护进程等；我们也可以...
若依框架使用的log4j2.16.0，修复log4j漏洞log4j2下载最新log4j2.16.0下载
12-16
总结来说，Log4j2.16.0是一个关键的安全更新，解决了Log4j2框架中的“Log4Shell”漏洞。对于使用若依框架或其他依赖Log4j2的项目，升级到这个版本至关重要，可以避免系统遭受恶意攻击。用户需要下载并正确安装这个...
Springboot整合log4j2日志全解总结
08-26
Springboot 整合 log4j2 日志全解总结 本文主要介绍了 Springboot 整合 log4j2 日志的实现 шаги，旨在帮助开发者更好地理解日志框架在 Springboot 项目中的应用。 日志框架的重要性 在项目推进中，日志框架的...
log4j使用jar包和log4j.properties配置文件
09-26
本文将详细探讨Log4j的使用，主要关注1.2.17版本的jar包以及配置文件`log4j.properties`。 ### 1. Log4j简介 Log4j是一个开源的日志组件，支持多种输出格式，如控制台、文件、数据库等。它的核心概念包括Logger、...
Log4j学习后总结
yu829的专栏
03-17 457
Log4j学习后总结   日志输出终端 Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去  org.apache.log4j.ConsoleAppender(控制台) org.apache.log4j.FileAppender(文件) org.apache.log4j.DailyRollingFileAppender(每天都产生一个日志
log4net Invalid RollPoint, unable to parse
XinShun的博客
06-23 489
1、参考：https://issues.apache.org/jira/browse/LOG4NET-60 2、配置如下： <?xml version="1.0" encoding="utf-8" ?> <configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/&g
LOG4J 的 RollingFileAppender
奎德的专栏
02-11 1584
其实这不是个问题。昨天小李子跟我说，LOG4J的文件日志没有内容了，你这是咋整的亚。于是我看了以下，果不其然，LOG4J整趴下了。WHY?我这两天也没有改啥亚，只不过是增加了一个drools,而且是5.0滴；挠了半天头，又得请教GOOGLE大爷，不过让我怎么问呢，我现在写的时候我忘了怎么问了，可能年纪有些大了年纪大了就是成了忘事精，于是我想起了小时候姥姥给我讲的忘事
springboot多环境日志配置，启动时logback-test.xml文件冲突导致启动失败：openFile(null,true) call failed. java.io.FileNotFoun...
wuxun1997的专栏
01-13 1958
　　如题，在项目中用到了4个环境的日志配置文件，启动时在application.properties中指定环境，让springboot自动加载logback对应的配置文件： 　　每个环境的日志目录都不一样，比如sit和test环境分别是： 　　如果spring.profiles.active配置的是test，那么一切正常，非test环境，则启动失败。比如我现在配置spring.profi...
log4j mysql 详细日志文件_Log4j日志输出详细
weixin_35769289的博客
01-25 438
日志论在应用程序中输出日志有有三个目的：(1)监视代码中变量的变化情况，把数据周期性地记录到文件中供其他应用进行统计分析工作。(2)跟踪代码运行进轨迹，作为日后审计的依据。(3)担当集成开发环境中的调试器，向文件或控制台打印代码的调试信息。Apache能用日志包(Commons Logging Package)是Apache的一个开放源代码项目，它提供了一组通用的日志接口，用户可以自由...
log4j配置详解(非常详细)
热门推荐
孤独冰刃的博客
01-27 2万+
log4j配置详解(非常详细) Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。 配置文件 Log4J配置文件的基本格式如下： #配置根Logger log4j.rootLogger = [ level ] , appenderName1 , appenderName2 , … #配置日志信息输出目的地Appender log4j.a
log4j配置详解
eako的专栏
09-23 1万+
log4j详解        根据网络资料整理        >>>>1. 概述　　1.1. 背景　　　　在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。　　　　最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可
Log4j自定义Appender输出日志内容
bird_tp的博客
02-11 4422
一、Log4j知识了解 在自定义Appende之前，我们先来简单了解下Log4j 1、Log4j是什么 Log4j是由Apache提供的日志操作包，用于帮助用户处理日志信息。 2、log4j的作用 log4j提供了方法使我们能将日志信息分级存储。其次，log4j提供了日志不同的存储方式，我们可以将日志发送到控制台，或者文件，或者数据库中等等。 3、Log4j三大组件 Logger：日志写出器，负责供客户端代码调用，用于输入日志信息。Log4j 允许开发人员定义多个Logger，每个Logger
Log4j配置与使用详解
总结来说，Log4j的使用涉及配置文件的编写，包括设置日志级别、选择输出目的地和定义输出格式，以及在代码中调用相应的Logger接口。通过这种方式，Log4j能提供强大的日志管理能力，帮助开发者调试、监控和分析应用...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值