SDK开发技巧&注意事项
SDK结构
两种SDK形式
1. header-only
+- /include
| +- a.h
| +- b.h
| +- c.h
| +- ...
2.header-files+lib
+- /include
| +- a.h
| +- b.h
| +- c.h
+- /lib
| +- libxxx.so
+- /dependencies
| +- libaaa.so
| +- libbbb.so
| +- libccc.so
1. 接口信息暴露
一般,必须暴露出去的接口类,包含以下这些东西
- 插件(管理)(驱动)类
- 输入参数
- 输出参数
class manager {
public:
bool init();
void run(const int &input, int &output);
void destroy();
private:
//...
};
这样的类必不可少,开发时做好抽象,尽可能减少这种类的数量
2. 多个头文件整合
如果上面栗子的manager类,和输入input、输出output分别属于多个头文件,那么开发者需要include三次,可以进行一个头文件整

本文介绍了SDK的两种主要形式,强调了接口设计的重要性,包括接口的命名清晰、单一职责、参数精简以及参数校验。同时,提出了前置声明以减少编译时间和简化调用,以及SDK线程管理和日志配置的规范。此外,还提醒开发者注意接口的统一性和Readme文档的编写。
最低0.47元/天 解锁文章
347

被折叠的 条评论
为什么被折叠?



