C++ API设计

第1章　API简介　　1
1.1 　什么是API　　1
1.1.1 　契约和承包人　　2
1.1.2 　C++中的API　　3
1.2 　API设计上有什么不同　　4
1.3 　为什么使用API　　5
1.3.1 　更健壮的代码　　6
1.3.2 　代码复用　　6
1.3.3 　并行开发　　8
1.4 　何时应当避免使用API　　9
1.5 　API示例　　10
1.5.1 　API层次　　10
1.5.2 　真实示例　　12
1.6 　文件格式和网络协议　　13
1.7 　关于本书　　15
第2章　特征　　17
2.1 　问题域建模　　17
2.1.1 　提供良好的抽象　　17
2.1.2 　关键对象的建模　　19
2.2 　隐藏实现细节　　20
2.2.1 　物理隐藏：声明与定义　　20
2.2.2 　逻辑隐藏：封装　　22
2.2.3 　隐藏成员变量　　23
2.2.4 　隐藏实现方法　　26
2.2.5 　隐藏实现类　　28
2.3 　最小完备性　　29
2.3.1 　不要过度承诺　　29
2.3.2 　谨慎添加虚函数　　30
2.3.3 　便捷API　　31
2.4 　易用性　　33
2.4.1 　可发现性　　34
2.4.2 　不易误用　　34
2.4.3 　一致性　　36
2.4.4 　正交　　38
2.4.5 　健壮的资源分配　　40
2.4.6 　平台独立　　43
2.5 　松耦合　　44
2.5.1 　仅通过名字耦合　　45
2.5.2 　降低类耦合　　45
2.5.3 　刻意的冗余　　47
2.5.4 　管理器类　　48
2.5.5 　回调、观察者和通知　　50
2.6 　稳定的、文档详细且经过测试的API　　53
第3章　模式　　54
3.1 　Pimpl惯用法　　55
3.1.1 　使用Pimpl　　56
3.1.2 　复制语义　　59
3.1.3 　Pimpl与智能指针　　60
3.1.4 　Pimpl的优点　　61
3.1.5 　Pimpl的缺点　　62
3.1.6 　C语言的不透明指针　　62
3.2 　单例　　64
3.2.1 　在C++中实现单例　　64
3.2.2 　使单例线程安全　　66
3.2.3 　单例与依赖注入　　68
3.2.4 　单例与单一状态　　69
3.2.5 　单例与会话状态　　71
3.3 　工厂模式　　71
3.3.1 　抽象基类　　72
3.3.2 　工厂示例　　73
3.3.3 　扩展工厂示例　　74
3.4 　API包装器模式　　76
3.4.1 　代理模式　　76
3.4.2 　适配器模式　　79
3.4.3 　外观模式　　81
3.5 　观察者模式　　83
3.5.1 　MVC架构　　83
3.5.2 　实现观察者模式　　84
3.5.3 　推与拉观察者　　87
第4章　设计　　88
4.1 　良好设计的例子　　89
4.1.1 　积累技术债　　89
4.1.2 　偿还技术债　　90
4.1.3 　为长期而设计　　91
4.2 　收集功能性需求　　92
4.2.1 　什么是功能性需求　　93
4.2.2 　功能性需求举例　　94
4.2.3 　维护需求　　94
4.3 　创建用例　　95
4.3.1 　开发用例　　95
4.3.2 　用例模板　　95
4.3.3 　编写高质量用例　　96
4.3.4 　 需求与敏捷开发　　98
4.4 　API设计的元素　　100
4.5 　架构设计　　102
4.5.1 　架构的开发　　103
4.5.2 　架构的约束　　104
4.5.3 　识别主要抽象　　105
4.5.4 　创造关键对象　　106
4.5.5 　架构模式　　109
4.5.6 　架构的交流　　110
4.6 　类的设计　　111
4.6.1 　面向对象概念　　112
4.6.2 　类设计选项　　113
4.6.3 　使用继承　　113
4.6.4 　Liskov替换原则　　115
4.6.5 　开放?封闭原则　　118
4.6.6 　迪米特法则　　119
4.6.7 　类的命名　　120
4.7 　函数设计　　121
4.7.1 　函数设计选项　　121
4.7.2 　函数命名　　122
4.7.3 　函数参数　　123
4.7.4 　错误处理　　125
第5章　风格　　129
5.1 　纯C API　　129
5.1.1 　ANSI C特性　　130
5.1.2 　ANSI C API的优点　　132
5.1.3 　使用ANSI C编写API　　132
5.1.4 　从C++中调用C函数　　134
5.1.5 　案例研究：FMOD C API　　135
5.2 　面向对象的C++ API　　136
5.2.1 　面向对象API的优点　　136
5.2.2 　面向对象API的缺点　　136
5.2.3 　案例研究：FMOD C++ API　　137
5.3 　基于模板的API　　138
5.3.1 　基于模板的API示例　　138
5.3.2 　模板与宏　　139
5.3.3 　基于模板的API的优点　　140
5.3.4 　基于模板的API的缺点　　141
5.4 　数据驱动型API　　141
5.4.1 　数据驱动型Web服务　　142
5.4.2 　数据驱动型API的优点　　143
5.4.3 　数据驱动API的缺点　　144
5.4.4 　支持可变参数列表　　144
5.4.5 　案例研究：FMOD数据驱动型API　　147
第6章　C++用法　　149
6.1 　命名空间　　149
6.2 　构造函数和赋值　　150
6.2.1 　控制编译器生成的函数　　152
6.2.2 　定义构造函数和赋值操作符　　153
6.2.3 　explicit关键字　　154
6.3 　const正确性　　155
6.3.1 　方法的const正确性　　155
6.3.2 　参数的const正确性　　157
6.3.3 　返回值的const正确性　　157
6.4 　模板　　158
6.4.1 　模板术语　　158
6.4.2 　隐式实例化API设计　　160
6.4.3 　显式实例化API设计　　162
6.5 　操作符重载　　164
6.5.1 　可重载的操作符　　164
6.5.2 　自由操作符与成员操作符　　165
6.5.3 　为类添加操作符　　166
6.5.4 　操作符语法　　168
6.5.5 　转换操作符　　170
6.6 　函数参数　　171
6.6.1 　指针与引用参数　　171
6.6.2 　默认参数　　172
6.7 　避免使用#define定义常量　　173
6.8 　避免使用友元　　175
6.9 　导出符号　　176
6.10 　编码规范　　179
第7章　性能　　181
7.1 　通过const引用传递输入参数　　182
7.2 　最小化#include依赖　　184
7.2.1 　避免“无所不包型”头文件　　184
7.2.2 　前置声明　　184
7.2.3 　冗余的#include警戒语句　　186
7.3 　声明常量　　188
7.4 　初始化列表　　190
7.5 　内存优化　　192
7.6 　除非需要，勿用内联　　196
7.7 　写时复制　　198
7.8 　迭代元素　　202
7.8.1 　迭代器　　202
7.8.2 　随机访问　　203
7.8.3 　数组引用　　204
7.9 　性能分析　　205
7.9.1 　时效性分析　　205
7.9.2 　基于内存的分析　　207
7.9.3 　多线程分析　　208
第8章　版本控制　　209
8.1 　版本号　　209
8.1.1 　版本号的意义　　209
8.1.2 　小众的编号方案　　210
8.1.3 　提供API的版本信息　　211
8.2 　软件分支策略　　213
8.2.1 　分支策略　　213
8.2.2 　分支方针　　213
8.2.3 　API和并行分支　　214
8.2.4 　文件格式和并行发布产品　　215
8.3 　API的生命周期　　216
8.4 　兼容性级别　　217
8.4.1 　向后兼容性　　217
8.4.2 　功能兼容性　　218
8.4.3 　源代码兼容性　　218
8.4.4 　二进制兼容性　　219
8.4.5 　向前兼容性　　221
8.5 　怎样维护向后兼容性　　222
8.5.1 　添加功能　　222
8.5.2 　修改功能　　223
8.5.3 　弃用功能　　224
8.5.4 　移除功能　　226
8.6 　API审查　　226
8.6.1 　API审查的目的　　226
8.6.2 　API预发布审查　　227
8.6.3 　API预提交审查　　228
第9章　文档　　230
9.1 　编写文档的理由　　230
9.1.1 　定义行为　　230
9.1.2 　为接口契约编写文档　　232
9.1.3 　告知行为的改变　　233
9.1.4 　文档涉及的内容　　234
9.2 　文档的类型　　236
9.2.1 　自动生成的API文档　　237
9.2.2 　概述文档　　237
9.2.3 　示例和教程　　238
9.2.4 　发布说明　　238
9.2.5 　 授权信息　　239
9.3 　文档可用性　　241
9.4 　使用Doxygen　　242
9.4.1 　配置文件　　242
9.4.2 　注释风格和命令　　242
9.4.3 　API注释　　243
9.4.4 　文件注释　　245
9.4.5 　类注释　　245
9.4.6 　方法注释　　246
9.4.7 　枚举注释　　247
9.4.8 　带有文档的示例头文件　　247
第10章　测试　　250
10.1 　编写测试的理由　　250
10.2 　API测试的类型　　252
10.2.1 　单元测试　　253
10.2.2 　集成测试　　255
10.2.3 　性能测试　　257
10.3 　编写良好的测试　　259
10.3.1 　良好测试的特征　　259
10.3.2 　测试对象　　260
10.3.3 　关注测试工作量　　261
10.3.4 　与QA一起工作　　261
10.4 　编写可测试的代码　　262
10.4.1 　测试驱动开发　　262
10.4.2 　桩对象和模拟对象　　264
10.4.3 　测试私有代码　　267
10.4.4 　使用断言　　269
10.4.5 　契约编程　　270
10.4.6 　记录并重放功能　　272
10.4.7 　支持国际化　　273
10.5 　自动化测试工具　　273
10.5.1 　自动化测试框架　　274
10.5.2 　代码覆盖率　　277
10.5.3 　缺陷跟踪系统　　279
10.5.4 　持续构建系统　　280
第11章　脚本化　　282
11.1 　添加脚本绑定　　282
11.1.1 　扩充或嵌入　　282
11.1.2 　脚本化的优点　　283
11.1.3 　语言兼容性问题　　284
11.1.4 　跨越语言障碍　　285
11.2 　脚本绑定技术　　286
11.2.1 　Boost Python　　286
11.2.2 　SWIG　　286
11.2.3 　Python-SIP　　287
11.2.4 　COM自动化　　287
11.2.5 　CORBA　　288
11.3 　使用Boost Python添加Python绑定　　289
11.3.1 　构建Boost Python　　290
11.3.2 　使用Boost Python包装C++ API　　290
11.3.3 　构造函数　　292
11.3.4 　扩充Python API　　293
11.3.5 　C++中的继承　　295
11.3.6 　跨语言多态　　296
11.3.7 　支持迭代器　　298
11.3.8 　综合应用　　298
11.4 　使用SWIG添加Ruby绑定　　300
11.4.1 　使用SWIG包装C++ API　　301
11.4.2 　调整Ruby API　　303
11.4.3 　构造函数　　304
11.4.4 　扩充Ruby API　　304
11.4.5 　C++中的继承　　305
11.4.6 　跨语言多态　　307
11.4.7 　综合应用　　307
第12章　可扩展性　　310
12.1 　通过插件扩展　　310
12.1.1 　插件模型概览　　311
12.1.2 　插件系统设计问题　　313
12.1.3 　以C++实现插件　　314
12.1.4 　插件API　　315
12.1.5 　插件示例　　317
12.1.6 　插件管理器　　318
12.1.7 　插件版本控制　　321
12.2 　通过继承扩展　　322
12.2.1 　添加功能　　322
12.2.2 　修改功能　　323
12.2.3 　继承与STL　　324
12.2.4 　继承与枚举　　325
12.2.5 　访问者模式　　326
12.2.6 　禁止子类化　　331
12.3 　通过模板扩展　　332
12.3.1 　基于策略的模板　　332
12.3.2 　奇特的递归模板模式　　334
附录A 　库　　336
参考文献　　351
索引　　355