草庐IT

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

coder 2023-05-03 原文

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

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

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

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

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

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

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

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

最佳答案

初步说明:我假设是 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 文件中，只是为了保持头文件干净且易于理解。

关于c++ - 库设计: allow user to decide between "header-only" and dynamically linked?，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/25606736/

ampheader-onlycodeLIBRARY内联c++c++11librarieslibrary-design

有关c++ - 库设计: allow user to decide between "header-only" and dynamically linked?的更多相关文章

  1. ruby-on-rails - rails : "missing partial" when calling 'render' in RSpec test - 2

    我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身，new.html.erb，有代码:当我运行rspec时，它失败了:1)messages/new.html.erbshou

  2. ruby-on-rails - 由于 "wkhtmltopdf"，PDFKIT 显然无法正常工作 - 2

    我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中，我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-

  3. ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co

  4. ruby - 检查 "command"的输出应该包含 NilClass 的意外崩溃 - 2

    为了将Cucumber用于命令行脚本，我按照提供的说明安装了arubagem。它在我的Gemfile中，我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作，我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了，但失败的原因是错误的:@announceScenario:Testingcucumber/ar

  5. ruby-on-rails - 如何优雅地重启 thin + nginx？ - 2

    我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？ 最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server

  6. ruby-on-rails - 使用 rails 4 设计而不更新用户 - 2

    我将应用程序升级到Rails4，一切正常。我可以登录并转到我的编辑页面。也更新了观点。使用标准View时，用户会更新。但是当我添加例如字段:name时，它​​不会在表单中更新。使用devise3.1.1和gem'protected_attributes'我需要在设备或数据库上运行某种更新命令吗？我也搜索过这个地方，找到了许多不同的解决方案，但没有一个会更新我的用户字段。我没有添加任何自定义字段。 最佳答案 如果您想允许额外的参数，您可以在ApplicationController中使用beforefilter，因为Rails4将参数

  7. ruby-on-rails - 迷你测试错误 : "NameError: uninitialized constant" - 2

    我遵循MichaelHartl的“RubyonRails教程:学习Web开发”，并创建了检查用户名和电子邮件长度有效性的测试(名称最多50个字符，电子邮件最多255个字符)。test/helpers/application_helper_test.rb的内容是:require'test_helper'classApplicationHelperTest在运行bundleexecraketest时，所有测试都通过了，但我看到以下消息在最后被标记为错误:ERROR["test_full_title_helper",ApplicationHelperTest,1.820016791]test

  8. ruby-on-rails - 相关表上的范围为 "WHERE ... LIKE" - 2

    我正在尝试从Postgresql表(table1)中获取数据，该表由另一个相关表(property)的字段(table2)过滤。在纯SQL中，我会这样编写查询:SELECT*FROMtable1JOINtable2USING(table2_id)WHEREtable2.propertyLIKE'query%'这工作正常:scope:my_scope,->(query){includes(:table2).where("table2.property":query)}但我真正需要的是使用LIKE运算符进行过滤，而不是严格相等。然而，这是行不通的:scope:my_scope,->(que

  9. 使用 ACL 调用 upload_file 时出现 Ruby S3 "Access Denied"错误 - 2

    我正在尝试编写一个将文件上传到AWS并公开该文件的Ruby脚本。我做了以下事情:s3=Aws::S3::Resource.new(credentials:Aws::Credentials.new(KEY,SECRET),region:'us-west-2')obj=s3.bucket('stg-db').object('key')obj.upload_file(filename)这似乎工作正常，除了该文件不是公开可用的，而且我无法获得它的公共(public)URL。但是当我登录到S3时，我可以正常查看我的文件。为了使其公开可用，我将最后一行更改为obj.upload_file(file

  10. ruby - 安装 Ruby 时遇到问题(无法下载资源 "readline--patch") - 2

    当我尝试安装Ruby时遇到此错误。我试过查看this和this但无济于事➜~brewinstallrubyWarning:YouareusingOSX10.12.Wedonotprovidesupportforthispre-releaseversion.Youmayencounterbuildfailuresorotherbreakages.Pleasecreatepull-requestsinsteadoffilingissues.==>Installingdependenciesforruby:readline,libyaml,makedepend==>Installingrub

随机推荐