web-dev-qa-db-ja.com

BOOT-INF / classesの代わりにrootにクラスをパッケージ化するSpringBoot uber jar

こんにちはSpringBootExperts-

Apacheストームクラスターにデプロイする必要があるSpringBoot Uberjarを作成しようとしています。ただし、「spring-boot-maven-plugin」を使用してパッケージ化した場合、パッケージ化されたアプリファイルが「BOOT-INF/classes」の下にある間、Stormはjarのルートにあるすべてのクラスファイルを予期しているという問題があります。

「BOOT-INF/classes」の代わりにルートの直下にアプリクラスをパッケージ化する方法はありますか?

以下に示すように、「maven-Assembly-plugin」と「spring-boot-maven-plugin」を使用してみました。これにより、uberjarのルートにパッケージ化された依存関係jarのすべてのクラスファイルを含むUberjarが作成されます。アプリクラスはまだBOOT-INF/classesにあります。

<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
            <excludes>
                <exclude>
                    <groupId>org.Apache.storm</groupId>
                    <artifactId>storm-core</artifactId>
                </exclude>
            </excludes>
            <requiresUnpack>
                <dependency>
                    <groupId>com.myorg</groupId>
                    <artifactId>my-app-artifact</artifactId> <!-- This does not help! :( -->
                </dependency>
            </requiresUnpack>
        </configuration>
    </plugin>
    <plugin>
        <groupId>org.Apache.maven.plugins</groupId>
        <artifactId>maven-Assembly-plugin</artifactId>
        <version>2.4</version>
        <configuration>
            <appendAssemblyId>false</appendAssemblyId>
            <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
            </descriptorRefs>
        </configuration>
        <executions>
            <execution>
                <id>make-Assembly</id>
                <phase>package</phase>
                <goals>
                    <goal>single</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
</plugins>
9
Satya

だから、私の将来の自分のために、または同様の質問に対する答えを見つけようとしている人のために。これについての研究中に私が気付いたさまざまなことがあります-

  1. Stormは実行可能ファイルを必要としていますJava jarファイル
  2. Spring Bootは、カスタムjarパッケージを提供します。 Java jarパッケージングで確認している間、SpringBootはBOOT-INF/classesからクラスをロードします

したがって、SpringBootとして動作しながらSpringBootjarをストームクラスターで機能させるには、BOOT-INF/classesからjarファイルのルートまでのすべてのクラスのコピーを作成する必要があります。

これは可能ですか?答えはイエスです。

アプローチdescribe here を使用して、Boot-INF/classesをSpringBootjarのルートにコピーしてSpringBootjarを作成することができました。このアプローチには、以下に示すように、ant build.xml、ivy設定、およびivy.xmlが必要です。 (免責事項:構成は、ストームクラスター上ではなくパッケージ化されるまでのみテストされました)

ルートのクラスでハッキングされたSpringBootJarを作成できるので-

やるべきですか? NO

理由は次のとおりです-

  1. Springは、このアプローチを採用しないことを強くお勧めします。これは、jarファイル間で同じ名前を持ち、バージョンが異なるクラスで、不要なクラスの上書きやクラスのバージョン管理の問題が発生しないようにするためです。

  2. Spring Boot Jarパッケージは、依存関係jarとして使用することを目的とした形式ではありません。 ここで最初の行を読んでください。 したがって、依存関係のユースケースでは、単純な古いJavaモジュールを使用する必要があります。SpringBootは、より多くのスタンドアロン実行可能ファイルまたはデプロイメント用です。 Tomcatのようなコンテナで。

幸運を!

build.xml

<project
        xmlns:ivy="antlib:org.Apache.ivy.ant"
        xmlns:spring-boot="antlib:org.springframework.boot.ant"
        name="spring-boot-sample-ant"
        default="build">

    <description>
        Sample ANT build script for a Spring Boot executable JAR project. Uses ivy for
        dependency management and spring-boot-antlib for additional tasks. Run with
        '$ ant -lib ivy-2.2.jar spring-boot-antlib.jar' (substitute the location of your
        actual jars). Run with '$ Java -jar target/*.jar'.
    </description>

    <property name="spring-boot.version" value="1.4.2.RELEASE" />
    <property name="lib.dir" location="${basedir}/target/lib" />
    <property name="start-class" value="com.my.main.class" />

    <target name="resolve" description="--> retrieve dependencies with ivy">
        <ivy:retrieve pattern="${lib.dir}/[conf]/[artifact]-[type]-[revision].[ext]" />
    </target>

    <target name="classpaths" depends="resolve">
        <path id="compile.classpath">
            <fileset dir="${lib.dir}/compile" includes="*.jar" />
        </path>
    </target>

    <target name="init" depends="classpaths">
        <mkdir dir="target/classes" />
    </target>

    <target name="compile" depends="init" description="compile">
        <javac srcdir="src/main/Java" destdir="target/classes" classpathref="compile.classpath" />
    </target>

    <target name="clean" description="cleans all created files/dirs">
        <delete dir="target" />
    </target>

    <target name="build" depends="compile">
        <spring-boot:exejar destfile="target/${ant.project.name}-${spring-boot.version}.jar" classes="target/classes">
            <spring-boot:lib>
                <fileset dir="${lib.dir}/runtime" />
            </spring-boot:lib>
        </spring-boot:exejar>
    </target>

    <target name="unjar_dependencies" depends="compile">
        <unzip dest="target/classes">
            <fileset dir="${lib.dir}/compile">
                <include name="my-app-common-0.1-SNAPSHOT.jar" />
            </fileset>
        </unzip>
    </target>

    <!-- Manual equivalent of the build target -->
    <target name="manual" depends="compile, unjar_dependencies">
        <jar destfile="target/manual/${ant.project.name}-${spring-boot.version}.jar" compress="false">
            <mappedresources>
                <fileset dir="target/classes" />
                <globmapper from="*" to="BOOT-INF/classes/*"/>
            </mappedresources>
            <mappedresources>  <!-- **** this mapped resources block does what I was looking for **** -->
                <fileset dir="target/classes" />
                <globmapper from="*" to="/*"/> 
            </mappedresources>
            <mappedresources>
                <fileset dir="src/main/resources" erroronmissingdir="false"/>
                <globmapper from="*" to="BOOT-INF/classes/*"/>
            </mappedresources>
            <mappedresources>
                <fileset dir="${lib.dir}/runtime" />
                <globmapper from="*" to="BOOT-INF/lib/*"/>
            </mappedresources>
            <zipfileset src="${lib.dir}/loader/spring-boot-loader-jar-${spring-boot.version}.jar" />
            <manifest>
                <attribute name="Main-Class" value="org.springframework.boot.loader.JarLauncher" />
                <attribute name="Start-Class" value="${start-class}" />
            </manifest>
        </jar>
    </target>
</project>

ivysettings.xml

<ivysettings>
    <settings defaultResolver="chain" />
    <resolvers>
        <chain name="chain" returnFirst="true">
            <!-- NOTE: You should declare only repositories that you need here -->
            <filesystem name="local" local="true" m2compatible="true">
                <artifact pattern="${user.home}/.m2/repository/[organisation]/[module]/[revision]/[module]-[revision].[ext]" />
                <ivy pattern="${user.home}/.m2/repository/[organisation]/[module]/[revision]/[module]-[revision].pom" />
            </filesystem>
            <ibiblio name="ibiblio" m2compatible="true" />
            <ibiblio name="spring-milestones" m2compatible="true" root="http://repo.spring.io/release" />
            <ibiblio name="spring-milestones" m2compatible="true" root="http://repo.spring.io/milestone" />
            <ibiblio name="spring-snapshots" m2compatible="true" root="http://repo.spring.io/snapshot" />
        </chain>
    </resolvers>
</ivysettings>

ivy.xml

<ivy-module version="2.0">
    <info organisation="org.springframework.boot" module="spring-boot-sample-ant" />
    <configurations>
        <conf name="compile" description="everything needed to compile this module" />
        <conf name="runtime" extends="compile" description="everything needed to run this module" />
        <conf name="loader" description="Spring Boot loader used when manually building an executable archive" />
    </configurations>
    <dependencies>
        <dependency org="org.springframework.boot" name="spring-boot-starter" rev="${spring-boot.version}" conf="compile">
                <exclude org="ch.qos.logback" name="logback-classic"/>
        </dependency>

        <dependency org="org.springframework.boot" name="spring-boot-loader" rev="${spring-boot.version}" conf="loader->default" />

        <dependency org="org.Apache.storm" name="storm-core" rev="1.0.2">
            <exclude org="org.Apache.logging.log4j" name="log4j-slf4j-impl"/>
            <exclude org="org.Apache.logging.log4j" name="log4j-core"/>
        </dependency>

        <dependency org="com.mycompany" name="app-common" rev="0.1-SNAPSHOT"/>

        <dependency org="org.Apache.storm" name="storm-kafka" rev="1.0.2"/>

        <dependency org="org.Apache.kafka" name="kafka_2.10" rev="0.10.1.0"/>

        <dependency org="org.Apache.kafka" name="kafka_2.10" rev="0.10.1.0"/>

        <dependency org="org.Apache.httpcomponents" name="httpcomponents-client" rev="4.5.2"/>

        <dependency org="org.Eclipse.paho" name="org.Eclipse.paho.client.mqttv3" rev="1.1.0"/>

        <dependency org="com.amazonaws" name="aws-Java-sdk-s3" rev="1.11.53"/>

        <dependency org="com.jcraft" name="jsch" rev="0.1.54"/>

        <dependency org="io.netty" name="netty-handler" rev="3.7.0.Final"/>


    </dependencies>
</ivy-module>
9
Satya

「BOOT-INF/classes」の代わりにルートの直下にアプリクラスをパッケージ化する方法はありますか?

はい、Spring Boot1.3を使用する必要があります。次のように親を宣言した場合、pom.xmlでmavenに戻ります。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.3.5.RELEASE</version>
</parent>

次に、クラス(およびその他のファイル)がルートレベルに配置されます。これがSpringBootの「古い方法」です。

バージョン1.4では、BOOT-INFディレクトリを使用するようにSpring Bootjar構造を変更しました。したがって、たとえば<version>1.4.1.RELEASE</version>を使用する場合、クラスはBOOT-INF/classesの下にあります。望ましくない副作用は、構成ファイル(たとえば、application.properties、application-myprofile.propertiesなど)がJava)でなくても、BOOT-INF/classesの下にあることです。クラス。

3
Paulo Merson