0

0

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

DDD

DDD

发布时间:2025-10-13 11:38:03

|

707人浏览过

|

来源于php中文网

原创

使用maven构建包含本地外部库的可执行jar文件

本教程详细指导如何在不依赖IDE的情况下,使用Maven构建一个包含本地外部JAR库的可执行JAR文件。通过配置system范围依赖、maven-dependency-plugin复制依赖,以及maven-jar-plugin设置Class-Path清单条目,确保所有必需的本地库都能被正确打包并被JVM在运行时发现,从而解决system范围依赖在可执行JAR中无法加载的问题。

在Java项目开发中,尤其是在不使用集成开发环境(IDE)的情况下,有时需要将本地文件系统中的外部JAR库(例如,一些自定义工具包或不通过Maven仓库发布的库)打包进一个可执行的JAR文件。Maven作为强大的项目管理工具,虽然主要用于管理通过仓库发布的依赖,但通过特定的插件配置,也能很好地处理本地外部库。本教程将详细阐述如何通过Maven的pom.xml配置,实现这一目标。

项目结构与示例代码

为了演示,我们假设有两个Java文件:一个提供简单功能的本地库testlib.jar,另一个是调用该库的主应用程序。

1. 外部库代码 (TEST/Lib.java)

这个代码将被编译并打包成testlib.jar。

package TEST;

import javax.swing.*;

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

2. 主应用程序代码 (TEST/App.java)

这个应用程序将调用testlib.jar中的go()方法。

package TEST;

public class App {
    public static void main(String[] args) {
        new Lib().go();
    }
}

3. 项目目录结构

Cutout.Pro
Cutout.Pro

AI驱动的视觉设计平台

下载

在您的Maven项目根目录下,创建以下结构:

my-app/
├── pom.xml
├── src/
│   └── main/
│       └── java/
│           └── TEST/
│               └── App.java
└── libs/
    └── testlib.jar  <-- 您的本地外部库

请确保testlib.jar已经存在于libs/目录下。如果尚未生成,您可以使用javac和jar命令手动编译Lib.java并打包:

# 在 my-app/libs/ 目录下创建 Lib.java
# javac Lib.java
# jar -cvf testlib.jar Lib.class
# 或者,在 my-app/ 目录下创建 testlib-src/TEST/Lib.java
# cd testlib-src
# javac TEST/Lib.java
# jar -cvf ../libs/testlib.jar TEST/*.class
# cd ..

Maven pom.xml 配置详解

要使Maven能够将本地外部库正确地包含在可执行JAR中,我们需要在pom.xml中进行以下关键配置。

1. 声明本地系统依赖

首先,在pom.xml的<dependencies>部分声明testlib.jar为system范围的依赖。

<dependencies>
    <dependency>
        <groupId>testlib</groupId>
        <artifactId>testlib</artifactId>
        <version>1</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/libs/testlib.jar</systemPath>
    </dependency>
</dependencies>
  • <groupId>、<artifactId>、<version>: 这些是Maven坐标,即使是本地库也需要定义,它们在pom.xml中作为唯一标识符使用。
  • <scope>system</scope>: 指示Maven此依赖是系统级别的,不会从Maven仓库下载,而是直接从本地文件系统获取。
  • <systemPath>${project.basedir}/libs/testlib.jar</systemPath>: 指定本地JAR文件的绝对路径。${project.basedir}是一个Maven内置变量,代表项目根目录,确保路径的相对性和跨平台兼容性。请使用正斜杠/作为路径分隔符,即使在Windows系统上也是如此。

2. 使用 maven-dependency-plugin 复制依赖

system范围的依赖不会被Maven自动打包到最终的JAR文件中,也不会在默认的Class-Path中引用。为了解决这个问题,我们需要使用maven-dependency-plugin将这些本地库复制到项目构建目录(target)下的一个指定子目录(例如lib)。

<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>
                        <includeScope>system</includeScope> <!-- 仅复制system scope的依赖 -->
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- ... 其他插件配置 ... -->
    </plugins>
</build>
  • <groupId>、<artifactId>: 插件标识符。
  • <version>: 插件版本,建议使用较新且稳定的版本。
  • <execution>: 定义插件的执行阶段。
    • <id>copy-dependencies</id>: 执行ID,用于唯一标识此执行。
    • <phase>prepare-package</phase>: 指定插件在package阶段之前执行,确保在JAR打包前依赖已被复制。
    • <goals><goal>copy-dependencies</goal></goals>: 指定执行copy-dependencies目标。
    • <configuration>: 插件配置。
      • <outputDirectory>${project.build.directory}/lib</outputDirectory>: 指定依赖将被复制到的目录。${project.build.directory}通常是target目录。
      • <includeScope>system</includeScope>: 这是一个重要配置,它告诉插件只复制system范围的依赖。

3. 配置 maven-jar-plugin 构建可执行JAR并设置 Class-Path

最后,我们需要配置maven-jar-plugin来构建可执行JAR,并在其META-INF/MANIFEST.MF文件中正确设置Main-Class和Class-Path,以便JVM在运行时能够找到外部库。

<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>
                        <!-- addClasspath 默认会添加所有Maven管理的依赖到Class-Path,但对system scope不直接生效 -->
                        <!-- <addClasspath>true</addClasspath> -->
                    </manifest>
                    <manifestEntries>
                        <!-- 显式指定本地库的路径,注意Maven会重命名文件为 artifactId-version.jar -->
                        <Class-Path>lib/testlib-1.jar</Class-Path>
                    </manifestEntries>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>
  • <mainClass>TEST.App</mainClass>: 指定应用程序的入口类。
  • <manifestEntries>: 这是解决问题的关键。它允许您向MANIFEST.MF文件添加自定义条目。
    • <Class-Path>lib/testlib-1.jar</Class-Path>: 此条目告诉JVM在查找类时,除了JAR自身,还要在与JAR同级的lib目录下寻找testlib-1.jar。
      • 注意文件名: maven-dependency-plugin在复制依赖时,通常会将文件重命名为artifactId-version.jar的格式。因此,testlib.jar会变成testlib-1.jar(如果版本是1)。请务必根据实际复制后的文件名进行设置。
  • <addClasspath>true</addClasspath>: 这个配置通常用于Maven管理的(非system范围)依赖,它会根据Maven的依赖解析结果自动生成Class-Path。对于我们手动复制的system范围依赖,需要通过manifestEntries显式指定。为了避免混淆,在此示例中我们将其注释掉,以强调manifestEntries的重要性。

完整的 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>my-app</artifactId>
    <version>1.0-SNAPSHOT</version>

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

    <dependencies>
        <!-- 声明本地系统依赖 -->
        <dependency>
            <groupId>testlib</groupId>
            <artifactId>testlib</artifactId>
            <version>1</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/libs/testlib.jar</systemPath>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 插件1: 复制系统依赖到target/lib目录 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.1.2</version>
                <executions>
                    <execution>
                        <id>copy

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
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

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

213

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

325

2024.02.23

java标识符合集
java标识符合集

本专题整合了java标识符相关内容,想了解更多详细内容,请阅读下面的文章。

293

2025.06.11

c++标识符介绍
c++标识符介绍

本专题整合了c++标识符相关内容,阅读专题下面的文章了解更多详细内容。

179

2025.08.07

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

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

49

2026.03.13

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.4万人学习

Java 教程
Java 教程

共578课时 | 82.5万人学习

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

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