SpringBoot解析自定義yml文件的流程步驟

更新時間：2024年06月27日 10:02:47 作者：Winson.J

這篇文章主要介紹了SpringBoot解析自定義yml文件的流程步驟,文章通過代碼示例和圖文結合的方式給大家介紹的非常詳細, 對大家的學習或工作有一定的幫助,需要的朋友可以參考下

背景

公司產品微服務架構下有十幾個模塊，幾乎大部分模塊都要連接redis。每次在客戶那里部署應用，都要改十幾遍配置，太痛苦了。當然可以用nacos配置中心的功能，配置公共參數。不過我是喜歡在應用級別上解決問題，因為并不是每個項目都會使用nacos，做個知識儲備還是不錯的。

公共配置文件位置

公共配置文件

啟動本地redis（windows版）

啟動redis

當前redis 沒有數據

在這里插入圖片描述

初始化redis

這里的初始化和正常把redis配置信息放到application.yml里的初始化是一樣的。

package cn.com.soulfox.common.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisOperations;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

/**
 * 
 * @create 2024/4/11 10:48
 */
@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Slf4j
public class RedisTemplateConfig {

    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<String, Object> getRedisTemplate(RedisConnectionFactory factory){
        log.info("開始初始化 RedisTemplate ------------------");
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        // key的序列化類型
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(new JdkSerializationRedisSerializer());
        redisTemplate.setValueSerializer(new JdkSerializationRedisSerializer());
        redisTemplate.setConnectionFactory(factory);
        log.info("初始化 RedisTemplate 結束------------------");
        return redisTemplate;
    }
}

解析自定義sf-redis.yml

package cn.com.soulfox.business.config;

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.FileSystemResource;
import org.springframework.stereotype.Component;

/**
 * 
 * @create 2024/6/26 16:41
 */
@Configuration
public class CommonConfig {
    
    @Bean("common-config")
    public static PropertySourcesPlaceholderConfigurer properties() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();

        YamlPropertiesFactoryBean redis = new YamlPropertiesFactoryBean();
        //文件路徑寫死的，真正做項目時，文件路徑可以配置到application.yml文件
        FileSystemResource redisResource = new FileSystemResource("../common-config/sf-redis.yml");
        redis.setResources(redisResource);
		configurer.setPropertiesArray(redis.getObject());
		
		//如果有多個配置文件，也是可以處理的。setPropertiesArray(Properties... propertiesArray)方法的參數是個數組，
		//如下還可以同時處理文件sf-ports.yml,此時configurer.setPropertiesArray(redis.getObject());代碼要注釋掉
		
		//YamlPropertiesFactoryBean ports = new YamlPropertiesFactoryBean();
//        FileSystemResource portsResource = new FileSystemResource("../common-config/sf-ports.yml");
//        ports.setResources(portsResource);
		//同時添加sf-redis.yml和sf-ports.yml的配置信息
//        configurer.setPropertiesArray(redis.getObject(), ports.getObject());
        return configurer;
    }
}

應用啟動類

注意一下，因為我已經搭建了完整的微服務，包括nacos，mybatis，feign等，所有啟動類上注解比較多。如果只是單純測試一下，引入springboot基礎框架和redis依賴，寫一個基礎啟動類就可以了。

package cn.com.soulfox.business;

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.PathResource;
import org.springframework.core.io.Resource;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import tk.mybatis.spring.annotation.MapperScan;

import java.io.File;

@SpringBootApplication
@EnableDiscoveryClient//nacos注冊中心
@EnableFeignClients(basePackages = {"cn.com.soulfox.common.feign.client"})//feign掃描
@MapperScan(basePackages={"cn.com.soulfox.*.mvc.mapper"})//mybatis mapper掃描
@EnableTransactionManagement//開啟數據庫事務
@ComponentScan("cn.com.soulfox")
public class BusinessApplicationRun {

	public static void main(String[] args) {
		SpringApplication.run(BusinessApplicationRun.class, args);
	}

}

啟動一下應用看看redis是否初始化成功

在這里插入圖片描述

測試一下是否可以正常使用

單元測試類

package cn.com.soulfox.common.config;

import cn.com.soulfox.business.BusinessApplicationRun;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.test.context.junit4.SpringRunner;

/**
 * 
 * @create 2024/6/26 16:52
 */
@RunWith(SpringRunner.class)
@SpringBootTest(classes = BusinessApplicationRun.class,
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class CommonConfigTest {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    //文件sf-redis.yml里屬性的使用和applications.yml一樣
    @Value("${spring.redis.host}")
    private String redisHost;

    @Test
    public void test(){
        System.out.println("從文件取參數測試+++++++++++");
        System.out.println("redisHost: " + redisHost);
    }
}

測試sf-redis.yml屬性使用

使用方法和配置在application.yml文件是一樣，都是通過@Value注解獲取

測試結果

在這里插入圖片描述

測試redis是否可以正常使用

測試寫入數據，增加以下測試方法

	@Test
    public void testRedisSetValue(){
        this.redisTemplate.opsForValue().set("test", "test123");
    }

測試結果

在這里插入圖片描述

測試讀取數據，增加以下測試方法

	@Test
    public void testRedisGetValue(){
        Object testValue = this.redisTemplate.opsForValue().get("test");
        System.out.println(testValue);
    }

測試結果

在這里插入圖片描述