从编译器对指令集的要求看API设计原则

摘要：最近看《计算机体系结构：量化研究方法（第五版）》，发现指令集设计中的一些原则，对API设计也同样适用，给大家分享一下。

本文中的所有内容来自工作和学习过程中的心得整理，如需转载请注明出处。周荣华@燧原科技

1 正交

指令集需要满足操作、数据类型和寻址方式三个方面的功能就是正交的。所以API设计应该也要满足对外的一些功能需求，一般是基本操作、数据类型定义和内存访问方式。

正交的要求不只是接口设计要覆盖所有功能，还需要尽量减少冗余接口。

2 提供原语而不是解决方案

API应该提供完成解决方案需要的一些原语的集合，而不是某个解决方案。

提供解决方案到API中的最大缺点是稳定性太差，这些解决方案可能在当前适用，但过几个月，有新的解决方案的时候，原来的API被废掉的概率非常大。

当然，对部分多个解决方案中共用的一些功能，即使能够用现有原语实现，额外提供一些公共功能的接口也是一种不错的选择，但切忌不要过于特定化。

3 简化候选项之间的权衡

如果完成一个功能有多种选项，必须要有严格的使用场景约束。

多个选项都可以用，会额外增加测试覆盖的负担，用户制定解决方案的时候，也会不知道该选择哪个，往往会通过多个原型测试验证来推动API的实际选择，但这种测试得到的结果，在多个版本的API之间可能是不稳定的，这也会给客户的版本升级带来巨大负担。

4 常量编译期绑定

部分调用比较频繁的接口，如果对性能要求特别苛刻的话，需要对外提供inline函数，方便性能的极致优化。