如何使用gradle构建源jar

时间:2012-07-13 16:40:40

标签: java jar gradle

我正在使用使用gradle构建的开源项目。我想生成一个(项目)-sources.jar文件,我可以将其加载到我的IDE(IntelliJ IDEA)并通过项目进行调试。如果我可以生成文件,我知道如何加载文件。

我查看了项目的可用gradle任务,但没有一个生成源jar文件。

为此项目生成源jar文件的最简单方法是什么?

将源添加到包含已编译类文件的jar文件中也可以。

7 个答案:

答案 0 :(得分:225)

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

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
    archives javadocJar
}

答案 1 :(得分:47)

如果您使用的是Android:

task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives javadocJar
    archives sourcesJar
}

来自here

答案 2 :(得分:33)

如果您希望将源添加到已编译的类JAR文件,您也说这是可以接受的,您可以轻松地做到这一点。只需将以下内容添加到构建文件中即可。从理论上讲,您可以看到,它非常类似于将源放入单独的JAR中的解决方案:

 jar {
     from sourceSets.main.allSource
 }

不同之处在于您通过使用“jar”代替sourcesJar将其添加到主JAR文件中。

答案 3 :(得分:9)

这应该有效

assemble.dependsOn 'propertyJar'

task propertyJar(type: Jar) {
 archiveName = "myJarName.jar"
 from('src/main/resources') {
    include '**'
 }}

答案 4 :(得分:5)

使用时:

  • 等级:5 +
  • javamaven-publish插件
task sourceJar(type: Jar) {
    from sourceSets.main.allJava
    archiveClassifier = "sources"
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
            artifact sourceJar
        }
    }
}

https://docs.gradle.org/current/dsl/org.gradle.api.publish.maven.MavenPublication.html

答案 5 :(得分:3)

Kotlin DSL的等价物是:

tasks {

    val sourcesJar by creating(Jar::class) {
        dependsOn(JavaPlugin.CLASSES_TASK_NAME)
        classifier = "sources"
        from(java.sourceSets["main"].allSource)
    }

    val javadocJar by creating(Jar::class) {
        dependsOn(JavaPlugin.JAVADOC_TASK_NAME)
        classifier = "javadoc"
        from(java.docsDir)
    }

    artifacts {
        add("archives", sourcesJar)
        add("archives", javadocJar)
    }
}

答案 6 :(得分:1)

从Gradle 6.0开始的解决方案

假设您在Gradle 6.0或更高版本中使用java / java-library插件,则可以使用以下配置获得sourcesJar任务:

java {
    withSourcesJar()
    // and/or analogously use “withJavadocJar()” to get a “javadocJar” task
}

如果您还使用maven-publish / ivy-publish插件(当今推荐),那么它还将与您的主要Java出版物一起发布*-sources.jar工件。

另请参阅the Gradle docs