À quoi sert le maven-shade-plugin, et pourquoi voudriez-vous déplacer les paquets Java?

je me demandais récemment pourquoi elasticsearch abat et déplace quelques-unes (mais pas toutes) de ses dépendances. Voici une explication du responsable du projet, @kimchy :

la partie ombragée est intentionnelle, les bibliothèques ombragées que nous utilisons dans elasticsearch sont pour tout but et partie d'elasticsearch, la version utilisée est étroitement liée à ce qu'elasticsearch expose et comment il utilise la bibliothèque basé sur les internes de la façon dont la bibliothèque fonctionne (et que les changements entre les versions), netty et guava sont de grands exemples.

Btw, Je n'ai aucun problème à réellement fournir plusieurs pots de elasticsearch, un avec lucene pas ombragé, et un avec Lucene ombragé. Mais je ne sais pas comment faire avec maven. Je ne veux pas fournir une version qui ne nuance pas netty / jackson par exemple, en raison de l'utilisation intimiate profonde elasticsearch A avec eux (par exemple, en utilisant l'amélioration de bufferring à venir avec n'importe quelle version précédente de netty à l'exception de la version actuelle utilisera en fait plus de mémoire par rapport à l'utilisation considérablement moins).

-- https://github.com/elasticsearch/elasticsearch/issues/2091#issuecomment-7156766

et un autre ici de drewr :

l'ombrage est il est important de garder nos dépendances (notamment netty, lucene, guava) près de notre code afin que nous puissions résoudre un problème même si le fournisseur amont est en retard. Il est possible que nous distribuions des versions modularisées du code, ce qui aiderait pour votre problème particulier (#2091 par exemple), mais nous ne pouvons pas simplement supprimer les dépendances ombragées pour le moment. Vous pouvez construire une version locale de ES pour vos besoins jusqu'à ce qu'il y ait une meilleure solution.

-- https://github.com/elasticsearch/elasticsearch/pull/3244#issuecomment-20125452

Donc, c'est un cas d'utilisation. Comme pour un exemple illustratif, voici comment maven-shade-plugin est utilisé dans les pom d'elasticsearch.xml (v0.90.5). Les lignes artifactSet::include lui indiquent les dépendances à tirer dans le bocal uber (en gros, ils sont décompressés et emballés avec les propres classes d'elasticsearch lorsque le bocal cible d'elasticsearch est produire. (Dans le cas où vous ne le saviez pas déjà, un fichier JAR est juste un fichier ZIP qui contient les classes du programme, les ressources, etc. et certaines métadonnées. Vous pouvez en extraire un pour voir comment il est assemblé.)

les lignes relocations::relocation sont semblables, sauf que dans chaque cas, elles appliquent aussi les substitutions spécifiées aux catégories de personnes à charge - dans ce cas, elles sont regroupées sous org.elasticsearch.common .

enfin la section filters exclut certaines choses de la jarre cible qui ne devrait pas être là - bas-tels que les métadonnées de la jarre, ant construisent des fichiers, des fichiers texte, etc. qui sont empaquetés avec certaines dépendances, mais qui n'ont pas leur place dans un Uber JAR.

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>2.1</version>
        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>shade</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            <minimizeJar>true</minimizeJar>
            <artifactSet>
                <includes>
                    <include>com.google.guava:guava</include>
                    <include>net.sf.trove4j:trove4j</include>
                    <include>org.mvel:mvel2</include>
                    <include>com.fasterxml.jackson.core:jackson-core</include>
                    <include>com.fasterxml.jackson.dataformat:jackson-dataformat-smile</include>
                    <include>com.fasterxml.jackson.dataformat:jackson-dataformat-yaml</include>
                    <include>joda-time:joda-time</include>
                    <include>io.netty:netty</include>
                    <include>com.ning:compress-lzf</include>
                </includes>
            </artifactSet>
            <relocations>
                <relocation>
                    <pattern>com.google.common</pattern>
                    <shadedPattern>org.elasticsearch.common</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>gnu.trove</pattern>
                    <shadedPattern>org.elasticsearch.common.trove</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>jsr166y</pattern>
                    <shadedPattern>org.elasticsearch.common.util.concurrent.jsr166y</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>jsr166e</pattern>
                    <shadedPattern>org.elasticsearch.common.util.concurrent.jsr166e</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.mvel2</pattern>
                    <shadedPattern>org.elasticsearch.common.mvel2</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>com.fasterxml.jackson</pattern>
                    <shadedPattern>org.elasticsearch.common.jackson</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.joda</pattern>
                    <shadedPattern>org.elasticsearch.common.joda</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.jboss.netty</pattern>
                    <shadedPattern>org.elasticsearch.common.netty</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>com.ning.compress</pattern>
                    <shadedPattern>org.elasticsearch.common.compress</shadedPattern>
                </relocation>
            </relocations>
            <filters>
                <filter>
                    <artifact>*:*</artifact>
                    <excludes>
                        <exclude>META-INF/license/**</exclude>
                        <exclude>META-INF/*</exclude>
                        <exclude>META-INF/maven/**</exclude>
                        <exclude>LICENSE</exclude>
                        <exclude>NOTICE</exclude>
                        <exclude>/*.txt</exclude>
                        <exclude>build.properties</exclude>
                    </excludes>
                </filter>
            </filters>
        </configuration>
    </plugin>
</plugins>

---

petit avertissement

bien que ce ne soit pas décrire pourquoi on voudrait utiliser le maven-shade-plugin (puisque la réponse sélectionnée le décrit assez bien), je voudrais noter que j'ai eu des problèmes avec elle. Il a changé le pot (depuis que ce qu'il fait) et il a causé la régression dans mon logiciel.

donc, au lieu d'utiliser ceci (ou le maven-jarjar-plugin), j'ai utilisé le binaire de JarJar qui semble fonctionner sans problème.

je poste ici ma solution, car il m'a fallu un certain temps pour trouver une solution convenable.

---

Télécharger JarJar du fichier JAR

vous pouvez télécharger le pot d'ici: https://code.google.com/p/jarjar / Dans le menu de gauche, vous avez un lien pour le télécharger.

---

un autre

dans cet exemple, nous changerons le paquet de" com.fasterxml.jackson " to " io.kuku.les dépendances.com.fasterxml.jackson". - Le pot source s'appelle "jackson-databind-2.6.4.jar " et le nouveau JAR modifié (cible) s'appelle "kuku-jackson-databind-2.6.4.pot." - Le fichier" jarjar " est dans la version 1.4

1. Créer les règles".txt" un fichier. Le contenu du fichier doit être (regarder la période avant le'@' caractère): règle de com.fasterxml.Jackson.** io.kuku.dependencies.com.fasterxml.jackson.@1

2. exécutez la commande suivante: java-jar jarjar-1.4.les règles du jar process.txt jackson-databind-2.6.4.jar kuku-jackson-databind-2.6.4.jar

---

installation des pots modifiés dans le dépôt local

dans ce cas, j'installe 3 fichiers situés sur" c:\my-jars\" dossier.

mvn install:install-fichier -Dfile=C:\mon-pots\kuku-jackson-annotations-2.6.4.jar-DgroupId=io.kuku.dépendances-DartifactId=kuku-jackson-annotations -Dversion=2.6.4-Dpackaging =jar

mvn install:install-fichier -Dfile=C:\mon-pots\kuku-jackson-core-2.6.4.jar-DgroupId=io.kuku.dependencies-DartifactId=kuku-jackson-core-Dversion=2.6.4-Dpackaging =jar

mvn install: install-file -Dfile=C:\mon-pots\kuku-jackson-databind-2.6.4.jar-DgroupId=io.kuku.dépendances-DartifactId=kuku-jackson-annotations -Dversion=2.6.4-Dpackaging =jar

---

utilisant les bocaux modifiés dans les pom du projet

dans cet exemple, c'est l'élément" dépendances "dans les projets pom:

<dependencies>
    <!-- ================================================== -->
    <!-- kuku JARs -->
    <!-- ================================================== -->
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-annotations</artifactId>
        <version>2.6.4</version>
    </dependency>
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-core</artifactId>
        <version>2.6.4</version>
    </dependency>
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-databind</artifactId>
        <version>2.6.4</version>
    </dependency>
</dependencies>