Spring Boot 加载本地 JAR 包的技术实践

随着微服务架构的兴起，Spring Boot 因其快速构建、易于部署的特性，成为了众多开发者的首选框架。在开发过程中，我们有时需要引入一些不在公共 Maven 仓库中的 JAR 包作为依赖，这时候就需要加载本地的 JAR 包。本文将详细介绍在 Spring Boot 项目中如何加载本地 JAR 包，并给出一个具体的案例。

一、为什么需要加载本地 JAR 包？

在实际开发中，我们可能会遇到以下需要加载本地 JAR 包的情况：

1. 赖的 JAR 包没有发布到公共 Maven 仓库。
2. 依赖的 JAR 包是私有库，不方便公开。
3. 需要使用某个特定版本的 JAR 包，而该版本并未在 Maven 仓库中提供。

二、加载本地 JAR 包的方法

1. 将本地 JAR 包复制到项目的 libs 目录下（如果没有 libs 目录，可以手动创建）。
2. 在 IntelliJ IDEA 中，右键点击 libs 目录，选择 Add -> Existing Item…，然后选择刚刚复制的 JAR 包。
3. 右键点击刚刚添加的 JAR 包，选择 Add as Library…，在弹出的窗口中设置库的名称，并选择将其添加到项目的模块依赖中。
4. 使用 Maven 添加系统依赖 如果项目使用 Maven 管理依赖，可以在 pom.xml 文件中添加系统范围的依赖，指向本地的 JAR 包。

<dependencies>  
    <!-- 其他依赖 -->  
    <dependency>  
        <groupId>自定义groupId</groupId>  
        <artifactId>自定义artifactId</artifactId>  
        <version>自定义版本号</version>  
        <scope>system</scope>  
        <systemPath>${project.basedir}/libs/自定义jar文件名.jar</systemPath>  
    </dependency>  
</dependencies>

请确保替换 自定义groupId、自定义artifactId、自定义版本号 和 自定义jar文件名.jar 为你的实际值。${project.basedir} 是 Maven 的一个属性，代表项目的根目录。

三、案例演示

假设我们有一个名为 jdp-core-1.1.2.RELEASE.jar 的本地 JAR 包，需要添加到 Spring Boot 项目中。

步骤一：复制 JAR 包到项目目录

将 jdp-core-1.1.2.RELEASE.jar 复制到项目的 libs 目录下。

步骤二：在 IntelliJ IDEA 中添加 JAR 包为库

1. 在 IntelliJ IDEA 中，右键点击 libs 目录，选择 Add -> Existing Item…，然后选择 jdp-core-1.1.2.RELEASE.jar。
2. 右键点击 jdp-core-1.1.2.RELEASE.jar，选择 Add as Library…，设置库的名称（例如 My Local Library），并将其添加到项目的模块依赖中。

步骤三： Maven 添加系统依赖

<dependency>
  <groupId>com.dz.jdp</groupId>
  <artifactId>jdp-core</artifactId>
  <version>1.1.2.RELEASE</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/src/main/resources/libs/jdp-core-1.1.2.RELEASE.jar</systemPath>
</dependency>

步骤三：在代码中使用 JAR 包中的类

一旦 JAR 包被添加为库，你就可以在代码中使用其中的类了。例如：

import com.gsww.jdp.MyClass; // 假设 MyClass 是 jdp-core-1.1.2.RELEASE.jar 包中的一个类  
  
@SpringBootApplication  
public class MyApplication {  
    public static void main(String[] args) {  
        MyClass myClass = new MyClass();  
        // 使用 myClass 中的方法  
        SpringApplication.run(MyApplication.class, args);  
    }  
}

四、注意事项

1. 使用本地 JAR 包通常不是最佳实践，因为它会导致项目依赖于特定路径上的文件，这不利于项目的可移植性和协作开发。在可能的情况下，最好将依赖发布到公共或私有
   Maven 仓库中。
2. 如果使用 Maven 添加系统依赖，请确保在团队开发中，每个成员都知道如何正确配置本地的 Maven 仓库和 pom.xml 文件。
3. 在提交项目到版本控制系统（如 Git）时，不要将本地 JAR 包一起提交，因为这样做会增加仓库的大小，并可能导致其他开发者无法正确构建项目。

五、总结

加载本地 JAR 包到 Spring Boot 项目中，可以通过手动复制 JAR 包到项目目录，并在 IDE 中添加为库，或者使用 Maven 的系统依赖功能来实现。在实际开发中，应优先考虑将依赖发布到公共或私有 Maven 仓库，以便更好地管理和协作开发。

六、将 JAR 文件安装到本地 Maven 仓库（新）

可以使用 Maven 的 install:install-file 命令将 JAR 文件安装到本地 Maven 仓库中。这样，Maven 就可以像处理其他 Maven 中央仓库中的依赖一样来处理这个 JAR 文件了。

mvn install:install-file -Dfile=libs/jdp-core-1.1.2.RELEASE.jar -DgroupId=com.dz.jdp -DartifactId=jdp-core -Dversion=1.1.2.RELEASE -Dpackaging=jar

安装后，可以在 pom.xml 中像下面这样声明依赖，而不需要指定 systemPath：

<dependency>  
    <groupId>com.google.code.gson</groupId>  
    <artifactId>gson</artifactId>  
    <version>2.8.5</version>  
</dependency>