17370845950

新闻动态

WireMock 在 Java 项目中的正确集成与编译问题解析

本文旨在解决Java项目中WireMock集成时常见的“无法找到符号”编译错误。核心问题在于Maven依赖的test作用域限制了WireMock在主代码中的可用性。教程将详细解释Maven依赖作用域的概念，并指导开发者如何将WireMock正确地应用于测试代码中，通过JUnit集成实现高效的API模拟。

引言

wiremock 是一个功能强大的 http api 模拟器，广泛应用于 java 项目的测试阶段，用于模拟外部服务、控制其行为，从而实现独立、可重复和快速的单元及集成测试。然而，对于初学者而言，在将其集成到 maven 或 gradle 项目时，可能会遇到编译错误，特别是经典的“cannot find symbol”问题。本文将深入探讨这一问题，并提供专业的解决方案和最佳实践。

常见问题：WireMock 编译错误解析

许多开发者在尝试将 WireMock 引入 Java 项目时，可能会遇到以下编译错误：

[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /path/to/your/project/src/main/java/YourMainClass.java:[4,9] cannot find symbol
  symbol:   class WireMockServer
  location: class YourMainClass
[ERROR] /path/to/your/project/src/main/java/YourMainClass.java:[4,60] cannot find symbol
  symbol:   method options()
  location: class YourMainClass

这类错误通常发生在尝试在 src/main/java 目录下的主应用程序代码中直接实例化 WireMockServer 时。例如，以下 pom.xml 配置和 Java 代码片段：

错误的 pom.xml 配置示例：


    4.0.0
    com.mycode
    test
    1.0
    
        19
        19
    
    
        
            com.github.tomakehurst
            wiremock-jre8
            2.35.0
            test

错误的 Java 代码示例 (src/main/java/testWiremock.java)：

public class testWiremock {
    public static void main(String[] args) {
        WireMockServer wiremockServer = new WireMockServer(options().port(8080)); // 编译错误发生在此处
        wiremockServer.start();
        System.out.println("Server running successfully!");
        wiremockServer.stop();
    }
}

当执行 mvn compile 命令时，Maven 编译器会报告 cannot find symbol 错误，表明它无法识别 WireMockServer 类和 options() 方法。这并不是 WireMock 库本身的问题，而是对 Maven 依赖作用域理解不足导致的。

Maven 依赖作用域 (scope) 详解

Maven 依赖管理中的 scope（作用域）是一个至关重要的概念，它定义了依赖在构建生命周期中何时可用以及如何被传递。理解不同的作用域是解决上述问题的关键。

compile (默认): 这是默认作用域。此类依赖在项目的编译、测试、运行和打包阶段都可用。它们会被打包到最终的 JAR/WAR 中。
provided: 类似于 compile，但在打包时不会包含在最终的 JAR/WAR 中。适用于那些在运行时由容器（如 Servlet API 由应用服务器提供）提供的依赖。
runtime: 依赖在运行和测试时需要，但在编译时不需要。例如 JDBC 驱动。
test: 这是本文问题的核心。 此类依赖仅在测试编译和测试执行阶段可用。它们不会被打包到最终的 JAR/WAR 中，也不会在主应用程序的运行时类路径中。WireMock 通常就属于此作用域。
system: 类似于 provided，但需要提供一个明确的路径到本地文件系统中的 JAR 包。不推荐使用。
import: 仅在部分使用，用于导入另一个 pom.xml 中的依赖管理配置。

回到前面的错误，当我们将 wiremock-jre8 的 scope 设置为 test 时，Maven 明确指示 WireMock 库只在 src/test/java 目录下的测试代码编译和执行时才会被添加到类路径中。因此，当 mvn compile 尝试编译 src/main/java 目录下的 testWiremock.java 文件时，它无法找到 WireMockServer 和 options() 方法，因为这些类和方法并不在主代码的编译类路径中。

WireMock 的正确使用姿势

WireMock 的主要设计目标是作为测试工具，用于模拟外部服务，而不是作为应用程序的核心运行时组件。因此，它的代码和配置通常应放在 src/test/java 目录下。

以下是使用 WireMock 进行测试的正确方法，结合 JUnit 5 和 @WireMockTest 注解：

更新 pom.xml： 确保 WireMock 依赖的 scope 仍然是 test。同时，为了使用 JUnit 5 的 @WireMockTest 注解，还需要添加 JUnit 5 的相关依赖。


    4.0.0
    com.mycode
    test
    1.0
    
        19
        19
        5.10.0 
    
    
        
        
            com.github.tomakehurst
            wiremock-jre8
            2.35.0
            test
        
        
        
            org.junit.jupiter
            junit-jupiter-api
            ${junit.jupiter.version}
            test
        
        
        
            org.junit.jupiter
            junit-jupiter-engine
            ${junit.jupiter.version}
            test
        
        
        
        
            com.github.tomakehurst
            wiremock-junit5
            2.35.0 
            test
        
    
    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.11.0 
            
            
                org.apache.maven.plugins
                maven-surefire-plugin
                3.2.2

创建测试类 (src/test/java/MyWireMockTest.java)： 在 src/test/java 目录下创建你的测试类。使用 @WireMockTest 注解可以声明式地启动和停止 WireMock 服务器，并配置其端口。

import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.junit5.WireMockTest;
import org.junit.jupiter.api.Test;

import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

// 使用 @WireMockTest 注解，WireMock 服务器会在测试方法执行前后自动启动和停止
// httpPort 定义了 WireMock 服务器监听的端口
@WireMockTest(httpPort = 8080)
public class MyWireMockTest {

    @Test
    void testWireMockStu*g() throws Exception {
        // 1. 定义 WireMock 桩 (Stub)
        // 当请求路径为 /my/resource 且方法为 GET 时，返回状态码 200 和指定响应体
        stubFor(get(urlEqualTo("/my/resource"))
                .willReturn(aResponse()
                        .withStatus(200)
                        .withHeader("Content-Type", "application/json")
                        .withBody("{\"message\": \"Hello from WireMock!\"}")));

        // 2. 使用 HttpClient 发送请求到 WireMock 服务器
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("http://localhost:8080/my/resource"))
                .GET()
                .build();

        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());

        // 3. 验证响应
        assertEquals(200, response.statusCode());
        assertEquals("{\"message\": \"Hello from WireMock!\"}", response.body());

        // 4. 验证 WireMock 服务器是否接收到请求 (可选)
        verify(getRequestedFor(urlEqualTo("/my/resource")));
    }

    @Test
    void testAnotherEndpoint() throws Exception {
        stubFor(post(urlEqualTo("/api/data"))
                .withRequestBody(containing("test data"))
                .willReturn(aResponse()
                        .withStatus(201)
                        .withBody("Created successfully")));

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("http://localhost:8080/api/data"))
                .POST(HttpRequest.BodyPublishers.ofString("{\"payload\": \"test data\"}"))
                .build();

        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());

        assertEquals(201, response.statusCode());
        assertEquals("Created successfully", response.body());
        verify(postRequestedFor(urlEqualTo("/api/data")));
    }
}

运行测试： 现在，你可以使用 mvn test 命令来运行你的测试。WireMock 服务器将在每个带有 @WireMockTest 的测试类执行前自动启动，并在执行后停止。
```
mvn test
```
此时，编译和测试都将成功执行，因为 WireMock 依赖在 test 作用域下被正确地应用于测试代码。

注意事项

WireMock 作为测试工具： 始终牢记 WireMock 主要用于测试。如果你的主应用程序确实需要嵌入一个 HTTP 服务器（例如，作为回调端点或模拟服务），那么可能需要考虑其他轻量级 HTTP 服务器库，或者将 WireMock 的 scope 改为 compile 并引入 wiremock-jre8-standalone 依赖（不推荐在生产代码中这样做，除非有非常特殊的理由）。

JUnit 4 用户： 如果你仍然使用 JUnit 4，可以使用 @Rule 注解配合 WireMockRule 来管理 WireMock 服务器的生命周期。

import com.github.tomakehurst.wiremock.junit.WireMockRule;
import org.junit.Rule;
import org.junit.Test;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;

public class MyJUnit4WireMockTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(wireMockConfig().port(8080)); // 指定端口

    @Test
    public void testSomething() {
        stubFor(get(urlEqualTo("/some/path"))
                .willReturn(aResponse().withBody("Hello JUnit 4!")));
        // ... 发送请求并验证 ...
    }
}

独立运行 WireMock： 除了在 Java 代码中嵌入，WireMock 还可以作为独立的 JAR 包或 Docker 容器运行。这对于非 Java 项目或需要独立于应用程序生命周期运行模拟服务的场景非常有用。
Maven 插件： Maven Surefire Plugin 负责运行单元测试，Maven Failsafe Plugin 负责运行集成测试。确保你的 pom.xml 中配置了这些插件的最新版本，以正确执行测试。

总结

解决 WireMock 在 Java 项目中遇到的“cannot find symbol”编译错误，关键在于正确理解和使用 Maven 依赖的 scope 概念。WireMock 作为一个测试工具，其依赖应配置为 test 作用域，并且相关代码应放置在 src/test/java 目录下。通过利用 JUnit 5 的 @WireMockTest 等注解，可以优雅地管理 WireMock 服务器的生命周期，从而实现高效、可靠的 API 模拟测试。遵循这些最佳实践，将有助于开发者更顺畅地集成和利用 WireMock 的强大功能。

17370845950

引言

常见问题：WireMock 编译错误解析

Maven 依赖作用域 (scope) 详解

WireMock 的正确使用姿势

注意事项

总结

关于我们

服务项目

广告推广

案例欣赏