移动开发中接口层自动化设计调研

目前问题

1. 接口文档更新不及时，增加联调时间，降低交付速度
2. 接口文档更改后，前端接口层，后端接口层及测试用例均需要各自修改，增加开发成本

解决思路

在前后端交互中，涉及到四个东西

1. 接口文档H
2. 前端接口层CI
3. 后端接口层BI
4. 测试用例TC

假设后续接口做了一个修改操作m，比如说m是增加一个参数，m对四者而言都是同一个变动因素，则

H' = FH(H,DSL(m))
CI' = FC(CI,DSL(m))
BI' = FB(BI,DSL(m))
TC' = FT(TC,DSL(m))

其中DSL是使用语言结构化描述操作m，这部分操作需要去按DSL规范手工更改。FX函数是对变化m产生新的描述处理过程。
正常而言，需要做到自动化，需要做到

1. 找到一种DSL方式描述m
2. 开发4个FX函数

为了降低开发成本，我们可以选择使用DSL描述H，通过按规范把变化m加入到H中变成H'，然后其他三个函数变成

CI' = FC(H')
BI' = FB(H')
TC' = FT(H')

这是为了简化编程模式，采用修改全覆盖策略，换句话说三者的变化只跟H'相关，与自身前后状态无关。
为了达到这一点，需要的工作是

1. 选择DSL描述H
2. 开发三个不同的FX函数

解决方案

解决方案基于两点出发

1. 最大限度使用现有工具链
2. 最小侵入性及最小开发工作量

对于接口描述的DSL，我们可以选择有很多语言都支持的json，xml和yaml等，免去开发解析的成本。
对于后面三个函数的开发，根据我们的业务类型，需要做的工作

1. Android端Java接口层代码和Model层自动生成
2. iOS端OC接口层和Model层自动生成
3. J2EE端Form层自动生成
4. 测试端测试页面及测试用例自动生成

这块业界已经有较为完善的解决方案，比如swagger

1. 使用yaml描述接口及交互数据结构定义，DEMO
2. 可以生成client端（Android和iOS）和server端（Spring MVC）的代码
3. 测试接口页面自动生成，DEMO

基本上已经满足我们这边的需求（测试用例自动生成这块跟测试组同学再进行详细沟通），我们需要根据自身的框架修改部分自动代码生成的代码

收益评估

如果解决方案落地，主要的收益有

1. 规范化接口文档定义，增加项目可维护性
2. 统一多端接口层定义，并且通过自动生成方式减少人工投入和联调成本

在此基础上，把方案与我们自身的持续集成平台Jenkins相结合，还可以在修改接口定义的时候自动修改响应各端代码接口层，这样的好处有

1. 避免因接口更改没通知到位而产生的沟通及联调成本
2. 由于接口定义改变导致各端接口层改变，强制各端工程师及时响应并做响应更改
3. 提供交付速度和代码质量

实现计划

由于这个方案涉及到多端人员，涉及前端，后端，测试三个组织，从落地角度来说，可以先在部门内部先落地，前期先把基础服务后端接口定义引入，然后逐步把后端接口层自动化及测试用例自动化做起来，最后再推动Android和iOS端接口层自动化。