conan入门(十九):封装第三方开源库cpp_redis示例

conan: 封装第三方开源库cpp_redis示例在我的之前关于conan系列博客中，已经介绍过如何引用Conan中央仓库(conan-center)预定义的第三库(《conan入门(五):conan 交叉编译引用第三方库示例》),以及如何将自己的项目封装为Conan包以供第三方引用(《conan入门(七):将自己的项目生成conan包》)。但是这个世界实际是复杂的，虽然Conan中央仓库已经收

10km

2641人浏览 · 2022-03-15 15:11:00

10km · 2022-03-15 15:11:00 发布

conan: 封装第三方开源库cpp_redis示例

在我的之前关于conan系列博客中，已经介绍过如何引用Conan中央仓库(conan-center)预定义的第三方库(《conan入门(五):conan 交叉编译引用第三方库示例》),以及如何将自己的项目封装为Conan包以供第三方引用(《conan入门(七):将自己的项目生成conan包》)。

但是这个世界实际是复杂的，虽然Conan中央仓库已经收录了上千个常用的开源第三方库，但仍然有更多的第三库并没被Conan中央仓库收录，你不能指望你所需要的任何第三方库都已经被中央仓库收录，能舒舒服服的直接引用。

如果你希望在自己的项目中全面引用conan来做包管理，那么遇到这种不在Conan中央仓库收录的第三方库该怎么办呢？这就是本文要说明的问题。

解决这个问题有两个办法，

方案一：根据Conan 中央仓库的说明，按照Conan中央仓库的要求的格式将这个第三方库配置贡献到conan-center-index.一旦被中央仓库批准，可以供全球conan用户使用。
方案二：根据Conan官方文档《Recipe and Sources in a Different Repo》为第三方库实现conanfile.py。这样就可以直接用conan create命令生成第三方库，并用conan upload 命令将生成的第三方库上传到自己的私有仓库。只能为自己团队使用。

我看了Conan 中央仓库的说明,发现要自己将一个第三方贡献到conan-center-index.还是很麻烦的，需要补充学习更多的conan相关知识，还需要通过很多平台的编译测试。以我目前的能力，还做不到。

还是第二个办法相对简单，所以本文介绍的是第二种方案。

cpp_redis是一个C++11实现的redis client库，我的项目中需要使用它，但它目前并没有被Conan中央仓库收录，所以本文以cpp_redis为例介绍将第三方库封装为Conan包的过程。

首先执行conan new cpp_redis/4.3.1 -b创建一个最简单的conanfile.py文件，在此基础上根据cpp_redis的实际情况修改为如下：

conanfile.py 码云地址: https://gitee.com/l0km/cpp_redis.build/blob/master/conanfile.py

from conan import ConanFile
from conan.tools.cmake import CMake, CMakeToolchain
from conan.tools.scm import Git
from conan.tools.files import copy
from os.path import join

class CppRedisConan(ConanFile):
    name = "cpp_redis"
    ##########################################################
    # 这里根据需要可以填版本号,如4.3.1,也可以填git分支名     #
    # 填版本号,source()方法在克隆代码后会自动切换到指定的tag #
    # 填分支名,source()方法在克隆代码后会自动切换到指定的分支#
    ##########################################################
    version = "master"
    license = "MIT License"
    #url = "https://github.com/cpp-redis/cpp_redis"
    ##########################################################
    # 如果访问github较慢,可以使用我fork到到gitee.com的链接   #
    ##########################################################
    url = "https://gitee.com/l0km/cpp_redis"
    description = "C++11 Lightweight Redis client"
    topics = ("redis", "c++11","redis_client")
    package_type = "library"
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}
    generators = "CMakeDeps","VirtualBuildEnv"
    ##########################################################
    # 克隆项目到本地并切换到指定的分支或tag(版本号)          #
    ##########################################################
    def source(self):
        git = Git(self)
        git.clone(self.url + ".git", args=['--branch', self.version,"--recursive"])

    def config_options(self):
        if self.settings.os == "Windows":
            del self.options.fPIC

    def generate(self):
        tc = CMakeToolchain(self)
        tc.variables["BUILD_TESTS"] = False
        tc.variables["BUILD_EXAMPLES"] = False
        if self.settings.compiler == "msvc" :
            ##########################################################
            # cpp_redis通过MSVC_RUNTIME_LIBRARY_CONFIG 变量控制代码  #
            # 的运行库(/MD或/MT),                                    #
            # 所以用conan定义的编译器属性compiler.runtime 来定义     #
            # MSVC_RUNTIME_LIBRARY_CONFIG                            #
            ##########################################################
            _runtime = str(self.settings.compiler.runtime)
            tc.variables["MSVC_RUNTIME_LIBRARY_CONFIG"] = "/" + _runtime[0:2]
        tc.generate()

    ##########################################################
    # 根据项目的实际情况定义cmake编译变量,编译项目           #
    ##########################################################
    def build(self):
        cmake = CMake(self)
        cmake.configure(build_script_folder=self.name)
        cmake.build()

    ##########################################################
    # 项目打包,一旦编译成功执行,执行此方法完成项目打包       #
    # 生成项目的安装包                                       #
    ##########################################################
    def package(self):
        ##########################################################
        # cpp_redis 的CMakeLists.txt中的install命令生成的安装文件#
        # 目录结构不标准,没办法通过find_package查找,所以这里使用 #
        # copy命令生成标准的安装目录结构                         #
        # copy命令执行时src为基于build_folder文件夹的相对路径    #
        ##########################################################  	
        copy(self, "*",join(self.source_folder,"cpp_redis/includes"),join(self.package_folder,"include"))
        copy(self, "*", join(self.source_folder,"cpp_redis/tacopie/includes"), join(self.package_folder,"include"))
        copy(self, "*.lib", join(self.build_folder,"lib"),join(self.package_folder, "lib"),False)
        copy(self, "*.dylib", join(self.build_folder,"lib"),join(self.package_folder, "lib"),False)
        copy(self, "*.so", join(self.build_folder,"lib"),join(self.package_folder, "lib"),False)
        copy(self, "*.a", join(self.build_folder,"lib"),join(self.package_folder, "lib"),False)
        copy(self, "*.dll", join(self.build_folder,"lib"),join(self.package_folder, "bin"),False)

    ##########################################################
    # 根据项目的实际情况定义conan 安装包的构建信息           #
    ##########################################################	
    def package_info(self):
        self.cpp_info.libs = ["cpp_redis","tacopie"]
        if self.settings.os == "Windows" and self.settings.compiler == "gcc":
            # for MinGW
            self.cpp_info.system_libs = ["ws2_32"]
        elif self.settings.os in ["Linux", "FreeBSD"]:
            # for Unix
            self.cpp_info.system_libs = ["pthread"]

conan create

有了上面的conanfile.py，就可以执行conan create 命令将cpp_redis生成到本地的conan仓库了

$ conan create .

conan create .根据配置文件 (同级文件夹下的conanfile.py) 构建二进制包
conan create 命令行用法参见Conan官方文档《conan create》

执行conan search cppredis/4.3.1@会显示本地仓库二进制包的信息

在这里插入图片描述

conan upload

项目编译成功就可以执行conan upload上传到私有制品库了：

conan upload cpp_redis/4.3.1  -r ${repo} --all
# ${repo}为私有制品库的名字

在这里插入图片描述

–all 指定上传所有内容(配置文件conanfile.py,源码和二进制包),如果不指定些选项，只上传除二进制包之外的所有文件

关于 conan upload命令的详细说明参见Conan官方文档:《conan upload》

test_package

如果你还需要在编译第三方库的时候执行测试，还需要一个名为test_package的测试代码文件夹，这就需要根据不同的第三方库来自己设计，关于cpp_redis的test_package参见码云仓库 https://gitee.com/l0km/cpp_redis.build/tree/master/test_package