上一篇，我们聊了如何通过逐步的分拆业务流程和场景来吃透需求，那么，下一步就开始直接写代码了吗？还不是，我们还需要继续拆解，拆解出接口和数据字典。下面，我们继续来聊。
为什么要拆解出接口和数据字典呢？那是因为技术开发这个行业已经是一个充分分工、成熟的行业，每一个功能的开发都需要多个工种配合才能够完成，比如前端开发工程师、后端开发工程师、测试工程师、客户端开发工程师等等。那么，怎么让大家的分工协作足够高效和高质量呢？这就需要我们提前商量好互相协作的方式和边界，而接口和数据字典就是大家协作过程中必须共享的信息。
首先说接口，接口定义了一个前端、后端、客户端和测试最基本的边界，接口确定下来之后，各个工种就可以进行并行开发了，测试同学也可以进行接口测试用例的编写了。同样，数据字典也依然如此，他描述了我们对于需要存储和传输的数据信息的基本描述。接口和数据字典是我们对一个业务最基本的了解，这是研发人员内部需要共享的最基本的信息。
那么，接口和数据字典如何拆解出来呢？上一篇，我们拆解到了具体的场景和功能点，接口和数据字典就是要在功能点上继续拆解，就是看这个功能点需要几个接口来完成，又有哪些数据需要传输和存储。我们可以在头脑中想象，通过这些接口和数据字典能不能完成用户的这个功能点，然后，不同的功能点下，有哪些接口和数据字典是通用的，就需要抽取出来进行复用。
那么，怎么去定义接口和数据字典呢？还是要回到我们定义它的目标来看，目标就是要让开发的各个工种能够高效的协同，尽可能的信息对称，回到这个目标来看，我们就能知道怎么来定义了。
首先，无论接口还是数据字典，起名字是最重要的事情，一个好的名字，就可以让大家瞬间领会，不需要额外的解释，沟通成本极低。所以，好名字非常关键，起名字的规范也非常关键，总之，不要让大家思考，要瞬间秒懂。
其次，光有好名字还不够，接口和数据字典还有一些核心的信息是需要大家准确理解的，这些信息的定义一定要按照大家统一的规范来做，始终要记住一点，我们的目标只有一个，就是让各个合作方不用思考、下意识就可以记住和理解。
对接口来说，核心的信息就是IOE，这三个字母的缩写分别代表了Input、Output和Exception，翻译过来就是接口的输入、输出和异常情况。这三个信息是接口最重要的东西，我们在写代码之前就需要明确出来的。接口实现的过程中，就需要关注输入和输出的校验，以及各种可能出现的异常和如何处理。如果忽略了这些基本的考量，代码的健壮性就会很差。
对数据字典来说，最重要的信息就是标示出实体，以及实体和实体之间的关系。一个系统中肯定会有很多的信息需要存储和传输，所谓的实体，就是把这些信息的数据结构抽象出来，看哪些信息是经常被使用的，就应该被抽象成统一的东西，这个东西就是抽象的实体。按照面向对象的思想来说，这里的实体就是对象。
接口和数据字典对一个系统来说是至关重要的，他代表了我们对于业务的理解，是把业务需求翻译成了技术的语言。通过这个语言，让工程师团队之间可以做到信息的同步。同时，接口和数据字典也是一个系统的基础，因为系统的各个模块都是通过接口和数据字典耦合在一起的，一旦接口和数据字典发生变化，或者发生修改，对系统的冲击都是很大的。所以，对顶尖的程序员来说，在写代码之前，要花大工夫在搞懂需求上，花大工夫在理清接口和数据字典上。
总结一下，磨刀不误砍柴工，只有搞懂了接口和数据字典才能正式进入开发，搞懂了这些，才能让不同的开发工种信息同步，高效的协同。接口实现之前，要特别关注IOE，这样的代码才足够健壮。数据字典代表了我们对于系统的信息的一种抽象，好的数据字典可以凝聚大家的共识，更方便大家的理解。
网友评论