模块图的修剪

Module graph pruning 模块图的修剪

原文:https://go.dev/ref/mod#graph-pruning

​ 如果主模块是go 1.17或更高版本,用于minimal version selection(最小化版本选择)模块图仅包括每个模块依赖项的 immediate(直接)requirements ,这些依赖项在其自己的 go.mod 文件中指定到go 1.17或更高版本,除非该版本的模块也被go 1.16或更低版本的其他依赖(过渡性)所需要。(go 1.17版本的过渡性依赖项会从模块图中删去)。

​ 由于 go 1.17go.mod 文件包括构建任何包或测试所需的每个依赖项的 require 指令,因此修剪后的模块图包括go buildgo testmain module(主模块)明确要求的任何依赖项中的包所需的所有依赖项。不需要构建任何包或测试的模块不能影响其包的运行时行为,因此从模块图中修剪出来的依赖项只会导致其他不相关的模块之间的干扰。

​ 那些 requirements 被修剪掉的模块仍然出现在模块图中,并且仍然被go list -m all报告:它们selected versions(所选择的版本)是已知的并且定义良好,并且包可以从这些模块中加载(例如,作为从其他模块加载的测试的过渡性依赖项)。然而,由于go命令不能轻易识别这些模块的哪些依赖项得到了满足,所以go buildgo test的参数不能包括那些 requirements 已被修剪掉的模块的包。 go get将包含每个命名包的模块提升为显式的依赖项,允许在该包上调用go buildgo test

因为Go 1.16和更早的版本不支持模块图的修剪,所以对于每个指定Go 1.16或更低版本的模块来说,完整的依赖项的过渡性闭包 —— 包括过渡性的go 1.17依赖项 —— 仍然被包括在内。(在 go 1.16 及以下版本中,go.mod 文件只包括direct dependencies(直接依赖项),因此必须加载更大的图以确保包括所有间接依赖项)。

​ 默认情况下,go mod tidy为模块记录的 go.sum 文件 包括Go 版本在 go 指令中指定的版本的前一个版本所需的校验和。因此,go 1.17 的模块包括 Go 1.16 所加载的完整模块图所需的校验和,但 go 1.18 的模块将只包括 Go 1.17 所加载的修剪模块图所需的校验和。可以使用-compat标志来覆盖默认版本(例如,在go 1.17模块中更积极地修剪go.sum文件)。

​ 更多细节参见设计文档

Lazy module loading 延迟模块加载

​ 为模块图修剪增加的更全面的 requirements 也使得在模块内工作时可以进行另一种优化。如果主模块是在go 1.17或更高版本,go命令会避免加载完整的模块图,直到(或除非)需要它。相反,它只加载主模块的go.mod文件,然后尝试只使用这些 requirements 来加载要构建的包。如果在这些 requirements中没有找到要导入的包(例如,主模块之外的包的测试依赖项),那么模块图的其余部分将被加载。

​ 如果在不加载模块图的情况下能找到所有导入的包,go命令将只加载包含这些包的模块的go.mod文件,并将它们的requirements 与主模块的requirements 进行核对,以确保它们是本地一致的。(不一致可能是由于版本控制的合并,手工编辑,以及使用本地文件系统路径替换的模块的更改造成的)。

最后修改 October 10, 2024: 更新 (a4b8f85)