客户端接口模拟框架

一. 开发原因

在客户端开发过程中,经常遇到很多功能强依赖于后台复杂的返回值,如果自己写死数据即不方便又会引入很多杂乱的代码,无法全流程跑通,但是在大公司里各个方向的时间又很难匹配上,所以造成了很多时间都在等待后台的接口开发,于是我们就需要一个简单方便的接口模拟平台来解决这一问题。

二. 开发思路

这个框架目前已经完成且已经很好的在公司的项目中运行了,因为是服务于公司项目,所以代码不方便公开,暂时给大家介绍一下思路和完成难点的解决方案。

首先,因为我们是奔着接入简单,使用方便的思路去的,设想一下我们使用时候的情况:我给这个平台配置好需要进行接口模拟的 URL 和这个 URL 需要返回的数据,其他的我都不用管就可以使用起来(不需要修改原项目的任何代码),而且对于那些不需要进行模拟的接口,还需要返回线上应有的真实数据,这样才能保证这个项目跑通。

针对上面的这些需求,我们可以联想到 VPN、远程代理,这些东西似乎和我们需要的功能很像,于是我们就可以按照这个思路来做,在客户端实现一个小型服务器,客户端所有发送的请求都先发到这个小型服务器上,然后在这个服务器上我们分析客户端发来的 HTTP 请求,提取其中的重要信息,如 URL,我们再对这个 URL 进行判断,如果这个 URL 是我们需要进行接口模拟的地址,我们就返回模拟数据拼装成的 HTTP 响应报文,如果不需要进行接口模拟,我们就直接连接远程服务器,把从客户端发送来的请求转发到远程服务器,再接收远程服务器响应报文回返给客户端,整个系统就完整的运行起来,且可以满足我们的需求。

其中最重要的心脏模块就是我们的小型服务器,因为客户端使用的网络框架多种多样,我们怎么样才能适应所有的这些网络框架呢?通过简单思考我们就可以想到,其实大家用的都是 HTTP 协议,底层都是 SOCKET 实现(一到底层一切都清晰了),我们只要在 APP 上将 BASE_URL 暂时修改成小型服务器的 IP 地址,我们就可以收到 APP 上所有的网络请求了,对这些请求进行转发或者是返回模拟报文就都很简单了。

三. 具体实现

因为代码不方便贴出来,相信大家看了上面的思路描述之后也可以想到应该怎么实现了,其实最重要的也就是思路,具体的实现无非就是一些代码架构等各有不同了,下面就放两张具体实现的流程图吧。


c3e862f1f709e4872213cde414c16b8e.png

5c758c2de92317f359debb49269b4aac.png
四. 实现难点分析

在实现过程中,对于不需要模拟的URL,我们需要将求情转发到远程服务器,这是非常重要的部分,在这之前需要先对 APP 端的请求报文进行读取,但是读取时发现,InputStream.read() 方法一直阻塞,一直读不到结束标志-1,这样就很难知道什么时候能读取完 APP 端发来的请求,对请求的转发也变的不可能了。

解决方案一:

InputStream.avaiable() 方法可以获得当前流中可读的字节数目,然后通过他的值构建 byte 数组,直接从流中获取我们需要的所有数据,但是现实很可怕,因为网络请求中我们的报文会被拆分成若干段,avaiable() 方法只能获得当前传过来的部分报文的长度,也就是我们得到的 byte 数组是不完整的,如果想完整获取,需要让线程先睡眠,先等待报文完整发送过来再读取,但是如果请求很长,我们就不好评估这个睡眠时间了,总不能一直等吧?而且等的时间不够还容易读取不完整,所以 PASS。

解决方案二:

客户端发送来的报文终究是有格式的,HTTP 协议就是它的规范,那我们就可以对发送的报文进行拼装分析,当我们分析发送来的数据已经发送到结尾的时候,我们就可以进行转发了。方法可行,且解决了上面方案一的问题,但是我们做了很多不必要的事情,我们不想关心 HTTP 报文的复杂分析,我们不需要它,花费时间在这没必要,所以 PASS。

解决方案三:

我们不想做 HTTP 协议分析,但是远程服务器会做啊,并且他们必须做,而且经过分析发现,InputStream.read() 一直阻塞,读取不到结束标志 -1 是因为 SOCKET 没有关闭,当 SOCKET 关闭时 -1 才会返回,这个 SOCKET 关闭的过程是服务器主动触发的,这样就能保证整个传输过程中数据的完整传输,于是我们就可以先开启一个 SOCKET 连接远程服务器,将 APP 端发送来的报文逐字节的直接转发到服务器(这个过程我们可以先截获换行等符号,这样就可以从报文的第一行获取我们所需要的 URL),并且通过这个 SOCKET 的 ImputStream.read() 方法一直监控服务器的返回值,我们先不关心 APP端发送的数据什么时候能读完,因为当服务器读取并分析出 HTTP 请求发送完毕的时候,就会开始给我们回返数据(当然还有处理过程),这个时候我们连接远程服务器的 SOCKET 的 InputStream.read() 就从阻塞状态转换为可读状态了,我们就可以获取到我们所需要的完整数据,而且因为远程服务器写完数据后会主动关闭连接,我们在读完报文后也会正确获取到 -1 结束符,我们就可以在这时将返回的报文转发给 APP,整个环节就通了,这个方法可行。

五. 总结

经过实际测试这个思路实现的框架可以稳定使用,并且可以节省很多我们的开发时间,只要接口文档有了各个方向就可以相互独立的开始开发。作为一个程序员可能语言组织能力有点差,希望大家见谅,欢迎朋友们一起讨论~

hello.jpg
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容