springboot自定义工具类构建打包踩坑经历

艾-普-西-隆

已于 2022-04-15 14:29:02 修改

阅读量5.8k

点赞数 10

分类专栏： springboot 文章标签： springboot 自定义工具类静态方法注入变量

于 2022-04-13 17:17:17 首次发布

本文链接：https://blog.csdn.net/a20100997/article/details/124143470

版权

springboot 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

前言

1、如何打包一个工具类？

2、如何在工具类中引入第三方jar包？

3、如何在调用工具类时能够正确识别工具类中的静态资源？

4、如何在静态方法中注入变量？

如果你有以上问题，请看下去，相信对你有帮助。

1、打包

2、正确识别工具包中的静态资源

3、静态方法中使用配置文件

最近把项目里的一些零散的工具整理了下，心想干脆封装成一个工具类，之后便于复用。由于之前没有封装过工具类，过程中间花了很多时间，踩了很多坑，这里记录下，希望对大家有帮助。

首先看下我的项目结构：

项目结构非常简单，工具类就放在com.dimpt.holiday.util路径下。需要注意的是这个工具类中会使用到一些静态的资源文件，放在resources/static目录下，这些文件是工具类运行所必须的。

再看下pom文件：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.dimpt</groupId>
    <artifactId>holiday</artifactId>
    <version>0.0.1</version>
    <name>HolidayUtil</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
    </properties>

    <dependencies>
        ......
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal><!--可以把依赖的包都打包到生成的Jar包中-->
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>8</source><!--确保IDEA不会自动重置source-->
                    <target>8</target>
                </configuration>
            </plugin>

        </plugins>
    </build>

</project>

此处省略了dependency的内容，着重看下build标签里的两个plugin。第一个是打包工具spring-boot-maven-plugin，相信大家都比较熟悉，里面的<goal>repackage</goal>会把依赖的包也一同生成。第二个plugin是为了保证修改maven依赖后IDEA不会自动将source重置，参考这个链接解决IDEA自动重置LanguageLevel和JavaCompiler版本的问题_isea533的博客-CSDN博客_idea的language level

1、打包

问：如何打包一个工具类？

答：这有什么难的，不就是打包一个jar，实在小case。

于是熟练的在命令行敲入以下命令：

mvn clean package

稍等一会儿，target目录下就生成了一个刚出炉的jar包：

太简单了吧，现在把它引人到其他项目中试一试。

首先将生成的jar包放入resources的lib目录下，并在pom文件中加入引用。

<dependency>
            <groupId>com.dimpt</groupId>
            <artifactId>holiday</artifactId>
            <version>0.0.1</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/src/main/resources/lib/holiday-0.0.1.jar</systemPath>
</dependency>

试着在代码里引用工具类的方法，可以看到飘红了，并且IDEA也给出了提示。

尝试import这个类，会发现无论怎么操作，都无法正确识别，即便加上全路径:

查看下此时项目目录下的jar包，可以看到里面确实没有com.dimpt.holiday的路径。

以上的打包方式是我们常用的微服务打包方式，但并不适用于工具类的打包。

正确的打包方式（以IDEA为例）：

步骤5是为了将工具包中依赖的三方包也打包进来（问题2 solved），不然工具包无法正常使用。

步骤9需要选择MANIFEST.MF文件的位置，放在resources目录下就可以。如果该目录下已有该文件，请先删除。

之后选择build->build artifacts，选择你刚才配置的artifact。之后等待build完毕，在目标目录下应该可以看到最终打包成功的jar包。

好的，我们再次尝试将生成的jar包引入其他项目中，发现已经能够正常使用：

此时我们再次查看jar的目录结构，可以看到工具类的引用路径已经存在，并且工具类引用到的其他包也都正确导入了。（问题1 solved）

好的，到这里小伙伴们应该能够解决文章开头的问题1和问题2了。

2、正确识别工具包中的静态资源

好的，让我们把项目跑起来，试着调用工具类中的方法，这里我的工具类中需要一些内部的静态资源，但是程序却抛出异常：无法找到该静态文件。

这就奇怪了，明明单独测试跑工具类的时候没有问题，怎么打成工具包引入后就找不到静态资源了？

因为打包后的工具类不能使用ClassPathResource的形式找资源，ClassPathResource会去找你项目resources中的资源，而不是三方jar包中的静态资源！

我们要使用以下方法加载工具包内部的静态资源：

这种方式才能够正确去找你工具包中的资源！（问题3 solved）

3、静态方法中使用配置文件

工具类中我们一般会定义一些静态方法，如果静态方法需要读取配置文件怎么办？

如果用传统的@Value方式尝试加载application.properties中的配置，程序运行中会发现始终读取到的是null！

那么如何正确的让静态方法读取配置？

我们可以先在工具类中定义一个配置Config。配置中定义的就是静态方法需要注入的参数，我这里定义了两个，并都设置了默认值。注意init方法（方法名字随便取），使用了@PostConstruct注解，这是重点。

工具类中需要定义一个setConfigInfo方法：

@PostConstrust注解会在构造函数之后自动执行。

如果你试着运行代码，会发现Config会先加载，并通过@Value注解成功初始化Config中的两个私有变量，然后会运行init方法，该方法会调用工具类中的静态方法setConfigInfo，之后工具类中的静态私有变量就能够成功赋值了。当我们将工具类打包放入其他项目中时，就可以在项目的配置文件中增加相应的配置，工具类会自动识别并注入。

好的，以上就是自定义工具类的打包全过程，希望对大家有所帮助。