spring-boot-configuration-processor(生成自定义配置的元数据信息)

1 相关案列

平时在我们的springBoot项目中,可能会有许多的配置文件。如下图:

图中红色框框住的地方显示和我们的yml文件是不一样的,没有被我们的spring管理。

此时可以点击File>>>Project Structure 

之后点击我们的spring配置后选择+号,然后选择自己想要被spring管理的配置文件 

但是此时我们配置文件中自定义的属性点击不会跳转。如:你在yml文件中点击port或其他属性都会自动跳转。但是你在自己的配置文件下点击确不会有任何反应。

 此时我们可以在依赖中引入如下依赖,然后重新启动项目:

        <!--生成自定义配置的元数据信息-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

以下是自己的配置:


@ConfigurationProperties(prefix="wxpay") //读取wxpay节点
@Data //使用set方法将wxpay节点中的值填充到当前类的属性中
public class WxPayConfig {

    // 商户号
    private String mchId;

    // 商户API证书序列号
    private String mchSerialNo;

    // 商户私钥文件
    private String privateKeyPath;

    // APIv3密钥
    private String apiV3Key;

    // APPID
    private String appid;

    // 微信服务器地址
    private String domain;

    // 接收结果通知地址
    private String notifyDomain;

}

 发现自己所配置的属性ctrl点击也会跳转到相应位置。

2 原文解释

官网原文:

You can easily generate your own configuration metadata file from items annotated with @ConfigurationProperties by using the spring-boot-configuration-processor jar. The jar includes a Java annotation processor which is invoked as your project is compiled. To use the processor, include a dependency on spring-boot-configuration-processor.

翻译后:

通过使用spring boot配置处理器jar,您可以轻松地从带有@ConfigurationProperties注释的项生成自己的配置元数据文件。jar包含一个Java注释处理器,在编译项目时调用该处理器。要使用处理器,请包括对spring boot配置处理器的依赖关系。

通俗的说:这个依赖+@ConfigurationProperties注解就可以从自定义的配置类上生成元数据信息

posted @ 2022-07-18 09:12  小猪不会叫  阅读(152)  评论(0)    收藏  举报  来源