從args講到springboot全套配置體系架構（四）

四、springboot 多配置文件

爲什麼需要分配置文件？

我們的項目可能使用了各種各樣的組件，比如oss 比如 redis 比如 mq 比如對接的第三方api信息等等
想象一下如果你把這些配置統統裝到application.properties 中，會不會顯得很臃腫？
這就需要我們自定義配置文件了，那麼我們自定義的配置文件如何加入的springboot的配置體系下呢？

@PropertySource註解

我們在 resources 目錄下新建一個resources\redis.properties redis配置文件。
redis.properties

redis.host=127.0.0.1
redis.port=6379
redis.password=123456

新建一個RedisConfig.java

@Data
@Configuration
@PropertySource(value = {"classpath:redis.properties"})
@ConfigurationProperties(prefix = "redis")
public class RedisConfig {
    private String host;
    private String password;
    private int port;
}

這樣就實現了多配置文件的設置

@RestController
@RequestMapping("/user")
public class UserController {
    
    @Autowired
    RedisConfig redisConfig;
    
    @GetMapping("/get_user")
    public Result<User> getUser() {
        Result result = new Result();
        Map<String,Object> map=new HashMap<>();
        map.put("host",redisConfig.getHost());
        map.put("port",redisConfig.getPort());
        map.put("password",redisConfig.getPassword());
        String data=JSON.toJSONString(map);
        result.success(data);
        return result;
    }

}

反問接口就返回配置文件內容。

@PropertySources註解

這個註解是批量引入配置文件，它可以嵌套 @PropertySource 使用

@PropertySources({@PropertySource("classpath:redis.properties"),
@PropertySource("classpath:jdbc.properties")})

@PropertySource({"classpath:redis.properties","classpath:jdbc.properties"})

至少我覺得@PropertySource 就夠用了，前面這個本身就可以加載多個配置文件了，所以這個註解我是不怎麼用到。

@Value註解與@ConfigurationProperties(prefix = “redis”)

@Value和@ConfigurationProperties(prefix = “redis”)效果是一樣的，所以，以上程序還可以寫成這樣

@Data
@Configuration
@PropertySource(value = {"classpath:redis.properties"})
public class RedisConfig {
    @Value("${redis.host}")
    private String host;
    @Value("${redis.password}")
    private String password;
    //表達式冒號隔開的部分爲默認值，當取不到當前值時使用冒號後面的默認值
    @Value("${redis.port:1000}")
    private int port;
}

spring提供了這個@ConfigurationProperties(prefix = “redis”)簡化了以上代碼段的寫法，實質上沒有什麼特別的地方。所以不要糾結用哪個註解，能實現你的需求就可以了，沒有什麼高大上的東西。

注意的點

以上註解不支持yml配置文件，所以如果你需要用到多配置，請使用.properties 擴展名的配置文件
當然如果你非要用其他格式的文件擴展名，也不是不可以，只要你的內容按照如下格式編寫即可
只要符合這個格式，你就算把文件擴展名改爲.txt 或者乾脆不填也是可以的

格式1

redis.host: 127.0.0.1
redis.port: 6379
redis.password: 123456

格式2

redis.host=127.0.0.1
redis.port=6379
redis.password=123456

這也從側面反映出一個問題。使用@PropertySource 添加的配置文件，不管你是什麼擴展名，只要是符合解析格式的。它就會給你解析出來。