JAVA项目通过IDEA如何构建可执行JAR

最新推荐文章于 2024-04-15 10:42:50 发布

softbook

最新推荐文章于 2024-04-15 10:42:50 发布

阅读量4.6k

点赞数 6

分类专栏： Java 文章标签： java intellij-idea jar maven

本文链接：https://blog.csdn.net/bk120/article/details/130655627

版权

Java 专栏收录该内容

11 篇文章 1 订阅

订阅专栏

开发JAVA工程代码(main方法启动)如何构建出可以通过java -jar命令直接执行的jar？如果工程中依赖其他jar又如何处理？本文即针对以上两点通过IDEA开发工具来做一个简单的分析和尝试，测试如下四种方法，如有瑕疵请轻喷。

文字目录

1.通过IDEA直接构建可执行jar
2.通过ANT构建可执行jar
3.通过maven-assembly插件构建可执行jar
4.通过maven-shade插件构建可执行jar

1.通过IDEA直接构建可执行jar

如下所示通过IDEA创建一个本地JAVA工程，此处工程名JavaPackage1，在lib引入一个hutool-all-5.3.7.jar作为测试，目录结构如下点击运行JPackage1正常打印日期。

在这里插入图片描述
如何通过IDEA直接构建可执行jar呢？具体步骤如下：

选择File -> Project Structure
选择Arifacts->ADD->JAR->Form modules with dependencies
在Main Class栏选择要打包成jar文件的java类，点击OK
出现如下界面，点击ok。最后构建完成jar的启动相关信息会写入到META-INF/MANIFEST.MF清单文件中。
点击Build->Build Artifacts，参照以下两张图，最后在\out\artifacts\目录下生成j可执行ar文件
最后通过在cmd窗口直接执行java -jar JavaPackage1.jar 运行正常输出hutool工具类获取的日期

后续若修改代码后可直接执行Build->Build Artifacts生成jar，不需要再做前面的配置步骤。同时解压该生成的jar可以发现依赖的hutool工具类是以class文件全部打入进来了。其中生成的MANIFEST.MF文件很简单就指明了Main-Class启动类信息。

2.通过ANT构建可执行jar

IDEA新建JAVA工程，此处新建工程名JavaPackage2，并在lib下引入hutool依赖jar
在项目根目录下编写ant.xml(文件名无要求)

xml中内容如下，具体语法可参考官网学习

<?xml version="1.0" encoding="UTF8"?>
<project name="buildJar" default="jar" basedir=".">
    <tstamp>
        <format property="TODAY" pattern="yyyy-MM-dd HH:mm:ss" />
    </tstamp>
    <!-- 定义:打包生成的jar的名字 -->
    <property name="jar.name" value="JavaPackage2.jar"/>
    <!-- 定义:主类路径 -->
    <property name="main.class" value="com.xren.jpackage2.JPackage2"/>
    <property name="build.dir" value="${basedir}/build" />
    <property name="classes.dir" value="${basedir}/classes" />
    <property name="lib.dir" value="${basedir}/lib" />
    <!--阶段1.删除之前生成的jar包-->
    <target name="clean">
        <delete dir="${build.dir}"/>
        <delete dir="${classes.dir}"/>
    </target>
    <!--定义依赖jar路径-->
    <path id="lib.path">
        <fileset dir="${lib.dir}">
            <include name="*.jar"/>
        </fileset>
    </path>
    <!--阶段2.编译java文件-->
    <target name="compile" depends="clean">
        <!--创建classes文件夹-->
        <mkdir dir="${classes.dir}"/>
        <!--编译java文件-->
        <javac srcdir="${basedir}/src" destdir="${classes.dir}" encoding="UTF8">
                <!--编译依赖jar -->
                <classpath refid="lib.path"/>
        </javac>
    </target>
    <!--阶段3.生成可运行的jar包-->
    <pathconvert property="relate.classpath" pathsep=" ">
        <mapper>
            <chainedmapper>
                <flattenmapper />
                <globmapper from="*" to="lib/*" />
            </chainedmapper>
        </mapper>
        <path refid="lib.path" />
    </pathconvert>
    <target name="jar" depends="compile">
        <mkdir dir="${build.dir}"/>
        <!--指定清单文件 -->
        <manifest file="${build.dir}/MANIFEST.MF">
            <!--主类路径-->
            <attribute name="Main-class" value="${main.class}"/>
            <!-- 引入依赖jar-classpath -->
            <attribute name="Class-Path" value="${relate.classpath}" />
            <attribute name="Built-Date" value="${TODAY}" />
        </manifest>
        <jar destfile="${build.dir}/${jar.name}"
             basedir="${classes.dir}"
             manifest="${build.dir}/MANIFEST.MF">
        </jar>
        <!--拷贝依赖jar到当前build目录 -->
        <copy todir="${build.dir}/lib" >
            <fileset dir="${lib.dir}"></fileset>
        </copy>
    </target>
</project>

添加ant.xml文件
选中buildJar、点击执行，而后便会在build目录下生成一个可执行的jar
执行效果如下

此方式生成的jar需要和同级目录下的lib依赖引入才能运行成功，原因是在ant.xml文件中打包时已经在清单文件MANIFEST.MF里固定了lib路径。

如果想将外部的jar全部打入到jar中，需要在xml中做如下单独引入，最后jar可直接运行。xml配置及包结构如下：

 <target name="jar" depends="compile">
        <mkdir dir="${build.dir}"/>
        <!--指定清单文件 -->
        <manifest file="${build.dir}/MANIFEST.MF">
            <!--主类路径-->
            <attribute name="Main-class" value="${main.class}"/>
        </manifest>
        <jar destfile="${build.dir}/${jar.name}"
             basedir="${classes.dir}"
             manifest="${build.dir}/MANIFEST.MF">
            <zipfileset src="${lib.dir}/hutool-all-5.3.7.jar"/>
        </jar>
    </target>

在这里插入图片描述

3.通过maven-assembly插件构建可执行jar

新建Java-maven工程，通过pom引入hutool工具库依赖,此处新建工程名JavaPackage3

pom.xml配置

	<dependencies>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.3.7</version>
        </dependency>
    </dependencies>

如果hutool-all.jar依赖下载不了请检查IDEA的maven配置是否正确。
在这里插入图片描述

Pom中引入maven-assembly-plugin插件打包

	<build>
        <plugins>
            <!-- 使用maven-assembly-plugin插件打包 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <!--主类 -->
                            <mainClass>com.xren.jpackage3.JPackage3</mainClass>
                        </manifest>
                    </archive>
                    <descriptorRefs>
                        <!-- 可执行jar名称结尾-->
                        <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>

执行maven-package，而后在target目录下会生成一个以jar-with-dependencies结尾的可直接执行jar，另外一个jar里面没有依赖不可执行
该可执行jar的目录结构和清单文件MANIFEST.MF内容如下

通过Maven-assembly插件构建的jar和ant构建出来的jar中结构基本一致，将依赖jar以class方式加入内容部，同时在打包配置文件中指定清单文件MANIFEST.MF的主启动类Main-Class。

4.通过maven-shade插件构建可执行jar

新建Java-maven工程，通过pom引入hutool工具库依赖,此处新建工程名JavaPackage4
Pom文件中引入maven-shade-plugin插件

	<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.4</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer
                                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>com.xren.jpackage4.JPackage4</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

执行maven package，而后会在target目录下生成一个可执行JavaPackage4-1.0-SNAPSHOT.jar
执行该jar，正常运行

利用maven-shade-plugin构建除了会生成可执行jar，还会在target目录下生成一个以original-开头的原始jar，该jar不可执行内部没有依赖其他，其清单文件MANIFEST.MF如下：

而可执行jar清单文件如下，差别就是多了一个Main-Class

**总结：**综上几种构建可执行jar的方式可知，其都有一个共同点-jar里面有一个包含Main-Class的MANIFEST.MF文件，Main-Class配置指向main方法的主启动类。jar依赖的其他程序会以lib-jar或者class文件的方式包含其中(此文只验证依赖jar，没有验证配置文件依赖)。

softbook

关注

6
点赞
踩
21

收藏

觉得还不错? 一键收藏
1
评论
JAVA项目通过IDEA如何构建可执行JAR

开发JAVA工程代码(main方法启动)如何构建出可以通过java -jar命令直接执行的jar？如果工程中依赖其他jar又如何处理？本文即针对以上两点通过IDEA开发工具来做一个简单的分析和尝试，测试四种方法构建可执行jar。
复制链接

扫一扫