将sourceJar任务添加到自定义Gradle插件

Question

我的公司最近写了gradle插件来进行原始配置（存储库，项目间的通用依赖关系等）。总体而言，这大大简化了我们的构建过程，并发现了项目之间的一些不一致之处。我们最近尝试向插件添加sourcesJar任务，但该任务无法正常工作。

这是坏掉的插件：

package com.mycompany.plugins

import org.gradle.api.Project
import org.gradle.api.Plugin
import org.gradle.api.tasks.bundling.Jar

class OurJavaPlugin implements Plugin<Project> {

    void apply(Project project) {

        def date = com.mycompany.util.UtilityFunctions.getDate()

        project.configure(project) {
            println('Applying Java properties to: ' + project.name)

            apply plugin: 'java'
            apply plugin: 'maven'
            apply plugin: 'idea'
            apply plugin: 'eclipse'

            version = date

            // Use the local repos
            repositories {
                maven {
                    url "$externalDependenciesRepo"
                }
                maven {
                    url "$internalDependenciesRepo"
                }
            }

            uploadArchives {
                repositories {
                    mavenDeployer {
                        // Deploy to internal repo
                        repository(url: "$internalDependenciesRepo")
                    }
                }
            }

            // Common dependencies
            dependencies {
                compile group: 'log4j', name: 'log4j', version:'1.2.17'
                compile group: 'org.slf4j', name: 'slf4j-log4j12', version:'1.6.6'
                compile group: 'org.slf4j', name: 'slf4j-api', version:'1.6.6'
                testCompile "junit:junit:$junit_version"
            }

            eclipse.project {
              natures 'org.springsource.ide.eclipse.gradle.core.nature'
            }

            task sourcesJar(type: Jar, dependsOn: classes) {
                classifier = 'sources'
                from sourceSets.main.allSource
            }

            artifacts {
                archives sourcesJar
            }
        }
    }
}

除了之外，此插件都很好用sourcesJar。当我将其添加到混合中（并编译/部署到我们的本地仓库）时，当我尝试构建使用插件的项目时出现此错误：

$ gradle :myProject:clean -x Test
Applying Java properties to: myProject

FAILURE: Build failed with an exception.

* Where:
Build file 'C:\Users\me\Documents\code\root\myProject\build.gradle' line: 1

* What went wrong:
A problem occurred evaluating project ':myProject'.
> Failed to apply plugin [id 'customjava']
   > Could not find method sourcesJar() for arguments [{type=class org.gradle.api.tasks.bundling.Jar, dependsOn=task ':analytics-isr:classes'}, com.mycompany.plugins.OurJavaPlugin $_apply_closure1$_closure6@4c1d59cd] on project ':myProject'.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

BUILD FAILED

Total time: 3.352 secs

Answer 1

在build.gradle脚本中定义任务时，task将调用方法中的一种（共4种）-您可以在此处看到第一个方法。您还可以看到，这些方法都没有与DSL匹配的，您在DSL中定义了任务build.gradle。为什么？因为在执行之前会先build.gradle评估所有内容，以
将 DSL 转换
为适当的方法调用。有关更多详细信息，请查看此问题。

提到的机制在自定义插件中不起作用-在这里，代码无需 翻译 就可以 按原样
解释。如您所见，在类上没有定义任何方法。要在插件中创建任务，您需要调用上述方法，例如：
__sourcesJar``Project``task

task('sourcesJar', type: Jar, dependsOn: classes) {
   classifier = 'sources'
   from sourceSets.main.allSource
}

确切地调用此方法（我知道参数顺序不同，但这是常规的工作方式-
相信我）。

另外你不需要project.configure(project) {...}，project.with {...}就足够了。