阅读数:200 评论数:0

一、概述

在maven中， 主要有三个插件可以用来打包：

1、maven-jar-plugin

默认的打包插件，用来打包普通的project JAR包。

2、maven-shade-plugin

用来打包可执行jar包，也就是所谓的fat jar包。

3、maven-assembly-plugin

支持自定义的打包结构，也可以定制依赖等。

Maven插件列表：https://maven.apache.org/plugins/index.html；

二、maven-jar-plugin

maven-jar-plugin这个插件通常用于将maven工程打成jar包，该插件绑定到package生命周期阶段。

1、生成可执行jar包。

<plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.4</version>
            <configuration>
                <archive>
                    <manifest>                         <!--是否要把第三方jar放到manifest的classpath中-->
                        <addClasspath>true</addClasspath>                         <!--生成的manifest中classpath的前缀，                          因为要把第三方jar放到lib目录下，                         所以classpath的前缀是lib/-->
                        <classpathPrefix>lib/</classpathPrefix>                          <!-- 执行的主程序路径 -->
                        <mainClass>com.example.demo.test.App</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>

这样打包出来的路径结构：

2、一级配置

3、archive配置

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <archive>
                        <!-- 创建的归档文件是否包含以下pom.xml 和pom.properties Maven 文件,默认是true -->
                        <addMavenDescriptor/>
                        <!-- 是否对存档进行压缩。默认值为 true -->
                        <compress/>
                        <!-- 是否强制重新创建存档。
                            将此选项设置为 false（默认值为 true）意味着将所包含文件的时间戳与目标存档的时间戳进行比较，并重建存档，
                            前提是后者的时间戳小于前者的时间戳。检查时间戳通常会带来性能提升
                            （特别是，如果构建中的以下步骤被抑制，如果没有重新创建归档文件），
                            代价是您会不时得到不准确的结果。特别是，不会检测到源文件的删除。
                            归档程序不一定支持检查最新版本。如果是这样，将此选项设置为 true 将被忽略。-->
                        <forced/>
                        <!-- 创建的存档文件是否包含 INDEX.LIST 文件。默认值为 false -->
                        <index/>
                        <!--  使用此选项覆盖自动创建的 pom.properties 文件（仅当 addMavenDescriptor 设置为 true 时） -->
                        <pomPropertiesFile/>
                        <!-- 提供自己的清单文件 -->
                        <manifestFile/>
                        <!--                        -->
                        <manifest>
                            <!-- 是否创建 Class-Path 清单条目。默认值为 false-->
                            <addClasspath/>
                            <!-- 如果为true，清单将包含以下条目：
                                Created-By: Maven Archiver ${maven-archiver.version}
                                Build-Jdk-Spec: ${java.specification.version}
                             -->
                            <addDefaultEntries/>
                            <!-- 如果为true，清单将包含以下条目：
                                Implementation-Title: ${project.name}
                                Implementation-Version: ${project.version}
                                Implementation-Vendor: ${project.organization.name}
                            -->
                            <addDefaultImplementationEntries/>
                            <!-- 如果为true，清单将包含以下条目：
                                Specification-Title: ${project.name}
                                Specification-Version: ${project.artifact.selectedVersion.majorVersion}.${project.artifact.selectedVersion.minorVersion}
                                Specification-Vendor: ${project.organization.name}
                            -->
                            <addDefaultSpecificationEntries/>
                            <!-- 如果为true，清单将包含以下条目：
                                Build-Tool: ${maven.build.version}
                                Build-Jdk: ${java.version} (${java.vendor})
                                Build-Os:  ${os.name} (${os.version}; (${os.arch})
                            -->
                            <addBuildEnvironmentEntries/>
                            <!-- 是否创建 Extension-List 清单条目。默认值为 false -->
                            <addExtensions/>
                            <!-- 在所创建的 Class-Path 中格式化条目时要使用的布局类型。
                                有效值包括：simple、repository（与Maven类路径布局相同）和 custom。
                                注意：如果指定 custom 的类型，还必须设置 customClasspathLayout。默认值为 simple
                            -->
                            <classpathLayoutType/>
                            <!-- 将作为所有 Class-Path 项前缀的文本。默认值为空字符串 “”-->
                            <classpathPrefix/>
                            <!-- 在 classpathLayoutType 中设置的布局类型值为 custom 时使用的布局表达式。表达式将根据类路径相关对象的以下有序列表进行计算：
                                当前 Artifact 实例（如果存在）。
                                来自上述 Artifact 的当前 ArtifactHandler 实例。
                                注意：如果指定 custom 布局类型，则必须设置该布局表达式
                            -->
                            <customClasspathLayout/>
                            <!-- Main-Class 清单项-->
                            <mainClass/>
                            <!-- 名为 Package 清单条目-->
                            <packageName/>
                            <!-- 是否使用唯一的时间戳快照版本而不是 -SNAPSHOT。默认值为 true-->
                            <useUniqueVersions/>
                        </manifest>
                        <!-- 要添加到清单的键/值对的列表 -->
                        <manifestEntries>
                            <key>value</key>
                        </manifestEntries>
                        <manifestSections>
                            <manifestSection>
                                <!-- 节的名称-->
                                <name/>
                                <!-- 要添加到清单的键/值对的列表。java.util.Map 类型-->
                                <manifestEntries>
                                    <key>value</key>
                                </manifestEntries>
                            </manifestSection>
                        </manifestSections>
                    </archive>
                </configuration>
</plugin>

三、maven-assembly-plugin

打包生成的的普通jar包，只包含该工程下源码编译结果，不包含依赖内容，所以还需要使用maven-assembly-plugin来二次组装，

<plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals> // 该打包任务只运行一次
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                 <descriptors>  
                        <descriptor>assembly.xml</descriptor>   //和 pom.xml 同级目录下
                     </descriptors>
                    <outputDirectory>output</outputDirectory>    //和 pom.xml同级目录下，assembly 组装出来的包会被放置在output目录下
            </configuration>
        </plugin>

assembly.xml内容如下：

<?xml version='1.0' encoding='UTF-8'?> 
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
    <id>consul-consumer-demo</id>
    <formats> 
        <format>zip</format> 
    </formats> 
    <includeBaseDirectory>false</includeBaseDirectory> 
    <fileSets> 
        <fileSet> 
            <directory>${project.build.directory}</directory> //${project.build.directory} 指 target目录
            <outputDirectory>/</outputDirectory>   //表示输出到 pom 中配置的 output目录下
            <includes>
               <include>consul-product.jar</include>
            </includes>
        </fileSet> 
        <fileSet> 
            <directory>${project.build.directory}/classes</directory> 
            <outputDirectory>/config</outputDirectory>   //表示输出到 pom 中配置的 output/config 目录下
           <includes>
               <include>application.properties</include>
            </includes> 
        </fileSet> 
        <fileSet> 
            <directory>${project.basedir}</directory> //${project.basedir} 指 工程根目录
            <outputDirectory>/</outputDirectory> 
            <includes>
               <include>script/*.*</include>
            </includes> 
        </fileSet>
    </fileSets> 
</assembly>

在不指定jar包名称的时候，通常的jar包名称是：artifactId-version.jar。要自定义jar包名称，可以直接在pom.xml中build结点下设置finalName，如：

<build>
      <finalName>p-test-tool</finalName>
</build>