简单Mock Server服务
最近公司对接了不少客户单点登录，需要调用外部的接口，接口配置等信息给到比较晚，因此自己实现了一个简单的Mock Server来模拟对方接口，基于spring boot开发，只要有JDK8+就可以运行，独立一个压缩包，下载后直接运行bin/start.bat即可，比较方便实用。
目前网络上有很多mock服务，包括Postman、easy-mock等都提供在线版本mock server，在线版本稳定性比较差，经常访问失败。
前端开发可以使用mockjs来做mock服务，后端对接却并不方便。
而且大部分对于后台对接使用非json支持不太友好。
安装和配置
文件是个zip压缩包，只依赖JDK8+，没有其他依赖项目，数据库等信息都嵌入在内。
下载simple-boot-mock-server
目前发布到github上，可以下载：https://github.com/fugary/simple-boot-mock-server/releases
下载后文件：simple-boot-mock-server-0.9.1-SNAPSHOT-assembly.zip
解压后文件和目录介绍：
- /bin——里面有start.bat和start.sh启动文件，当然可以不用，直接用
java -jar xxx.jar启动 - /config——里面有个spring boot的application.yml，可以修改数据库配置，日志路径等。
- simple-boot-mock-server-0.9.1-SNAPSHOT.jar——可运行的fat jar
- /data——默认H2数据库文件
- /logs——logback日志输出
运行simple-boot-mock-server
Windows环境下双击 start.bat即可。
由于没有做任何权限控制，界面默认已经填好账号，登录即可，登录后如下：
image
可以看到目前只有两个菜单：【模拟分组】和【数据库控制台】
数据库控制台是H2数据库控制台，默认密码也是123456，其实都可以在application.yml中配置。
模拟分组就是模拟服务的分组，方便以不同的URL访问
使用模拟服务
下面可以建立和测试模拟服务了。
新建模拟服务分组
一个模拟服务分组对应一个模拟的路径
image
保存之后会生成一个路径ID，整个路径默认就是以/mock/xxxxxxxxxxx开头
下面可以配置请求路径了。
image
配置模拟请求路径
请求路径是以/开头的路径，访问的时候前缀是分组的路径
image
建立好请求路径之后，其实是没有任何响应数据的，因此还需要新建响应数据
image
注：没有响应数据的请求已经是可以预览了，不过是一个404的输出。
image
配置响应数据
点击【+】之后，可以添加响应数据。
image
响应数据可以配置http状态码，输出Content Type，输出内容等信息。
输出内容可以配置Json、XML等任何文本数据
对于Json数据，可以是Json对象数据，不一定按照JSON标准双引号输入，后台使用了mockjs做处理，Json数据是支持mockjs的语法和输出。
image
另外有个编辑详情功能，方便配置更多输出信息，自定义响应头（未完成）、描述信息等。
image
然后可以配置多个响应输出，请求输出是第一个响应，然后可以设置其中一个为默认响应，设置好请求输出就是配置的默认响应了。
image
到这一步就算配置好了，可以使用了，也可以在页面预览
预览和参数定义
点击预览的按钮就可以预览请求了。
image
支持路径参数，用下面的配置做测试：
使用路径：/test2/:id/:name
image
输出信息配置：
{
id: ${id},
name: '${name}',
desc: '${name} New Bee'
}
预览信息：
image
使用参数后的真实输出：
{
"id": 1,
"name": "小猪佩琪",
"desc": "小猪佩琪 New Bee"
}
另外mockjs语法支持：
开始出现过中文乱码问题，使用java参数-Dfile.encoding=UTF-8
配置：
{
"user|2": [{
'name': '@cname',
'id|+1': 1
}]
}
输出：
{
"user": [
{
"name": "陆明",
"id": 1
},
{
"name": "范明",
"id": 2
}
]
}
simple-mock-server原理
基于SpringBoot开发的服务端，基于Vue-Admin-Template开发的客户端，然后打包的时候合并到服务端同一个项目。
源码地址：
https://github.com/fugary/simple-boot-mock-server
核心代码，匹配/mock/**根据Request请求获取MockGroup的配置，查找到匹配的MockData，然后输出：
@RestController
@RequestMapping(MockConstants.MOCK_PREFIX)
public class MockController {
@Autowired
private MockGroupService mockGroupService;
@RequestMapping("/**")
public ResponseEntity doMock(HttpServletRequest request, HttpServletResponse response) throws IOException {
String dataId = request.getHeader(MockConstants.MOCK_DATA_ID_HEADER);
MockData data = mockGroupService.matchMockData(request, NumberUtils.toInt(dataId));
if (data != null) {
if(HttpStatus.MOVED_TEMPORARILY.value() == data.getStatusCode()){
if(SimpleMockUtils.isMockPreview(request)){
return ResponseEntity.ok("重定向请设为默认响应后复制URL到浏览器访问");
}
return ResponseEntity.status(data.getStatusCode()).header(HttpHeaders.LOCATION, data.getResponseBody()).body(null);
}
return ResponseEntity.status(data.getStatusCode())
.header(HttpHeaders.CONTENT_TYPE, data.getContentType())
.body(data.getResponseBody());
}
return ResponseEntity.notFound().build();
}
}
Java直接调用MockJS调用代码：
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class MockJsUtils {
/**
* Javascript执行引擎
*/
public static final ScriptEngine MOCK_JS_ENGINE;
/**
* mockjs的资源路径
*/
private static final String MOCK_JS_PATH = "js/mock-min.js";
static {
MOCK_JS_ENGINE = new ScriptEngineManager().getEngineByName("js");
try (
InputStream mockJs = MockJsUtils.class.getClassLoader().getResourceAsStream(MOCK_JS_PATH);
InputStreamReader reader = new InputStreamReader(mockJs)
) {
MOCK_JS_ENGINE.eval(reader);
} catch (ScriptException | IOException e) {
log.error("执行MockJs错误", e);
}
}
public static String mock(String template) {
String result = StringUtils.trimToEmpty(template);
if (isJson(result)) {
try {
result = MOCK_JS_ENGINE.eval("JSON.stringify(Mock.mock(" + result + "))").toString();
} catch (ScriptException e) {
log.error("执行Mock.mock错误", e);
}
}
return result;
}
}
另外：
所有的数据、日志等都在同一个目录下面，后期更新，可以保留data和logs文件夹替换其他文件即可保留以前的数据。
内部使用了flyway做数据版本控制。
flyway:
baseline-on-migrate: true
out-of-order: true
placeholder-prefix: "${"
table: flyway_schema_history
locations: classpath:db/migration
网友评论