接口规范, 是协作的合约

本文探讨了在软件开发中接口规范的重要性,将其比喻为协作的合约,强调接口要成文、清楚、稳定且变更要谨慎。区分外部接口和内部实现,通过Java Doc组织接口规范,并指出接口合约的制定不应由源代码维护者单方面决定,而应经过多方讨论和共识。
摘要由CSDN通过智能技术生成

一个软件项目, 一般需要交付两类文档。 一类文档是面向开发者的, 另一类文档是面向最终用户
的。 这两类文档, 由于面向用户的不同, 无论是内容还是形式, 都有巨大的差异。 今天我们先来
聊聊面向开发者的文档。 下一讲中, 我们再接着聊面向最终用户的文档

区分外部接口和内部实现

外部接口, 就是协作的界面, 要简单规矩; 内部实现, 可以是千变万化的复杂小世界。

为了便于维护和协作, 一个软件通常被划分为几个不同的部分。 比如我们通常使用的MVC架
构, 把软件分为模型(Model) 、 视图(View) 和控制器(Controller) 三个部分。

  • 这样做, 可以降低复杂度, 让程序结构更加直观。 同时, 这种架构也很容易对程序进行修改和扩展, 并且可以重复利用基础的功能。
  • 不同功能的分离, 让程序员之间产生了分工, 专业人员可以更聚焦于个人的专长领域。 这是一个
    多赢的局面, 也能让软件的质量得到提升。

既然有分工, 就要有协作。 MVC架构把软件拆分为三块, 是分工; 而MVC模块之间的调用关
系, 就是协作。

一个好的软件设计, 要区分外部接口和内部实现。 外部接口, 就是协作的界面, 要简单规矩; 内部实现, 可以是千变万化的复杂小世界。

这种区分无处不在, 即使是最普通的API。 比如我们常用的InputStream, 一旦我们获得这个对
象实

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值