c++ - 库设计: allow user to decide between "header-only" and dynamically linked?

Question

我已经创建了几个目前仅 header 的 C++ 库。我的类的接口(interface)和实现都写在同一个 .hpp 文件中。

我最近开始觉得这种设计不太好:

1. 如果用户想要编译库并动态链接它，他/她不能。
2. 更改单行代码需要完全重新编译依赖库的现有项目。

我真的很喜欢纯头文件库的各个方面:所有函​​数都可能被内联，并且它们非常容易包含在您的项目中 - 无需编译/链接任何东西，只需一个简单的 #include 指令。

是否可以两全其美？我的意思是 - 允许用户选择他/她想如何使用图书馆。它还可以加快开发速度，因为我会在“动态链接模式”下处理库以避免荒谬的编译时间，并以“仅头文件模式”发布我的成品以最大限度地提高性能。

第一个逻辑步骤是在 .hpp 和 .inl 文件中划分接口(interface)和实现。

不过，我不确定如何前进。我已经看到许多库将 LIBRARY_API 宏添加到它们的函数/类声明中 - 也许需要类似的东西来允许用户选择？

---

我所有的库函数都以 inline 关键字为前缀，以避免 “multiple definition of...” 错误。我假设关键字将被 .inl 文件中的 LIBRARY_INLINE 宏替换？对于“仅标题模式”，该宏将解析为 inline，而对于“动态链接模式”，该宏将解析为无。

Answer 1

初步说明:我假设是 Windows 环境，但这应该很容易转移到其他环境。

您的图书馆必须为四种情况做好准备:

1. 用作仅 header 库
2. 用作静态库
3. 用作动态库(导入函数)
4. 内置动态库(函数导出)

因此，让我们为这些情况编写四个预处理器定义:INLINE_LIBRARY、STATIC_LIBRARY、IMPORT_LIBRARY 和 EXPORT_LIBRARY (这只是一个示例；您可能想要使用一些复杂的命名方案)。用户必须定义​​其中之一，具体取决于他/她想要什么。

然后你可以这样写你的标题:

// foo.hpp

#if defined(INLINE_LIBRARY)
#define LIBRARY_API inline
#elif defined(STATIC_LIBRARY)
#define LIBRARY_API
#elif defined(EXPORT_LIBRARY)
#define LIBRARY_API __declspec(dllexport)
#elif defined(IMPORT_LIBRARY)
#define LIBRARY_API __declspec(dllimport)
#endif

LIBRARY_API void foo();

#ifdef INLINE_LIBRARY
#include "foo.cpp"
#endif

你的实现文件看起来和往常一样:

// foo.cpp

#include "foo.hpp"
#include <iostream>

void foo()
{
    std::cout << "foo";
}

如果定义了 INLINE_LIBRARY，则函数被声明为内联，实现就像 .inl 文件一样包含在内。

如果定义了 STATIC_LIBRARY，则函数声明时不带任何说明符，用户必须将 .cpp 文件包含到他/她的构建过程中。

如果定义了IMPORT_LIBRARY，则导入函数，不需要任何实现。

如果定义了EXPORT_LIBRARY，函数会被导出，用户必须编译那些.cpp文件。

在静态/导入/导出之间切换是很常见的事情，但我不确定将仅 header 添加到等式中是否是一件好事。通常，有充分的理由来定义内联或不这样做。

就我个人而言，我喜欢将所有内容都放入 .cpp 文件中，除非它确实必须被内联(如模板)或者它在性能方面有意义(非常小的函数，通常是单行)。这减少了编译时间和 - 更重要的 - 依赖关系。

但如果我选择内联定义某些内容，我总是将其放在单独的 .inl 文件中，只是为了保持头文件干净且易于理解。