使用 Kotlin 和 JUnit 测试 Java 代码 – 教程
Kotlin 与 Java 完全互操作,这意味着你可以使用 Kotlin 为 Java 代码编写测试,并在同一项目中与现有的 Java 测试一起运行。
在本教程中,你将学习如何:
- 配置 Java–Kotlin 混合项目以使用 JUnit 运行测试。
- 添加用于验证 Java 代码的 Kotlin 测试。
- 使用 Maven 或 Gradle 运行测试。
开始之前,请确保你已具备:
- IntelliJ IDEA 或安装了 Kotlin 扩展程序 的 VS Code。
- Java 17 或更高版本。
配置项目
在你的 IDE 中,从版本控制克隆示例项目:
texthttps://github.com/kotlin-hands-on/kotlin-junit-sample.git导航至
initial模块并查看项目结构:textkotlin-junit-sample/ ├── initial/ │ ├── src/ │ │ ├── main/java/ # Java 源代码 │ │ └── test/java/ # Java 中的 JUnit 测试 │ ├── pom.xml # Maven 配置 │ └── build.gradle.kts # Gradle 配置initial模块包含一个用 Java 编写的简单 Todo 应用程序以及单个测试。在同一目录下,打开你的构建文件并更新其内容以支持 Kotlin:
pom.xml file {...}
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.jetbrains.kotlin</groupId> <artifactId>kotlin-junit-complete</artifactId> <version>1.0-SNAPSHOT</version> <name>kotlin-junit-complete</name> <url>https://kotlinlang.org/docs/jvm-test-using-junit.htm</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.release>17</maven.compiler.release> <jexer.version>1.6.0</jexer.version> <kotlin.version>2.4.21</kotlin.version> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.junit</groupId> <artifactId>junit-bom</artifactId> <version>6.0.3</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-api</artifactId> <scope>test</scope> </dependency> <!-- 添加用于测试运行时的 JUnit Jupiter 引擎 --> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-engine</artifactId> <scope>test</scope> </dependency> <!-- 可选:参数化测试支持 --> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-params</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>com.gitlab.klamonte</groupId> <artifactId>jexer</artifactId> <version>${jexer.version}</version> </dependency> </dependencies> <build> <pluginManagement><!-- 锁定插件版本以避免使用 Maven 默认值(可移至父 pom 文件) --> <plugins> <!-- Clean 生命周期,请参阅 https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle --> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.4.0</version> </plugin> <!-- Default 生命周期,jar 打包:请参阅 https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging --> <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.3.1</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>3.3.0</version> </plugin> <plugin> <artifactId>maven-jar-plugin</artifactId> <version>3.4.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>3.1.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>3.1.2</version> </plugin> <!-- Site 生命周期,请参阅 https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle --> <plugin> <artifactId>maven-site-plugin</artifactId> <version>3.12.1</version> </plugin> <plugin> <artifactId>maven-project-info-reports-plugin</artifactId> <version>3.6.1</version> </plugin> <!-- 使用 Kotlin extensions 时不需要 maven-compiler-plugin --> </plugins> </pluginManagement> <plugins> <!-- 为 main 和 test 源代码激活 Kotlin Maven 插件 --> <plugin> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-maven-plugin</artifactId> <version>${kotlin.version}</version> <extensions>true</extensions> </plugin> </plugins> </build> </project>- 在
<properties>部分中设置 Kotlin 版本。 - 在
<dependencies>部分中添加用于运行测试的 JUnit Jupiter 依赖项。 - 在
<build><plugins>部分中应用kotlin-maven-plugin,并将<extensions>设置为true。它会自动将相应的执行目标以及kotlin-stdlib依赖项添加到构建中。 - 当结合 extensions 使用 Kotlin Maven 插件时,不需要将
maven-compiler-plugin添加到<build><pluginManagement>部分。
build.gradle.kts {...}
kotlin// build.gradle.kts group = "org.jetbrains.kotlin" version = "1.0-SNAPSHOT" description = "kotlin-junit-complete" java.sourceCompatibility = JavaVersion.VERSION_17 plugins { application kotlin("jvm") version "2.4.21" } kotlin { jvmToolchain(17) } application { mainClass.set("org.jetbrains.kotlin.junit.App") } repositories { mavenCentral() } dependencies { implementation("com.gitlab.klamonte:jexer:1.6.0") testImplementation(kotlin("test")) testImplementation(libs.org.junit.jupiter.junit.jupiter.api) testImplementation(libs.org.junit.jupiter.junit.jupiter.params) testRuntimeOnly(libs.org.junit.jupiter.junit.jupiter.engine) testRuntimeOnly(libs.org.junit.platform.junit.platform.launcher) } tasks.test { useJUnitPlatform() }- 在
plugins {}块中添加kotlin("jvm")插件。 - 设置 JVM 工具链版本以匹配你的 Java 版本。
- 在
dependencies {}块中添加kotlin.test库,它提供了 Kotlin 的测试实用程序并与 JUnit 集成。
Kotlin/JVM 支持最新的稳定版 JUnit 版本(JUnit 6)。你可以在
gradle/libs.versions.toml版本目录中找到它。如果你通常更喜欢使用版本目录,甚至可以在其中添加
kotlin("jvm")插件:libs.versions.toml {...}
toml# gradle/libs.versions.toml [versions] kotlin = "2.4.21" junit = "6.0.3" [libraries] org-junit-jupiter-junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" } org-junit-jupiter-junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" } org-junit-jupiter-junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" } org-junit-platform-junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher" } [plugins] kotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }- 在
在 IDE 中重新加载构建文件。
有关构建文件设置的更多详细说明,请参阅项目配置。
添加你的第一个 Kotlin 测试
initial/src/test/java 中的 TodoItemTest.java 测试已经验证了应用程序的基础功能:条目创建、默认值、唯一 ID 以及状态更改。
你可以通过添加用于验证仓库层行为的 Kotlin 测试来扩展测试覆盖率:
导航至相同的测试源目录
initial/src/test/java。在与 Java 测试相同的包中创建
TodoRepositoryTest.kt文件。创建包含字段声明和设置函数的测试类:
kotlinpackage org.jetbrains.kotlin.junit import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Assertions import org.junit.jupiter.api.Test import org.junit.jupiter.api.DisplayName internal class TodoRepositoryTest { lateinit var repository: TodoRepository lateinit var testItem1: TodoItem lateinit var testItem2: TodoItem @BeforeEach fun setUp() { repository = TodoRepository() testItem1 = TodoItem("Task 1", "Description 1") testItem2 = TodoItem("Task 2", "Description 2") } }- JUnit 注解在 Kotlin 中的工作方式与在 Java 中相同。
- 在 Kotlin 中,
lateinit关键字允许声明稍后初始化的非 null 属性。这有助于避免在测试中使用可空类型(TodoRepository?)。
在
TodoRepositoryTest类中添加一个测试,以检查初始仓库状态及其大小:kotlin@Test @DisplayName("Should start with empty repository") fun shouldStartEmpty() { Assertions.assertEquals(0, repository.size()) Assertions.assertTrue(repository.all.isEmpty()) }- 与 Java 的静态导入不同,Jupiter 的
Assertions是作为类导入的,并用作断言函数的限定符。 - 你无需调用
.getAll(),而是可以在 Kotlin 中使用repository.all将 Java getter 作为属性访问。
- 与 Java 的静态导入不同,Jupiter 的
编写另一个测试以验证所有条目的复制行为:
kotlin@Test @DisplayName("Should return defensive copy of items") fun shouldReturnDefensiveCopy() { repository.add(testItem1) val items1 = repository.all val items2 = repository.all Assertions.assertNotSame(items1, items2) Assertions.assertThrows( UnsupportedOperationException::class.java ) { items1.clear() } Assertions.assertEquals(1, repository.size()) }- 要从 Kotlin 类获取 Java 类对象,请使用
::class.java。 - 你可以将复杂的断言拆分为多行,而无需使用任何特殊的延续字符。
- 要从 Kotlin 类获取 Java 类对象,请使用
添加一个测试以验证根据 ID 查找条目:
kotlin@Test @DisplayName("Should find item by ID") fun shouldFindItemById() { repository.add(testItem1) repository.add(testItem2) val found = repository.getById(testItem1.id()) Assertions.assertTrue(found.isPresent) Assertions.assertEquals(testItem1, found.get()) }Kotlin 可以与 Java 的
OptionalAPI 无缝协作。它会自动将 getter 方法转换为属性,因此这里的isPresent()方法被作为属性访问。编写一个测试以验证条目移除机制:
kotlin@Test @DisplayName("Should remove item by ID") fun shouldRemoveItemById() { repository.add(testItem1) repository.add(testItem2) val removed = repository.remove(testItem1.id()) Assertions.assertTrue(removed) Assertions.assertEquals(1, repository.size()) Assertions.assertTrue(repository.getById(testItem1.id()).isEmpty) Assertions.assertTrue(repository.getById(testItem2.id()).isPresent) } @Test @DisplayName("Should return false when removing non-existent item") fun shouldReturnFalseForNonExistentRemoval() { repository.add(testItem1) val removed = repository.remove("non-existent-id") Assertions.assertFalse(removed) Assertions.assertEquals(1, repository.size()) }在 Kotlin 中,你可以链式调用方法和属性访问,例如
repository.getById(id).isEmpty。
你可以向 TodoRepositoryTest 测试类添加更多测试以覆盖其他功能。 请在示例项目的 complete 模块中查看完整源代码。
运行测试
同时运行 Java 和 Kotlin 测试以验证你的项目是否按预期工作:
使用装订区域图标运行测试:

你也可以使用命令行在
initial目录下运行所有项目测试:bashmvn testbash./gradlew test通过更改其中一个变量值来检查测试是否正常工作。 例如,修改
shouldAddItem测试以使其断言一个不正确的仓库大小:kotlin@Test @DisplayName("Should add item to repository") fun shouldAddItem() { repository.add(testItem1) Assertions.assertEquals(2, repository.size()) // 从 1 改为 2 Assertions.assertTrue(repository.all.contains(testItem1)) }再次运行测试并验证它是否失败:

你可以在示例项目的 complete 模块中找到配置完整且包含测试的项目。
后续步骤
- 详细了解使用 Maven 测试 Kotlin 项目。
- 在 Kotlin 后端开发常见问题解答中查找常见问题的答案。
