花椒接口Mock方案

最新推荐文章于 2022-09-14 14:37:18 发布
最新推荐文章于 2022-09-14 14:37:18 发布
阅读量320 收藏
点赞数
原文链接：https://mp.weixin.qq.com/s/2l2Zk0Fic4CByix7qDpNAw#rd
版权


奇技指南

Mock是指在测试过程中，对于一些不容易构造/获取的对象，创建一个Mock对象来模拟对象的行为。本文主要讲述Web接口的Mock。

本文来自公众号花椒技术。


什么是Mock？

Mock是指在测试过程中，对于一些不容易构造/获取的对象，创建一个Mock对象来模拟对象的行为。早期Mock多被用于单元测试/接口测试中，被测试对象依赖其他对象，且这些对象的构造复杂、耗时或者根本无法构造(未交付)， 对于单个测试对象，假定其依赖对象的逻辑正确，我们只需要保证测试模块内部逻辑的质量即可。本文主要讲述Web接口的Mock。



接口Mock用处？

在实际的软件开发过程中，我们的链路往往是：服务业务A->服务业务B->客户端/前端->测试，整个开发周期里，业务B的人依赖业务A才能联调提测，客户端/前端依赖B的接口有数据后才能开发新的功能，Mock很好缩短了这个过程中等待的时间。

1． 客户端/前端开发联调前置，现今移动端的app多依赖服务端接口的返回来开发app的页面，在接口未开发完成的情况下，需要等待接口的数据来进行开发，这时候完善的的接口Mock服务能大大缩短开发联调等待时间。

2． 接口集成测试，部分依赖服务未完成前，利用Mock完成本身的接口开发/测试

3． 复杂的场景模拟，复现验证bug的时候，需要先准备比较复杂的数据场景，才能复现一个bug，此时，Mock的定制返回，节省了大量数据准备的时间，直接可复现和验证bug

4． 测试时，异常场景的模拟，如长字符串，负数，异常返回等


花椒的Mock方案

说了这么多，我们来说说花椒的接口Mock方案。传统的接口Mock服务弊端有：

  1. 需要绑定接口请求的业务服务到指定的Mock服务，这样需要wifi的host不停更改，或本机的host不停更改，来切换正常环境和Mock环境

  2. 绑定host因为是整个域名绑定到Mock服务，如果其他接口没有Mock会导致很多接口不可用，而走不到想走的场景，且多人公用wifi的情况下，会互相影响

  3. 不同的用户对同一接口的请求，期望的返回不一样，无法对用户定制化，也即同时只能满足一个开发或测试人员的Mock需求

  4. 传统的Mock服务大多采用文件编辑Mock数据，不易编辑管理

考虑到上述弊端，我们的接口Mock服务，设计的初衷有以下几点：

  1. 如何让客户端/前端开发人员简单易用，不需要太多环境的设置，保证用户能在正式环境和Mock环境之间切换

  2. 如何支持多用户同时使用，且Mock数据不一样的需求

  3. 花椒的部分服务是有加解密的，返回的数据是一堆加密串，如何更方便的编辑管理Mock返回数据

花椒的接口Mock方案, 主要是采用业务服务器跳转 + Mock服务 + 后台管理，同时支持传统的Mock服务的使用方式。

640?wx_fmt=jpeg
Mock1

主要有如下三部分组成：

Mock后台

Mock后台是整个Mock服务的配置中心, 用户在后台定制自己的接口Mock数据，配置需要跳转的用户及接口。开发框架用的是springboot + mybatis + vue，前端页面和后端服务剥离，springboot提供操作数据库的接口给前端vue页面调用，主要文件目录一个vueMockController， 一个数据库操作文件MockMapper，文件目录非常简单，主要功能有：

1． 展示用户的所有Mock数据，支持根据作者查询，uri查询，模块查询

 1/按Uri查找数据 2@RequestMapping("findByUri") 3public RestResult findByUri(@RequestBody JSONObject request) throws Exception { 4    int offset = request.getIntValue("offset"); 5    String uri = request.getString("uri"); 6    uri = "%" + uri + "%"; 7    List<MockData> data = mapper.getMockDataByUri(uri, offset); 8    for (MockData one : data) { 9        one.decryptData();10    }11    int total = mapper.getMockDataByUriTotal(uri);12    return success(formatPageData(data, total, offset));13}

2． 支持新增，删除、编辑Mock数据功能，写入数据根据选择的平台ios/android，判断有无加密，有加密按各自的加密key加密后写requset和response数据到数据库

主要数据库信息如下, encrypt是否加密，platform（请求客户端iOS或Android），model为模块，uid为用户私有标识，request为请求参数（同时支持key=value的form数据，{“key”：“value”}的json数据），response为响应数据

 1TABLE `mock` ( 2  `id` bigint(20) NOT NULL AUTO_INCREMENT, 3  `uri` varchar(255) DEFAULT NULL, 4  `request` varchar(500) CHARACTER SET utf8mb4 DEFAULT NULL, 5  `response` text CHARACTER SET utf8mb4, 6  `statusCode` int(11) DEFAULT NULL, 7  `platform` varchar(20) CHARACTER SET utf8mb4 DEFAULT NULL, 8  `encrypt` tinyint(1) DEFAULT NULL COMMENT '0无 1经济 2底层', 9  `model` varchar(20) CHARACTER SET utf8mb4 DEFAULT NULL,10  `author` varchar(20) CHARACTER SET utf8mb4 DEFAULT NULL,11  `moduser` varchar(20) CHARACTER SET utf8mb4 DEFAULT NULL,12  `server` tinyint(1) unsigned DEFAULT NULL,13  `method` tinyint(1) unsigned DEFAULT NULL COMMENT '0Get 1Post',14  `uid` varchar(255) CHARACTER SET utf8mb4 DEFAULT NULL,15)

对应的页面展示如下，同时提供了加完数据后运行查看是否Mock成功的功能.

640?wx_fmt=jpeg
mock3

3． 获取业务服务器所有Mock配置，并展示，支持新增，编辑，修改后同步设置到业务服务器

640?wx_fmt=jpeg
mock2


Mock Service

Mock service是Mock请求/返回处理的中心模块，主要逻辑是获取跳转过来的用户请求，处理请求数据，根据不同的请求参数，查询数据库里的配置数据，修改response数据为Mock数据返回给用户。开发框架是基于git上开源项目Moco的二次开发， Moco在git上的开源地址https://github.com/dreamhead/moco， 是一个简单搭建模拟服务器的程序库/工具, 基于java开发的，Mock数据通过文件管理，使用方式很便捷简单，但由于本身花椒服务的特殊性，和考虑到可视化管理，我们对Moco进行了二次开发，主要改动方向：

1． Mock数据管理新增数据库存储管理方式, mybatis连接数据库，新增一个数据库操作MockMapper文件，新增一个service方法来处理数据库查询合并结果，具体的mybatis的配置如下：

 1<configuration> 2    <environments default="development"> 3        <environment id="development"> 4            <transactionManager type="JDBC" /> 5            <!-- 配置数据库连接信息 --> 6            <dataSource type="POOLED"> 7                <property name="driver" value="com.mysql.jdbc.Driver" /> 8                <property name="url" value="jdbc:mysql://10.14.*.*:port/db_name?useUnicode=true&characterEncoding=utf-8" /> 9                <property name="username" value="username" />10                <property name="password" value="password" />11            </dataSource>12        </environment>13    </environments>14    <mappers>15    <mapper class="com.github.dreamhead.moco.MockMapper"/>16    </mappers>17</configuration>

2． 请求处理适应花椒业务，url请求参数和post数据同时处理，匹配Mock数据，以及匹配优先级等特殊处理

修改moco-core工程里com.github.dreamhead.moco.internal下的MocoHandler.java方法doGetHttpResponse（），匹配规则：

  • 优先匹配用户私有的Mock数据，uri（接口uri）+ platform + uid + request参数，有则返回

  • 其次匹配非用户私有的Mock数据，uri（接口uri）+ platform + request参数，有则返回

  • 忽略请求参数匹配Mock数据，uri（接口uri）+ platform，有则返回

  • 忽略端平台匹配Mock数据，uri（接口uri），有则返回

此处之所以要做这么多优先级规则，是为了让使用Mock服务的接口能正常匹配到数据，大部分使用者在初期并没有私有数据的需求，随着场景的加深，才会设计独有的数据，所以根据使用习惯，做了分层匹配

3． https的方案更改为nginx配置处理业务证书，证书验证剥离Mock服务

java -jar mock-1.0.0-uber.jar http -p 3001 -c config.json //启动服务

本机nginx配置：

 1server { 2        listen       443 ssl http2 default_server; 3        server_name  *.*.com; //服务根域名 4        root         /usr/share/nginx/html; 5 6        ssl_certificate "/etc/nginx/ssl/tongpei.*.*.com_bundle.crt"; //证书 7        ssl_certificate_key "/etc/nginx/ssl/tongpei.*.*.com.key"; //key 8        ssl_session_cache shared:SSL:1m; 9        ssl_session_timeout  10m;10        ssl_ciphers HIGH:!aNULL:!MD5;11        ssl_prefer_server_ciphers on;1213        # Load configuration files for the default server block.14        include /etc/nginx/default.d/*.conf;1516        location / {17           proxy_pass http://127.0.0.1:3001; //跳转mock服务18        }19


业务服务器跳转处理

此处的业务服务器是app应用/前端实际使用的服务器，比如登陆服务。业务服务器的跳转处理，主要是根据用户的请求，判断是否需要跳转到Mock服务。逻辑处理是在nginx层处理的，用的luascript，提供了两个接口，一个lua/pour，用于提供给Mock后台来设置跳转信息，写到Nginx缓存里；一个lua/get，用来获取nginx现有的配置。


1、提供mock跳转配置设置/获取接口

示例

1 curl 'http://proxy.**.com/lua/pour?project=test&group=mock&ttl=' -H "Cookie: auth=lua" -d 'value={"user/1**":{"4--60":true,"4--61":true}}'23 curl 'http://proxy.**.com/lua/get?project=test&group=mock'
参数

group: 写死为mock，表示Mock配置

project: 项目名称，比如live、test等

ttl: 这个配置的过期时间，默认是3600秒

value: 配置信息，是一个json串，详见以下说明

对于配置value的说明

示例

 1{ 2    "user/1**" : { 3        "4--60" : true, 4        "4--61" : "4.4.4.4" 5    }, 6    "user/2**" : { 7        "*" : true, 8        "4--60" : "4.4.4.4" 9    },10    "*" : {11        "*" : "8.8.8.8",12        "4--67" : true,13    }14}

 

说明：

json数组的第一级是url，注意这个url不带前导/，第二级是uid，匹配客户端请求参数中的userid；uid对应的值为Mock地址，如果值为true，则转到默认的...(Mock服务器)

这两级都可以配置为通配符*，匹配的优先级为先匹配精确的，再匹配通配符

例如上面这个例子中，如果4--61这个用户访问user/1**接口，则会转到4.4.4.4，而4--88这个用户访问的话，会被指到8.8.8.8


2、根据配置跳转业务请求到Mock服务

 1-- 转到对应的机器 2local proxy_res = cache:get(project .. "_proxy") 3if proxy_res and proxy_res ~= "" and (ngx.req.get_headers()["x-proxy-host"] == nil or ngx.req.get_headers()["x-proxy-host"] == "") then 4    -- 增加错误处理，对于有问题的json啥的，做容错 5    local status, proxy_cnf = pcall(function(proxy_res)  6        local cjson  = require "cjson" 7        return cjson.decode(proxy_res) 8    end 9    , proxy_res)10    if status == false then11        proxy_cnf = nil12    end1314    if proxy_cnf and type(proxy_cnf) == "table" then15        if proxy_cnf[ngx.var.arg_userid] then16            ngx.req.set_header("x-proxy-host", proxy_cnf[ngx.var.arg_userid])17            ngx.exec("@proxy")18        elseif proxy_cnf[ngx.var.arg_deviceid] then19            ngx.req.set_header("x-proxy-host", proxy_cnf[ngx.var.arg_deviceid])20            ngx.exec("@proxy")21        end22    end23end



使用方法

最后的最后，一切准备就绪，使用就非常简单了

使用方式一的步骤(如图)：

1． 新增要Mock接口的uri对应的返回数据

2． Mock后台新增跳转配置，如配置user/1**, uid=4--86跳转

2． 手机/前端正常操做请求，即可返回定制数据

640?wx_fmt=gif
mock
使用方式二的步骤：

1． wifi或本机hosts绑定请求接口域名到mock服务器 1.1.1.1 passport.**.com

2． 手机/前端连接绑host的wifi，返回定制数据

整个方案的过程中，我们也是一直在摸索调整，如：一开始的时候我们也并没有针对用户来做Mock数据的区分，使用时碰到开发有多人同时使用的情况，一个人改了数据，另外一个人使用时发现不对了；还有https证书的问题，花椒没有提供moco框架https服务需要的证书，为了Mock服务能同时支持客户端直接绑host的方式，采用ngnix跳转服务的方式，先处理完证书验证，再跳转到Mock服务。目前我们的Mock服务偏向于给开发人员和手工测试人员提供便捷的模拟服务，Mock在自动化测试上的应用还未被完全挖掘出来，有待进一步探讨。


界世的你当不

只做你的肩膀

无

640?wx_fmt=jpeg 640?wx_fmt=jpeg

 360官方技术公众号 

技术干货|一手资讯|精彩活动

空·

我知道你在看哟

640?wx_fmt=png
360技术
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
花椒直播，主播信息爬取
10-27
采用3.6开发，没有采用爬虫框架，直接用beautifulsoup代码爬取
python学习开发mock接口
09-19
Python中的Mock接口是一种在开发和测试过程中非常有用的工具，它允许开发者模拟真实接口的行为，以便在其他依赖项未完成或不可用时进行测试。在本文中，我们将深入探讨如何使用Python来开发Mock接口，以及为什么在...
花椒测试平台 - 接口篇
360技术
11-18 725
奇技指南花椒测试平台需要满足1、降低接口测试对测试人员代码能力的要求；2、可视化的case管理，执行，结果管理。具体要怎么实现呢？本文将为大家详细介绍一下~本文来自花椒技...
Foxman, 基于微核架构的 Mock 解决方案
weixin_33889245的博客
06-08 194
本文来自 网易云社区 。   Foxman ⇗ 是一个使用 Node.js 开发的命令行工具，定位是一个可扩展的 Mock Server，帮助前端开发者轻松、独立、高效地进行前端开发和完成后续的联调工作。 他不是一款静态文件响应工具， 假如你只需要一款轻量的 Node.js 开发服务器，推荐你使用 puer ⇗ 或 webpack-dev-server ⇗。 github 地址: http...
常见MOCK方案
xbczrz的博客
08-06 289
常见MOCK方案 MOCK:模拟数据请求方案 (前端一般会比后端开发速度快，后端接口没有那么快提供时使用) 项目中常见的MOCK方案 一、代码入侵 直接在代码中写死Mock数据，或请求本地的json文件 优点： 无 缺点：代码是死的，无法模拟真实模拟前端实现的增删改查 二、 请求拦截 重新http请求 网址：http://mockjs.com 优点：与前端代码分离。生成随机数据 缺点：假数据、无法真实反应。只支持ajax,不支持fetch 三、 接口管理工具 代表：rap,swagger,mo
React开发学习（项目目录介绍、环境配置、mock方案）
火腿肠的博客
07-30 295
文件目录分析 配置根目录位置 Prettier 安装后需要在跟目录创建 .gitignore .prettierrc.json 两个文件，用于配置Prettier 由于eslint与其冲突 所以需要更改package.json配置： 下载插件：npm i eslint-config-prettier "eslintConfig": { "extends": [ "react-app", "react-app/jest", "prettier"
dubbo-easy-mock:针对Dubbo接口的Mock解决方案
05-30
在自动测试中，针对dubbo接口进行mock的框架 原理 利用dubbo的扩展点自动包装，通过EasyMockClusterWrapper将原本的rpc请求改写为http请求转发到mock服务器返回我们对应mock结果 使用 1. 添加依赖 mvn clean package...
mock
04-16
本项目涉及的内容是关于如何在Windows或Linux操作系统上搭建一个Mock接口，通过提供的文件，我们可以看到这是一个基于Moco Runner的Mock服务。 1. **Mock概念**： Mock是测试驱动开发(TDD)和行为驱动开发(BDD)中的...
前端mock方案对比文档
最新发布
04-01
前端mock方案对比文档
mock-stores——简单易用的数据mock方案
weixin_33819479的博客
10-19 128
mock-stores是一款简单易用的数据mock npm包，可以针对无法拦截ajax请求或者非ajax请求的项目做mock，简单易用仅需三步，便可完成整个过程。优点有： 1.简单易用易部署 2.随处可用 3.无脏代码 4.轻量级（仅十多行代码） 5.改变mock数据无需重新编译 6.我实在想不出来还有比这个更简单省事的了 1.安装 $ yarn add mock-stores -D复制代码2.P...
前后端联调 Mock 方案
GitChat
10-26 613
前后端联调过程中，通常我们只需要联调变更过的接口，但是往往因为开发环境维护力度不够，依赖的一些接口常常没有部署或开发完成，这时会严重影响联调效率。在本场 Chat 中，分享了本人在日常工作中使用到的一种 Mock 方案：首先为不可访问的接口创建 Mock 服务，然后通过 Nginx 将前端请求转发到 Mock 服务上，提高了联调效率。 前后端联调案例介绍 创建 Mock 服务 安装 Nginx ...
从实习经历中总结，项目中常见 Mock 方案
超逸の学习技术博客
06-05 611
之前在某杭州公司实习的时候，就有提到前端先 Mock 一下，当时对于 Mock 这块也不是很熟，就搜了搜下 Mock.js 是干嘛的...
我们用到的3种Mock测试方案​
m0_58026506的博客
09-14 1936
Mock这个词对于测试人员来说并不陌生，当我们要测试的接口A依赖接口B，可B无法满足我们的测试需求时，需要Mock一下接口B，来测试A。当前端和服务端并行开发时，如果服务端接口还没有开发好，前端同学也会Mock一下。 那 Mock 到底是什么？ 维基百科： 在面向对象程序设计中，模拟对象（英语：mock object，也译作模仿对象）是以可控的方式模拟真实对象行为的假的对象。程序员通常创造模拟对象来测试其他对象的行为，很类似汽车设计者使用碰撞测试假人来模拟车辆碰撞中人的动态
DaZeng：设置Mock的三种方案
大曾blog
11-06 541
设置Mock的三种方案Mock设置（模拟数据）使用JSON文件使用easy-mock使用本地集成Mockjs API Mock设置（模拟数据） Mock的项目实战：从0独立开发企业级电商系统 为什么要用Mock？ 开发阶段，为了高效率，需要提前Mock 减少代码冗余，灵活插拔 减少沟通，减少接口联调时间 如何创建Mock？ 本地创建JSON（接口文档已经规定好） easy-mock平台 集成Mock API 使用JSON文件 public文件夹下创建mock文件夹，创建一个user文件夹存放logi
我们如何选择mock方案
过河的小卒子的博客
03-14 798
1.背景：我们为什么需一个mock方案？ 我们需要对外提供稳定可靠的对外联调&测试环境，同时我们作为平台（或者叫前台）应用，会依赖大量的业务应用。当某些业务应用不可用的时候，会相应导致我们的业务不可用。同时依赖服务中，一些服务没有稳定可靠的使用环境，我们要提供一个解决方案，来保证我们环境的可用和稳定。 2.可选方案 提出需求，让我们的同志团队，为我们的服务来部署一套专门由我们团队使用的环境，独自使用下相应的稳定性也会更好。这个方案就需要考虑我们自己服务的优先级，因为搭建相应的环境需要申请额外
前端六类常用的MOCK方案说明
LuckyWinty的博客
01-18 3938
点击上方前端Q，关注公众号回复加群，加入前端Q技术交流群前言工具好不好用，关键在于用。肯定有很多前端程序猿联调前很悠闲????，但联调阶段持续加班，直到提测、上线。这其中缘由不外乎需求不明确等...
为使用mock方案测试，而重构代码的小小案例
weixin_30249203的博客
03-29 122
import com.sun.deploy.config.DefaultConfig; import javax.security.auth.login.Configuration; import java.util.PropertyResourceBundle; import java.util.ResourceBundle; public class Test { } ...
花椒移动端基础框架架构
360技术
09-17 1630
奇技指南本文转载自花椒技术。作者：花椒android组背景随着公司业务需求的不断增加、三方合作不断接入、新APP快速产出，就会出现想在原有的代码中想增加新的业务和功能，怕...
java实现dubbo接口mock
06-13
好的，实现dubbo接口mock一般有两种方式，分别是手动mock和使用dubbo-easy-mock工具。 手动mock需要开发者自己编写Mock类，实现dubbo接口，并在测试代码中使用Mock类替换掉真正的dubbo服务，这样在测试时就可以正常...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值