问题
在平时的项目中,经常会用到各种配置,比较基础和重要的有数据库连接参数,第三方服务的密钥,还有跟业务比较相关的,例如性别、年级,还有一些是内容管理需要配置的,比如轮播图、文案等需要动态调整的。
虽然以上都可以归为配置,但是在使用上,也有区别。比如说数据库连接参数,这种配置只跟环境有关,在特定的运行环境下几乎不变,配置的参数数量也不多,后面把这些配置统称为系统配置。
对于业务和领域相关的配置参数,跟环境没有关系,几乎也很少变动,主要随着业务变化而变化,或者对领域的认知有了变化,并且一般都需要修改代码。以年级配置为例,小学一般是 6 年级,这种配置参数一般是不会变化的,但是一旦出现变化,比如六年级取消,增加了初中预科,那么以前的六年级需要保留以应对历史数据的处理,同时需要增加一个新的初中预科配置参数,同时也要开发新的代码来处理初中预科的逻辑,后面把这些配置统称为业务配置。
最后一种是内容相关的配置,这种配置有较强的动态性,很多时候需要在系统运行期间进行修改,比如前面提到的轮播图,一旦有新的活动或者广告,都需要动态(不升级系统)改变参数,对于一些更加复杂的内容配置,甚至要开发专门的 cms 系统,在本文中,只覆盖简单的内容配置。这一类配置,后面统称为内容配置。
对于这三种配置,总结如下:
系统配置 | 业务配置 | 内容配置 | |
---|---|---|---|
运行期可变性 | 不可变 | 不可变 | 需要在运行时动态修改 |
改变后是否需升级 | 需要 | 需要 | 不需要 |
数据量 | 很少 | 较少 | 数量不定,一般随着系统功能增加而增加 |
系统配置的处理
Spring的系统配置放在一般放在application.yml中,如果是Spring cloud,则是在启动时从config service取服务,不管哪种情况用起来都一样。
系统配置一般需要在启动后运行前加载,Spring拿到配置后,才方便根据配置初始化bean。Spring提供了两种方式获取配置数据,一种是用@Value,另一种是用@ConfigurationProperties,如果配置参数比较多,用后一种比较好,并且这种方法还可以用校验注解,这样可以在系统运行前就简单检查配置参数是否有效。
aliyun:
access_id: aliyun_access_id
access_key: aliyun_access_key
oss:
endpoint: oss-cn-hangzhou.aliyuncs.com
bucket: your_oss_bucket
accessUrl: http://your_oss_bucket.oss-cn-hangzhou.aliyuncs.com
rds:
url: your_rds.rds-cn-hangzhou.aliyuncs.com
user: root
password: 123123123
对应的配置bean是
@Configuration
@ConfigurationProperties(prefix = ALiyunProperty.ALIYUN_PROPERTY_PREFIX)
@Validated
public class ALiyunProperty {
public static final String ALIYUN_PROPERTY_PREFIX = "aliyun";
@NotEmpty(message = "aliyun access_id should not be empty")
private String accessId;
private String accessKey;
private AliyunOSS oss;
private Rds rds;
// 忽略getter setter
public static class AliyunOSS {
private String endpoint;
private String bucket;
private String accessUrl;
// 忽略getter setter
}
public static class Rds {
private String url;
private String user;
private String password;
// 忽略getter setter
}
}
这段代码使用了@NotEmpty对accessId进行了校验,如果忘记提供该参数,Spring会启动失败,这样可以早点发现问题。
这个方法还有一个好处是可以使用嵌套的配置,其中oss和rds配置都是嵌套进来的,这样方便把一个领域的参数归在一起。
如果要使用配置参数,只需要在使用的地方@Autowire ALiyunProperty。
以上是系统配置的用法,后续会把业务配置和内容配置的补上。