0

0

使用Maven构建包含本地外部库的可执行JAR文件教程

霞舞

霞舞

发布时间:2025-10-13 12:12:01

|

942人浏览过

|

来源于php中文网

原创

使用Maven构建包含本地外部库的可执行JAR文件教程

本文详细介绍了如何在不依赖ide的情况下,使用maven构建包含本地外部jar库的可执行jar文件。核心解决方案涉及声明`system`范围依赖、利用`maven-dependency-plugin`将本地库复制到目标目录,并通过`maven-jar-plugin`的`manifestentries`配置,将这些库正确添加到生成jar的`class-path`中,确保程序在独立运行时能够找到并加载所有必要的外部依赖。

在Java项目开发中,特别是在没有IDE辅助的情况下,如何将本地的外部JAR库(例如,一些自定义的工具库或特定版本的第三方库)打包进一个可独立运行的Maven项目,并确保其在运行时能够被正确加载,是一个常见的挑战。本文将提供一个详细的教程,指导您如何通过Maven的配置实现这一目标。

1. 项目结构与示例代码

首先,我们假设您有一个主项目(MyApplication)需要依赖一个本地的外部库(testlib.jar)。

主项目(MyApplication)代码示例:

// src/main/java/TEST/App.java
package TEST;

import TEST.Lib; // 假设Lib类在testlib.jar中

public class App {
    public static void main( String[] args ) {
        new Lib().go();
        System.out.println("Application started, attempting to call external lib method.");
    }
}

外部库(testlib.jar)的源代码示例(假设编译后生成testlib.jar):

// testlib/src/main/java/TEST/Lib.java
package TEST;

import javax.swing.JFrame;
import javax.swing.JLabel;

public class Lib {
    public void go() {
        JFrame frame = new JFrame("Test Lib Window");
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setSize(400,100);
        frame.add(new JLabel("Hello from Test Lib!"));
        frame.setVisible(true);
    }
}

为了使MyApplication能够找到testlib.jar,我们通常会在主项目根目录下创建一个libs文件夹,并将testlib.jar放入其中。

项目目录结构示意:

MyApplication/
├── pom.xml
├── src/
│   └── main/
│       └── java/
│           └── TEST/
│               └── App.java
└── libs/
    └── testlib.jar

2. 配置Maven pom.xml

为了正确地将本地外部库打包并使其可执行,我们需要对pom.xml进行以下关键配置:

2.1 声明本地依赖

首先,在pom.xml的<dependencies>部分声明testlib.jar为本地依赖。使用system范围(scope)和systemPath指向本地JAR文件的相对路径。

<dependencies>
    <!-- 其他依赖... -->
    <dependency>
        <groupId>testlib</groupId>
        <artifactId>testlib</artifactId>
        <version>1.0</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/libs/testlib.jar</systemPath>
    </dependency>
</dependencies>

注意事项:

  • groupId和artifactId可以根据实际情况自定义,但要与后续配置保持一致。
  • version字段是必需的,Maven在复制依赖时会用到。
  • systemPath应使用${project.basedir}来确保路径的相对性和可移植性。

2.2 使用 maven-dependency-plugin 复制依赖

system范围的依赖默认不会被Maven打包到最终的JAR中,也不会自动添加到Class-Path。因此,我们需要使用maven-dependency-plugin将testlib.jar复制到目标(target)目录下的一个子文件夹中,例如lib。

将以下配置添加到<build>部分的<plugins>中:

小微助手
小微助手

微信推出的一款专注于提升桌面效率的助手型AI工具

下载
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <version>3.1.2</version> <!-- 推荐使用较新版本 -->
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/lib</outputDirectory>
                        <overWriteReleases>false</overWriteReleases>
                        <overWriteSnapshots>false</overWriteSnapshots>
                        <overWriteIfNewer>true</overWriteIfNewer>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- maven-jar-plugin 配置将在下一节介绍 -->
    </plugins>
</build>

配置说明:

  • phase: prepare-package阶段确保在打包主JAR之前,依赖已经被复制。
  • outputDirectory: 指定依赖将被复制到的目标文件夹,这里是${project.build.directory}/lib,即target/lib。
  • overWrite*: 这些配置控制是否覆盖已存在的依赖文件。

2.3 配置 maven-jar-plugin 创建可执行JAR

最后,我们需要配置maven-jar-plugin来创建可执行JAR,并确保在JAR的MANIFEST.MF文件中正确设置Class-Path,使其指向我们刚刚复制的本地库。

将以下配置添加到<build>部分的<plugins>中(与maven-dependency-plugin同级):

<build>
    <plugins>
        <!-- maven-dependency-plugin 配置... -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.3.0</version> <!-- 推荐使用较新版本 -->
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>TEST.App</mainClass>
                    </manifest>
                    <manifestEntries>
                        <!-- 注意:Maven在复制时会将testlib.jar重命名为 testlib-1.0.jar -->
                        <Class-Path>lib/testlib-1.0.jar</Class-Path>
                    </manifestEntries>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

配置说明:

  • mainClass: 指定您的应用程序的入口类。
  • manifestEntries: 这是关键部分。它允许您向JAR的MANIFEST.MF文件添加自定义条目。
  • Class-Path: 此条目告诉JVM在哪里查找外部依赖。非常重要的一点是,Maven在复制system范围的依赖时,通常会将其重命名为artifactId-version.jar的形式。因此,如果您的testlib.jar版本是1.0,它将被复制为testlib-1.0.jar。这里的路径lib/testlib-1.0.jar是相对于生成的JAR文件所在目录的路径。

3. 完整的 pom.xml 示例

综合上述配置,您的pom.xml文件将类似于:

<?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>

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

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!-- 本地外部库依赖 -->
        <dependency>
            <groupId>testlib</groupId>
            <artifactId>testlib</artifactId>
            <version>1.0</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/libs/testlib.jar</systemPath>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 复制依赖到 target/lib 目录 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.1.2</version>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <overWriteReleases>false</overWriteReleases>
                            <overWriteSnapshots>false</overWriteSnapshots>
                            <overWriteIfNewer>true</overWriteIfNewer>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <!-- 创建可执行JAR并配置Class-Path -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>TEST.App</mainClass>
                        </manifest>
                        <manifestEntries>
                            <Class-Path>lib/testlib-1.0.jar</Class-Path>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

4. 构建与运行

在完成pom.xml配置后,您可以通过命令行执行Maven命令来构建项目:

mvn clean package

执行成功后,您会在项目的target目录下找到以下文件和目录:

  • MyApplication-1.0-SNAPSHOT.jar (您的主可执行JAR)
  • lib/ 目录,其中包含 testlib-1.0.jar

现在,您可以运行您的可执行JAR文件:

java -jar target/MyApplication-1.0-SNAPSHOT.jar

此时,您应该能看到由testlib.jar中的Lib.go()方法创建的Swing窗口。

5. 注意事项与总结

  • system Scope的局限性: system范围的依赖通常用于那些无法通过Maven仓库获取的本地JAR文件。它不适合作为常规的、可传递的依赖。在大多数情况下,建议将本地JAR安装到本地Maven仓库 (mvn install:install-file) 或将其发布到私有Maven仓库。
  • 依赖命名: 务必注意maven-dependency-plugin复制依赖时,会将其重命名为artifactId-version.jar的形式。在maven-jar-plugin的Class-Path配置中,必须使用这个重命名后的文件名。
  • Class-Path的相对路径: Class-Path中的路径是相对于可执行JAR文件本身的。这意味着MyApplication-1.0-SNAPSHOT.jar和lib/testlib-1.0.jar必须位于相同的父目录下才能被正确加载。
  • 插件版本: 示例中使用了特定版本的Maven插件。建议使用较新且稳定的版本,以获得更好的兼容性和功能。
  • 替代方案(Fat JAR): 对于更复杂的场景,如果希望将所有依赖都打包到一个独立的JAR文件中(即“胖JAR”或“Uber JAR”),可以考虑使用maven-shade-plugin或spring-boot-maven-plugin。这种方式会将所有依赖的类文件解压并重新打包到主JAR中,避免了外部lib文件夹的需求,但会增加JAR文件的大小。

通过上述步骤,您已经成功地使用Maven构建了一个包含本地外部库的可执行JAR文件,并确保了其在独立运行时的依赖加载。这种方法在特定场景下非常有用,尤其是在没有IDE或需要精细控制打包过程时。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

161

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

89

2026.01.26

Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

0

2025.09.15

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1949

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2119

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1172

2024.11.28

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

911

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

32

2025.12.06

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.4万人学习

Java 教程
Java 教程

共578课时 | 82.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号