在 VS Code 中试试

在 Visual Studio Code 中测试 Java

在 Visual Studio Code 中测试 Java 是通过 Test Runner for Java 扩展实现的。它是一个轻量级扩展,用于运行和调试 Java 测试用例。

概述

此扩展支持以下测试框架

Test Runner for Java 扩展可与 Language Support for Java™ by Red HatDebugger for Java 扩展配合使用,提供以下功能

  • 运行/调试测试用例
  • 自定义测试配置
  • 查看测试报告
  • 在测试资源管理器中查看测试

要求

  • JDK (1.8 或更高版本)
  • Visual Studio Code (1.59.0 或更高版本)
  • Java 扩展包

安装 Java 扩展包

项目设置

注意:如果您的项目中已设置 Java 测试框架,可以跳到功能部分。

启用测试并将测试框架 JAR 添加到项目

从 Test Runner for Java 0.34.0 版本开始,您只需在测试资源管理器中执行几个步骤,即可为非托管文件夹项目(未使用任何构建工具的项目)启用测试框架

注意:目前此功能仅支持不包含任何测试依赖项的非托管文件夹。

JUnit 4

Maven

将以下配置添加到您的 pom.xml

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>(YOUR_JUNIT_VERSION)</version>
  <scope>test</scope>
</dependency>

Gradle

确保在您的 build.gradle 中添加了以下行

plugins {
    java
}

dependencies {
    testImplementation('junit:junit:(YOUR_JUNIT_VERSION)')
}

非托管文件夹

如果您的项目未使用任何构建工具,您可以通过测试资源管理器启用 JUnit 4,或者手动下载以下 JAR 并将其添加到项目类路径中(通过设置 java.project.referencedLibraries 实现,有关详细信息,请参阅依赖项管理

您可以查看JUnit 官方 Wiki,了解有关如何设置 JUnit 4 的更多信息。

JUnit 5

JUnit 5 团队提供了一系列使用不同构建工具的示例项目。如果您的项目使用 Maven 或 Gradle 作为构建工具,请查看 junit5-sample 仓库

非托管文件夹

如果您的项目未使用任何构建工具,您可以通过测试资源管理器启用 JUnit 5,或者手动将 junit-platform-console-standalone JAR 文件包含到项目类路径中(通过设置 java.project.referencedLibraries 实现,有关详细信息,请参阅依赖项管理)。

TestNG

Maven

将以下配置添加到您的 pom.xml

<dependency>
  <groupId>org.testng</groupId>
  <artifactId>testng</artifactId>
  <version>(YOUR_TESTNG_VERSION)</version>
  <scope>test</scope>
</dependency>

Gradle

确保在您的 build.gradle 中添加了以下行

plugins {
    java
}

dependencies {
    testImplementation('org.testng:testng:(YOUR_TESTNG_VERSION)')
}

非托管文件夹

如果您的项目未使用任何构建工具,您可以通过测试资源管理器启用 TestNG,或者手动下载以下 JAR 并将其添加到项目类路径中(通过设置 java.project.referencedLibraries 实现,有关详细信息,请参阅依赖项管理

功能

运行/调试测试用例

Test Runner for Java 扩展将在类和方法定义的左侧生成快捷方式(绿色播放按钮)。要运行目标测试用例,请选择绿色播放按钮。您也可以右键单击它以查看更多选项。

测试资源管理器

测试资源管理器是一个树状视图,用于显示工作区中的所有测试用例。您可以选择 Visual Studio Code 左侧活动栏上的测试视图图标来打开它。您还可以在那里运行/调试测试用例并查看测试结果。

自定义测试配置

有时您可能想自定义运行测试用例的配置。为此,您可以在工作区设置中的 java.test.config 部分下添加配置。

Customize test configurations

目前支持的配置如下

  • args:指定将传递给测试运行器的命令行参数。
  • classPaths:此设置中定义的类路径将附加到解析后的类路径。
  • env:通过键值对象指定运行测试时额外的环境变量。
  • envFile:指定包含环境变量定义文件的绝对路径。
  • modulePaths:此设置中定义的模块路径将附加到解析后的模块路径。
  • name:指定配置项的名称。您可以通过设置 java.test.defaultConfig 来设置默认配置名称。
  • preLaunchTask:指定 tasks.json(位于工作区的 .vscode 文件夹中)中指定任务的标签。该任务将在测试开始前启动。
  • sourcePaths:指定调试测试时额外的源路径。
  • vmArgs:指定 JVM 的额外选项和系统属性。
  • workingDirectory:指定运行测试时的工作目录。
  • testKind:指定此测试配置的目标测试框架。支持的值为 junittestng
  • filters:指定测试过滤器。
    • tags:指定要包含或排除的标签。以 ! 作为前缀的标签将被排除。注意:此设置仅在 testKind 设置为 junit 时生效

更多详细信息可以在 vscode-java-test Wiki 上找到。

查看测试结果

运行/调试测试用例后,相关测试项的状态将在编辑器装饰和测试资源管理器中更新。

您可以触发命令 测试: 窥视输出 (Test: Peek Output) 来查看结果视图。您可以选择堆栈跟踪中的链接以导航到源代码位置。

生成测试

此扩展提供了帮助您搭建测试用例的功能。您可以在编辑器上下文菜单中找到该入口。选择源操作... (Source Action...),然后选择生成测试... (Generate Tests...)。

如果您从主源代码(测试对象)触发此源操作,系统将询问您测试类的完全限定名以及要测试的方法。然后扩展将为您生成测试代码

如果您从测试源代码触发源操作,系统将询问您要添加哪种类型的测试方法。包括生命周期方法和测试方法

测试导航

此扩展提供了帮助您在测试和测试对象之间导航的功能。如果您的源代码位于 src/main/javasrc/test/java 中,您可以在编辑器上下文菜单中找到名为转到测试 (Go to Test) 或转到测试对象 (Go to Test Subject) 的入口

您还可以在命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中搜索 Java: 转到测试 (Java: Go to Test) 来找到该命令。

VS Code 测试命令

还有其他测试命令(例如,运行当前文件中的测试 (Run Tests in Current File)),可以通过在命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中搜索“Test:”找到。

Testing commands in the Command Palette

VS Code 测试设置

有一些特定于测试的 VS Code 设置,可以通过在设置编辑器 (⌘, (Windows、Linux Ctrl+,)) 中搜索“testing”找到。

Testing settings in the Settings editor

常见问题

如果您在使用此扩展时遇到任何问题,可以查看常见问题解答 (FAQ) 和我们的问题列表,看看是否有问题的答案。

贡献与反馈

如果您有兴趣提供反馈或直接贡献代码库,请阅读贡献 Test Runner for Java,其中包含以下内容

后续步骤

继续阅读以了解

  • 调试 - 了解如何在 VS Code 中调试您的 Java 项目。
  • Java 扩展 - 了解更多适用于 VS Code 的有用 Java 扩展。