确保内部共享库版本正确

Question

我目前的任务是在我们的内部库方面尝试改进我们公司的版本控制实践。我已经阅读了 Semantic Versioning 2.0.0，这对于我们当前的问题来说似乎是一个非常好的、简单和优雅的解决方案，因为我们当前的版本控制实践（例如 library_v01）并没有真正告诉我们每个库版本的太多信息。

理想情况下，应用程序会在编译时检查正在使用的库的版本，以便在部署和/或测试之前发现任何不匹配的情况。我们的应用程序是用 Visual Studio 编写的，我们很快就会升级到 C++11 编译器友好的 VS2013，这就是为什么我的第一个想法是使用 static_asserts 以便在编译时检查版本，例如：

// Defined in library code and accessible by applications
struct LibraryVersion {
    static const unsigned int LIB_VERSION_MAJOR = 1;
    static const unsigned int LIB_VERSION_MINOR = 0;
    static const unsigned int LIB_VERSION_PATCH = 0;
}

// Application code
static const unsigned int EXPECTED_LIB_VERSION_MAJOR = 1;
static const unsigned int EXPECTED_LIB_VERSION_MINOR = 0;
static const unsigned int EXPECTED_LIB_VERSION_PATCH = 0;

void lib_version_check() {
    static_assert(LibraryVersion::LIB_VERSION_MAJOR == EXPECTED_LIB_VERSION_MAJOR, "Error Major");
    static_assert(LibraryVersion::LIB_VERSION_MINOR == EXPECTED_LIB_VERSION_MINOR, "Error Minor");
    static_assert(LibraryVersion::LIB_VERSION_PATCH == EXPECTED_LIB_VERSION_PATCH, "Error Patch");
}

此外，最好在库 prop 文件中包含某种预处理器定义，该文件可用于包含路径，以便每个应用程序始终包含正确的库文件，例如

$(LIB_DIR)="C:\Libs\"
$(LIB_VERS)="v1.0.0"
Include_Path = $(LIB_DIR)\$(LIB_VERS);

文件结构类似于：

C:\Libs\v1.0.0\include\...
C:\Libs\v1.0.1\include\...
C:\Libs\v1.0.2\include\...
C:\Libs\v1.2.0\include\...

然而，这对我来说似乎不是最优雅的解决方案，并且必须跟踪两个版本变量（预处理器值和代表 MAJOR、MINOR 和 PATCH 版本的无符号整数）似乎有点多。

所以基本上我想问一下其他人是否遇到过类似的事情，他们是否对什么是优雅的解决方案有任何见解，或者使用上述解决方案是否有任何我可能没有想到的陷阱的？也许具有像上述那样的文件结构是有问题的和/或有更简单的方法？对于任何反馈，我们都表示感谢。非常感谢。

Answer 1

我们只是使用 git 标签作为主要、次要和补丁生成带有模板的标题。我们做你上面所做的，但它都是自动化的。这并不能解决编译依赖问题。

然而，需要什么库版本的依赖被提升到我们自定义的waf 构建系统的包依赖中。例如：

# We need boost
conf.env.BOOST_MINIMUM_VERSION = (1, 50)
conf.load('boost', tooldir=vcawaflib.dir)

# VCA project dependencies
conf.env.VCA_TEST_MINIMUM_VERSION = (0, 2, 3)
conf.project_uselib('sdk/test', 'vca_test')

构建系统与系统包管理器接口（在 Windows 上它使用我们编写的自定义 python 包管理器）并解决所有依赖关系。

话虽如此，建立我们的构建系统需要做很多工作。对于您的情况，您可以允许编译器计算出库依赖项，但我会使用 std::tuple，因为在版本比较方面这样做是正确的

include/my_awesome_library/version.h

namespace my_awesome_library {
  static constexpr auto version = std::make_tuple(1, 0, 0);
}  // namespace my_awesome_library

src/my_program_or_library/dependencies.c

static_assert(my_awesome_library::version >= std::make_tuple(1, 0, 0), "\nmy_awesome_library is old");

这可以被定义为：

#define VERSION_CHECK(version, ...) \
  static_assert(version >= std::make_tuple(__VA_ARGS__), #version " is old");

VERSION_CHECK(my_awesome_library::version, 1, 0, 0);

您可以扩展它以进行最小和最大检查等。

Microsoft 在新版本 Visual Studio 中变得更加符合标准方面做得很好，但您必须检查上述内容是否适用于您使用的任何 MSVC 编译器。