Użycie Gradle do zbudowania jar z zależnościami

122

Mam kompilację z wieloma projektami i umieściłem zadanie zbudowania słoika z tłuszczem w jednym z podprojektów. Stworzyłem zadanie podobne do opisanego w książce kucharskiej .

jar {
  from configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
  manifest { attributes 'Main-Class': 'com.benmccann.gradle.test.WebServer' }
}

Uruchomienie go powoduje następujący błąd:

Przyczyna: Nie możesz zmienić konfiguracji, która nie jest w stanie nierozwiązanym!

Nie jestem pewien, co oznacza ten błąd. Zgłosiłem to również w Gradle JIRA na wypadek, gdyby był to błąd .

Ben McCann
źródło

Odpowiedzi:

196

Aktualizacja: w nowszych wersjach Gradle (4+) compilekwalifikator jest przestarzały i zastępuje nowe apii implementationkonfiguracje. Jeśli ich używasz, poniższe powinny działać dla Ciebie:

// Include dependent libraries in archive.
mainClassName = "com.company.application.Main"

jar {
  manifest { 
    attributes "Main-Class": "$mainClassName"
  }  

  from {
    configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
  }
}

W przypadku starszych wersji Gradle lub jeśli nadal używasz kwalifikatora "kompilacja" dla swoich zależności, to powinno działać:

// Include dependent libraries in archive.
mainClassName = "com.company.application.Main"

jar {
  manifest { 
    attributes "Main-Class": "$mainClassName"
  }  

  from {
    configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
  }
}

Zauważ, że mainClassNamemusi pojawić się PRZED jar {.

Ben McCann
źródło
4
Musiałem zmodyfikować to do configureations.runtime.collect dla mojego projektu, ponieważ mam również zależności środowiska uruchomieniowego.
vextorspace
2
Musiałem dodać, def mainClassNameaby kod działał ... Otrzymałem Nie można ustawić nieznanej właściwości 'mainClassName' dla projektu głównego
hanskoff
1
Jak radzisz sobie z kolizjami nazw plików? Pliki na tej samej ścieżce w różnych plikach JAR zostaną nadpisane.
wst
3
Niestety to już nie działa. Używam gradle 4.10 i nowej implementationkonfiguracji zamiast przestarzałej compile. Powyższy kod buduje mi mały jar bez zależności. Kiedy to zmieniam ( from { configurations.implementation.collect {...} }), pojawia się błąd mówiący, że bezpośrednie rozwiązanie
Bastian Voigt
1
@BastianVoigt configurations.compileClasspathnaprawi wszystkie implementations, ale apipominie afik zależności. Znalazłem tutaj w innej odpowiedzi rozwiązanie runtimeClasspath. Obejmuje to apirównież zależności.
rekire
64

Odpowiedź @felix prawie mnie tam sprowadziła. Miałem dwa problemy:

  1. W Gradle 1.5 znacznik manifestu nie został rozpoznany w zadaniu fatJar, więc nie można było bezpośrednio ustawić atrybutu Main-Class
  2. jar miał sprzeczne zewnętrzne pliki META-INF.

Następująca konfiguracja rozwiązuje ten problem

jar {
  manifest {
    attributes(
      'Main-Class': 'my.project.main',
    )
  }
}

task fatJar(type: Jar) {
  manifest.from jar.manifest
  classifier = 'all'
  from {
    configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
  } {
    exclude "META-INF/*.SF"
    exclude "META-INF/*.DSA"
    exclude "META-INF/*.RSA"
  }
  with jar
}

Aby dodać to do standardowego zadania asemblacji lub kompilacji, dodaj:

artifacts {
    archives fatJar
}

Edycja: dzięki @mjaggard: w ostatnich wersjach Gradle zmień configurations.runtimenaconfigurations.runtimeClasspath

blootsvoets
źródło
3
Rozwiązało to również problem, który miałem, gdy jeden z moich słoików zależności był podpisany. Pliki podpisów zostały umieszczone w META-INF mojego jar, ale podpis nie był już zgodny z zawartością.
Flavin
2
Specjalne podziękowania za artifacts: dokładnie to, czego szukałem.
AlexR
Po uruchomieniu gradle fatJarzależności środowiska wykonawczego nie wydają się być skompilowane, więc nie można ich skopiować.
mjaggard
64

Jeśli chcesz, aby jarzadanie działało normalnie, a także masz dodatkowe fatJarzadanie, użyj następujących:

task fatJar(type: Jar) {
    classifier = 'all'
    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
    with jar
}

Ważna część to with jar. Bez tego zajęcia tego projektu nie są uwzględnione.

Felix
źródło
1
Zobacz także następujący problem, jeśli używasz podpisanych słoików do dołączenia i napotkasz problem z podpisami: stackoverflow.com/questions/999489/ ...
Peter N. Steinmetz
6
To nie działa. W tym rozwiązaniu plik manifestu jest pusty.
Jonas
4
Moje 2 centy: Lepiej jest ustawić klasyfikator niż zmienić nazwę. Umieść klasyfikator = 'all' zamiast baseName = project.name + '-all'. W ten sposób nazwa artefaktu będzie zgodna z zasadami Maven / Nexus.
taciosd
1
Dodaj group "build"i to zadanie będzie w buildgrupie (z innymi zadaniami, np jar. Zadanie.
MAGx2
1
Nie mogę znaleźć żadnej dokumentacji na temat with jarsłowa kluczowego, co dokładnie robi?
Philipp Hemmelmayr
9

U mnie to działa dobrze.

Moja klasa główna:

package com.curso.online.gradle;

import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Logger;

public class Main {

    public static void main(String[] args) {
        Logger logger = Logger.getLogger(Main.class);
        logger.debug("Starting demo");

        String s = "Some Value";

        if (!StringUtils.isEmpty(s)) {
            System.out.println("Welcome ");
        }

        logger.debug("End of demo");
    }

}

I to jest zawartość mojego pliku build.gradle:

apply plugin: 'java'

apply plugin: 'eclipse'

repositories {
    mavenCentral()
}

dependencies {
    compile group: 'commons-collections', name: 'commons-collections', version: '3.2'
    testCompile group: 'junit', name: 'junit', version: '4.+'
    compile  'org.apache.commons:commons-lang3:3.0'
    compile  'log4j:log4j:1.2.16'
}

task fatJar(type: Jar) {
    manifest {
        attributes 'Main-Class': 'com.curso.online.gradle.Main'
    }
    baseName = project.name + '-all'
    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
    with jar
}

W konsoli piszę:

java -jar ProyectoEclipseTest-all.jar

A wynik jest świetny:

log4j:WARN No appenders could be found for logger (com.curso.online.gradle.Main)
.
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more in
fo.
Welcome
Aron
źródło
6

Aby wygenerować gruby plik JAR z główną klasą wykonywalną, unikając problemów z podpisanymi plikami JAR, proponuję wtyczkę gradle-one-jar . Prosta wtyczka korzystająca z projektu One-JAR .

Łatwy w użyciu:

apply plugin: 'gradle-one-jar'

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.github.rholder:gradle-one-jar:1.0.4'
    }
}

task myjar(type: OneJar) {
    mainClass = 'com.benmccann.gradle.test.WebServer'
}
Italo Borssatto
źródło
5

Proste sulution

jar {
    manifest {
        attributes 'Main-Class': 'cova2.Main'
    } 
    doFirst {
        from { configurations.runtime.collect { it.isDirectory() ? it : zipTree(it) } }
    }
}
Jonas Mayer
źródło
5

Odpowiedź z @ben prawie działa dla mnie, z wyjątkiem tego, że moje zależności są zbyt duże i otrzymałem następujący błąd

Execution failed for task ':jar'.
> archive contains more than 65535 entries.

  To build this archive, please enable the zip64 extension.

Aby rozwiązać ten problem, muszę użyć następującego kodu

mainClassName = "com.company.application.Main"

jar {
  manifest { 
    attributes "Main-Class": "$mainClassName"
  }  
  zip64 = true
  from {
    configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
  }
}
Algorytm
źródło
1

Dla tych, którzy muszą zbudować więcej niż jeden słoik z projektu.

Utwórz funkcję w gradle:

void jarFactory(Jar jarTask, jarName, mainClass) {
    jarTask.doFirst {
        println 'Build jar ' + jarTask.name + + ' started'
    }

    jarTask.manifest {
        attributes(
                'Main-Class':  mainClass
        )
    }
    jarTask.classifier = 'all'
    jarTask.baseName = jarName
    jarTask.from {
        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
    }
    {
        exclude "META-INF/*.SF"
        exclude "META-INF/*.DSA"
        exclude "META-INF/*.RSA"
    }
    jarTask.with jar 
    jarTask.doFirst {
        println 'Build jar ' + jarTask.name + ' ended'
    }
}

Wtedy zadzwoń:

task makeMyJar(type: Jar) {
    jarFactory(it, 'MyJar', 'org.company.MainClass')
}

Działa na gradle 5.

Słoik zostanie umieszczony o godz ./build/libs.

MiguelSlv
źródło
0

Używam zadania shadowJarprzez wtyczkę. com.github.jengelman.gradle.plugins:shadow:5.2.0

Użycie po prostu uruchom ./gradlew app::shadowJar plik wynikowy będzie oMyProject/app/build/libs/shadow.jar

build.gradleplik najwyższego poziomu :

 apply plugin: 'kotlin'

buildscript {
    ext.kotlin_version = '1.3.61'

    repositories {
        mavenLocal()
        mavenCentral()
        jcenter()
    }

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.github.jengelman.gradle.plugins:shadow:5.2.0'
    }
}

build.gradleplik na poziomie modułu aplikacji

apply plugin: 'java'
apply plugin: 'kotlin'
apply plugin: 'kotlin-kapt'
apply plugin: 'application'
apply plugin: 'com.github.johnrengelman.shadow'

sourceCompatibility = 1.8

kapt {
    generateStubs = true
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    implementation "org.seleniumhq.selenium:selenium-java:4.0.0-alpha-4"
    shadow "org.seleniumhq.selenium:selenium-java:4.0.0-alpha-4"

    implementation project(":module_remote")
    shadow project(":module_remote")
}

jar {
    exclude 'META-INF/*.SF', 'META-INF/*.DSA', 'META-INF/*.RSA', 'META-INF/*.MF'
    manifest {
        attributes(
                'Main-Class': 'com.github.kolyall.TheApplication',
                'Class-Path': configurations.compile.files.collect { "lib/$it.name" }.join(' ')
        )
    }
}

shadowJar {
    baseName = 'shadow'
    classifier = ''
    archiveVersion = ''
    mainClassName = 'com.github.kolyall.TheApplication'

    mergeServiceFiles()
}

NickUnuchek
źródło
0

Gradle 6.3, biblioteka Java. Kod z „zadania jar” dodaje zależności do „build / libs / xyz.jar” podczas uruchamiania zadaniagradle build ”.

plugins {
    id 'java-library'
}

jar {
    from {
        configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
    }
}
Alex Ureche
źródło
-1

Jeśli jesteś przyzwyczajony do mrówek, możesz spróbować tego samego z Gradle:

task bundlemyjava{
    ant.jar(destfile: "build/cookmyjar.jar"){
        fileset(dir:"path to your source", includes:'**/*.class,*.class', excludes:'if any')
        } 
}
mig
źródło