matman

Mock service and Tester assistant

matman 是什么

本质上是一个 mock 服务器，可以方便的管理你的不同的 mock 数据。在大部分前后端分离的架构中，一般会先加载前端页面，然后通过 CGI 请求获取数据，最后完成渲染。CGI 返回什么样的数据会直接影响页面的展现和交互。借助 matman，你很容易构造自己的 mock 数据，并且指定返回哪些形式的数据。

如何使用

matman 提供 run 方法来启动，接受一个配置参数

var matman = require('matman');

var options = {};

matman.run(options);

更多使用请看 demo。

技术细节

matman 操作的基本单位为 mocker，每一条 CGI 的操作，我们称之为一个 mocker，每一种数据返回我们称之为一个 mock module。

每个项目中可能有多个 mocker （因为会有多条CGI），每个 mocker 包含多个 mock module（因为每条CGI返回肯定会有多种状态）。

mocker

matman 提供了一套路由系统，用于将 CGI 和 本地的 mocker 建立联系。每个 mocker 必须包含一个 config.json 文件，详细说明如下：

其中必须配置的字段为 route。matman 是基于 Express 开发的，因此这里的 route 值最终将被应用到 app.use(route,callback) 中，而 callback 回调返回最终将引用到对应的 mocker 中的文件。

具体使用细节可以参考 demo。

matman 项目启动之后，会在每个 mocker 中生成一个缓存文件 matman.json，一般情况下你无须关注，由于 matman 的存储是使用文件夹存储的，如果你需要保持你的行为，你可以保存 matman.json ，但请不要直接修改，而是使用 config.json 文件。

mock module

必须符合 CommonJS 规范

matman 的每个 mock module 都是一个独立的 js 模块，必须符合 CommonJS 规范。

方式1：返回 Object：

module.exports = {
  "isExist": true,
  "name": "matman",
  "version": "0.0.1"
};

方式2：返回 Function：

当返回一个函数时，matman 会传递两个参数，params 是 CGI 的请求参数对象， req 是 Express 的 req 对象

export default function getData(params, req) {
    return {
        name: 'return-function-pure',
        age: params && params.age || 0
    };
}

如果在函数中有异步处理，则在函数中返回 Promise ：

export default function getData(params, req) {
  return new Promise((resolve, reject) => {

    // 异步处理，例如请求CGI等操作，这里使用 setTimeout 来模拟
    setTimeout(() => {
      resolve({
        name: 'return-promise',
        age: 16
      })
    }, 1000);

  });
}

方式3：返回 Promise，但是不建议使用。

config.json 配置文件扩展能力

每个 mock module 都支持配置 config.json 文件，用于扩展一些能力，其字段的定义如下：

如何识别是 mock 数据

如果是 mock 数据，则在 response header 中会有 matman-mocker 和 matman-mock-module 字段。

如果禁用了整个 mocker，则在响应中增加 matman_disable 字段来标识，其值为 mocker 的名字。

从请求 req 或者 config.json 文件中检查当前请求是否需要禁用 mock 服务，区别在于前者是单次请求（携带了 _m_disable 参数），而后者是所有的请求都禁用。

开发者文档

• 贡献代码