springboot家族之 configuration-processor加载配置文件注入(三)

文件处理器，Spring Configuration Processor，它的作用和 主配置文件application.properties或者application.yml里面的spring.profiles.active有着相似的作用，但是不同的是，使用spring.profiles.avtive,你添加的其他配置文件命名格式只能是application-{name}.properties或者application-{name}.yml，而使用文件处理器这个依赖，则对文件名没有任何约束。
springboot中获取配置文件的方式，通常大家最常用的是@Value("${mail.username}")的形式，也可以用spring-boot-configuration-processor来更优雅得读取配置文件。下面讲下具体用法。

1. 引入pom文件

在使用idea创建springboot项目的时候，可以选择。

也可以直接引入pom文件

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

2. 定义配置文件

mail.username=wjh
mail.password=wjh123

3. 新建配置文件读取类

@Data
@Configuration
@EnableConfigurationProperties(MailConfig.class)
@ConfigurationProperties(prefix = MailConfig.PREFIX, ignoreInvalidFields = true)
public class MailConfig {

    public static final String PREFIX = "mail";
     // 这里对应配置文件中的mail前缀

    private String username;

    private String password;
}

@Component
@PropertySource(value = {"classpath:static/config/authorSetting.properties"},
        ignoreResourceNotFound = false, encoding = "UTF-8", name = "authorSetting.properties")
public class Author {
 
    @Value("${author.name}")
    private String name;
    @Value("${author.age}")
    private int age;
}

/*value:加载配置文件的路径。 
  ignorResourceNotFound: 指定是否忽略 配置文件不存在的 报错提示。
  默认是false（不忽略，不存在则报错）
  encoding: 指定读取属性文件所使用的编码。
  当使用@value注入的属性较多时，代码会显得很冗杂，
  于是@ConfigurationProperties(prefix="author") 登场。*/

@Data
@Configuration
@EnableConfigurationProperties(Author.class)
@ConfigurationProperties(prefix = Author.PREFIX, ignoreInvalidFields = true)
@PropertySource(value = {"classpath:static/config/authorSetting.properties"},
        ignoreResourceNotFound = false, encoding = "UTF-8", name = "authorSetting.properties")
public class Author {
    public static final String PREFIX = "author"; // 这里对应配置文件中的mail前缀
    private String name;
    private String age;
}

4.取用配置

先注入配置文件类
取配置文件

@RestController
@EnableConfigurationProperties
public class DemoController {
 
    @Autowired
    Author author;
    @Autowired
	private MailConfig mailConfig;
	
 
    @RequestMapping("/index")
    public String index(){
    String userName = mailConfig.getUsername();
        return "author's name is " + author.getName() + ",ahtuor's age is " + author.getAge()+",userName is"+userName;
    }
}

用get的方式即可取到配置文件，并且在配置文件中也可以自动提示，个人觉得这种取用方式更为优雅。