从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 添加的配置文件，不管你是什么扩展名，只要是符合解析格式的。它就会给你解析出来。