如何让application.yml中的“魔法值”不魔法之application-*.properties文件

你有没有遇到过在Spring Boot项目中，application.yml中的一些参数需要在application-.properties文件中重复定义的情况？这些参数被称为“魔法值”，因为它们在代码中没有明确的定义，而是在配置文件中出现。这样做的问题是，如果你在application.yml中更改了一个参数，你还需要在所有的application-.properties文件中更改它，否则你的应用程序就会出现问题。

那么，有没有一种方法可以让这些“魔法值”不再那么神秘呢？答案是肯定的。你可以使用Spring Boot Configuration Processor来自动生成这些属性文件。这个处理器可以自动检测你的配置类，并生成与之对应的属性文件。

要使用Spring Boot Configuration Processor，你需要在你的项目中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

添加完依赖后，你需要在你的application.yml文件中添加一个配置：

spring:
  profiles:
    active: dev

这个配置告诉Spring Boot Configuration Processor，现在所处的环境为开发环境，你需要读取applcation-dev.properties文件中的常量来替换applcation.yml中的变量

例如：你现在需要配置MySQL的数据源，按照传统的做法，你应该会在application.yml中写出这样的配置：

spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
        username: root
        password: 123456

而这个有什么缺陷呢？
和魔法值有点相似之处，就是硬编码问题，如果我们项目后期需要测试部署，，这个时候测试和部署的环境坑不同，你还得手动调整，太麻烦了，如果你使用spring-boot-configuration-processor依赖，就不用担心这样的问题，因为我们可以定义多个环境的配置文件，其中的名称相同，只是值不同，springboot在识别到当前开发环境时，就会读取不同的文件，已达到效果，如下图：

spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://${self.spring.datasource.url}:${self.spring.datasource.port}/${self.spring.datasource.database}?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
        username: ${self.spring.datasource.username}
        password: ${self.spring.datasource.password}

总之，使用Spring Boot Configuration Processor可以让你的应用程序更加可维护和易于管理。它可以帮助你消除那些神秘的“魔法值”，让你的配置更加清晰和易于理解。