• Selenium Video Tutorials

Selenium - Log4j 日志记录

上一页
下一页

Selenium Webdriver 可用于在测试执行期间记录信息。日志记录主要用于提取有关执行方式的信息。

日志记录通过提供有关应用程序功能（正在运行或未运行）的数据来帮助增强任何应用程序。因此，日志记录对于提高应用程序质量和故障排除非常重要。

什么是 Log4j？

Log4j 是一个基于 Java 的开源框架，主要用于记录信息。它是一个简单、可靠且快速的框架。Log4j 必须使用配置文件（如 Log4j.xml 文件、Log4j.properties 文件、yaml 或 JSON 文件等）以键值对的形式进行配置。Log4j 是 Apache Logging Services 的一部分。

Log4j 的组件

Log4j 的组件如下所示：

  • 记录器 (Loggers)

  • 追加器 (Appenders)

  • 布局 (Layouts)

记录器 (Loggers)

记录器包含使用 Log4j 框架生成的全部重要日志信息。记录器的基本组件包括：

  • Logger 类的对象。

  • 日志级别 - 日志级别有助于获取日志消息。日志级别包括：ALL（记录所有信息）、ERROR（仅记录可能暂停执行的错误信息）、WARN（仅记录可能暂停执行但并非致命的错误信息）、DEBUG（记录调试所需的信息）、INFO（记录应用程序的响应方式）、TRACE（记录最详细的日志信息）和 FATAL（记录应用程序中可能导致应用程序崩溃的挑剔信息）。

追加器 (Appenders)

追加器从记录器获取信息并将其输出到另一个文件或存储区。追加器包括：FileAppender（将日志信息写入另一个文件）、RollingFileAppender（类似于 FileAppender，但限制了文件大小，一旦文件大小超过限制，剩余的日志信息将被捕获到追加器创建的另一个新文件中）、DailyRollingFileAppender（用于提供捕获日志信息的间隔）、以及 ConsoleAppender（将日志信息写入控制台）。

布局

布局用于设置日志文件的格式。布局包括：模式布局、HTML 布局、XML 布局等。

Log4j 日志记录的先决条件

  • 在系统中安装 Java（8 以上版本），并使用命令 java -version 检查它是否存在。如果安装成功，将显示安装的 Java 版本。

  • 在系统中安装 Maven，并使用命令 mvn -version 检查它是否存在。如果安装成功，将显示安装的 Maven 版本。

  • 安装任何 IDE，例如 Eclipse、IntelliJ 等。

  • 保存包含所有依赖项的 pom.xml 文件并更新 Maven 项目

Log4j 日志记录步骤

步骤 1 - 创建一个 Maven 项目，并将正确的依赖项添加到 pom.xml 文件中，用于以下项目：

步骤 2 - 创建一个配置文件 - log4j.xml 或 loj4j.properties 文件。在这里，我们将提供设置。在我们的项目中，我们在 resources 文件夹下创建了一个名为 log4j2.properties 的文件。

Selenium Log4j Logging 1

步骤 3 - 创建一个测试类，在其中我们将创建 Logger 类的对象并包含日志语句。运行项目并验证结果。

示例

package Logs;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.util.concurrent.TimeUnit;

public class LoggingsInfo {

   // object of Logger class
   private static Logger logger = LogManager.getLogger(LoggingsInfo.class);

   public  static void main(String args[]){

      System.out.println("Execution started: ");

      // logging messages
      logger.info("This is for information");
      logger.error("This is for error information");
      logger.warn("This is for warning information");
      logger.fatal("This is for fatal information");

      System.out.println("Execution done: ");
   }
}

log4j2.properties 文件中的配置。

name=PropertiesConfig
property.filename = logs
appenders = console, file

appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n

appender.file.type = File
appender.file.name = LOGFILE
appender.file.fileName=${filename}/LogsGenerated.log
appender.file.layout.type=PatternLayout
appender.file.layout.pattern=[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n

loggers=file
logger.file.name=Logs
logger.file.level = debug
logger.file.appenderRefs = file
logger.file.appenderRef.file.ref = LOGFILE

rootLogger.level = debug
rootLogger.appenderRefs = stdout
rootLogger.appenderRef.stdout.ref = STDOUT

pom.xml 中的依赖项。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.example</groupId>
   <artifactId>SeleniumJava</artifactId>
   <version>1.0-SNAPSHOT</version>
   
   <properties>
      <maven.compiler.source>16</maven.compiler.source>
      <maven.compiler.target>16</maven.compiler.target>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
   
   <!-- https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java -->
   <dependencies>
   
      <dependency>
         <groupId>org.seleniumhq.selenium</groupId>
         <artifactId>selenium-java</artifactId>
         <version>4.11.0</version>
      </dependency>

      <dependency>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-api</artifactId>
         <version>2.23.1</version>
      </dependency>

      <dependency>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-core</artifactId>
         <version>2.23.1</version>
      </dependency>

   </dependencies>
</project>

输出

Execution started: 
[INFO ] 2024-03-21 16:15:08.431 [main] LoggingsInfo - This is for information
[ERROR] 2024-03-21 16:15:08.432 [main] LoggingsInfo - This is for error information
[WARN ] 2024-03-21 16:15:08.432 [main] LoggingsInfo - This is for warning information
[FATAL] 2024-03-21 16:15:08.432 [main] LoggingsInfo - This is for fatal information
Execution done: 

Process finished with exit code 0

除此之外，项目中的 log 文件夹中还会生成一个名为 LogsGenerated.log 的文件，其中包含与控制台输出相同的日志信息。

Selenium Log4j Logging 2

我们还可以通过更新 log4j2.properties 文件中的 rootLogger.level = trace 和 logger.file.level = trace 来更改日志级别配置为 trace。

更新后的 log4j2.properties 配置

name=PropertiesConfig
property.filename = logs
appenders = console, file

appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n

appender.file.type = File
appender.file.name = LOGFILE
appender.file.fileName=${filename}/LogsGenerated.log
appender.file.layout.type=PatternLayout
appender.file.layout.pattern=[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n

loggers=file
logger.file.name=Logs
logger.file.level = trace
logger.file.appenderRefs = file
logger.file.appenderRef.file.ref = LOGFILE

rootLogger.level = trace
rootLogger.appenderRefs = stdout
rootLogger.appenderRef.stdout.ref = STDOUT

示例

package Logs;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.util.concurrent.TimeUnit;

public class LoggingsInfo {

   // object of Logger class
   private static Logger logger =
   LogManager.getLogger(LoggingsInfo.class);

   public  static void main(String args[]){
      System.out.println("Execution started: ");

      // logging messages
      logger.trace("This is for trace information");
      logger.info("This is for information");
      logger.error("This is for error information");
      logger.warn("This is for warning information");
      logger.fatal("This is for fatal information");

      System.out.println("Execution done: ");
   }
}

输出

[TRACE] 2024-03-21 16:25:08.354 [main] LoggingsInfo - This is for trace information
[INFO ] 2024-03-21 16:25:08.356 [main] LoggingsInfo - This is for information
[ERROR] 2024-03-21 16:25:08.356 [main] LoggingsInfo - This is for error information
[WARN ] 2024-03-21 16:25:08.356 [main] LoggingsInfo - This is for warning information
[FATAL] 2024-03-21 16:25:08.356 [main] LoggingsInfo - This is for fatal information
Execution done: 

Process finished with exit code 0

除此之外，项目中的 log 文件夹中生成的 LogsGenerated.log 文件已更新为包含 trace 信息。

Selenium Log4j Logging 3

在上述两种情况下，我们都覆盖了日志文件，但是，我们可以通过将配置 appender.file.append=true 添加到 log4j2.properties 文件中来将日志追加到日志文件中。

此外，要禁用控制台和日志文件的日志信息，我们必须使用 logger.file.level = off 和 rootLogger.level = off 更新 log4j2.properties 文件。

本教程总结了Selenium - Log4j日志记录的全面内容。我们首先介绍了Log4j及其组件、设置Log4j的先决条件，并逐步演示了如何创建一个Log4j，并通过示例说明了如何将其与Selenium一起使用。这将使您深入了解Log4j。建议您多练习所学内容，并探索与Selenium相关的其他知识，以加深理解并拓宽视野。

打印页面
上一篇
下一篇
广告