C++ API设计

Author： [美]Martin Reddy 著

Publishers： 人民邮电出版社

Publishing year： 2013

ISBN： 9787115322999

Subject： [TP 自动化技术、计算机技术]

Language： CHS

Introduction

　　如何构建高效、健壮、稳定且可扩展的优质API？对于这一软件工程上的难题，Martin Reddy凭借长期的从业经验，对优质API所应具备的各要素进行了全面分析，针对API的不同风格及模式，以及大型长期项目的内在需求，给出了种种最佳设计策略，从而对API设计过程的规范性及可持续性作出了理论上不可磨灭的贡献。 　　《C++ API设计》适合具有一定C++编程经验的程序员阅读，也适合对API设计主题感兴趣的读者参考。

Chapter

  • 扉页

  • 版权页

  • 版权声明

  • 译者序

  • 序言

  • 前言

  • 致谢

  • 目录

  • 第1 章 API 简介

  • 1.1　什么是API

  • 1.1.1　契约和承包人

  • 1.1.2　C++中的API

  • 1.2　API设计上有什么不同

  • 1.3　为什么使用API

  • 1.3.1　更健壮的代码

  • 1.3.2　代码复用

  • 1.3.3　并行开发

  • 1.4　何时应当避免使用API

  • 1.5　API示例

  • 1.5.1　API层次

  • 1.5.2　真实示例

  • 1.6　文件格式和网络协议

  • 1.7　关于本书

  • 第2 章 特征

  • 2.1　问题域建模

  • 2.1.1　提供良好的抽象

  • 2.1.2　关键对象的建模

  • 2.2　隐藏实现细节

  • 2.2.1　物理隐藏：声明与定义

  • 2.2.2　逻辑隐藏：封装

  • 2.2.3　隐藏成员变量

  • 2.2.4　隐藏实现方法

  • 2.2.5　隐藏实现类

  • 2.3　最小完备性

  • 2.3.1　不要过度承诺

  • 2.3.2　谨慎添加虚函数

  • 2.3.3　便捷API

  • 2.4　易用性

  • 2.4.1　可发现性

  • 2.4.2　不易误用

  • 2.4.3　一致性

  • 2.4.4　正交

  • 2.4.5　健壮的资源分配

  • 2.4.6　平台独立

  • 2.5　松耦合

  • 2.5.1　仅通过名字耦合

  • 2.5.2　降低类耦合

  • 2.5.3　刻意的冗余

  • 2.5.4　管理器类

  • 2.5.5　回调、观察者和通知

  • 2.6　稳定的、文档详细且经过测试的API

  • 第3 章 模式

  • 3.1　Pimpl惯用法

  • 3.1.1　使用Pimpl

  • 3.1.2　复制语义

  • 3.1.3　Pimpl与智能指针

  • 3.1.4　Pimpl的优点

  • 3.1.5　Pimpl的缺点

  • 3.1.6　C语言的不透明指针

  • 3.2　单例

  • 3.2.1　在C++中实现单例

  • 3.2.2　使单例线程安全

  • 3.2.3　单例与依赖注入

  • 3.2.4　单例与单一状态

  • 3.2.5　单例与会话状态

  • 3.3　工厂模式

  • 3.3.1　抽象基类

  • 3.3.2　工厂示例

  • 3.3.3　扩展工厂示例

  • 3.4　API包装器模式

  • 3.4.1　代理模式

  • 3.4.2　适配器模式

  • 3.4.3　外观模式

  • 3.5　观察者模式

  • 3.5.1　MVC架构

  • 3.5.2　实现观察者模式

  • 3.5.3　推与拉观察者

  • 第4 章 设计

  • 4.1　良好设计的例子

  • 4.1.1　积累技术债

  • 4.1.2　偿还技术债

  • 4.1.3　为长期而设计

  • 4.2　收集功能性需求

  • 4.2.1　什么是功能性需求

  • 4.2.2　功能性需求举例

  • 4.2.3　维护需求

  • 4.3　创建用例

  • 4.3.1　开发用例

  • 4.3.2　用例模板

  • 4.3.3　编写高质量用例

  • 4.3.4　 需求与敏捷开发

  • 4.4　API设计的元素

  • 4.5　架构设计

  • 4.5.1　架构的开发

  • 4.5.2　架构的约束

  • 4.5.3　识别主要抽象

  • 4.5.4　创造关键对象

  • 4.5.5　架构模式

  • 4.5.6　架构的交流

  • 4.6　类的设计

  • 4.6.1　面向对象概念

  • 4.6.2　类设计选项

  • 4.6.3　使用继承

  • 4.6.4　Liskov替换原则

  • 4.6.5　开放封闭原则

  • 4.6.6　迪米特法则

  • 4.6.7　类的命名

  • 4.7　函数设计

  • 4.7.1　函数设计选项

  • 4.7.2　函数命名

  • 4.7.3　函数参数

  • 4.7.4　错误处理

  • 第5 章 风格

  • 5.1　纯C API

  • 5.1.1　ANSI C特性

  • 5.1.2　ANSI C API的优点

  • 5.1.3　使用ANSI C编写API

  • 5.1.4　从C++中调用C函数

  • 5.1.5　案例研究：FMOD C API

  • 5.2　面向对象的C++ API

  • 5.2.1　面向对象API的优点

  • 5.2.2　面向对象API的缺点

  • 5.2.3　案例研究：FMOD C++ API

  • 5.3　基于模板的API

  • 5.3.1　基于模板的API示例

  • 5.3.2　模板与宏

  • 5.3.3　基于模板的API的优点

  • 5.3.4　基于模板的API的缺点

  • 5.4　数据驱动型API

  • 5.4.1　数据驱动型Web服务

  • 5.4.2　数据驱动型API的优点

  • 5.4.3　数据驱动API的缺点

  • 5.4.4　支持可变参数列表

  • 5.4.5　案例研究：FMOD数据驱动型API

  • 第6 章 C++用法

  • 6.1　命名空间

  • 6.2　构造函数和赋值

  • 6.2.1　控制编译器生成的函数

  • 6.2.2　定义构造函数和赋值操作符

  • 6.2.3　explicit关键字

  • 6.3　const正确性

  • 6.3.1　方法的const正确性

  • 6.3.2　参数的const正确性

  • 6.3.3　返回值的const正确性

  • 6.4　模板

  • 6.4.1　模板术语

  • 6.4.2　隐式实例化API设计

  • 6.4.3　显式实例化API设计

  • 6.5　操作符重载

  • 6.5.1　可重载的操作符

  • 6.5.2　自由操作符与成员操作符

  • 6.5.3　为类添加操作符

  • 6.5.4　操作符语法

  • 6.5.5　转换操作符

  • 6.6　函数参数

  • 6.6.1　指针与引用参数

  • 6.6.2　默认参数

  • 6.7　避免使用#define定义常量

  • 6.8　避免使用友元

  • 6.9　导出符号

  • 6.10　编码规范

  • 第7 章 性能

  • 7.1　通过const引用传递输入参数

  • 7.2　最小化#include依赖

  • 7.2.1　避免“无所不包型”头文件

  • 7.2.2　前置声明

  • 7.2.3　冗余的#include警戒语句

  • 7.3　声明常量

  • 7.4　初始化列表

  • 7.5　内存优化

  • 7.6　除非需要，勿用内联

  • 7.7　写时复制

  • 7.8　迭代元素

  • 7.8.1　迭代器

  • 7.8.2　随机访问

  • 7.8.3　数组引用

  • 7.9　性能分析

  • 7.9.1　时效性分析

  • 7.9.2　基于内存的分析

  • 7.9.3　多线程分析

  • 第8 章 版本控制

  • 8.1　版本号

  • 8.1.1　版本号的意义

  • 8.1.2　小众的编号方案

  • 8.1.3　提供API的版本信息

  • 8.2　软件分支策略

  • 8.2.1　分支策略

  • 8.2.2　分支方针

  • 8.2.3　API和并行分支

  • 8.2.4　文件格式和并行发布产品

  • 8.3　API的生命周期

  • 8.4　兼容性级别

  • 8.4.1　向后兼容性

  • 8.4.2　功能兼容性

  • 8.4.3　源代码兼容性

  • 8.4.4　二进制兼容性

  • 8.4.5　向前兼容性

  • 8.5　怎样维护向后兼容性

  • 8.5.1　添加功能

  • 8.5.2　修改功能

  • 8.5.3　弃用功能

  • 8.5.4　移除功能

  • 8.6　API审查

  • 8.6.1　API审查的目的

  • 8.6.2　API预发布审查

  • 8.6.3　API预提交审查

  • 第9 章 文档

  • 9.1　编写文档的理由

  • 9.1.1　定义行为

  • 9.1.2　为接口契约编写文档

  • 9.1.3　告知行为的改变

  • 9.1.4　文档涉及的内容

  • 9.2　文档的类型

  • 9.2.1　自动生成的API文档

  • 9.2.2　概述文档

  • 9.2.3　示例和教程

  • 9.2.4　发布说明

  • 9.2.5　 授权信息

  • 9.3　文档可用性

  • 9.4　使用Doxygen

  • 9.4.1　配置文件

  • 9.4.2　注释风格和命令

  • 9.4.3　API注释

  • 9.4.4　文件注释

  • 9.4.5　类注释

  • 9.4.6　方法注释

  • 9.4.7　枚举注释

  • 9.4.8　带有文档的示例头文件

  • 第10 章 测试

  • 10.1　编写测试的理由

  • 10.2　API测试的类型

  • 10.2.1　单元测试

  • 10.2.2　集成测试

  • 10.2.3　性能测试

  • 10.3　编写良好的测试

  • 10.3.1　良好测试的特征

  • 10.3.2　测试对象

  • 10.3.3　关注测试工作量

  • 10.3.4　与QA一起工作

  • 10.4　编写可测试的代码

  • 10.4.1　测试驱动开发

  • 10.4.2　桩对象和模拟对象

  • 10.4.3　测试私有代码

  • 10.4.4　使用断言

  • 10.4.5　契约编程

  • 10.4.6　记录并重放功能

  • 10.4.7　支持国际化

  • 10.5　自动化测试工具

  • 10.5.1　自动化测试框架

  • 10.5.2　代码覆盖率

  • 10.5.3　缺陷跟踪系统

  • 10.5.4　持续构建系统

  • 第11 章 脚本化

  • 11.1　添加脚本绑定

  • 11.1.1　扩充或嵌入

  • 11.1.2　脚本化的优点

  • 11.1.3　语言兼容性问题

  • 11.1.4　跨越语言障碍

  • 11.2　脚本绑定技术

  • 11.2.1　Boost Python

  • 11.2.2　SWIG

  • 11.2.3　Python-SIP

  • 11.2.4　COM自动化

  • 11.2.5　CORBA

  • 11.3　使用Boost Python添加Python绑定

  • 11.3.1　构建Boost Python

  • 11.3.2　使用Boost Python包装C++ API

  • 11.3.3　构造函数

  • 11.3.4　扩充Python API

  • 11.3.5　C++中的继承

  • 11.3.6　跨语言多态

  • 11.3.7　支持迭代器

  • 11.3.8　综合应用

  • 11.4　使用SWIG添加Ruby绑定

  • 11.4.1　使用SWIG包装C++ API

  • 11.4.2　调整Ruby API

  • 11.4.3　构造函数

  • 11.4.4　扩充Ruby API

  • 11.4.5　C++中的继承

  • 11.4.6　跨语言多态

  • 11.4.7　综合应用

  • 第12 章 可扩展性

  • 12.1　通过插件扩展

  • 12.1.1　插件模型概览

  • 12.1.2　插件系统设计问题

  • 12.1.3　以C++实现插件

  • 12.1.4　插件API

  • 12.1.5　插件示例

  • 12.1.6　插件管理器

  • 12.1.7　插件版本控制

  • 12.2　通过继承扩展

  • 12.2.1　添加功能

  • 12.2.2　修改功能

  • 12.2.3　继承与STL

  • 12.2.4　继承与枚举

  • 12.2.5　访问者模式

  • 12.2.6　禁止子类化

  • 12.3　通过模板扩展

  • 12.3.1　基于策略的模板

  • 12.3.2　奇特的递归模板模式

  • 附录A 库

  • 参考文献

  • 索引

    • 服务邮箱： whx@cnpiec.com.cn

    联系电话：010-65063046；65001305

    京ICP备09090397号-16 京公网安备 11010502049547号