使用包列表

注意

此功能目前处于预览阶段。这意味着它极不可能被移除,也极不可能发生重大更改。维护者将尽可能不破坏它,仅在非常必要时才进行。有关更多信息,请参阅Conan 稳定性部分。

包列表是 Conan 中一个强大且便捷的功能,它允许自动化和连接不同的 Conan 命令。下面我们来看一些常见用例

列出并下载包

一个简单的首要用例可能是列出服务器中的一些配方和/或二进制文件,然后下载它们。

我们可以执行任何 conan list 命令,例如,列出所有高于 1.2.11zlib 版本、最新的配方修订版、该最新配方修订版的所有 Windows 二进制文件,以及每个二进制文件的最新包修订版。请注意,如果以后要实际下载某些内容,则必须指定 latest 包修订版,否则将只下载配方。

$ conan list "zlib/[>1.2.11]#latest:*#latest" -p os=Windows --format=json -r=conancenter > pkglist.json

该命令的输出以 json 格式发送到 pkglist.json 文件,其内容如下

pkglist.json (简化版)
"conancenter": {
    "zlib/1.2.12": {
        "revisions": {
            "b1fd071d8a2234a488b3ff74a3526f81": {
                "timestamp": 1667396813.987,
                "packages": {
                    "ae9eaf478e918e6470fe64a4d8d4d9552b0b3606": {
                        "revisions": {
                            "19808a47de859c2408ffcf8e5df1fdaf": {
                            }
                        },
                        "info": {
                            "settings": {
                                "arch": "x86_64",
                                "os": "Windows"
                            }
                        }
                    }
                }
            }
        },
    "zlib/1.2.13": {
    }
}

pkglist.json 中的第一层是“来源”远程或“本地缓存”,如果列表操作发生在缓存中。在本例中,由于我们在 conancenter 远程列出了包,因此它将是来源。

现在,我们可以通过一次 conan download 调用来下载这些配方和二进制文件

$ conan download --list=pkglist.json -r=conancenter
# Download the recipes and binaries in pkglist.json
# And displays a report of the downloaded things

从一个远程下载并上传到另一个远程

假设我们从上一步下载的包中创建一个新的包列表

$ conan download --list=pkglist.json -r=conancenter --format=json > downloaded.json
# Download the recipes and binaries in pkglist.json
# And stores the result in "downloaded.json"

生成的 downloaded.json 文件将与 pkglist.json 文件几乎相同,但在本例中,这些包的“来源”是 "Local Cache"(因为下载的包将位于缓存中)

downloaded.json (简化版)
"Local Cache": {
        "zlib/1.2.12": {
            "revisions": {
            }
        }
    }

这意味着我们现在可以将这组相同的配方和二进制文件上传到不同的远程仓库

$ conan upload --list=downloaded.json -r=myremote -c
# Upload those artifacts to the same remote

注意

最佳实践

这是一种**缓慢**的机制,用于在不同服务器仓库之间进行推广。像 Artifactory 这样的服务器提供了无需使用客户端即可直接将包从一个仓库复制到另一个仓库的方法,这种方法由于文件去重而快得多,因此是推荐的方法。本节介绍的方法可用于气隙环境以及其他无法进行服务器间复制的情况。

构建和上传包

最有趣的流程之一是当某些包在本地缓存中通过 conan createconan install --build=xxx 命令构建时。通常,我们希望将本地构建的包上传到服务器,这样其他人就不必再次重新构建它们。但我们可能只想上传已构建的二进制文件,而不是所有其他传递性依赖项或我们之前在本地缓存中的其他包。

可以从 conan installconan createconan graph info 命令的输出中计算出包列表。然后,该包列表可用于上传。分步说明

首先,假设我们有自己的包 mypkg/0.1,并且我们创建它

$ conan new cmake_lib -d name=mypkg -d version=0.1
$ conan create . --format=json > create.json

这将创建一个图的 JSON 表示,其中包含已构建包的信息 "binary": "Build"

create.json (简化版)
{
"graph": {
    "nodes": {
        "0": {
            "ref": "conanfile",
            "id": "0",
            "recipe": "Cli",
            "context": "host",
            "test": false
        },
        "1": {
            "ref": "mypkg/0.1#f57cc9a1824f47af2f52df0dbdd440f6",
            "id": "1",
            "recipe": "Cache",
            "package_id": "2401fa1d188d289bb25c37cfa3317e13e377a351",
            "prev": "75f44d989175c05bc4be2399edc63091",
            "build_id": null,
            "binary": "Build"
        }
    }
}

我们可以从该文件计算出包列表,然后使用以下命令将这些工件上传到服务器

$ conan list --graph=create.json --graph-binaries=build --format=json > pkglist.json
# Create a pkglist.json with the known list of recipes and binaries built from sources
$ conan upload --list=pkglist.json -r=myremote -c

移除包列表

也可以先 conan list 创建要移除的列表,然后移除它们

# Removes everything from the cache
$ conan list "*#*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

请注意,在这种情况下,listremove 中的默认模式是不同的,因为 conan remove 具有破坏性。

  • 当像 conan remove zlib/1.2.13 这样将一个配方传递给 remove 时,它将移除 zlib/1.2.13 的配方及其所有二进制文件,因为二进制文件无法在没有配方的情况下存在。

  • 当传递一个 package_id 时,例如 conan remove zlib/1.2.13:package_id,则将移除该特定的 package_id,但配方不会被移除。

因此,如果直接调用 conan remove,或者如果首先调用 conan list,则移除所有内容的模式将不同,例如

# Removes everything from the cache
$ conan remove "*"
# OR via list, we need to explicitly include all revisions
$ conan list "*#*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

# Removes only the binaries from the cache (leave recipes)
$ conan remove "*:*"
# OR via list, we need to explicitly include all revisions
$ conan list "*#*:*" --format=json > pkglist.json
$ conan remove --list=pkglist.json  -c

有关更多信息,请参阅参考命令章节