karentwan/mock-system

使用docker部署

先编译出服务的jar包，可以使用idea的package指令，或者使用maven命令，如下:

mvn package

构建docker镜像

# 进入工程目录，执行
docker build -t mock .

服务启动

服务的启动有两种模式, 分别为：

MEM-内存存储模式

启动命令如下：

docker run -e mode=MEM -p 8079:8079 mock

MEM模式表示可以通过接口配置模板，配置的模板将存储在内存里面。配置接口如下

POST http://localhost:8079/template/config

{
    "api": "/test",
    "headers": {
        "Content-Type": "text/plain",
        "cust": "aaa"
    }, 
    "template": "{\"a\": \"wan\"}"
}

其中api表示接口名称, headers表示响应头(可选), template表示模板响应的内容。

配置完后访问：

POST http://localhost:8079/test

{
    "a": "wan"
}


# 响应结果

{
    "a": "wan"
}

FILE -文件模式

启动命令如下：

docker run -e mode=FILE -e path=/app/data -p 8079:8079 mock

FILE模式表示响应的模板放在/app/data目录下面。

该模式下，系统在接收到请求的时候，会去模板目录下面寻找对应的文件配置(文件配置和调接口配置的内容格式是一样的)。

模板文件必须以.json格式结尾，文件名为接口名称(/被替换为_)，举个例子，接口/test/a/b,那么对应的文件名为test_a_b.json。

模板中预制的变量

模板中有一些预制的变量：header、body、F, 分别表示http请求头、请求体、可以使用的自定义函数。举个例子，在我们渲染的模板中，有些内容是取自请求头、有些则是取自请求体、还有随机生成的数字，那么配置模板可以这样写：

{
  "api": "/test",
  "headers": {
    "content-type": "application/json"
  },
  "template": "<#if header.token??> {\"hello\": \"wan\", \"param\": \"${body.a}\", \"token\": \"${header.token}\", \"content_type\": \"${header.contentType}\"} <#else> {\"hello\": \"no token\", \"param\": \"${body.a}\", \"random\": \"${F.random.nextInt()}\"} </#if>"
}

仔细看template字段的内容，上面语法的意思是，如果header(发送请求时的http请求头)里面含有token则响应:

{
    "hello": "wan",
    "param": "${body.a}",
    "token": "${header.token}",
    "content_type": "${header.contentType}"
}

这上面的param取自请求体里面的a字段，content_type取自请求头里面的content-type字段。

如果header里面不含有token则响应:

{
    "hello": "no token",
    "param": "${body.a}",
    "random": "${F.random.nextInt()}"
}

这上面的param取自请求体里面的a字段，random取自随机生成的数字，而F.random就是Java里面的Random类, 用法跟它一样。

发送请求：

POST http://localhost:8079/test

{
  "a": "123"
}

插件系统

为了增强请求和响应的处理，系统还引入了一套插件系统体系，插件系统的配置是可插拔式的，下面给出一个修改http状态码的插件例子。

插件系统的配置

POST http://localhost:8079/template/config

{
    "api": "/test",
    "headers": {
      "content-type": "application/json"
    },
    "template": "<#if header.token??> {\"hello\": \"wan\", \"param\": \"${body.a}\", \"token\": \"${header.token}\", \"content_type\": \"${header.contentType}\"} <#else> {\"hello\": \"no token\", \"param\": \"${body.a}\", \"random\": \"${F.random.nextInt()}\"} </#if>",
    "plugins":
    [
        {
            "name": "HttpStatus",
            "config": "{\"status\": 400 }"
        }
    ]
}

使用上面的配置，当我们访问http://localhost:8079/test 时，返回的http状态码为400，这可以在测试我们的系统时模拟一些异常情况，方便我们测试。

上面的模板配置中，plugins是配置的插件列表，该参数配置的多个插件会以责任链的方式依次执行。

自定义插件规范

如果有自定义插件的需求，需要实现cn.karent.filter.plugin.Plugin 接口, 并重写它的方法：

void doProcess(Request request, Response response, PluginChain chain) throws ServletException, IOException;

如果只想要改变请求、响应二者之一，可以继承cn.karent.filter.plugin.PluginAdapter接口，并实现里面的processRequest(Request)方法或者processResponse(Response)方法。

如果自定义插件有自己的参数（如上面配置Http状态码），那么需要实现cn.karent.common.Configurable接口，并重写它的方法：

void configure0(C c);

该方法会将参数传递给插件，具体的例子可以参考：cn.karent.plugin.HttpStatusPlugin类的实现。

注意：自定义的插件需要加上SpringBoot的@Component注解，否则插件系统的配置将无法生效。

karentwan / mock-system

使用docker部署

服务启动

模板中预制的变量

插件系统

自定义插件规范

About

Languages