使用 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> <!-- Add JUnit Jupiter engine for test runtime --> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-engine</artifactId> <scope>test</scope> </dependency> <!-- Optionally: parameterized tests support --> <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><!-- Lock down plugin versions to avoid using Maven defaults (can be moved to a parent pom file) --> <plugins> <!-- Clean lifecycle, see 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 lifecycle, jar packaging: see 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 lifecycle, see 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> <!-- No maven-compiler-plugin needed with Kotlin extensions --> </plugins> </pluginManagement> <plugins> <!-- Activate Kotlin Maven plugin for main and test sources --> <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相依性。 - 當使用帶有擴充套件的 Kotlin Maven 外掛程式時,無需在
<build><pluginManagement>區段中新增maven-compiler-plugin。
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 toolchain 版本以符合你的 Java 版本。
- 在
dependencies {}區塊中,新增提供 Kotlin 測試工具並與 JUnit 整合的kotlin.test程式庫。
Kotlin/JVM 支援最新的穩定 JUnit 版本(JUnit 6)。你可以在
gradle/libs.versions.toml版本目錄 (version catalog) 中找到它。如果你通常偏好使用版本目錄,甚至也可以將
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 以及狀態變更。
你可以透過新增一個驗證 repository 層級行為的 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 屬性。這有助於避免在測試中必須使用可 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是作為類別匯入,並作為斷言函式的限定詞使用。 - 你可以使用
repository.all在 Kotlin 中將 Java getter 作為屬性存取,而不必呼叫.getAll()。
- 與 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 後端開發常見問題中尋找常見問題的解答。
