依赖冲突

在依赖图中，当不同的包依赖同一个包的不同版本时，这被称为依赖版本冲突。产生冲突相对容易。让我们通过一个实际的例子来看一下，开始克隆 examples2 仓库

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/versioning/conflicts/versions

在这个文件夹中，我们有一个小型项目，由几个包组成：matrix（一个数学库）、engine/1.0 视频游戏引擎，它依赖于 matrix/1.0；intro/1.0，一个实现视频游戏介绍字幕和功能的包，它依赖于 matrix/1.1；最后是 game 配方，它同时依赖于 engine/1.0 和 intro/1.0。所有这些包实际上都是空的，但它们足以产生冲突。

digraph conflict { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="BT" "game/1.0" -> "engine/1.0" -> "matrix/1.0"; "game/1.0" -> "intro/1.0" -> "matrix/1.1"; "matrix/1.0" [fillcolor="orange"]; "matrix/1.1" [fillcolor="orange"]; }


让我们创建依赖关系

$ conan create matrix --version=1.0
$ conan create matrix --version=1.1  # note this is 1.1!
$ conan create engine --version=1.0 # depends on matrix/1.0
$ conan create intro --version=1.0 # depends on matrix/1.1

当我们尝试安装 game 时，我们将收到错误

$ conan install game
Requirements
    engine/1.0#0fe4e6890766f7b8e21f764f0049aec7 - Cache
    intro/1.0#d639998c2e55cf36d261ab319801c322 - Cache
    matrix/1.0#905c3f0babc520684c84127378fefdd0 - Cache
Graph error
    Version conflict: intro/1.0->matrix/1.1, game/1.0->matrix/1.0.
ERROR: Version conflict: intro/1.0->matrix/1.1, game/1.0->matrix/1.0.

这是一个版本冲突，Conan 不会自动决定如何解决冲突，但用户应明确解决此类冲突。

解决冲突

当然，解决此类冲突最直接、最简单的方法是修改依赖项的 conanfile.py 文件，并升级其 requirements()，使其指向相同的版本。然而，在某些情况下这可能不实用，甚至可能无法修复依赖项的 conanfiles。

在这种情况下，应该由消费方 conanfile.py 来解决冲突（在本例中是 game），通过明确指定使用哪个版本的依赖项，语法如下：

game/conanfile.py
class Game(ConanFile):
    name = "game"
    version = "1.0"

    def requirements(self):
        self.requires("engine/1.0")
        self.requires("intro/1.0")
        self.requires("matrix/1.1", override=True)

这被称为 override。 game 包不直接依赖于 matrix，这个 requires 声明不会引入这种直接依赖。但是 matrix/1.1 版本将在依赖图中向上传播，覆盖依赖于任何 matrix 版本的包的 requires，强制图的一致性，因为所有上游包现在都将依赖于 matrix/1.1。

$ conan install game
...
Requirements
    engine/1.0#0fe4e6890766f7b8e21f764f0049aec7 - Cache
    intro/1.0#d639998c2e55cf36d261ab319801c322 - Cache
    matrix/1.1#905c3f0babc520684c84127378fefdd0 - Cache

digraph conflict { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="BT" "game/1.0" -> "engine/1.0" -> "matrix/1.1"; "game/1.0" -> "intro/1.0" -> "matrix/1.1"; { rank = same; edge[ style=invis]; "matrix/1.1" -> "matrix/1.0" ; rankdir = LR; } }


注意

在这种情况下，不需要 engine/1.0 的新二进制文件，但在某些情况下，上述操作可能会因 engine/1.0 “二进制文件丢失错误”而失败。因为之前 engine/1.0 的二进制文件是针对 matrix/1.0 构建的。如果 package_id 规则和配置定义 engine 在依赖项的小版本发生变化时应重新构建，那么就有必要为 engine/1.0 构建一个新的二进制文件，该文件将构建并链接到新的 matrix/1.1 依赖项。

如果 game 直接依赖于 matrix/1.2 会怎样？让我们创建这个版本

$ conan create matrix --version=1.2

现在让我们修改 game/conanfile.py 来引入这个作为直接依赖

game/conanfile.py
class Game(ConanFile):
    name = "game"
    version = "1.0"

    def requirements(self):
        self.requires("engine/1.0")
        self.requires("intro/1.0")
        self.requires("matrix/1.2")

digraph conflict { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="BT" "game/1.0" -> "engine/1.0" -> "matrix/1.0"; "game/1.0" -> "intro/1.0" -> "matrix/1.1"; "game/1.0" -> "matrix/1.2"; "matrix/1.0" [fillcolor="orange"]; "matrix/1.1" [fillcolor="orange"]; "matrix/1.2" [fillcolor="orange"]; { rank = same; edge[ style=invis]; "matrix/1.1" -> "matrix/1.2" ; rankdir = LR; } }


因此，安装它将再次引发冲突错误

$ conan install game
...
ERROR: Version conflict: engine/1.0->matrix/1.0, game/1.0->matrix/1.2.

由于这次我们希望尊重 game 和 matrix 之间的直接依赖关系，我们将定义 force=True 需求特性，以表明此依赖项版本也将强制覆盖上游

game/conanfile.py
class Game(ConanFile):
    name = "game"
    version = "1.0"

    def requirements(self):
        self.requires("engine/1.0")
        self.requires("intro/1.0")
        self.requires("matrix/1.2", force=True)

这将再次解决冲突（如上所述，请注意，在实际应用中，这可能意味着 engine/1.0 和 intro/1.0 的二进制文件将丢失，并且需要构建它们以链接到新强制的 matrix/1.2 版本）

$ conan install game
Requirements
    engine/1.0#0fe4e6890766f7b8e21f764f0049aec7 - Cache
    intro/1.0#d639998c2e55cf36d261ab319801c322 - Cache
    matrix/1.2#905c3f0babc520684c84127378fefdd0 - Cache

digraph conflict { node [fillcolor="lightskyblue", style=filled, shape=box] rankdir="BT" "game/1.0" -> "engine/1.0" -> "matrix/1.2"; "game/1.0" -> "intro/1.0" -> "matrix/1.2"; "game/1.0" -> "matrix/1.2"; { rank = same; edge[ style=invis]; "matrix/1.2" -> "matrix/1.0" -> "matrix/1.1" ; rankdir = LR; } }


注意

最佳实践

  • 一般来说，应尽量避免使用 overrides/forces 来解决版本冲突，并将其作为临时解决方案。真正的解决方案是让依赖项的 requires 向前发展，以便它们自然地收敛到上游依赖项的相同版本。

  • 关键要点是，force 特性将在消费者和所需包之间创建直接依赖关系，而 override 不会，它只指示 Conan 在包已存在于依赖图中时优先选择所需的版本。

  • 版本范围也可能导致一些版本冲突，即使 Conan 试图减少它们。这篇 关于版本冲突的 FAQ 讨论了图解析算法和最小化冲突的策略。

覆盖选项

当依赖图中存在菱形结构时（如上所示），不同的配方可能会为上游 options 定义不同的值。在这种情况下，这不会直接导致冲突，而是第一个定义的值将被优先考虑并占优势。

在上面的例子中，如果 matrix/1.0 可以是静态库或共享库，而 engine 决定它应该是静态库（实际上没有必要，因为这已经是默认值）

engine/conanfile.py
class Engine(ConanFile):
    name = "engine"
    version = "1.0"
    # Not strictly necessary because this is already the matrix default
    default_options = {"matrix*:shared": False}

警告

在配方中定义选项值没有很强的保证，请查看 关于依赖项选项值的 FAQ。定义选项值的推荐方法是在配置文件中。

而 intro 配方也会做同样的事情，但会定义它想要一个共享库，并添加一个 validate() 方法，因为出于某种原因 intro 包只能针对共享库构建，否则会崩溃

intro/conanfile.py
class Intro(ConanFile):
    name = "intro"
    version = "1.0"
    default_options = {"matrix*:shared": True}

    def requirements(self):
        self.requires("matrix/1.0")

    def validate(self):
        if not self.dependencies["matrix"].options.shared:
            raise ConanInvalidConfiguration("Intro package doesn't work with static matrix library")

然后，这会导致一个错误，因为第一个定义选项值的是 engine（它在 game conanfile 的 requirements() 方法中声明）。在 examples2 仓库中，转到“options”文件夹，并创建不同的包

$ cd ../options
$ conan create matrix
$ conan create matrix -o matrix/*:shared=True
$ conan create engine
$ conan create intro
$ conan install game  # FAILS!
...
-------- Installing (downloading, building) binaries... --------
ERROR: There are invalid packages (packages that cannot exist for this configuration):
intro/1.0: Invalid: Intro package doesn't work with static matrix library

遵循相同的原则，下游消费方配方，在本例中是 game conanfile.py，可以定义选项值，这些值将被优先考虑

game/conanfile.py
class Game(ConanFile):
    name = "game"
    version = "1.0"
    default_options = {"matrix*:shared": True}

    def requirements(self):
        self.requires("engine/1.0")
        self.requires("intro/1.0")

这将强制 matrix 成为一个共享库，无论 engine 是否定义了 shared=False，因为下游消费者总是优先于上游依赖项。

$ conan install game
...
-------- Installing (downloading, building) binaries... --------
matrix/1.0: Already installed!
matrix/1.0: I am a shared-library library!!!
engine/1.0: Already installed!
intro/1.0: Already installed!

注意

最佳实践

总的来说，避免在消费方的 conanfile.py 中修改或定义依赖项 options 的值。声明的 options 默认值在大多数情况下都应该很好，而与这些默认值的差异最好在配置文件中定义。