fox-mock 项目使用教程

fox-mock 项目使用教程

fox-mock 基于Java Agent实现的自测，联调Mock利器 项目地址: https://gitcode.com/gh_mirrors/fo/fox-mock

1. 项目的目录结构及介绍

fox-mock 项目的目录结构如下：

fox-mock/
├── fox-mock-agent/
│   └── fox-mock-agent-${version}.jar
├── fox-mock-boot/
│   └── fox-mock-boot-jar-with-dependencies.jar
├── fox-mock-example/
│   └── mockdata/
├── script/
│   └── start.sh
├── static/
├── .gitignore
├── LICENSE
├── README.md
├── agent.properties
└── pom.xml

目录结构介绍

• fox-mock-agent/: 包含 fox-mock-agent-${version}.jar，这是 fox-mock 的核心代码，用于在应用启动时挂载。
• fox-mock-boot/: 包含 fox-mock-boot-jar-with-dependencies.jar，这是用于 attach 挂载的启动程序。
• fox-mock-example/: 包含 mockdata 文件夹，用于存放示例的 mock 数据文件。
• script/: 包含 start.sh 脚本，用于 attach 挂载时的启动脚本。
• static/: 静态资源文件夹。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• agent.properties: 配置文件，用于指定 mock 文件路径等配置。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

2.1 启动挂载使用

在服务器上启动应用时，需要在启动参数中添加以下参数：

java -javaagent:fox-mock包的路径/fox-mock-agent-${version}.jar=foxMockFilePath=mock数据文件的路径 -jar 你的jar

如果是在开发工具中启动，也需要将 -javaagent 加入到启动类的 VM options 中。

2.2 Attach 挂载使用

进入到下载好的文件夹中，执行 start.sh 脚本：

./start.sh

执行之前请确保存在 JAVA_HOME 的环境变量。执行之后会提示选择要 attach 的进程 ID，输入数字按回车即可完成 mock 动作。

3. 项目的配置文件介绍

3.1 agent.properties 配置文件

agent.properties 文件用于指定 mock 文件路径等配置。示例如下：

foxMockFilePath=mock数据文件的路径

3.2 Mock 数据文件格式

mock 数据文件格式为方法的全路径，格式为 com.xx.xxService#getName。文件内容为该方法要返回的数据，基本类型直接写内容即可，如果是对象需要用 JSON 格式。

示例：

{
  "name": "example",
  "age": 25
}

以上是 fox-mock 项目的目录结构、启动文件及配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用 fox-mock 项目。

fox-mock 基于Java Agent实现的自测，联调Mock利器 项目地址: https://gitcode.com/gh_mirrors/fo/fox-mock