如何给 Java 文件打成独立的 JAR 包

如何给 Java 文件打成独立的 JAR 包

在 Java 开发中，打包 JAR（Java ARchive）文件是将编译后的 .class 文件、资源文件（如配置文件、图片等）以及依赖的库文件打包成一个压缩文件，便于分发和运行的常见操作。本文将详细介绍如何将 Java 文件打成独立的 JAR 包，包括各个步骤的详细说明（包括maven项目和非maven项目）。

---

一、 非Maven项目如何单独打成JAR包

1. 准备工作

在开始打包之前，确保你已经具备以下环境和文件：

• Java Development Kit (JDK)：确保已经安装了 JDK 并正确配置了环境变量（JAVA_HOME）。
• Java 源代码：已编写并通过编译的 Java 程序，通常存放在 src 目录下。
• Manifest 文件（可选）：用于指定主类和其他 JAR 文件的元数据文件（MANIFEST.MF）。

假设你有一个简单的 Java 项目结构如下：

MyProject/
│
├── src/
│   └── com/
│       └── example/
│           └── MyApp.java
│
└── manifest/
    └── MANIFEST.MF

其中，MyApp.java 是你的主程序文件，MANIFEST.MF 是你的可选 manifest 文件。

---

2. 编译 Java 文件

首先，你需要将 .java 源文件编译成 .class 字节码文件。假设你当前位于项目的根目录（即 MyProject/ 目录下）。

命令：

javac -d out/production/classes src/com/example/MyApp.java

• -d 参数指定了编译后的 .class 文件存放目录。
• out/production/classes 是编译后 .class 文件的输出目录。

执行后，你将得到如下的项目结构：

MyProject/
│
├── out/
│   └── production/
│       └── classes/
│           └── com/
│               └── example/
│                   └── MyApp.class
│
├── src/
│   └── com/
│       └── example/
│           └── MyApp.java
│
└── manifest/
    └── MANIFEST.MF

---

3. 创建 Manifest 文件（可选）

Manifest 文件可以指定 JAR 包的入口类以及其他元数据。如果没有提供 manifest 文件，JAR 包将无法通过命令行直接运行。

示例 MANIFEST.MF 文件内容：

Manifest-Version: 1.0
Main-Class: com.example.MyApp

• Main-Class 指定了 JAR 包的入口类，也就是 public static void main(String[] args) 方法所在的类。

---

4. 打包成 JAR 文件

在编译完成和（可选的）manifest 文件准备好后，你可以使用 jar 命令将项目打包成 JAR 文件。

命令：

jar cvfm MyApp.jar manifest/MANIFEST.MF -C out/production/classes/ .

• c 选项表示创建一个新的 JAR 文件。
• v 选项表示生成详细输出。
• f 选项表示指定 JAR 文件的名称。
• m 选项表示将 manifest 文件添加到 JAR 文件中。
• -C 选项表示切换到指定目录并添加该目录下的文件到 JAR 文件中。
• MyApp.jar 是生成的 JAR 文件的名称。

执行后，你将得到如下的项目结构：

MyProject/
│
├── MyApp.jar
│
├── out/
│   └── production/
│       └── classes/
│           └── com/
│               └── example/
│                   └── MyApp.class
│
├── src/
│   └── com/
│       └── example/
│           └── MyApp.java
│
└── manifest/
    └── MANIFEST.MF

MyApp.jar 就是你打包好的 JAR 文件。

---

5. 运行 JAR 文件

生成 JAR 文件后，你可以通过以下命令来运行它：

命令：

java -jar MyApp.jar

如果 JAR 包包含正确的 Main-Class 信息，它将直接执行主程序。

---

6. 常见问题与解决方法

6.1 找不到主类

如果在运行 JAR 包时出现 Error: Could not find or load main class 错误，通常是因为 Main-Class 未正确配置或路径错误。确保 MANIFEST.MF 文件中的 Main-Class 指向正确的类，并且在打包时使用了 -m 选项将 manifest 文件包含在 JAR 包中。

6.2 打包后缺少依赖库

如果你的项目依赖于外部库，需要将这些库打包到 JAR 文件中。可以使用 fat JAR 或 uber JAR 的方法，将所有依赖库打包到一个 JAR 文件中。常见工具如 Maven 的 shade 插件或 Gradle 的 shadow 插件都可以实现这一点。

---

二、Maven项目如何单独打成JAR包

在使用Maven进行项目管理时，将项目打包成JAR文件是一项非常常见的操作。Maven通过提供内置的生命周期阶段，极大地简化了代码的编译和打包过程。接下来我们详细讲解如何使用Maven将一个电商系统的项目单独打包成JAR文件。

2.1 配置pom.xml文件

首先，确保你的pom.xml文件中已经正确配置了相关依赖和插件。通常，我们需要使用Maven的maven-jar-plugin来帮助我们完成打包操作。

<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.ecommerce</groupId>
    <artifactId>ecommerce-system</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 这里添加项目所需的依赖 -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.ecommerce.MainApplication</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

• artifactId：表示项目的唯一标识符，通常与项目名保持一致。
• version：项目的版本号，通常是SNAPSHOT（开发中版本）或者特定的发布版本号。
• packaging：指定打包类型为jar。
• mainClass：指定项目的主类路径，这个类包含main方法，是程序的入口。

2.2 使用Maven命令打包

配置好pom.xml文件后，可以使用Maven命令来打包项目。

mvn clean package

执行该命令后，Maven会进行以下步骤：

1. 清理阶段：删除之前编译生成的目标目录下的内容。
2. 编译阶段：编译源代码，将Java文件编译为字节码文件（.class）。
3. 测试阶段：执行测试用例，确保代码功能正常（如果有测试用例）。
4. 打包阶段：将编译生成的文件和资源文件打包成一个JAR文件。

打包成功后，JAR文件会生成在target目录下，文件名通常为artifactId-version.jar，例如ecommerce-system-1.0-SNAPSHOT.jar。

2.3 运行生成的JAR包

打包完成后，可以通过以下命令运行生成的JAR文件：

java -jar target/ecommerce-system-1.0-SNAPSHOT.jar

如果pom.xml文件配置正确，程序将会顺利启动。

2.4 使用maven-shade-plugin合并依赖

有时候，我们可能需要将所有依赖一起打包进JAR文件中，这时可以使用maven-shade-plugin插件。

在pom.xml中添加以下配置：

<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>
                        <createDependencyReducedPom>false</createDependencyReducedPom>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

然后再次执行mvn clean package命令，生成的JAR文件将包含所有依赖，方便直接运行。

这样，你就成功将Maven项目打包成了一个可执行的JAR文件，接下来可以继续深入部署和运行这个JAR文件。