Mock是一个零侵入的服务端Mock平台，底层基于JVM Sandbox。相比于Fiddler、-mock-fe.zip

# 1 简介   Mock是一个零侵入的服务端Mock平台，底层基于JVM Sandbox。相比于Fiddler、Charles和Burp Suite等客户端的代理调试工具，Mock的优势在于可以对调用链中的任何服务节点数据进行Mock，而不只是Mock离客户端最近一个节点的数据。 ## 1.1 主要特性 * 零侵入，即不修改目标应用程序任何代码就能实现Mock功能。 * 支持静态Mock，即根据配置的类和方法，返回Mock数据。 * 支持动态Mock，即根据调用方法时传入的参数，动态判断是返回Mock数据还是真实数据。 * 支持返回多种Mock数据，包括JSON列表、JSON、null、String和基本类型，并支持抛出异常。 * 新增、编辑、删除、启用和禁用配置时，不需要重启目标应用程序。 * 自带Mock控制台，可通过界面管理Mock配置和查看目标应用程序。 * 自带示例应用程序，可作为目标应用程序以便用户学习。 ## 1.2 组成部分 * Mock模块：即[mock](https://github.com/lujiatao2/mock)工程中的mock-module。Mock模块的底层基于JVM Sandbox，其属于JVM Sandbox的一个用户模块，可被JVM Sandbox加载。由于JVM Sandbox只支持Linux、Unix和macOS操作系统，因此Mock模块也只能在这些操作系统上安装。 * Mock控制台后端：即[mock](https://github.com/lujiatao2/mock)工程中的mock-be。它是Mock控制台的后端服务，使用MySQL作为数据库。 * Mock控制台前端：即本工程。它是Mock控制台的前端服务。 * 示例应用程序：即[mock](https://github.com/lujiatao2/mock)工程中的mock-example-app。示例应用程序提供多个示例接口，以便用户学习使用。 # 2 安装   由于安装过程会用到一些基础工具（比如wget），若提示“未找到命令”或“command not found”，则需要先安装对应的基础工具。   演示安装过程的服务器IP地址为192.168.3.102，用户需根据实际情况进行修改。 ## 2.1 安装Mock模块   有两种方法可以安装Mock模块，任选其一。 ### 2.1.1 在线安装   下载在线安装脚本： ```shell wget https://github.com/lujiatao2/mock/releases/download/1.0.0/install-online.sh ```   给安装脚本增加执行权限： ```shell chmod +x install-online.sh ```   执行安装脚本： ```shell ./install-online.sh ``` ### 2.1.2 本地安装   下载源代码到本地： ```shell git clone https://github.com/lujiatao2/mock.git ```   进入安装脚本所在目录： ```shell cd mock/bin/ ```   给安装脚本增加执行权限： ```shell chmod +x install-local.sh ```   执行安装脚本： ```shell ./install-local.sh ``` ## 2.2 安装Mock控制台   由于Mock控制台使用的是常用技术栈，因此安装方式很多，这里仅以Docker来演示安装过程，容器管理使用Docker Compose（当然也可以使用Docker Swarm或Kubernetes等）。   新增docker-compose.yml文件，文件内容如下： ```yaml version: "3.3" services: mock-mysql: image: mysql:5.7.33 container_name: mock-mysql restart: always ports: - "10000:3306" environment: - MYSQL_ROOT_HOST=% - MYSQL_ROOT_PASSWORD=root123456 - MYSQL_DATABASE=mock - TZ=Asia/Shanghai command: --character-set-server=utf8 volumes: - /opt/mysql/mock:/var/lib/mysql mock-be: image: registry.cn-chengdu.aliyuncs.com/lujiatao/mock-be:1.0.0 container_name: mock-be restart: always ports: - "10001:8080" environment: - MYSQL_URL=jdbc:mysql://mock-mysql:3306/mock depends_on: - mock-mysql mock-fe: image: registry.cn-chengdu.aliyuncs.com/lujiatao/mock-fe:1.0.0 container_name: mock-fe restart: always ports: - "10002:80" environment: - MOCK_BE_IP=192.168.3.102 - MOCK_BE_PORT=10001 - MOCK_FE_PORT=10002 depends_on: - mock-be ```   可能需要修改的配置： * MySQL、Mock控制台后端和Mock控制台前端映射的宿主机端口分别为10000、10001和10002，需根据实际情况进行修改。 * MySQL root密码默认为root123456，需根据实际情况进行修改。 * Mock控制台后端IP地址默认为192.168.3.102，需根据实际情况进行修改。   执行以下命令启动Mock控制台： ```shell docker-compose up -d ```   执行以下命令查看Mock控制台运行状态： ```shell docker-compose ps ```   如果启动成功，那么mock-be、mock-fe和mock-mysql服务都处于Up状态，如下所示： ```shell Name Command State Ports ---------------------------------------------------------------------------------------- mock-be java -jar mock-be.jar Up 0.0.0.0:10001->8080/tcp mock-fe /docker-entrypoint.sh /bin ... Up 0.0.0.0:10002->80/tcp mock-mysql docker-entrypoint.sh --cha ... Up 0.0.0.0:10000->3306/tcp, 33060/tcp ```   访问 http://192.168.3.102:10002/ 显示Mock控制台首页，如下图所示：  # 3 配置   在对目标应用程序进行Mock之前，需求做一些配置工作。 ## 3.1 安装示例应用程序   为了方便用户学习，这里提供了一个示例应用程序作为待Mock的目标应用程序。   下载示例应用程序： ```shell wget https://github.com/lujiatao2/mock/releases/download/1.0.0/mock-example-app-1.0.0.jar ```   执行以下命令启动示例应用程序： ```shell java -jar mock-example-app-1.0.0.jar ```   由于示例应用程序默认使用8080端口，如果与现有端口冲突，可指定不同的端口号来启动，比如指定8090端口启动： ```shell java -jar mock-example-app-1.0.0.jar --server.port=8090 ```   启动成功后就可以调用示例应用程序的接口了： ```shell curl http://192.168.3.102:8090/mock-example-app/by-id?id=1 ```   接口返回如下： ```json { "id": 1, "stringParameter": "String Parameter 0", "intParameter": 0, "integerParameter": 10, "doubleParameter": 0.0, "booleanParameter": true, "adoubleParameter": 1.0, "abooleanParameter": false } ```   示例应用程序接口详见[5.1 示例应用程序接口](https://github.com/lujiatao2/mock#51-%E7%A4%BA%E4%BE%8B%E5%BA%94%E7%94%A8%E7%A8%8B%E5%BA%8F%E6%8E%A5%E5%8F%A3)。 ## 3.2 配置Mock模块   Mock模块的配置文件是mock.properties，位于~/.sandbox-module/cfg目录，配置项说明如下： * app.env：Mock应用环境，比如development、test、demo、production等，需根据实际情况进行修改，缺省值是unknown。 * app.name：Mock应用名称，比如order-server、pay-server等，需根据实际情况进行修改，缺省值是unknown。 * mock.be.url：Mock控制台后端URL地址，需根据实际情况进行修改，缺省值是 http://127.0.0.1:80 。   以下是演示使用的配置： ```properties # Mock应用环境 app.env=demo # Mock应用名称 app.name=mock-example-app # Mock后端URL mock.be.url=http://192.168.3.102:10001 ``` ## 3.3 接入Mock应用   接入Mock应用是指使用JVM Sandbox加载Mock模块生成Mock模块的实例，并将Mock模块实例注册到Mock控制台。   进入JVM Sandbox脚本所在目录： ```shell cd ~/sandbox/bin/ ```   执行以下命令接入Mock应用： ```shell ./sandbox.sh -p `ps -ef | grep mock-example-app-1.0.0.jar | grep -v grep | awk '{print $2}'` ```   -p命令指定的是目标应用程序的进程号，这里使用了ps命令，并结合grep和awk命令查询进程号�