mock-server & moco初探

分手后的思念是犯贱 2022-04-04 08:26 465阅读 0赞

# mock-server & moco初探 #

### 文章目录 ###

*  mock-server & moco初探
 *   *  000. Readme
     *  001. What/Why/When
     *  010. How
     *   *  00. moco quick start
         *  01. moco + maven
         *  10. mock-server quick start
         *  11. mock server + maven
     *  011. Which
     *  100. Where

## 000. Readme ##

*  主要介绍[mockserver][]和[moco][]，前者是重点，后者是辅助理解和比较。
 *  但其实比较`github`上的两个项目，无论是在`star/fork`还是`issue/contributors`上面都不分伯仲，前者稍微占些优势吧。
 *  就主要功能而言，两者差不多，但是`mockserver`有更多的使用方式和场景，支持更多的语言和环境。

## 001. What/Why/When ##

`mock-server/moco`是啥？能干什么？为什么要用？什么时候会用到？

*  mock-server/moco都可以模拟任何基于HTTP或HTTPS请求的系统，比如WebService、REST接口等等。
 *  当我们需要基于接口开发或测试的时候，我们可以先简单地根据接口约定模拟好各个请求，实现接口开发和使用解耦；当我们需要测试单个接口的时候，希望其它接口正常请求，我们可以只模拟单个接口，做到服务隔离(需要结合`mock-server-proxy`)；

## 010. How ##

### 00. moco quick start ###

1.  下载moco jar 包：[moco-runner-0.12.0-standalone.jar][]
2.  在jar包同级目录下创建config.json，键入以下内容并保存：
    
        [
          { 
            "response" :
              { 
                "text" : "Hello, Moco"
              }
          }
        ]
    
    内容是一个json array，array里的每一个对象代表一个HTTP请求的mock，这里没有匹配任何url，表示任何url都会返回相同的结果。
3.  使用命令启动：`java -jar moco-runner-0.12.0-standalone.jar http -p 80 -c config.json`
4.  访问`http://localhost`就会显示 `Hello, Moco`
5.  我们再加一个复杂一点链接规则：
    
        [
          { 
            "response" :
              { 
                "text" : "Hello, Moco"
              }
          },
          { 
            "request":{ 
                "uri":"/monitorApplication/alert/confirm",
                "method":"PUT",
                "headers":{ 
                    "userInfo":"{\"tenantId\":\"3\"}"
                },
                "text":"{\"id\":\"123\"}"
            },
            "response":{ 
                "status":200,
                "json":{ 
                    "code":"1000",
                    "msg":"操作成功！",
                    "data":null
                }
            }
          }
        ]
    
    postman访问一下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]
6.  更多配置：[apis.md][]，基本覆盖了所有http请求的场景，包括重定向、事件等等。

### 01. moco + maven ###

首先添加依赖：

<dependency>
      <groupId>com.github.dreamhead</groupId>
      <artifactId>moco-core</artifactId>
      <version>0.12.0</version>
    </dependency>

moco + JUnit

public class MocoTest { 
     
        @Test
        public void should_response_as_expected() throws Exception { 
            HttpServer server = httpServer(12306);
            server.response("foo");
     
            running(server, () -> { 
                Content content = Request.Get("http://localhost:12306").execute().returnContent();
                assertThat(content.asString(), is("foo"));
            });
        }
     
    }

moco runner

public class MocoRunnerTest { 
     
        public static void main(String[] args) { 
            HttpServer server = httpServer(12306, response(header("Content-Type","application/json;charset=gbk")));
            server.put(and(
                    match(header("userInfo"),".*\"tenantId\":\"3\".*"),
                    by(uri("/test")),
                    by(text("{\"id\":\"123\"}"))
            )).response(text(new JSONObject().fluentPut("code","100").fluentPut("data","").fluentPut("msg","操作成功！").toJSONString()));
            Runner runner = runner(server);
            runner.start();
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]  
这样就实现了代码启动，quick start应该也是基于此的一个封装。而且quick start里面的config.json可以实现模块化：

[
        { 
            "context": "/monitorApplication",
            "include": "monitorApplication.json"
        },
        { 
            "context": "/dbaasDbManage",
            "include": "dbaasDbManage.json"
        }
    ]

这样可以实现模块和项目的分离：`/dbaasDbManage/*`的链接会按照`dbaasDbManage.json`文件的规则匹配，`/monitorApplication/*`的链接会按照`monitorApplication.json`文件的规则匹配，并且文件会被箭筒，一旦被修改会马上重新加载，不需要重启。

### 10. mock-server quick start ###

1.  下载all-in-one-jar包：[mockserver-netty-5.5.0-jar-with-dependencies.jar][]
2.  命令启动：`java -jar mockserver-netty-5.5.0-jar-with-dependencies.jar -serverPort 8888 -logLevel INFO`
3.  mock server添加mock的方式不是写文件，而是通过REST接口来实现的，具体开放了哪些接口，可以参考文档：[mock-server-openapi][]
4.  通过接口添加一个测试expectation：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 2]
5.  尝试请求：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 3]

### 11. mock server + maven ###

pom添加依赖

<dependency>
      <groupId>org.mock-server</groupId>
      <artifactId>mockserver-netty</artifactId>
      <version>5.5.0</version>
    </dependency>

mock server

public class MockServerTest { 
     
        private static ClientAndServer mockServer;
     
        public static void main(String[] args) { 
            mockServer = startClientAndServer(10086);
            mockServer.when(
                    request()
                            .withMethod("PUT")
                            .withPath("/test")
                            .withHeader(header("userInfo",".*\"tenantId\":\"3\".*"))
                            .withBody("{\"id\":\"123\"}")
            )
                    .respond(
                            response()
                                    .withStatusCode(200)
                                    .withBody(new JSONObject().fluentPut("code","100").fluentPut("data","").fluentPut("msg","操作成功！").toJSONString(), Charset.forName("gbk"))
                    );
        }
     
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 4]  
跟moco是差不多的，但是mock service的写法和功能是比moco多的，mock server能适应更多场景。

这里并不讨论mock server proxy相关的问题。

## 011. Which ##

<table> 
 <thead> 
  <tr> 
   <th align="center">项目</th> 
   <th align="center">moco</th> 
   <th align="center">mock server</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">功能</td> 
   <td align="center">覆盖大部分场景</td> 
   <td align="center">覆盖几乎所有场景</td> 
  </tr> 
  <tr> 
   <td align="center">学习成本</td> 
   <td align="center">一般</td> 
   <td align="center">一般</td> 
  </tr> 
  <tr> 
   <td align="center">直接使用server时 配置修改方式</td> 
   <td align="center">修改文件、可持久化、修改不方便无错误验证</td> 
   <td align="center">REST接口、不能持久化、修改方便有错误提示</td> 
  </tr> 
  <tr> 
   <td align="center">二次开发成本(目标是spring+swagger/web+持久化)</td> 
   <td align="center">基于netty-http，Json-&gt;expectation的逻辑很复杂，可能需要改造后才能复用，难度较高</td> 
   <td align="center">基于Servlet，有现成的Json-&gt;expectation的parser，难度一般</td> 
  </tr> 
  <tr> 
   <td align="center">proxy server</td> 
   <td align="center">不支持</td> 
   <td align="center">支持</td> 
  </tr> 
 </tbody> 
</table>

从上面的对比来看，我觉得使用`mocker server`是更好地选择。

## 100. Where ##

<table> 
 <thead> 
  <tr> 
   <th align="center">项目</th> 
   <th align="center">跟随项目</th> 
   <th align="center">集中管理</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">模块化</td> 
   <td align="center">好控制</td> 
   <td align="center">有点难</td> 
  </tr> 
  <tr> 
   <td align="center">持久化和维护</td> 
   <td align="center">文件，顺便维护接口文档</td> 
   <td align="center">数据库，开发接口时会更新，修改接口时不一定</td> 
  </tr> 
  <tr> 
   <td align="center">相关度</td> 
   <td align="center">高</td> 
   <td align="center">低</td> 
  </tr> 
  <tr> 
   <td align="center">开闭原则和维护成本</td> 
   <td align="center">不遵循，维护成本高</td> 
   <td align="center">遵循，维护成本低</td> 
  </tr> 
  <tr> 
   <td align="center">侵入性</td> 
   <td align="center">高</td> 
   <td align="center">低</td> 
  </tr> 
 </tbody> 
</table>

从上面的对比来看，我觉得集中管理比较合适。

[mockserver]: https://github.com/jamesdbloom/mockserver
[moco]: https://github.com/dreamhead/moco
[moco-runner-0.12.0-standalone.jar]: http://central.maven.org/maven2/com/github/dreamhead/moco-runner/0.12.0/moco-runner-0.12.0-standalone.jar
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]: /images/20220404/79a14f6d46a5480aab640f791857d418.png
[apis.md]: https://github.com/dreamhead/moco/blob/master/moco-doc/apis.md
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]: /images/20220404/33accb1e47e449d8be1958e69b5c6613.png
[mockserver-netty-5.5.0-jar-with-dependencies.jar]: http://search.maven.org/remotecontent?filepath=org/mock-server/mockserver-netty/5.5.0/mockserver-netty-5.5.0-jar-with-dependencies.jar
[mock-server-openapi]: https://app.swaggerhub.com/apis/jamesdbloom/mock-server-openapi/5.5.x
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 2]: /images/20220404/d6302e3b2f8948c39b6ebf68d8c95dc0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 3]: /images/20220404/70e55ad536f84424afac5843187052b5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 4]: /images/20220404/dc0463bd772a41ee827e609895b7ff42.png