在胖JAR中包含来源

时间:2016-11-22 14:37:00

标签: gradle jar shadowjar

我将Gradle用于一个简单的Java项目,并希望生成一个包含源代码的胖JAR。

我在https://github.com/szarnyasg/gradle-shadowjar-source准备了一个示例存储库。我尝试了这个build.gradle配置:

plugins { id "com.github.johnrengelman.shadow" version "1.2.4" }

apply plugin: 'java'

shadowJar {
    classifier = 'fat'
    manifest { attributes 'Main-Class': 'org.example.MyMain' }
}

task packageSources(type: Jar) {
    from sourceSets.main.allSource
}

artifacts.archives packageSources

我可以用以下方式构建:

./gradlew clean build shadowjar

这导致build/libs目录中的两个JAR文件:

  • example-fat.jar - 没有来源的胖JAR
  • example.jar - 一个带(仅)来源的JAR

<{3}}的文档说明了

  

javagroovy插件出现时,Shadow会   自动配置以下行为:

     

[...]

     
      
  • shadowJar任务配置为包含来自的所有来源   project的主要sourceSet。
  •   

对我来说,这意味着源包含在生成的JAR中,但这可能不是它的含义。

可以从Gradle生成可执行的胖JAR,它还包含源代码?

1 个答案:

答案 0 :(得分:1)

我不是100%确定shadowJar如何处理来源,但你可以推出自己的胖罐实现。

apply plugin: 'groovy'

repositories {
    jcenter()
}

version = "0.1"
group = "com.jbirdvegas.so"

dependencies {
    // some dependencies to show the use case
    compile localGroovy(), 'org.slf4j:slf4j-api:1.7.21', 'org.slf4j:slf4j-simple:1.7.21'
    testCompile 'junit:junit:4.12'
}

jar {
    // set manifest
    manifest.attributes 'Implementation-Title': 'Executable fat jar',
            'Implementation-Version': version,
            'Main-Class': 'com.jbirdvegas.q40744642.Hello'
}

task fatJar(type: Jar) {
    // baseName must be unique or it clashes with the default jar task output
    baseName = "$project.name-fat"
    // make sure you have a valid manifest
    manifest = jar.manifest
    // Here put the source output (class) files in the jar
    // as well as dependencies (jar) files.
    from sourceSets.main.output,
            configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
}

// make sure our fatJar always runs immediately after the jar task
jar.finalizedBy fatJar

现在,在执行jar任务后,我们准备好了可执行jar

$ java -jar build/libs/q40744642-fat-0.1.jar 
[main] INFO com.jbirdvegas.q40744642.Hello - Hello World!

完整性在这里是我的Hello.groovy

package com.jbirdvegas.q40744642

import org.slf4j.Logger
import org.slf4j.LoggerFactory

class Hello {
    static main(args) {
        Logger logger = LoggerFactory.getLogger(Hello.class)
        logger.info("Hello World!")
    }
}