Log4J - 在文件中记录日志

2024 年 8 月 29 日 | 阅读 3 分钟

Log4j 提供了 org.apache.log4j.FileAppender 类，用于将您的日志信息写入文件。

FileAppender 参数

FileAppender 具有以下可配置参数

参数	描述
immediateFlush	此标志的默认值为 true，这意味着每次附加操作都会刷新到该文件的输出流。
encoding	我们可以使用任何字符编码。默认情况下，编码是特定于平台的编码方案。
threshold	此 appender 的阈值级别。
文件名	日志文件名。
fileAppend	默认值为 true，这意味着日志信息将附加到同一文件的末尾。
bufferedIO	此标志定义是否需要启用缓冲写入。默认值为 false。
bufferSize	如果启用了缓冲 I/O 或为 true，则它指示缓冲区大小。默认情况下，设置为 8kb。

让我们看一个 FileAppender 的例子

Log4j.properties

# Define the root logger with appender file
log = /usr/home/log4j

# Define the root logger with appender file
log4j.rootLogger = DEBUG, FILE

# Define the file appender
log4j.appender.FILE=org.apache.log4j.FileAppender

# Set the name of the file
log4j.appender.FILE.File=${log}/log.out

# Set the immediate flush to true (default)
log4j.appender.FILE.ImmediateFlush=true

# Set the threshold to debug mode
log4j.appender.FILE.Threshold=debug

# Set the append to false, overwrite
log4j.appender.FILE.Append=false

# Define the layout for file appender
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.conversionPattern=%m%n

Example.java

import org.apache.log4j.Logger;

import java.io.*;
import java.sql.SQLException;
import java.util.*;

public class HtmlLayoutEx{

   static Logger log = Logger.getLogger(HtmlLayoutEx.class.getName());
   
   public static void main(String[] args)throws IOException, SQLException{
      log.debug("Hello this is a debug message");
      log.info("Hello this is an info message");
   }
}

输出

Hello this is a debug message
Hello this is an info message

如果您希望拥有一个与上述 log4j.properties 文件等效的 XML 配置文件，则以下是内容

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>

<appender name="FILE" class="org.apache.log4j.FileAppender">

   <param name="file" value="${log}/log.out"/>
   <param name="immediateFlush" value="true"/>
   <param name="threshold" value="debug"/>
   <param name="append" value="false"/>
   
   <layout class="org.apache.log4j.PatternLayout">
      <param name="conversionPattern" value="%m%n"/>
   </layout>
</appender>

<logger name="log4j.rootLogger" additivity="false">
   <level value="DEBUG"/>
   <appender-ref ref="FILE"/>
</logger>

</log4j:configuration>

在多个文件中记录日志

由于某些原因，我们还可以将多个消息写入多个文件，例如，如果文件大小达到某个阈值。

要将有关日志记录的信息写入多个文件，您必须使用 org.apache.log4j.RollingFileAppender 类，该类扩展了 FileAppender 类并继承了其所有属性。

除了上面针对 FileAppender 提到的参数外，只有一个重要参数

DatePattern: 这表明何时滚动文件以及要遵循的命名约定。默认情况下，每天午夜执行滚动。

DatePattern 用于使用以下模式之一控制滚动计划

DatePattern	描述
'.' yyyy-MM	在每个月末和下月初滚动。
'.' yyyy-MM-dd	每天午夜滚动。它是默认值。
'.' yyyy-MM-dd-a	每天中午和午夜执行滚动。
'.' yyyy-MM-dd-HH	每小时顶部滚动。
'.' yyyy-MM-dd-HH-mm	每分钟滚动。
'.' yyyy-ww	根据语言环境，每周的第一天执行滚动。

让我们看一个示例配置文件 log4j.properties，以生成每天中午和午夜滚动的日志文件

# Define the root logger with appender file
log4j.rootLogger = DEBUG, FILE

# Define the file appender
log4j.appender.FILE=org.apache.log4j.DailyRollingFileAppender

# Set the name of the file
log4j.appender.FILE.File=${log}/log.out

# Set the immediate flush to true (default)
log4j.appender.FILE.ImmediateFlush=true

# Set the threshold to debug mode
log4j.appender.FILE.Threshold=debug

# Set the append-false, should not overwrite
log4j.appender.FILE.Append=true

# Set the DatePattern
log4j.appender.FILE.DatePattern='.' yyyy-MM-dd-a

# Define the layout for file appender
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.conversionPattern=%m%n

下一个主题Log4j PatternLayout

Log4J - 在文件中记录日志

FileAppender 参数

在多个文件中记录日志

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Log4j 教程

Log4J - 在文件中记录日志

FileAppender 参数

在多个文件中记录日志

相关帖子

Log4j 示例

Log4j vs SLF4J

Log4j 架构

Log4j HTMLLayout

Log4j 日志级别

Log4j Appenders

Log4j 日志方法

Log4j XML

Log4j 日志格式

Log4j 教程

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器