关于自定义程序打包成jar包，并读取配置

ゝ一纸荒年。 2024-03-23 18:55 55阅读 0赞

### 前言 ###

在实际开发过程中，我们有时候有把你编写的一段程序打成jar包的需求，而一些配置是需要去配置文件里面读取关于这项目的一些配置，本人在网络上查询了众多的资料，总的来说可以归为3类

#### 1.从数据库读取配置 ####

老生常谈，在dao层从数据库获取配置信息，然后返回到Service层进行业务逻辑处理

#### 2.在每次调用这个jar的时候通过关键字去读取配置 ####

在这一类中，方法有很多，不过大体都是

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>InputStream ins = getClass().getResourceAsStream(</code><code>"/resource/dbconfig.properties"</code><code>);</code> </td> 
 </tr> 
 </tbody> 
</table>

通过IO流对配置文件进行读取，然后再从 InputStream 流中读取数据，没什么技术含量，便不多讲

例如以下例子，就是通过Properties流来读取配置

![复制代码][61b6f129a712a1a0b19cd1209c5e3758.gif]

/**
         * 读取配置文件属性
         * @param path  配置文件路径
         * @return
         * @throws IOException
         */
        public Map readerConfigurationFile(String path) throws IOException {
            /**
             * 使用Properties读取配置文件并获取配置信息
             */
            Properties properties = new Properties();
            InputStream input = new BufferedInputStream(new FileInputStream(path));
            properties.load(input);
    
            /**
             * 将获取到的配置信息转存到map集合
             */
            Map map = new HashMap();
            for (Object key : properties.keySet()) {
                if (properties.get(key) != null && !properties.get(key).toString().trim().equals("")){
                    map.put(key,properties.get(key));
                }
            }
            return map;
        }

![复制代码][c86e701db9aea4b926b323d906f3cdb7.gif]

#### 3.通过Spring 自动装配，在项目启动时就把配置信息发送到jar包里面（强烈推荐） ####

这个方法虽然前期建立的时候比较繁琐，但是完成之后简直方便到飞起

首先，建立一下格式的结构，方便我们后面能够快捷找到要编写的文件

![3be6cee43a3039bef1f9287aab6e90f9.png][]

实际上DemoApplication.java 是可以去掉的，只是个人为了方便测试写的代码，看是否有bug就留下来启动项目用的

最最最重要的pom.xml文件应该这样写：

![复制代码][44ef01ab57be361ba2d815fcc50844b2.gif]

<?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.transfer</groupId> <artifactId>DataTransferService</artifactId> <version>0.0.1-SNAPSHOT</version> <name>DataTransferService</name> <description>DataTransferService</description> <properties> <spring-boot.version>2.6.13</spring-boot.version> </properties>
 
 
 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-jdbc</artifactId>
 </dependency>
 
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-autoconfigure</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
 </dependency>
 
 
 <dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <scope>provided</scope>
 </dependency>
 
 
 <dependency>
 <groupId>mysql</groupId>
 <artifactId>mysql-connector-java</artifactId>
 <version>8.0.28</version>
 <scope>runtime</scope>
 </dependency>
 </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.apache.maven.plugins</groupId>
 <artifactId>maven-compiler-plugin</artifactId>
 <configuration>
 <source>8</source>
 <target>8</target>
 </configuration>
 </plugin>
 </plugins>
 </build>
 
 </project>

![复制代码][b91b212407b76c431f99920ff6eabbe0.gif]

在config包里面，我们要建立几个配置文件：

UserConfiguration.java

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>@Slf4j</code> <code>@Configuration</code> <code>@ConditionalOnExpression</code><code>(</code><code>"${enabled:true}"</code><code>)</code> <code>@EnableConfigurationProperties</code><code>(UserConfiguration .</code><code>class</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserConfiguration { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Primary</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>UserConfig getConfigValue(UserProperties properties){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(properties.getLog()){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"数据库中转服务API组件 ——&gt; 开启组件"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>new</code>&nbsp;<code>UserConfig()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.setOtherDataSourcesMap(properties.getOtherDataSourcesMap())</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.setLog(properties.getLog());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

UserConfig.java

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Data</code> <code>@Accessors</code><code>(chain =&nbsp;</code><code>true</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserConfig&nbsp;</code><code>implements</code>&nbsp;<code>Serializable { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Map&lt;String,Map&lt;String,Map&lt;String,Object&gt;&gt;&gt; otherDataSourcesMap;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/** 是否打印操作日志 */</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Boolean log =&nbsp;</code><code>true</code><code>;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

UserProperties.java

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>@Data</code> <code>@ConfigurationProperties</code><code>(prefix =&nbsp;</code><code>"User"</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserProperties&nbsp;</code><code>implements</code>&nbsp;<code>Serializable { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Map&lt;String,Map&lt;String,Map&lt;String,Object&gt;&gt;&gt; otherDataSourcesMap;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/** 是否开启 */</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>boolean</code>&nbsp;<code>enabled =&nbsp;</code><code>true</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/** 是否打印操作日志 */</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Boolean log =&nbsp;</code><code>false</code><code>;</code> <code>}&lt;br&gt;请注意：这里的</code><code>@ConfigurationProperties</code>&nbsp;<code>注解里面的 prefix 参数指的是在配置文件中你自己定义的标识符</code> </td> 
 </tr> 
 </tbody> 
</table>

UserBeanInject.java

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserBeanInject { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* 注入配置Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* @param config 配置对象</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code><code>(required =&nbsp;</code><code>false</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setConfig(UserConfig config){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>UserSpi.setConfig(config);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

当然，还有重要的一步，那就是在resources文件夹下创建一个Spring自动装配的约定文件，使得我们这几个java配置文件能够生效

![1f82a0e50680685d22caefbf35664db9.png][]

spring.factories

# Auto Configure
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
      自己定义的包路径.configuration.UserConfiguration, \
      自己定义的包路径.configuration.UserBeanInject

然后，我们要暴露这个接口

UserSpi.Java

![复制代码][325a85e1a1cb42586a9b2baa5d7c4cab.gif]

@Slf4j
    public class UserSpi{
        public volatile static UserConfig config;
    
        public static void setConfig(UserConfig config){
            UserSpi.config = config;
            if (config.getLog()){
                log.info("数据库中转服务API组件 ——> 打印配置信息\n", JSONUtil.toJsonStr(UserSpi.config));
            }
        }
    
        // =================== 获取Api 相关 ===================
    
        public static IUserService api = new UserServiceImpl();
    }

![复制代码][273e605180d278c6397ae0436e3de37c.gif]

这样基本上完成jar自动装配外部配置文件的配置，业务逻辑什么的看个人习惯自己去编写

### 感言 ###

*  从数据库里面读取配置信息方便时挺方便的，但是在高并发与高请求的项目中并不适用，而每次调用这个jar的时候通过关键字去读取配置会造成内存资源不断被刷新，容易内存爆炸，个人推荐第3种方式。
 *  还有，每次该改写完代码，一定要重新构建项目，重新编译一下，不然你打出来的Jar包，永远都是你改写之前的代码，改写之后的代码不会写入到Jar包里面！！！！
 *  对了，直接把配置文件里面的值直接传递到jar包里面也是一种方法，但是要是被半路拦截，岂不是直接泄露数据，故不提倡，还有一点，就是代码的可维护性会变得很低

[61b6f129a712a1a0b19cd1209c5e3758.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/a068d4a6fd5e4412824770fadca0e897.png
[c86e701db9aea4b926b323d906f3cdb7.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/2b52fb86ffa5420e85505ea657280d72.png
[3be6cee43a3039bef1f9287aab6e90f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/e2636099b8a842f59503a2ce86a9c5ec.png
[44ef01ab57be361ba2d815fcc50844b2.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/6b8d301781cf406f8fbd76d0557b5c45.png
[b91b212407b76c431f99920ff6eabbe0.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/fbb88c38d6db4ccea0952e16f8d71c03.png
[1f82a0e50680685d22caefbf35664db9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/315229176e2e46c8a69e4e53f8bdaf7c.png
[325a85e1a1cb42586a9b2baa5d7c4cab.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/f87050a86cc146cbbd1cfdb8e74d7379.png
[273e605180d278c6397ae0436e3de37c.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b16ae27abb534c4691e14438615b51dc.png