C++库API.使用转换器类而不是普通的C api

C++ library API. Using converter classes instead of plain C api

本文关键字：api API 转换器 C++      更新时间：2023-10-16

这个问题是关于C++的C++互操作性。

众所周知，标准库类/函数的实现可能因不同的供应商而异。此外，即使在同一个库供应商中，当使用不同的编译器密钥、配置（调试/发布）等时，实现也可能不同。

由于这个原因，许多库开发人员转向了旧的纯C样式API。这导致了丑陋的易出错界面。

例如，为了从某些函数中获取字符串，使用了Win-GetCurrentDirectory函数等接口：

DWORD WINAPI GetCurrentDirectory(
  __in   DWORD nBufferLength,
  __out  LPTSTR lpBuffer
);

三个参数+两边的一些样板代码（检查缓冲区大小是否足够，等等），只是为了获得简单的字符串。

我正在考虑使用一些辅助适配器/代理类，它将自动完成所有转换，并且可以简单地重用。

类似于：

#include <string>
#include <algorithm>
#include <iostream>
#include <ostream>
class StringConverter
{
    char *str; // TODO: use smart pointer with right deleter
public:
    StringConverter(const std::string &user_string) // Will be defined only at user side
    {
        str=new char[user_string.length()+1];
        (*(std::copy(user_string.begin(),user_string.end(),str)))=0;
    }
    operator std::string() // Will be defined only at library side
    {
        return std::string(str);
    }
    ~StringConverter()
    {
        delete [] str;
    }
};
StringConverter foo()
{
    return std::string("asd");
}

int main(int argc,char *argv[])
{
    std::cout << std::string(foo()) << std::endl;
    return 0;
}

http://ideone.com/EfcKv

注意，我计划只在用户端保护从用户字符串到StringConverter的转换，只在库内保护从StringConverter到库字符串的转换。另外，应该使用右删除器（来自右堆）。

你觉得这种方法怎么样？

是否存在一些主要陷阱？

有什么更好的选择吗？

在标准数据类型不兼容的某些情况下，这种技术会起作用，但在其他情况下也不会更好：名称篡改差异和类内存布局差异（vptrs和标记）会浮现在脑海中。

这就是为什么首选C API。

但是可以通过将C API隐藏在库调用方不需要看到的地方来提高可用性。然后添加一个瘦的、惯用的C++覆盖，提供可见的库接口。在某些情况下，瘦覆盖代码可以在调用方和库端使用，每个代码都在自己的环境中编译：标志、链接约定等。只交换C数据类型。这些数据类型越简单，获得的兼容性就越强。

该层还注意到，内存分配和释放在API的同一侧以每个对象为基础进行，就像您的代码一样。但它可以更灵活。例如，可以安排在调用程序中分配的对象在库中解除分配，反之亦然。

// library.h for both caller and library
// "shadow" C API should not be used by caller
extern "C" {
void *make_message(char *text);
char *get_text_of_message(void* msg);
void send_message(void *msg); // destroys after send.
}
// Thin C++ overlay
class Message {
  void *msg;
public:
  Message(const std::string &text) {
    msg = make_message(text.c_str());
  }
  void send() {
    if (msg) send_message(msg);
    else error("already sent");
    msg = 0;
  }
  std:string getTextString() {
    return std:string(get_text_of_message(void* msg));
  }
}
相关文章：