自定义序列,
一、引言在实际的项目开发过程中,我们经常需要从代码中提取一些变量放入配置文件中,以便更加统一灵活地管理服务配置信息。比如数据库、eureka、zookeeper、redis、mq、kafka等服务组件的连接参数配置,以及我们自定义的项目参数配置变量。
当然,其实根据目前的业务需求,我们往往会自定义参数,然后注入到代码中灵活使用!
SpringBoot项目启动时,默认加载前两个配置文件bootstrap.properties或bootstrap.yml(这两个优先级最高);application.properties或application.yml然后将被加载;如果配置了变量spring.profiles,则相应的应用程序-{profile}。属性或应用程序-{profile}。yml文件也将被加载。Profile是对应的环境变量,比如dev。如果没有配置,将加载profile=default的配置文件。
虽然说配置项都写在同一个配置文件里没问题,但是很多时候我们还是希望可以分开写,这样会更清晰。比如zookeeper的配置写在zookeeper.properties,数据库相关的配置写在datasource.properties等等。所以需要设置和加载外部配置文件!
如何实现?我们来看看吧!
二、代码练习2.1、通过@value注释进行参数加载当我们要将一个变量注入到一个类中时,可以简单的通过@value注释注入参数!
例如,在application.properties文件中,为config.name配置一个值为张三的变量键。
//参数定义
配置。name=zhangshan,然后在对应的类中,通过参数@value注入!
@RestController
公共类HelloController {
@Value(${config.name} )
私有字符串配置;
@GetMapping(config )
公共字符串配置(){
返回JSON . tojsonstring(config);
}
}使用@value注释注入配置。通常有一个要求,注释中的变量必须事先在application.properties文件中定义,否则启动会报错!
当然,如果我们不希望它出错,我们可以给它一个默认值xxx,比如:
@Value(${config.name:xxx} )
私有字符串配置;这样SpringBoot项目启动时就不会报错了!
2.2.参数加载是通过@ConfigurationProperties注释实现的。在某些场景下,@value标注并不能满足我们所有的需求。例如,参数配置的数据类型是对象或数组。此时只使用@ConfigurationProperties会是更好的选择!
配置对象类型的参数。
例如,在application.properties文件中,当我们想要配置一个对象类型的参数时,我们可以这样做!
//参数定义
配置2.name=demo_1
2.value=demo _ value _ 1然后,创建一个配置类Config2,用于将定义的变量映射到配置类中。
@组件
@ConfigurationProperties(前缀=config2 )
公共类配置2 {
公共字符串名称;
公共字符串值;
}读取数据的方式也很简单,直接注入到对应的类中即可。
@RestController
公共类HelloController {
@自动连线
私有配置2配置2;
@GetMapping(config2 )
公共字符串config2(){
返回JSON . tojsonstring(config 2);
}
}配置Map类型的参数
例如,在application.properties文件中,当我们想要配置Map类型的参数时,我们可以这样做!
//参数定义
config 3 . map 1 . name=演示_ id _ 1 _名称
config 3 . map 1 . value=演示_ id _ 1 _值
config 3 . map 2 . name=演示_ id _ 2 _名称
3.map2.value=demo _ id _ 2 _ value然后,创建一个配置类Config3,用于将定义的变量映射到配置类中。
@组件
@ConfigurationProperties(前缀=config3 )
公共类配置3 {
私有映射字符串,String Map 1=new HashMap();
私有映射字符串,String Map 2=new HashMap();
}读取数据的方式,与之类似!
@RestController
公共类HelloController {
@自动连线
私有配置3配置3;
@GetMapping(config3 )
公共字符串config3(){
返回JSON . tojsonstring(config 3);
}
}配置列表类型的参数
例如在应用程序。属性文件里,当我们想配置一个目录类型的参数,我们可以这样操作!
//参数定义
配置4 .用户列表[0].enable=maillist_1_enable
配置4 .用户列表[0].name=maillist_1_name
配置4 .用户列表[0].值=邮件列表_ 1 _值
配置4 .用户列表[1]。enable=maillist_2_enable
配置4 .用户列表[1]。name=maillist_2_name
配置4 .用户列表[1]。值=邮件列表_ 2 _值
配置4 .用户列表[2]。enable=maillist_3_enable
配置4 .用户列表[2]。name=maillist_3_name
配置4 .用户列表[2]。值=邮件列表_ 3 _值然后,创建一个配置类配置4,用于将定义的变量映射到配置类里面。
@组件
@配置属性(前缀=配置4 )
公共类配置4 {
个人分发名单用户实体用户名单;
公共列表用户实体getUserList() {
返回用户列表;
}
public void set userList(列出用户实体userList){
this.userList=用户列表
}
}公共类用户实体{
私有字符串使能;
私有字符串名称;
私有字符串值;
}读取数据的方式,与之类似!
@RestController
公共类HelloController {
@自动连线
专用配置四配置4;
@GetMapping(config4 )
公共字符串配置4(){
返回JSON。tojsonstring(配置4);
}
}2.3、通过@财产来源注解实现配置文件加载正如我们最开始所介绍的,很多时间,我们希望将配置文件分卡写,比如动物园管理员组件对应的服务配置文件是动物园管理员。属性,redis组件对应的服务配置文件是redis.properties等等。
这种自定义的配置文件,我们应该如何加载到春天容器里面呢?
其实方法也很简单,通过@财产来源就可以实现!
首先,我们在资源资源文件夹下,创建两个配置文件测试。属性和业务。属性,内容如下!
测试。属性文件内容:
aaa.a1=aa1123
aaa.a2=aa2123
aaa.a3=aa3123
AAA。a4=aa 4123业务。性能文件内容:
bbbb.a1=bb1123
bbbb.a2=bb2123
bbbb.a3=bb3123
bbbb.a4=bb4123在跳羚启动类上加载配置文件即可!
@SpringBootApplication
@ property source(value={ test。属性, bussiness.properties })
公共类PropertyApplication {
公共静态void main(String[] args) {
春季申请。运行(属性应用程序。class,args);
}
}读取数据的方式,与之类似!
@RestController
公共类HelloController {
@Value(${aaa.a2} )
私有字符串a2;
@Value(${bbbb.a1} )
私有字符串bbbbA1
@GetMapping(a2 )
公共字符串a2(){
返回JSON。tojsonstring(a2);
}
@GetMapping(bbbbA1 )
公共字符串bbbbA1(){
返回JSON。tojsonstring(bbbba 1);
}
}如果我们只是在业务中需要用到自定义配置文件的值,这样引入并没有什么问题;但是如果某些自定义的变量,在项目启动的时候需要用到,这种方式会存在一些问题,原因如下:
翻译过来的意思就是说:
虽然在@SpringBootApplication上使用@财产来源似乎是在环境中加载自定义资源的一种方便而简单的方法,但我们不推荐使用它,因为跳羚在刷新应用程序上下文之前就准备好了环境。使用@财产来源定义的任何键都加载得太晚,无法对自动配置产生任何影响。
因此,如果某些参数是启动项变量,建议将其定义在应用程序。属性或应用程序。阳明海运股份有限公司文件里面,这样就不会有问题!
或者,采用【自定义环境处理类】来实现配置文件的加载!
2.4、通过自定义环境处理类,实现配置文件的加载实现方法也很简单,首先,创建一个实现自环境后处理器接口的类,然后自行加载配置文件。
公共类MyEnvironmentPostProcessor实现环境后处理器{
@覆盖
公共空间后处理环境(可配置环境环境,SpringApplication应用程序){
String[] profiles={
测试。属性,
业务。属性,
blog.yml
};
对于(字符串配置文件:配置文件){
resource resource=新的类路径资源(profile);
environment.getPropertySources().添加最后一个(加载配置文件(资源));
}
}
私有财产来源?负载曲线(资源资源){
如果(!resource.exists()) {
抛出新的IllegalArgumentException(资源资源不存在);
}
if(resource.getFilename().包含(。yml)){
返回loadYaml(资源);
}否则{
返回加载属性(资源);
}
}
私有属性源loadProperty(资源资源){
尝试{
性能属性=新属性();
属性。加载(资源。getinputstream());
返回新的属性属性源(资源。getfilename(),属性);
}catch (Exception ex) {
引发新的IllegalStateException("加载配置文件失败资源,例如);
}
}
私有属性来源装入YAML(资源资源){
尝试{
yamlpropertiesforybean factory=new yamlpropertiesforybean();
工厂.设置资源(资源);
属性属性=工厂。getobject();
返回新的属性属性源(资源。getfilename(),属性);
}catch (Exception ex) {
引发新的IllegalStateException("加载配置文件失败资源,例如);
}
}
}接着,在资源资源目录下,我们还需要创建一个文件META-INF/spring.factories,通过串行外设接口(串行外设接口的缩写)方式,将自定义环境处理类加载到春天处理器里面,当项目启动时,会自动调用这个类!
#启用我们的自定义环境处理类
org。spring框架。靴子。环境。environmentpostprocessor=com。举例。财产。环境。myenvironmentpostprocessor
这种自定义环境处理类方式,相对会更佳灵活,首先编写一个通用的配置文件解析类,支持性能和阳明海运股份有限公司文件的读取,然后将其注入到春天容器里面,基本上可以做到一劳永逸!
2.5、最后,我们来介绍一下阳明海运股份有限公司文件读取在上文中,我们大部分都是以性能为案例进行介绍,可能有的人已经踩过坑了,在项目中使用@财产来源注解来加载阳明海运股份有限公司文件,结果启动直接报错,原因是@财产来源不支持直接解析阳明海运股份有限公司文件,只能解析性能文件。
那如果,我想单独解析阳明海运股份有限公司文件,也不想弄一个【自定义环境处理类】这种方式来读取文件,应该如何处理呢?
操作方式也很简单,以自定义的博客。阳明海运股份有限公司文件为例!
博客。阳明海运股份有限公司文件内容:
pzblog:
名称:helloWorld然后,创建一个读取阳明海运股份有限公司文件的配置类
@配置
公共类ConfigYaml {
@Bean
公共静态PropertySourcesPlaceholderConfigurer属性(){
propertysourceplaceholderconfigure=new propertysourceplaceholderconfigure();
yamlpropertiesforybean YAML=new yamlpropertiesforybean();
YAML。设置资源(新的类路径资源( blog。yml’));
配置器。设置属性(YAML。getobject());
返回配置器;
}
}读取数据的方式,与之类似!
@RestController
公共类HelloController {
@Value(${pzblog.name} )
私有字符串pzblogName
@GetMapping(pzblogName )
公共字符串pzblogName(){
返回JSON。tojsonstring(pzblogName);
}
}三、小结本文主要围绕跳羚加载配置文件的几种实现方式,做了一次内容总结,如果有遗漏的地方,欢迎网友批评指出!
四、参考1、跳靴官方文档
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。