WireMock 项目教程

1. 项目目录结构及介绍

WireMock 项目的目录结构如下：

wiremock/
├── .github/
├── gradle/
├── perf-test/
├── sample-war/
├── scripts/
├── src/
├── test-extension/
├── testlogging/
├── ui/
├── wiremock-jetty12/
├── .gitignore
├── .nvmrc
├── .sdkmanrc
├── .snyk
├── CONTRIBUTING.md
├── LICENSE.txt
├── NOTICE.txt
├── README.md
├── RELEASING.md
├── Vagrantfile
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── jdepend.xsl
├── settings.gradle

目录介绍

• .github/: 包含 GitHub 相关的配置文件，如 Issue 模板、PR 模板等。
• gradle/: 包含 Gradle 构建工具的配置文件。
• perf-test/: 包含性能测试相关的代码和配置。
• sample-war/: 包含示例 WAR 文件的代码和配置。
• scripts/: 包含项目使用的脚本文件。
• src/: 包含项目的源代码，包括 Java 代码、资源文件等。
• test-extension/: 包含测试扩展相关的代码和配置。
• testlogging/: 包含测试日志相关的代码和配置。
• ui/: 包含用户界面相关的代码和配置。
• wiremock-jetty12/: 包含 Jetty 12 相关的代码和配置。
• .gitignore: Git 忽略文件配置。
• .nvmrc: Node Version Manager 配置文件。
• .sdkmanrc: SDKMAN 配置文件。
• .snyk: Snyk 安全扫描配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.txt: 项目许可证文件。
• NOTICE.txt: 项目通知文件。
• README.md: 项目介绍和使用说明。
• RELEASING.md: 发布指南。
• Vagrantfile: Vagrant 虚拟机配置文件。
• build.gradle: Gradle 构建配置文件。
• gradle.properties: Gradle 属性配置文件。
• gradlew: Gradle 包装器脚本。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• jdepend.xsl: JDepend 样式表文件。
• settings.gradle: Gradle 设置配置文件。

2. 项目启动文件介绍

WireMock 项目可以通过多种方式启动，包括作为 Java 库、独立进程或 Docker 容器。以下是几种常见的启动方式：

作为 Java 库启动

在项目的 build.gradle 文件中添加以下依赖：

testImplementation "org.wiremock:wiremock:3.9.1"

然后，在测试代码中启动 WireMock 服务器：

import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static com.github.tomakehurst.wiremock.client.WireMock.*;

public class WireMockTest {
    public static void main(String[] args) {
        WireMockServer wireMockServer = new WireMockServer(wireMockConfig().port(8080));
        wireMockServer.start();

        // 配置 WireMock 响应
        stubFor(get(urlEqualTo("/my/resource"))
                .willReturn(aResponse()
                        .withHeader("Content-Type", "text/plain")
                        .withBody("Hello World!")));

        // 进行测试
        // ...

        wireMockServer.stop();
    }
}

作为独立进程启动

下载最新的独立 JAR 文件，然后在终端中运行以下命令：

java -jar wiremock-standalone-3.9.1.jar

作为 Docker 容器启动

在终端中运行以下命令：

docker run -it --rm -p 8080:8080 --name wiremock wiremock/wiremock:3.9.1

3. 项目配置文件介绍

WireMock 项目的配置文件主要包括 Gradle 构建配置文件和一些项目特定的配置文件。

Gradle 构建配置文件

• build.gradle: 包含项目的构建配置，如依赖管理、任务定义等。
• settings.gradle: 包含项目的设置配置，如项目名称、模块配置等。
• gradle.properties: 包含 Gradle 属性配置，如版本号、仓库地址等。

项目特定配置文件

• .gitignore: 指定 Git 忽略的文件和目录。
• .nvmrc: 指定 Node.js 版本。
• .sdkmanrc: 指定 SDKMAN 配置。
• .snyk: 指定 Snyk 安全扫描配置。
• Vagrantfile: 指定 Vagrant 虚拟机配置。
• jdepend.xsl: 指定 JDepend 样式表配置。

这些配置文件共同确保了 WireMock 项目的构建、运行和管理的顺利进行。