java - Maven アセンブリ : ドキュメントとソース jar をバンドルします

Question

マルチモジュールのmavenプロジェクトがあります。各ライブラリモジュールは、独自の jar 出力を生成します。

Parent (Pom)
   |
   Library_01 (jar)
   |   output:
   |     |
   |     lib1.jar
   |     |
   |     lib1-docs.jar
   |     |
   |     lib1-sources.jar
   |
   Library_02 (jar)
   |   output:
   |     |
   |     lib2.jar
   |     |
   |     lib2-docs.jar
   |     |
   |     lib2-sources.jar
   |
   Distribution (pom) // uses assembly plug-in to assemble outputs of other modules here
       output:
         |
         lib1.jar
         |
         lib2.jar

maven-assembly-pluginのドキュメント hereで説明されているとおりに、Distribution モジュールで他のモジュールのバイナリをアセンブルしています。私のPOMはチュートリアルとまったく同じように見えます。

ドキュメントに示されている方法で動作します。パッケージフェーズでは、アセンブリプラグインが他のモジュールの両方の jar を配布モジュールに収集します。しかし、ご覧のとおり、他のライブラリモジュールもドキュメントとソース jar を生成するように構成されています。

他のモジュールのドキュメントとソース jar も収集するようにアセンブリプラグインを構成するにはどうすればよいですか?
配布を考えると、上記の設定は適切ではないようです。私はまだ、さまざまなライブラリ用の多数の jar ファイルを作成しています。他のすべてのモジュールのクラス、ソース、およびドキュメントをそれぞれ 1 つの jar ファイルに結合できますか? 基本的に、3 つのグローバル jar (バイナリ、ドキュメント、およびソース) を配布する必要があります。これはどのように達成できますか？

お気に入り：

   |
   Distribution (pom)
         |
         Global.jar (contains classes of Lib1 + Lib2)
         |
         Global-docs.jar (contains docs of Lib1 + Lib2)
         |
         Global-sources.jar (contains sources of Lib1 + Lib2)

score 1 · Accepted Answer

まあ、私は専門家ではありませんが、マルチモジュールプロジェクトでも同様のことをしています。これは、プラグインとドキュメントを指定する親のポンコツです。

<pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <inherited>true</inherited>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>jar</goal>
                            <goal>test-jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <inherited>true</inherited>
                <configuration>
                    <properties>
                        <property>
                            <name>outputDirectory</name>
                            <value>${project.build.outputDirectory}</value>
                        </property>
                    </properties>
                    <systemProperties>
                        <property>
                            <name>user.language</name>
                            <value>ca</value>
                        </property>
                        <property>
                            <name>user.country</name>
                            <value>ES</value>
                        </property>
                    </systemProperties>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>3.0</version>
                <inherited>false</inherited>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <inherited>true</inherited>
                <configuration>
                    <executable>javac</executable>
                    <source>1.6</source>
                    <target>1.6</target>
                    <encoding>ISO-8859-15</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.8</version>
                <inherited>true</inherited>
                <configuration>
                    <detectLinks>true</detectLinks>
                </configuration>
                <executions>
                    <execution>
                        <id>aggregate</id>
                        <goals>
                            <goal>aggregate</goal>
                        </goals>
                        <phase>site</phase>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <inherited>true</inherited>
                <configuration>
                    <encoding>ISO-8859-15</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-ejb-plugin</artifactId>
                <version>2.2.1</version>
                <inherited>true</inherited>
                <configuration>
                    <ejbVersion>3.0</ejbVersion>
                    <archive>
                        <addMavenDescriptor>false</addMavenDescriptor>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <useUniqueVersions>false</useUniqueVersions>
                        </manifest>
                    </archive>
                    <generateClient>false</generateClient>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <inherited>true</inherited>
                <configuration>
                    <archive>
                        <addMavenDescriptor>false</addMavenDescriptor>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>test-jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </pluginManagement>
    <extensions>
        <extension>
            <groupId>org.apache.maven.wagon</groupId>
            <artifactId>wagon-ssh</artifactId>
            <version>2.0</version>
        </extension>
    </extensions>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <!-- <configuration> <links> <link>http://download.oracle.com/javase/6/docs/api/</link> 
                <link>http://download.oracle.com/javaee/1.4/api/</link> <link>http://static.springsource.org/spring/docs/2.5.x/api/</link> 
                <link>http://docs.jboss.org/hibernate/core/3.2/api/</link> <link>http://www.easymock.org/api/easymock/2.5.2/</link> 
                <link>http://testng.org/javadocs/</link> <link>http://www.bouncycastle.org/docs/docs1.6/</link> 
                <link>http://www.bouncycastle.org/docs/mdocs1.6/</link> <link>http://www.bouncycastle.org/docs/pgdocs1.6/</link> 
                <link>http://www.bouncycastle.org/docs/tspdocs1.6/</link> </links> </configuration> -->
            <executions>
                <execution>
                    <id>agregar</id>
                    <goals>
                        <goal>aggregate</goal>
                    </goals>
                    <phase>pre-site</phase>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-project-info-reports-plugin</artifactId>
            <version>2.1.1</version>
        </plugin>
    </plugins>
</reporting>

score 0 · Accepted Answer

わかりました、次のオプションを試しました：

maven-assembly-plugin : 結合されたバイナリをビルドします。ソースの場合もありますが、javadoc はありません。また、非常に複雑です。
maven-shade-plugin : 結合されたバイナリとソースを非常に簡単にビルドしますが、javadoc はありません。また、ソースファイル名を制御するのは困難です。

したがって、私が取った簡単なアプローチは次のとおりです。

すべてのモジュールがソース jar を生成することを確認します。これは、すべてのモジュールに継承される親 pom でソースプラグインを有効にすることで実行できます。

<build>
    <plugins>
        <plugin>
            <inherited>true</inherited>
            <artifactId>maven-source-plugin</artifactId>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

特別な「ビルド」モジュールを作成して、他のすべてのモジュールのソースを結合します。これは、maven-dependency-pluginのunpack-dependencies目標をソース分類子とともに使用することによって行われます。これは、他のすべてのモジュール source をこのモジュールのソースとして結合することを意味します。

モジュールの pom をビルドします。

<?xml version="1.0" encoding="UTF-8"?>
<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>

    <parent>
        <artifactId>parent</artifactId>
        <groupId>com.example.product</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>build</artifactId>
    <packaging>jar</packaging>
    <name>Build</name>

    <properties>
        <!--add comma separated artifact names from dependencies, to be included in unpacking-->
        <project.build.unpack_includes>sub-product</project.build.unpack_includes>
    </properties>

    <dependencies>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>sub-product</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>${parent.artifactId}</finalName>
        <plugins>
            <plugin>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>unpack-sources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>unpack-dependencies</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <classifier>sources</classifier>
                    <type>jar</type>
                    <outputDirectory>${project.build.sourceDirectory}</outputDirectory>
                    <includeArtifactIds>${project.build.unpack_includes}</includeArtifactIds>
                    <includes>**\/*.java</includes>
                    <overWriteSnapshots>true</overWriteSnapshots>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-javadoc-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

これで、ビルドモジュールは他のプロジェクトと同様にコンパイルされ、必要なすべての jar が生成されます。

java - Maven アセンブリ : ドキュメントとソース jar をバンドルします

2 に答える 2

Related

Reference