Maven连同关联依赖一起打包成可执行jar

Maven连同关联依赖一起打包成可执行jar

---

前言

Maven可以使用mvn package指令对项目进行打包生成jar文件，如果直接使用java -jar xxx.jar指令运行jar文件，会出现”no main manifest attribute, in xxx.jar”（没有设置Main-Class）、ClassNotFoundException（找不到依赖包）等错误。

要想jar包能直接通过java -jar xxx.jar运行，需要满足：

1、在jar包中的META-INF/MANIFEST.MF中指定Main-Class，这样才能确定程序的入口在哪里；

2、要能加载到依赖包。

使用Maven有多种打包插件，可以生成满足以上两个条件能直接运行的jar包，这里主要介绍一种，这种方式，可以将仓库依赖以及本地依赖一起打包成一个可执行jar。

---

一、前提知识

1、使用maven将项目打包成jar，对于非maven项目需要先进行转成maven项目。
在idea中，创建pom.xml文件，然后右键该文件。

2、使用maven添加仓库依赖和添加本地依赖
仓库依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.57</version>
</dependency>

本地依赖：（指定项目jar的路径）

<dependency>
    <groupId>lib.zz1</groupId>
    <artifactId>zz1pdz</artifactId>
    <version>0.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/lib/zz1/zz1pdz.jar</systemPath>
</dependency>

3、对于一些资源配置文件，若想一同打入jar中，可以通过方式；并指定指定maven编译的jdk版本

<build>
<!-- 指定打包资源 -->
    <sourceDirectory>src</sourceDirectory>
    <resources>
        <resource>
            <directory>spd</directory>
            <excludes>
                <exclude>**/*.java</exclude>
            </excludes>
        </resource>
        <resource>
            <directory>src</directory>
            <includes>
                <include>**/*.xml</include>
                <include>**/*.properties</include>
            </includes>
        </resource>
    </resources>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.3</version>
            <!-- 指定jdk版本 -->
            <configuration>
                <source>1.7</source>
                <target>1.7</target>
                <encoding>GBK</encoding>
            </configuration>
        </plugin>
       <!-- 省略部分内容 -->

设置的jdk的编译版本，还需要修改ide工具的jdk编译版本，否则会编译出错。

二、上代码

连同仓库依赖一起打包

代码如下（示例）：

<build>
    <!—根据需要自己添加，或者省略，一般情况下可以省略，插件会默认打包-->    
    <sourceDirectory>src</sourceDirectory>
    <resources>
        <resource>
            <directory>spd</directory>
            <excludes>
                <exclude>**/*.java</exclude>
            </excludes>
        </resource>
        <resource>
            <directory>src</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
    </resources>

    <plugins>
        <!—指定maven编译的jdk-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.3</version>
            <configuration>
                <source>1.7</source>
                <target>1.7</target>
                <encoding>GBK</encoding>
            </configuration>
        </plugin>
        <!—打包插件-->
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>com.quan.simple.IncFrame</mainClass>
                    </manifest>
                    <manifestEntries>
                        <Class-Path>.</Class-Path>
                    </manifestEntries>
                </archive>
                <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>
</build>

到这一步，已经可以将项目以及关联的仓库依赖打包成功。
打包后会在target目录下生成一个xxx-jar-with-dependencies.jar文件，这个文件不但包含了自己项目中的代码和资源，还包含了所有依赖包的内容。所以可以直接通过java -jar来运行。

连同本地依赖一同打包

需要新建一个assembly.xml，路径随意（事后指定即可），填入内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<assembly>
    <id>jar-with-dependencies</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>        <!-- 默认的配置 -->
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
        </dependencySet>        <!-- 增加scope类型为system的配置 -->
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>system</scope>
        </dependencySet>
    </dependencySets>
</assembly>

然后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>ZA24.21</groupId>
    <artifactId>bchcmp</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <sourceDirectory>src</sourceDirectory>
        <resources>
            <resource>
                <directory>spd</directory>
                <excludes>
                    <exclude>**/*.java</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.3</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>GBK</encoding>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                        <!-- 指定主程序入口 -->
                        <mainClass>com.cmb.cmp.hdl.CMPHDL_CmpProcess</mainClass>
                        </manifest>
                        <manifestEntries>
                            <Class-Path>.</Class-Path>
                        </manifestEntries>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <!—仓库依赖 -->
        <dependency>
            <groupId>ZA24.21</groupId>
            <artifactId>bchcom</artifactId>
            <version>1.2-SNAPSHOT</version>
        </dependency>
        <!—本地依赖 -->
        <dependency>
            <groupId>lib.zz1</groupId>
            <artifactId>zz1log</artifactId>
            <version>0.0.0</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/lib/zz1/zz1log.jar</systemPath>
        </dependency>
    </dependencies>
</project>

---

留言：文章是博主本人遇到问题，通过各种渠道收集资料解决后，并记录在word文档里，最后才整理发博，因此有些相似的内容是借鉴网友的，若有雷同，请谅解！