====== Mavenで標準以外の成果物(artifact)を作成する ======

{{tag>java maven}}

===== 依存関係を含む実行可能jar(fat-jar)を作成する =====

''mvn package'' で ''target/${project.artifactId}-${project.version}-jar-with-dependencies.jar'' を生成。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <executions>
          <execution>
            <id>fat-jar</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
            <configuration>
              <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
              </descriptorRefs>
              <archive>
                <manifest>
                  <mainClass>com.example.Main</mainClass>
                </manifest>
              </archive>
              <attach>false</attach>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>

詳細は [[https://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html|assembly:single]] を参照。


==== 依存関係を含む実行可能jar(fat-jar)を複数作成する ====

Mavenの理念は一つのモジュールに一つの成果物。
本来は別のモジュールにするべき。

''execution''を複数作成し、''configuration''をその中に移動する。
jarファイル名がぶつかるので''finalName''で変更する。

<code xml>
<build>
  <plugins>
    <plugin>
      <artifactId>maven-assembly-plugin</artifactId>
      <executions>
        <execution>
          <id>make-first-jar</id>
          <phase>package</phase>
          <goals>
            <goal>single</goal>
          </goals>
          <configuration>
            <descriptorRefs>
              <descriptorRef>jar-with-dependencies</descriptorRef>
            </descriptorRefs>
            <archive>
              <manifest>
                <mainClass>somepackage.FirstMainClass</mainClass>
              </manifest>
            </archive>
            <finalName>first</finalName>
          </configuration>
        </execution>
        <execution>
          <id>make-second-jar</id>
          <phase>package</phase>
          <goals>
            <goal>single</goal>
          </goals>
          <configuration>
            <descriptorRefs>
              <descriptorRef>jar-with-dependencies</descriptorRef>
            </descriptorRefs>
            <archive>
              <manifest>
                <mainClass>somepackage.SecondMainClass</mainClass>
              </manifest>
            </archive>
            <finalName>second</finalName>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
</code>

===== 依存関係を含む実行可能jar(fat-jar)を作成する、ただし一部の依存jarファイルを除く =====

''mvn package'' で ''target/${project.artifactId}-${project.version}-executable.jar'' を生成。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <executions>
          <execution>
            <id>executable-jar</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
            <configuration>
              <descriptors>
                <descriptor>src/assembly/executable.xml</descriptor>
              </descriptors>
              <archive>
                <manifest>
                  <mainClass>com.example.Main</mainClass>
                </manifest>
              </archive>
              <attach>false</attach>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>

<file xml src/assembly/executable.xml>
<assembly
  xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0
                      http://maven.apache.org/xsd/assembly-2.0.0.xsd">

  <id>executable</id>
  <formats>
    <format>jar</format>
  </formats>
  <includeBaseDirectory>false</includeBaseDirectory>
  <dependencySets>
    <dependencySet>
      <scope>runtime</scope>
      <useProjectArtifact>true</useProjectArtifact>
      <outputDirectory></outputDirectory>
      <unpack>true</unpack>
      <excludes>
        <!-- use groupId:artifactId[:type[:classifier][:version]] -->
        <!-- 通常typeは'jar' でclassifierはなし -->
        <exclude>log4j:log4j</exclude>
        <exclude>org.slf4j:slf4j-log4j12:jar:1.7.10</exclude>
      </excludes>
    </dependencySet>
  </dependencySets>
</assembly>
</file>

===== 依存するjarファイルをコピーする =====

''mvn package'' で ''target/lib'' に依存するjarファイルをコピーする。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <executions>
          <execution>
            <id>copy-dependencies</id>
            <phase>prepare-package</phase>
            <goals>
              <goal>copy-dependencies</goal>
            </goals>
            <configuration>
              <includeScope>runtime</includeScope>
              <outputDirectory>${project.build.directory}/lib</outputDirectory>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>

===== ソースjarファイルを作成する =====

''mvn package'' で ''target/${project.artifactId}-${project.version}-sources.jar'' を生成。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-source-plugin</artifactId>
        <executions>
          <execution>
            <id>attach-sources</id>
            <goals>
              <goal>jar-no-fork</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>


===== javadoc jarファイルを作成する =====

''mvn package'' で ''target/${project.artifactId}-${project.version}-javadoc.jar'' を生成。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-javadoc-plugin</artifactId>
        <executions>
          <execution>
            <id>attach-javadocs</id>
            <goals>
              <goal>jar</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>


===== 配布用のファイルを作成する =====

''mvn package'' で ''target/${project.artifactId}-${project.version}-bin.zip'' と ''target/${project.artifactId}-${project.version}-bin.tar.gz'' を生成。

<file xml pom.xml>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <executions>
          <execution>
            <id>create-archive</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
            <configuration>
              <descriptors>
                <descriptor>src/assembly/bindist.xml</descriptor>
              </descriptors>
              <attach>false</attach>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</file>

<file xml src/assembly/bindist.xml>
<assembly
  xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0
                      http://maven.apache.org/xsd/assembly-2.0.0.xsd">

  <id>bin</id>
  <formats>
    <format>tar.gz</format>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>true</includeBaseDirectory>
  <fileSets>
    <fileSet>
      <directory>src/dist</directory>
      <outputDirectory></outputDirectory>
      <excludes>
        <exclude>bin/*.sh</exclude>
      </excludes>
    </fileSet>
    <fileSet>
      <directory>src/dist</directory>
      <outputDirectory></outputDirectory>
      <includes>
        <include>bin/*.sh</include>
      </includes>
      <fileMode>0755</fileMode>
    </fileSet>
  </fileSets>
  <dependencySets>
    <dependencySet>
      <outputDirectory>lib</outputDirectory>
      <scope>runtime</scope>
    </dependencySet>
  </dependencySets>
</assembly>
</file>

アセンブリデスクリプタの詳細は [[https://maven.apache.org/plugins/maven-assembly-plugin/assembly.html|Assembly]] を参照.