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

from conans import ConanFile, CMake, tools

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")
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}

    ##########################################################
    # 克隆项目到本地并切换到指定的分支或tag(版本号)          #
    ##########################################################
    def source(self):
        git = tools.Git(folder=self.name)
        git.clone(self.url + ".git", args="--recursive")
        git.checkout(self.version)

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

    ##########################################################
    # 根据项目的实际情况定义cmake编译变量,编译项目           #
    ##########################################################
    def build(self):
        cmake = CMake(self)
        cmake.definitions["BUILD_TESTS"] = False
        cmake.definitions["BUILD_EXAMPLES"] = False
        if self.settings.compiler == "Visual Studio" :
            ##########################################################
            # cpp_redis通过MSVC_RUNTIME_LIBRARY_CONFIG 变量控制代码  #
            # 的运行库(/MD或/MT),                                    #
            # 所以用conan定义的编译器属性compiler.runtime 来定义     #
            # MSVC_RUNTIME_LIBRARY_CONFIG                            #                   
            ##########################################################
            _runtime = str(self.settings.compiler.runtime)
            cmake.definitions["MSVC_RUNTIME_LIBRARY_CONFIG"] = "/" + _runtime[0:2]
        cmake.configure(source_folder=self.name)
        cmake.build()

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

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