API通用设计原则

什么是好的API

·        完备Be Complete

对确定重点支持的用户场景具有完备的功能支持。就是说,用户通过对一组API的调用能够完成预期的功能。

·        不冗余Be Minimal

在完备的前提下,API只提供最小的功能集合。不缺少、不冗余。

·        简单清晰Be Simple & Clear

接口设计简单清晰。每个接口都有自己明确的语义,并只专注于尽量单一的功能。产品概念简单、关系清楚。

·        易于学习Be Easy to Learn & Use

符合用户的直觉;接口设计有统一的范式,用户可以举一反三。极致是没有文档用户也知道怎样调用接口。

·        可扩展Be Extensible

设计具有扩展性,能够在一定程序上适应变化,API在发展中具有后向兼容性backward-compatibility)。

(不错的教程,欢迎下载) API是应用编程接口的缩写。API开发在现代软件开发中随处可见,其目的是为某个组件的功能提供一个逻辑接口,同时隐藏该模块内部的实现细节。有些API用起来很顺手,而有些则用起来让人摸不着头脑,更有些让人直接弃用。编写优质的API非常困难。大多数人的经验都源于不断犯错或借鉴别人的经验,而本书试图打破这种局面,提炼出耐用且不会过时的API设计策略。API有哪些品质要求,有哪些关键要素,有哪些通用的技巧,设计时要遵循哪些原则……这些问题都能在本书中找到答案。 本书主要内容。 第1章:API简介。阐释API的概念及其独特之处,概览全书内容。 第2章:特征。解答优秀API应具备的特点。 第3章:模式。着眼于一些特定的API设计模式和惯用法,包括Pimpl惯用法、单例(singleton)、工厂方法(factory method)、代理(proxy)、适配器(adapter)、外观(facade)模式以及观察者(observer)模式。 第4章:设计。讨论功能需求的收集和使用用例建模推动简洁有用的接口的设计,以及一些面向对象分析和设计的技术。这一章也将讨论大型软件项目所面临的诸多问题。 第5章:风格。叙述各种风格的C和C++ API,如纯C API、面向对象API、基于模板的API以及数据驱动的API。 第6章:C++的用法。讨论各种能够影响良好API设计的C++语言特性,如良好构造函数和操作符风格、命名空间、指针和引用参数的比较、友元的使用以及如何在动态库中导出符号。 第7章:性能。分析API的性能问题并说明如何使用C++构建高性能的API。 第8章:版本控制。主要讨论API版本控制以及如何保持向。。。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值