C++ API功能设计的实现

目录
  • 前言
  • 纯C API
  • 面向对象的C++ API
  • 基于模板的API
  • 数据驱动型API

前言

创建类来表示API中的每个关键对象,同时提供这些类的方法

此处的API风格指的是如何表现API的功能,以下4种:

  • C API

可以用C编译器编译的API。这种API只包含一组自由函数以及辅助的数据结构和常量。这种风格的接口不包含对象或继承,因此被称为纯C模式

  • 面向对象的C++ API

这种风格涉及对象(其中包含相关的数据与方法)的使用以及继承、封装和多态等概念的应用

  • 基于模板的API

通过模板功能,C++也支持泛型编程和元编程。它支持以泛型类型的方式编写函数和数据结构,在以后使用时,泛型类型可以通过具体类型来实例化,从而实现特化

  • 数据驱动型API

这类接口的特点是,将参数通过灵活的数据结构打包,连同命名的命令一起发送给处理程序,而不是调用特定的方法和自由函数

纯C API

C语言不支持对象封装和继承层次结构等概念,因此,纯C语法的API必须使用一组更为受限的语言特性来表示,比如typedef、结构体和全局命名空间中的函数调用等。因为C语言中没有namespace关键字,要避免与其他C库中的名字发生冲突,对这种风格的API而言,所有公开的函数和数据结构应该使用一个公共的前缀

当然,也可以使用内部链接隐藏实现中的符号名,比如将符号名声明为静态的,这样它们的作用域就限制在.c文件之中了。通过这种方式,可以确保任何这样的函数都不会被导出到外部,从而不会导致符号冲突

// c++ 示例
class Stack
{
public:
    void Push(int val);
    int Pop();
    bool IsEmpty() const;
private:
    int *mStack;
    int mCurSize;
};
// 纯C API
struct Stack
{
    int *mStack;
    int mCurSize;
};
void StackPush(struct Stack *stack, int val);
int StackPop(struct Stack *stack);
bool StackIsEmpty(const struct Stack *stack);
// 进一步改进
typedef struct Stack *StackPtr;
void StackPush(StackPtr stack, int val);
int StackPop(StackPtr stack);
bool StackIsEmpty(const StackPtr stack);
// 可以通过特定的API调用来完成数据库结构的创建与销毁
StackPtr StackCreate();
void StackDestory(StackPtr stack);

C API的头文件中使用extern "C"限制,以便C++程序能够正确的编译和链接C API

#ifdef _cplusplus
extern "C" {
#endif
// C API声明
#ifdef _cplusplus
}
#endif

面向对象的C++ API

过程式编程、泛型编程、函数式编程

使用面向对象的C++概念创建二进制兼容的API是极为困难的

基于模板的API

模板可以用来编写在编译时生成代码或执行代码的程序(该技术称为元编程)

模板可以在编译时执行一些工作,进而改进运行时性能

#include <vector>
template <typename T>
class Stack
{
public:
    void Push(T val);
    T Pop();
    bool IsEmpty() const;
private:
    std::vector<T> mStack;
};
// 可以定义一个typedef,这样就可以更方便地使用该模板实例了
typedef Stack<int> IntStack;
IntStack *stack = new IntStack();

模板实现方式的另一个选择是,利用C预处理器来定义一段文本,可以将其放入多个头文件中

#include <vector>
#define DECLARE_STACK(Prefix, T) \
class Prefix##Stack \
{ \
public: \
    void Push(T val); \
    T Pop(); \
    bool IsEmpty() const; \

private: \
    std::vector<T> mStack; \
}
DECLARE_STACK(Int, int);

模板提供了一种类型安全的在编译时生成代码的方式。你可以调试到类模板的时机代码行中。除非你要编写纯C API,无法使用模板,否则就应该避免使用预处理器来模拟模板

模板的一个重要属性是,不同于使用继承时的动态(运行时)多态,它支持静态(编译时)多态

不会像虚方法那样存在运行时代价

模板进一步的益处,对于特定类型的实例类,可以特化它的某些方法

template <>
void Stack<int>::Push(int val)
{
    // 实现特定于int类型的压栈功能
}

基于模板的API的缺点

  • 最严重的问题是:类模板的定义通常必须出现在公开的头文件中
  • 因为要特化模板,编译器必须能够访问模板代码的完整定义,显而易见,这会暴露内部细节
  • 每当其他文件包含了类模板定义所在的头文件时,内联的代码都需要重新编译,生成的代码会被添加到每个使用该API的模块的目标文件。这会增加编译时间,并致使代码膨胀
  • 实际上有些情况下你可以使用显式实例化技术将模板的实现隐藏在.cpp文件中
  • 模板的另一个缺点是,模板代码中出现错误时,大多数编译器生成的报错信息都是冗长且令人困惑的,可用STLFilt

相对于运行时开销而言,代码体积是需要优先考虑的因素,那么应该选择面向对象方案,而非模板。或者相反,如果运行时性能更为重要,那就应该选择模板

数据驱动型API

数据驱动型程序指的是:通过每次运行时提供不同的输入数据,它可以执行不同的操作

优点

  • 对于API将来可能发生的变化,它的容错性更强
  • 可以更容易地支持数据驱动型测试技术p143

API支持可变参数列表

  • 联合体
  • 继承
  • void *

到此这篇关于C++ API功能设计的实现的文章就介绍到这了,更多相关C++ API内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • C++设计与声明超详细讲解

    目录 让接口被正确使用不易被误用 宁以pass-by-reference-to-const替换pass-by-value 必须返回对象时 将成员变量声明为private 以non-member non-friend替换member函数 non-member 考虑写出一个不抛出异常的swap函数 让接口被正确使用不易被误用 除非有好的理由,否则应该让你的types的行为与内置types一致,请拿ints做范本 提供行为一致的接口! 阻止误用的办法包括建立新类型,限制类型上的操作,束缚对象值(比如要

  • C++设计与实现ORM系统实例详解

    目录 介绍 依赖关系 设计思路 项目进度 数据库通用接口 实例构造 智能查询方式设计 单元测试 运行方法 介绍 我们通用的ORM,基本模式都是想要脱离数据库的,几乎都在编程语言层面建立模型,由程序去与数据库打交道.虽然脱离了数据库的具体操作,但我们要建立各种模型文档,用代码去写表之间的关系等等操作,让初学者一时如坠云雾.我的想法是,将关系数据库拥有的完善设计工具之优势,来实现数据设计以提供结构信息,让json对象自动映射成为标准的SQL查询语句.只要我们理解了标准的SQL语言,我们就能够完成数据

  • C和C++ const的声明差异

    当在C源代码文件中将变量声明为const时,可以通过以下方式实现: const int i = 2; 然后,可以在另一个模块中使用此变量,如下表示: extern const int i; 但若要获取与 C++ 中相同的行为,则必须将 const 变量声明为: extern const int i = 2; 如果希望在 C++ 源代码文件声明用于 C 源代码文件的 extern 变量,请使用: extern "C" const int x = 10; 以防止 C++ 编译器进行名称重整

  • C++ API功能设计的实现

    目录 前言 纯C API 面向对象的C++ API 基于模板的API 数据驱动型API 前言 创建类来表示API中的每个关键对象,同时提供这些类的方法 此处的API风格指的是如何表现API的功能,以下4种: 纯C API 可以用C编译器编译的API.这种API只包含一组自由函数以及辅助的数据结构和常量.这种风格的接口不包含对象或继承,因此被称为纯C模式 面向对象的C++ API 这种风格涉及对象(其中包含相关的数据与方法)的使用以及继承.封装和多态等概念的应用 基于模板的API 通过模板功能,C

  • 利用百度地图API获取当前位置信息的实例

    利用百度地图API可以做很多事情,个人感觉最核心也是最基础的就是定位功能了.这里分享一个制作的JS可以实现登录网页后定位: <script type="text/javascript"> var map; var gpsPoint; var baiduPoint; var gpsAddress; var baiduAddress; var x; var y; function getLocation() { //根据IP获取城市 var myCity = new BMap.

  • 一个小型js框架myJSFrame附API使用帮助

    它在一定程度上改变了传统的 JavaScript 编程风格. 它还能识别 CSS 代码,它增加了 DOM 方法,扩展了 String 与 Array 原型对象,模拟  StringBuffer.NameSpace 类,支持操作 Cookie,浏览器检测. 当然,Ajax 还是它的强项,$ 函数支持的 CSS 选择符也不弱 -- myJSFrame.jsapi.htm帮助手册

  • sea.js常用的api简易文档

    本文罗列了seajs常用的api和代码示例,下面话不多说,来看看详细的介绍,有需要的朋友们可以参考借鉴. 一.seajs.config alias 别名配置,配置之后可在模块中使用require调用 require('jquery'); seajs.config({ alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' } }); define(function(require, exports, module) { //引用jQuery模块 var

  • seajs学习之模块的依赖加载及模块API的导出

    前言 SeaJS非常强大,SeaJS可以加载任意 JavaScript 模块和css模块样式,SeaJS会保证你在使用一个模块时,已经将所依赖的其他模块载入到脚本运行环境中. 通过参照上文的demo,我们结合源码分析在简单的API调用的背后,到底使用了什么技巧来实现各个模块的依赖加载以及模块API的导出. 模块类和状态类 首先定义了一个Module类,对应与一个模块 function Module(uri, deps) { this.uri = uri this.dependencies = d

  • JavaScript可视化图表库D3.js API中文参考

    D3库所提供的所有 API 都在 d3 命名空间下.d3 库使用语义版本命名法(semantic versioning). 你可以用 d3.version 查看当前的版本信息. d3 (核心部分) 选择集 d3.select - 从当前文档中选择一系列元素. d3.selectAll - 从当前文档中选择多项元素. selection.attr - 设置或获取指定属性. selection.classed - 添加或删除选定元素的 CSS 类(CSS class). selection.styl

  • AngularJS向后端ASP.NET API控制器上传文件

    本文实例介绍了前端AngularJS向后端ASP.NET Web API上传文件的实现方法,具体内容如下 首先服务端: public class FilesController : ApiController { //using System.Web.Http [HttpPost] public async Task<HttpResponseMessage> Upload() { if(!Request.Content.IsMimeMultipartContent()) { this.Requ

  • AngularJS中的API(接口)简单实现

    AngularJS API API 意为 Application Programming Interface(应用程序编程接口). AngularJS 全局 API AngularJS 全局 API 用于执行常见任务的 JavaScript 函数集合,如: 比较对象 迭代对象 转换对象 全局 API 函数使用 angular 对象进行访问. 以下列出了一些通用的 API 函数: API 描述 angular.lowercase() 转换字符串为小写 angular.uppercase() 转换字

  • 浅谈Spark RDD API中的Map和Reduce

    RDD是什么? RDD是Spark中的抽象数据结构类型,任何数据在Spark中都被表示为RDD.从编程的角度来看,RDD可以简单看成是一个数组.和普通数组的区别是,RDD中的数据是分区存储的,这样不同分区的数据就可以分布在不同的机器上,同时可以被并行处理.因此,Spark应用程序所做的无非是把需要处理的数据转换为RDD,然后对RDD进行一系列的变换和操作从而得到结果.本文为第一部分,将介绍Spark RDD中与Map和Reduce相关的API中. 如何创建RDD? RDD可以从普通数组创建出来,

  • ASP.NET MVC API 接口验证的示例代码

    项目中有一个留言消息接口,接收其他系统的留言和展示留言,参考了网上的一些API验证方法,发现使用通用权限管理系统提供的验证方法最完美. 下面将实现的完整思路共享 1.WebApiConfig全局处理 /// <summary> /// WebApiConfig /// 路由基础配置. /// /// /// 修改记录 /// /// 2016.11.01 版本:2.0 宋彪 对日期格式进行统一处理. /// 2016.10.30 版本:2.0 宋彪 解决json序列化时的循环引用问题. ///

随机推荐