干货 | Api 体系架构分享（下）

上一篇，讲到了，最近，在作 api 的设计

对于设计，一方面是对于后端 server 框架的设计，另外一方面呢，是对于整个 api 体系的设计

在这里呢，咱们来理理思路，先来大体分一下块

风格就不用说了，咱们就用 restful 风格，接下来：

• IDL，也就是咱们所说的接口描述语言

• server 框架，整个 api 服务的核心驱动

• 版本控制

• 还有一些辅助工具，好比说，自动化工具、认证受权、监控上报、日志记录、检索等等

---

上次呢，讲了 IDL 和 server 框架的设计思路

此次呢，来吧剩下两个也给说说

版本控制

说到版本控制，大多数人的大脑中都必定会马上想到 git 和 svn 吧，只惋惜，此次的主角可不是他们

虽然说 git 和 svn 虽好，对于一些项目也可以进行很好的开发，可是呢，对于某些场景，仍是有些 hold 不住的

好比，咱们来举一个场景：

如今咱们的源码大约有 500M，而后呢，采用的是分支开发，主干发布，可是呢，由于咱们是提供中间层 service 的，迭代周期很短，对于一些特殊的客户，会时常有些特殊的逻辑处理，每一个开发者可能会有好几个分支进行开发，这个样子的话，对于这些特殊逻辑，特殊版本的管理就很是的不方便，并且，由于每次都要拉出来一个分支，而后改动可能很是小，这就形成了很是大量的冗余量

因而，这个场景中，冗余量、大量迭代版本的管理，就上升到了咱们的一个主要问题

如何解决呢？

单体代码库

在这里，咱们引入一个节点（标签）的概念，先来讲一下总体思路

如今，咱们就抛弃 git 和 svn 的思想，把全部的代码都放在一块儿，经过控制 节点粒度 来控制总体的冗余

首先，节点粒度咱们先设定为以文件为单位，同时呢，约定咱们的命名规范，文件名.节点标识.php，例如 Test.v1.php

接下来呢，就会有咱们原始的版本，在这个原始的版本里面，全部的文件都是 base 节点

全部的文件都会有一个父节点，最终都是继承与 base 节点的

当咱们须要迭代到 1.0.1 版本的时候，咱们只要把须要改动的文件 copy 一个副本，而后按规范命名，接着只需对于这一个文件进行改动，这样，冗余的粒度就控制在了这个文件内

大大减小冗余的同时，还大大的提升了代码的复用，避免了菱形依赖，不一样团队间的跨团队协做也变得更加灵活

接下来，咱们怎么可以正常调用呢？

因此说，这种单体代码库须要一个路由引擎来驱动，这就要咱们根据实际状况来实现了，能够直接根据节点表示来路由，也能够在中间加一层路由映射表，这就看具体需求了

同理，咱们能够进一步调整节点粒度，来控制总体的冗余，好比，粒度细化到接口级别

~~~~~~ 萌萌哒的分割线 ~~~~~~~~~

好了，下面就来分析一下这种单体代码库的优劣

优势：

• 统一版本控制

• 普遍地代码共享和复用

• 简化依赖管理，避免菱形依赖

• 原子修改

• 大规模重构

• 跨团队协做

• 灵活的团队边界和代码全部权

• 代码可见性以及清晰的树形结构提供了隐含的团队命名空间

可是呢，随着代码量的增长，也会出现如下问题：

• 单体模型让代码结构更容易理解，但却让代码发现变得更困难

• 开发人员须要可以查看代码库，找到相关程序库，并看看如何使用它们以及谁编写了它们。这就须要有代码搜索和代码浏览工具

• 依赖重构和代码清理辅助工具，按期对无用代码进行清理

• 版本管理的重心转移到了冗余控制上

因此说呢，对于管理，咱们就须要开发一套额外的自动化工具了

具体关于单体代码库的细节也能够查看这篇文章：

---

ok，关于版本控制就说这么多，接下来就是最后的一些自动化工具以及辅助工程了

自动化工具

为何须要自动化工具呢？

一方面，节约咱们维护开发的成本，对于一些能够自动化的操做就不必去人工操做

另外一方面呢，也是为了减小人工操做中可能带来的一些失误

就好比咱们如今的 api，都须要哪些自动化工具呢？

• SDK 自动生成工具：对于咱们提供给用户的 SDK，咱们固然不但愿每次迭代都要从新给用户写一份新的，因此说呢，经过自动化工具，自动生成各类语言调用的 SDK 是颇有必要的

• IDL 解析工具：咱们在读取数据的时候，确定不能每次都去解析 IDL 的结构，这样会带来太多没必要要的额外开销，因此说呢，咱们须要提早解析 IDL 进行缓存，从而提升咱们调用的速度，而这个解析生成的过程，就交给工具来完成了

• 代码库搜索工具：由于咱们采用了单体代码库，因此慢慢的代码愈来愈多，代码搜索工具就变的必不可少了

• 代码发现工具：也是为了维护代码库，按期发现清理无用代码

至于一些其余的自动化工具，就根据你们的具体需求去实现吧，也就不一一列举了

其余辅助工具

好比说，认证、受权、监控、上报、日志等等

这些在 server 框架设计的同时就都要考虑进去，何时须要上报，如何设定日志格式从而使得咱们可以更加方便的去维护等等

对于日志管理，可使用一些开源系统快速搭建

好比，logstash 来搭建日志管理系统，经过 ElasticSearch 来进行索引检索服务，而后呢使用 kibana 做为分析和可视化平台

---

ok，api 设计分享就到这里

FROM: 一只热爱动漫的攻城狮 ~ ~ ~