SpringBoot的配置文件相关注解初步认识记录

如何读取配置文件，以下注解表示，对应配置文件里这一段wechat.cp

@ConfigurationProperties(prefix = "wechat.cp")

通常定义一个实体对应该配置文件的属性，例如：

@Getter
@Setter
@ConfigurationProperties(prefix = "wechat.cp")
public class WxCpProperties {
    /**
     * 设置企业微信的corpId
     */
    private String corpId;

    private List<AppConfig> appConfigs;

    @Getter
    @Setter
    public static class AppConfig {
        /**
         * 设置企业微信应用的AgentId
         */
        private Integer agentId;

        /**
         * 设置企业微信应用的Secret
         */
        private String secret;

        /**
         * 设置企业微信应用的token
         */
        private String token;

        /**
         * 设置企业微信应用的EncodingAESKey
         */
        private String aesKey;

    }

    @Override
    public String toString() {
        return JSON.toJSONString(this);
    }
}

如何使用，例如：

 

注入配置文件对应的实体类， 然后就能直接获取配置的值。

List<WxCpProperties.AppConfig> appConfigs = properties.getAppConfigs();
            Integer checkinSp = appidProperties.getCheckinSp();
            Optional<WxCpProperties.AppConfig> config = appConfigs.stream().filter(a -> a.getAgentId().equals(checkinSp)).findFirst();
            if (config.isPresent()) {
                WxCpProperties.AppConfig appConfig = config.get();
                corpId = properties.getCorpId();
                corpSecret = appConfig.getSecret();
            }

 注意点：springboot想要注入一个类，必须要让该类被spring @componentScan扫描到。

如何让一个类被spring扫描到呢？

@Component、@Configuration等，在类上加入这类注解都可以让sping管理该类。

遇到问题：

这个配置文件类并没有写@Component、@Configuration这样的注解，

@Getter、@Setter是lombok提供get、set方法的注解，

@ConfigurationProperties是指定配置文件下哪一块配置区域的注解

并没有其他能让spring @componentScan扫描到的注解。

 

 原来在使用配置类的地方，加上@Component及@EnableConfigurationProperties({WxCpProperties.class})就是这个作用。

@Resource和@Autowired作用差不多，一个是J2EE提供的注入，一个是spring提供的，可能@Autowired功能更强一点。

@EnableConfigurationProperties：字面意思来看“启用配置”，具体使用spring配置文件的方法有好几种，链接

@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "wechat.cp.appid")
public class WxCpAppidProperties {
    /**
     * 打卡appid
     */
    private Integer checkin;

    /**
     * 审批appid
     */
    private Integer checkinSp;

    @Override
    public String toString() {
        return JSON.toJSONString(this);
    }
}

 比如另一个配置文件类上，已经有@Configuration这个注解了，那在使用类上就不用加

@EnableConfigurationProperties这个类啦

疑问：

在研究@EnableConfigurationProperties作用的时候，我想确定是不是真的起作用，就把这个注解去掉了，

但是结果显示还是能获取到配置内容，我很疑惑

 这是怎么回事？？？不是说在配置类不加@Component、@Configuration这样的注解，就不能使用吗？

原来，这个类被其他地方已经使用。

 并且已经使用相关注解。

 由此发现，只要该类被spring @componentScan扫描到一次，就可以啦。但为了保险起见，还是在每个调用的地方都加上

@Configuration @EnableConfigurationProperties(WxCpProperties.class)。

其他：在研究Binary Wang对微信配置文件使用的代码时，看到下面这段：

    @PostConstruct
    public void initServices() {
        cpServices = this.properties.getAppConfigs().stream().map(a -> {
            val configStorage = new WxCpDefaultConfigImpl();
            configStorage.setCorpId(this.properties.getCorpId());
            configStorage.setAgentId(a.getAgentId());
            configStorage.setCorpSecret(a.getSecret());
            configStorage.setToken(a.getToken());
            configStorage.setAesKey(a.getAesKey());
            val service = new WxCpServiceImpl();
            service.setWxCpConfigStorage(configStorage);
            routers.put(a.getAgentId(), this.newRouter(service));
            return service;
        }).collect(Collectors.toMap(service -> service.getWxCpConfigStorage().getAgentId(), a -> a));
    }

@PostConstruct：让spring启动的时候就执行的方法，这样程序一启动，配置文件就加载好啦，针不错