使用 Maven 包含本地依赖包并打包部署到服务器的实践

哈哈哈哈哈哈哈哈853
1,281 阅读3分钟

使用 Maven 包含本地依赖包并打包部署到服务器的实践

在使用 Spring Boot 开发项目时，我们通常会通过 Maven 来管理依赖。但是有时候，我们需要引用一些本地的 JAR 包，而这些包并没有在公共 Maven 仓库中，这就需要我们手动将这些本地依赖包打包到最终的可执行文件中，以便在服务器上进行部署。本文将介绍如何在 Maven 中配置本地依赖包并确保它们能够顺利地打包和部署。

项目背景

我们在一个 Spring Boot 项目中需要使用一些本地的 JAR 包，例如 jntoo-query.jar、ueditor-mini.jar 和 jxl.jar。这些包并没有上传到 Maven 的公共仓库，但我们又需要确保它们在项目打包和部署时能够被包含。因此，我们需要对 Maven 的配置文件 pom.xml 进行一些调整。

解决方案概述

为了确保本地依赖包在打包时能够被正确包含，我们主要做了以下几个步骤：

  1. 在 pom.xml 中添加本地依赖配置
    通过 <dependency> 标签来定义本地依赖，并使用 systemPath 指定本地 JAR 文件的路径。

  2. 配置资源文件的路径
    在 Maven 的 <resources> 标签下，配置资源文件的路径，以确保这些 JAR 包在打包时被包含进来。

  3. 调整项目结构
    将原本在 webapp 目录下的本地包移到 resources 目录中，使得项目结构更加规范，并方便管理这些依赖。

具体实现步骤

1. 添加本地依赖配置

在 pom.xml 中，我们可以使用如下的配置来定义本地依赖包：

<dependency>
    <groupId>jntoo-query</groupId>
    <artifactId>jntoo-query</artifactId>
    <version>1.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/src/main/resources/lib/jntoo-query.jar</systemPath>
</dependency>
<dependency>
    <groupId>ueditor-mini</groupId>
    <artifactId>ueditor-mini</artifactId>
    <version>1.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/src/main/resources/lib/ueditor-mini.jar</systemPath>
</dependency>
<dependency>
    <groupId>jxl</groupId>
    <artifactId>jxl</artifactId>
    <version>1.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/src/main/resources/lib/jxl.jar</systemPath>
</dependency>

在这里，systemPath 属性指定了本地 JAR 文件的位置。注意，这种方式虽然能够解决本地依赖问题，但并不是最佳实践，特别是在团队开发或 CI/CD 环境中，因为路径是硬编码的，可能会在不同的环境中引发问题。不过对于一些临时性或特殊的需求，这种方式还是可行的。

2. 配置资源文件路径

为了确保本地依赖包在打包时被包含，我们还需要在 pom.xml 中配置资源路径：

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <includes>
            <include>lib/*.jar</include>
        </includes>
    </resource>
</resources>

这段配置告诉 Maven 在打包时将 src/main/resources/lib 目录下的 JAR 文件包含在最终的包中。

3. 调整项目结构

为了更好地管理本地依赖包，我们将这些 JAR 文件从 webapp 目录移动到了 resources 目录下。这样做的好处是，resources 目录中的文件会被默认包含在打包的 JAR 文件中，而且这种项目结构更加符合 Maven 的最佳实践。

打包和部署

配置完成后，我们可以使用以下命令进行打包：

mvn clean package

Maven 会根据配置将所有的依赖（包括本地依赖）打包到最终的 JAR 文件中。然后，你就可以将这个 JAR 文件部署到服务器上，确保它能够运行。

总结

在 Spring Boot 项目中包含本地依赖包并打包部署并不是一件复杂的事情，只需要在 pom.xml 中做一些配置即可。通过本文的实践，我们能够顺利地将本地 JAR 包打包进最终的可执行 JAR 文件中，并在服务器上进行部署。这种方式虽然简单有效，但仍需注意本地依赖路径的管理，以避免在不同环境中出现路径不一致的问题。

希望这篇文章能对你有所帮助。如果你在项目中也遇到了类似的问题，可以参考本文的方法进行配置。如果有其他问题或建议，欢迎留言讨论！

avatar
文章
阅读
粉丝