深入C++中API的问题详解（C++API文档）

前言：本文书写的格式与其它不相同。本文题目说是关于C++ API的思考，其实也不仅仅是C++，对于其它语言同样适用。

API实际是指Application Programming Interface,应用程序编程接口。

对API是一套用来控制Windows的各个部件的外观和行为的一套预先定义的Windows函数。在C++中我认为：

一个API就是一堆类以及类中方法和字段的集合。

并不是所有的签名都是API的一部分，未公开的部分(private)内容不是API，它不对外承诺兼容性。

API广泛定义：凡是有利于在“无绪”的状态下把一个大的系统以组件集成的方法拼装出来的东西都属于API

。

为什么要开发API？

我们希望将大块的构建模块“无绪”地集合成应用程序，一些构建模块包含共享库、框架、预先定义好的程序架构，以及这些内容的组合。

如何检查API的质量？

1、可理解性

2、一致性

3、可见性

4、简单的任务应该有简单的方案

5、保护投资

API设计技巧一:

不要把类中的字段直接对外公布，而应该放置在内部。最好让外部用户只能通过set、Get方法来访问字段，千万不要将字段直接公布出来。

使用方法访问字段要好于直接访问字段。如果你在编写API的时候遵守这一建议，那么可以在这个API的下一个版本中对方法的具体实现进行很多改动，如添加数据的验证和校验、覆盖一个方法等，还可以做一些大的变化。如果直接使用指端就不能做上述改动。

API设计技巧二:

使用工厂方法而不是直接使用构造函数来创建一个对象。

使用工厂方法创建对象的好处：

1、工厂方法的返回值并不一定是声明类型的实例，它可以是它子类的实例。使用工厂方法可以更好的体现面向对象语言中多态的优势，代码也会显得更加简洁。

2、每次返回的对象并不一定都是新创建的对象，完全可以将其缓存。相比之下，每次调用构造函数都会创建一个实例，而一个工厂方法可以缓存以前创建的对象，并重用他们，从而节省了内存。

3、对同步控制，在工厂方法中可以将创建对象前后的相应代码进行统一处理。构造函数对这一种情况就无能为力。

API设计技巧三:

让所有的内容不可改，如果不考虑让其拥有子类，就应该让这个类不能被继承。

强烈推荐：

不公开构造函数，转而提供工厂方法

API设计技巧四:

避免滥用set方法，在不部分情况下set方法是多余的。

建议：小心API中的每一个不必要的set方法

API设计技巧五:

尽可能通过友元的方式来公开功能。

为了让用户更加简单明了地使用好你的API，就不要再你的API中公开太多的方法，不要给用户犯错的机会。

API设计技巧六:

避免暴露深层次继承。

一旦发现继承体系超过两层时，一定要打住，并多多思考一下，要弄清楚：“我到底设计API还是在复用代码？”如果答案是后者，那么重新审视，并严格设计这个API，或者做好子类化的准备。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。