Spring - 使用 Log4J 进行日志记录


这是 Spring 应用程序中非常易于使用的 Log4J 功能。下面的示例将带您通过简单的步骤来讲解Log4J和Spring之间的简单集成。

我们假设您的计算机上已经安装了log4J。如果您没有它,那么您可以从https://logging.apache.org/下载它,然后将压缩文件解压到任何文件夹中。我们将在项目中仅使用log4j-xyzjar 。

接下来,让我们准备好一个可用的 Eclipse IDE,并按照以下步骤使用 Spring Web 框架开发基于动态表单的 Web 应用程序 -

脚步 描述
1 创建一个名为SpringExample的项目,并在创建的项目中的src文件夹下创建一个包com.tutorialspoint 。
2 使用“添加外部 JAR”选项添加所需的 Spring 库,如Spring Hello World 示例一章中所述。
3 使用AddExternal JARs在您的项目中添加 log4j 库log4j-xyzjar
4 com.tutorialspoint包下创建 Java 类HelloWorldMainApp
5 src文件夹下创建Beans配置文件Beans.xml
6 src文件夹下创建log4J配置文件log4j.properties
7 最后一步是创建所有 Java 文件和 Bean 配置文件的内容并运行应用程序,如下所述。

这是HelloWorld.java文件的内容

package com.tutorialspoint;

public class HelloWorld {
   private String message;
   
   public void setMessage(String message){
      this.message  = message;
   }
   public void getMessage() {
      System.out.println("Your Message : " + message);
   }
}

以下是第二个文件MainApp.java的内容

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.apache.log4j.Logger;

public class MainApp {
   static Logger log = Logger.getLogger(MainApp.class.getName());
   
   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
      log.info("Going to create HelloWord Obj");
      HelloWorld obj = (HelloWorld) context.getBean("helloWorld");
      obj.getMessage();
      
      log.info("Exiting the program");
   }
}

您可以按照与我们生成信息消息类似的方式生成调试错误消息。现在让我们看看Beans.xml文件的内容

<?xml version = "1.0" encoding = "UTF-8"?>

<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

   <bean id = "helloWorld" class = "com.tutorialspoint.HelloWorld">
      <property name = "message" value = "Hello World!"/>
   </bean>

</beans>

以下是log4j.properties的内容,定义了 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=C:\\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

创建完源文件和 bean 配置文件后,让我们运行该应用程序。如果您的应用程序一切正常,这将在 Eclipse 控制台中打印以下消息 -

Your Message : Hello World!

如果您检查 C:\\ 驱动器,那么您应该找到日志文件log.out,其中包含各种日志消息,如下所示 -

<!-- initialization log messages -->

Going to create HelloWord Obj
Returning cached instance of singleton bean 'helloWorld'
Exiting the program

雅加达共享日志记录 (JCL) API

或者,您可以使用Jakarta Commons Logging (JCL) API 在 Spring 应用程序中生成日志。JCL 可以从https://jakarta.apache.org/commons/logging/下载。从技术上讲,我们从这个包中需要的唯一文件是commons-logging-xyzjar文件,需要将其放置在您的类路径中,其方式与您在上面的示例中放置log4j-xyzjar 的方式类似。

要使用日志记录功能,您需要一个org.apache.commons.logging.Log对象,然后您可以根据您的要求调用以下方法之一 -

  • 致命(对象消息)
  • 错误(对象消息)
  • 警告(对象消息)
  • 信息(对象消息)
  • 调试(对象消息)
  • 跟踪(对象消息)

以下是 MainApp.java 的替换,它使用 JCL API

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.apache.commons.logging. Log;
import org.apache.commons.logging. LogFactory;

public class MainApp {
   static Log log = LogFactory.getLog(MainApp.class.getName());

   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
      log.info("Going to create HelloWord Obj");
      HelloWorld obj = (HelloWorld) context.getBean("helloWorld");
      obj.getMessage();

      log.info("Exiting the program");
   }
}

在编译和运行程序之前,您必须确保项目中已包含 commons-logging-xyzjar 文件。

现在保持上面示例中的其余配置和内容不变,如果编译并运行应用程序,您将获得与使用 Log4J API 获得的类似结果。