在 Gradle 构建中处理依赖项中缺少的配置答案

【问题标题】：Handling missing configuration in dependency in Gradle build在 Gradle 构建中处理依赖项中缺少的配置
【发布时间】：2013-02-23 01:51:34
【问题描述】：

我有一个 Gradle 构建，它可以生成我的产品的主要可交付工件（安装程序）。对此进行建模的 Gradle 项目在不同的配置中具有许多不同的依赖项。其中许多依赖项依赖于外部模块的默认配置，其中一些模块具有 testResults 配置，其中包含测试任务的（压缩）结果。

重要的是，所有依赖项的测试结果（如果存在）作为主要产品构建的工件发布（用作测试发生并成功的证据）。如果它们不存在，这不是问题。

我尝试通过迭代产品构建的所有配置、迭代每个配置中的依赖项并在模块的testResults 配置上添加以编程方式创建的依赖项（在为此目的创建的新配置中）来做到这一点。

换句话说，我创建这样的依赖项：

def processDependencyForTests( Dependency dependency ) {

    def testResultsDependency = [
      'group' : dependency.group,
      'name' : dependency.name,
      'version' : dependency.version,
      'configuration' : 'testResults'
      ]

    project.dependencies.add 'allTestResults', testResultsDependency

这可以很好地填充该配置，但是当然，当我尝试对其进行任何操作时，当我第一次遇到对实际上没有具有 @987654324 的模块的依赖时，它会失败@配置：

   def resolvedConfiguration = configurations.allTestResults.resolvedConfiguration

结果如下：

Build file 'C:\myproduct\build.gradle' line: 353

* What went wrong:
Execution failed for task ':myproduct:createBuildRecord'.
> Could not resolve all dependencies for configuration ':myproduct:allTestResults'.
   > Module version group:mygroup, module:myproduct, version:1.2.3.4, configuration:allTestResults declares a dependency on configuration 'testResults' which is not declared in the module descriptor for group:mygroup, module:mymodule, version:1.0

以声明方式显式列出依赖项并不实际，因为我希望它们源自“产品项目具有的任何真实依赖项”。

如何确保此类预期缺失的配置不会破坏我的构建？我认为与宽松配置有关的事情可能是答案，但我什至还没有走到这一步（据我所知，我需要先得到一个ResolvedConfiguration）。或者，如果我这样做的方式很疯狂，那么实现这一点的更自然的 Gradle 习惯用法是什么？

【问题讨论】：

您找到处理缺失配置的解决方案了吗？

标签： gradle

【解决方案1】：

在引用配置之前，您需要检查配置是否存在。在这种情况下，gradle DSL documentation 是您的朋友。事实上，gradle 项目是我合作过的文档最完善的开源项目之一。

在这里，您会发现configurations 只是configuration 对象的容器。它们分别是ConfigurationContainer 和Configuration 的实例。知道了这一点，您需要做的就是检查configurations 容器是否包含一个名为“testResults”的configuration。

这可以通过以下代码实现：

if (configurations.find { it.name == 'testResults' }) {
    // do your stuff
}

【讨论】：

问题是关于工件的模块描述符中的配置。

【解决方案2】：

似乎暗示传递给您的processDependencyForTests 方法的Dependency 实例是多模块构建中的模块依赖项。

在这种情况下，您可以将它们强制转换为具有 dependencyProject 属性的 ProjectDependency，该属性将允许您访问该依赖项的 Project 对象。从那里您可以使用depProject.configurations.findByName 来测试配置是否存在。

类似的东西：

def processDependencyForTests( Dependency dependency ) {
  if( dependency instanceof ProjectDependency ) {
    ProjectDependency projDep = (ProjectDependency) dependency
    if( projDep.dependencyProject.configurations.findByName( 'testResults' ) ) {
      def testResultsDependency = [
        'group' : dependency.group,
        'name' : dependency.name,
        'version' : dependency.version,
        'configuration' : 'testResults'
      ]
      project.dependencies.add 'allTestResults', testResultsDependency
    }
  }

HTH

【讨论】：