Vykdomo JAR su priklausomybėmis sukūrimas naudojant Maven

„Maven“ projektų supakavimas į vieną vykdomąjį JAR

Dirbant su „Java“ projektais dažnai reikia supakuoti programą į vieną vykdomąjį JAR failą, kad būtų lengva platinti. Maven, galingas kūrimo automatizavimo įrankis, leidžia kūrėjams įtraukti visas būtinas priklausomybes į šį vieną išvesties JAR.

Šis straipsnis padės atlikti veiksmus, kurių reikia norint sukonfigūruoti „Maven“ projektą, kad visi priklausomybės JAR būtų įtraukti į galutinį vykdomąjį JAR. Vykdydami šias instrukcijas supaprastinsite diegimo procesą ir užtikrinsite, kad jūsų programa sklandžiai veiktų įvairiose aplinkose.

Vykdomo JAR sukūrimas ir paleidimas su Maven

Aukščiau pateikti scenarijai parodo, kaip sukonfigūruoti Maven projektą, kad visos jo priklausomybės būtų supakuotos į vieną vykdomąjį JAR failą. Pirmasis scenarijus yra Maven pom.xml failą, kuriame yra projekto konfigūracija. Šiame faile yra <plugin> žyma naudojama apibrėžti Maven Assembly Plugin. Šis papildinys yra labai svarbus kuriant vykdomąjį JAR, apimantį visas priklausomybes. The <descriptorRefs> Papildinio konfigūracijos žyma nurodo, kaip naudoti jar-with-dependencies deskriptorius, kuris užtikrina, kad visos projekto priklausomybės būtų supakuotos į galutinį JAR failą. The <mainClass> žyma viduje <manifest> skyrius yra būtinas, nes jis nurodo Maven, kurioje klasėje yra pagrindinis metodas, kurį reikia paleisti, kai vykdomas JAR.

The <execution> Papildinio konfigūracijos blokas yra vieta, kur vyksta veiksmas. Nurodoma, kad papildinio tikslas single turėtų būti įvykdytas per package statybos gyvavimo ciklo fazė. Tai suaktyvina JAR failo su priklausomybėmis kūrimą. Antrasis scenarijus yra paprasta komandinės eilutės instrukcija: mvn clean package. Ši komanda išvalo projektą (pašalina ankstesnius kūrimo artefaktus), sukompiliuoja šaltinio kodą, atlieka testus ir supakuoja projektą į JAR failą. Galutinis JAR failas bus target projekto katalogas ir pavadintas pagal artifactId ir version nurodyta pom.xml.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-app</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>com.example.MainClass</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

mvn clean package
# This command will compile the code, run the tests, and create the JAR file
# The JAR file will include all dependencies specified in the pom.xml
# It will be located in the target directory of the project
# The final JAR file will be named my-app-1.0-SNAPSHOT-jar-with-dependencies.jar

# To run the JAR file, use the following command:
java -jar target/my-app-1.0-SNAPSHOT-jar-with-dependencies.jar
# Ensure that the mainClass specified in the pom.xml is correct
# This will start your application with all dependencies included

Pažangūs „Maven“ pakuočių priklausomybės metodai

Be pagrindinės konfigūracijos kuriant vykdomąjį JAR su Maven, yra papildomų metodų, kurie gali pagerinti jūsų kūrimo procesą. Viena iš tokių technikų apima naudojimą shade įskiepis vietoj assembly Prijunkite. „Maven Shade“ papildinys siūlo pažangesnes „uber-JAR“ (JAR su priklausomybėmis) kūrimo funkcijas. Tai leidžia pervardyti paketus, kad išvengtumėte klasių kelio konfliktų, ir geriau tvarkyti pasikartojančias klases ir išteklius. Be to, jame galima tiksliai valdyti, kurios priklausomybės yra įtrauktos į galutinį JAR.

Kitas svarbus aspektas yra JAR failo dydžio valdymas. Dideli JAR failai gali būti sudėtingi ir lėtai perkelti arba įkelti. The maven-shade-plugin gali padėti, leisdamas išskirti nereikalingus failus ir klases, taip sumažinant galutinio JAR dydį. Taip pat galite sukonfigūruoti papildinį, kad sumažintumėte JAR, pašalindami neesminę informaciją, pvz., nenaudojamas klases ar perteklinius išteklius. Šios išplėstinės konfigūracijos gali būti ypač naudingos dirbant su dideliais projektais su daugybe priklausomybių.

Baigiamosios mintys apie Maven Executable JAR

Sukūrus vykdomąjį JAR su priklausomybėmis naudojant Maven, supaprastinamas Java programų diegimo procesas. Tinkamai sukonfigūravus pom.xml failą ir naudodami papildinius, tokius kaip Maven Assembly Plugin arba Maven Shade Plugin, kūrėjai gali supakuoti visas reikalingas priklausomybes į vieną JAR failą. Šis metodas užtikrina, kad programa galėtų sklandžiai veikti įvairiose aplinkose, todėl platinimas ir vykdymas yra nesudėtingas. Atlikę šiuos veiksmus padėsite efektyviai valdyti projekto priklausomybes ir sukurti patikimus, vykdomus JAR failus.