|
关注后回复 “进群” ，拉你进程序员交流群 作者丨鸭血粉丝Tang 来源丨Java极客技术（ID：Javageektech） 一、简介 在实践的项目开发过程中，我们经常需求将某些变量从代码里面抽离出来，放在配置文件里面，以便愈加统一、灵活的管理效劳配置信息。好比，数据库、eureka、zookeeper、redis、mq、kafka 等效劳组件的衔接参数配置，还有我们自定义的项目参数配置变量。 当然，实践上依据当前的业务需求，我们常常会自定义参数，然后注入到代码里面去，以便灵活运用！ 今天，我们就一同来聊一聊 SpringBoot 加载配置文件的几种玩法，假如有遗漏，欢送留言！ SpringBoot 项目在启用时，首先会默许加载 bootstrap.properties 或者 bootstrap.yml 这两个配置文件（这两个优先级最高）；接着会加载 application.properties 或 application.yml ；假如何配置了 spring.profiles 这个变量，同时还会加载对应的 application-{profile}.properties 或者 application-{profile}.yml 文件， profile 为对应的环境变量，好比 dev ，假如没有配置，则会加载 profile=default 的配置文件。 固然说配置项都写在同一个配置文件没有问题，但是很多时分我们依旧希望能分开写，这样会比较明晰，好比 zookeeper 的配置写在 zookeeper.properties ，数据库相关的配置写在 datasource.properties 等等，因而就需求设置加载外部配置文件！ 细致该如何完成呢，我们一同来看看！ 二、代码理论 2.1、经过 @value 注解完成参数加载 当我们想要在某个类里面注入某个变量，经过 @value 注解就能够简单完成参数的注入！ 例如 application.properties 文件里，配置一个 config.name 的变量 key ，值为 zhangsan //参数定义 config.name=zhangsan 然后在对应的类里面，经过参数 @value 注入即可！ @RestController publicclassHelloController{ @Value( "${config.name}") privateString config; @GetMapping( "config") publicString config{ returnJSON.toJSONString(config); } } 运用 @value 注解注入配置，通常状况下有个请求就是，注解里面的变量，必须在 application.properties 文件里面事前定义好，否则启动报错！ 当然，假如我们不想让它抱错，我们能够给它一个缺省值 xxx ，好比： @Value( "${config.name:xxx}") privateString config; 这样，SpringBoot 项目在启用时不会报错！ 2.2、经过 @ConfigurationProperties 注解完成参数加载 某些场景下， @value 注解并不能满足我们一切的需求，好比参数配置的数据类型是一个对象或者数组，这个时分才用 @ConfigurationProperties 会是一个比较好的选择！
例如在 application.properties 文件里，当我们想配置一个对象类型的参数，我们能够这样操作！ //参数定义 config2.name=demo_1 config2.value=demo_value_1 然后，创建一个配置类 Config2 ，用于将定义的变量映射到配置类里面。 @Component @ConfigurationProperties(prefix = "config2") publicclassConfig2{ publicString name; publicString value; //...get、set } 读取数据的方式，也很简单，直接注入到对应的类里面就能够了 @RestController publicclassHelloController{ @Autowired privateConfig2 config2; @GetMapping( "config2") publicString config2{ returnJSON.toJSONString(config2); } }
例如在 application.properties 文件里，当我们想配置一个 Map 类型的参数，我们能够这样操作！ //参数定义 config3.map1.name=demo_id_1_name config3.map1.value=demo_id_1_value config3.map2.name=demo_id_2_name config3.map2.value=demo_id_2_value 然后，创建一个配置类 Config3 ，用于将定义的变量映射到配置类里面。 @Component @ConfigurationProperties(prefix = "config3") publicclassConfig3{ privateMap<String, String> map1 = newHashMap<>; privateMap<String, String> map2 = newHashMap<>; //...get、set } 读取数据的方式，与之相似！ @RestController publicclassHelloController{ @Autowired privateConfig3 config3; @GetMapping( "config3") publicString config3{ returnJSON.toJSONString(config3); } }
例如在 application.properties 文件里，当我们想配置一个 List 类型的参数，我们能够这样操作！ //参数定义 config4.userList[0]. enable=maillist_1_enable config4.userList[0].name=maillist_1_name config4.userList[0].value=maillist_1_value config4.userList[1]. enable=maillist_2_enable config4.userList[1].name=maillist_2_name config4.userList[1].value=maillist_2_value config4.userList[2]. enable=maillist_3_enable config4.userList[2].name=maillist_3_name config4.userList[2].value=maillist_3_value 然后，创建一个配置类 Config4 ，用于将定义的变量映射到配置类里面。 @Component @ConfigurationProperties(prefix = "config4") publicclassConfig4{ privateList<UserEntity> userList; publicList<UserEntity> getUserList{ returnuserList; } publicvoidsetUserList(List<UserEntity> userList){ this.userList = userList; } } publicclassUserEntity{ privateString enable; privateString name; privateString value; //...get、set } 读取数据的方式，与之相似！ @RestController publicclassHelloController{ @Autowired privateConfig4 config4; @GetMapping( "config4") publicString config4{ returnJSON.toJSONString(config4); } } 2.3、经过 @PropertySource 注解完成配置文件加载 正如我们最开端所引见的，很多时间，我们希望将配置文件分卡写，好比 zookeeper 组件对应的效劳配置文件是 zookeeper.properties ， redis 组件对应的效劳配置文件是 redis.properties 等等。 这种自定义的配置文件，我们应该如何加载到 Spring 容器里面呢？ 其实措施也很简单，经过 @PropertySource 就能够完成！ 首先，我们在 resources 资源文件夹下，创建两个配置文件 test.properties 和 bussiness.properties ，内容如下！ test.properties 文件内容： aaa.a1=aa1123 aaa.a2=aa2123 aaa.a3=aa3123 aaa.a4=aa4123 bussiness.properties 文件内容： bbbb.a1=bb1123 bbbb.a2=bb2123 bbbb.a3=bb3123 bbbb.a4=bb4123 在 SpringBoot 启动类上加载配置文件即可！ @SpringBootApplication @PropertySource(value = { "test.properties", "bussiness.properties"}) publicclassPropertyApplication{ publicstaticvoidmain(String[] args){ SpringApplication.run(PropertyApplication . class, args) ; } } 读取数据的方式，与之相似！ @RestController publicclassHelloController{ @Value( "${aaa.a2}") privateString a2; @Value( "${bbbb.a1}") privateString bbbbA1; @GetMapping( "a2") publicString a2{ returnJSON.toJSONString(a2); } @GetMapping( "bbbbA1") publicString bbbbA1{ returnJSON.toJSONString(bbbbA1); } } 假如我们只是在业务中需求用到自定义配置文件的值，这样引入并没有什么问题；但是假如某些自定义的变量，在项目启动的时分需求用到，这种方式会存在一些问题，缘由如下： 翻译过来的意义就是说： 固然在 @SpringBootApplication 上运用 @PropertySource 似乎是在环境中加载自定义资源的一种方便而简单的措施，但我们不引荐运用它，由于 SpringBoot 在刷新应用程序上下文之前就准备好了环境。运用 @PropertySource 定义的任何键都加载得太晚，无法对自动配置产生任何影响。 因而，假如某些参数是启动项变量，倡议将其定义在 application.properties 或 application.yml 文件里面，这样就不会有问题！ 或者，采用【 自定义环境处置类】来完成配置文件的加载！ 2.4、经过自定义环境处置类，完成配置文件的加载 完成措施也很简单，首先，创建一个完成自 EnvironmentPostProcessor 接口的类，然后自行加载配置文件。 publicclassMyEnvironmentPostProcessorimplementsEnvironmentPostProcessor{ @Override publicvoidpostProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application){ //自定义配置文件 String[] profiles = { "test.properties", "bussiness.properties", "blog.yml" }; //循环添加 for(String profile : profiles) { //从classpath途径下面查找文件 Resource resource = newClassPathResource(profile); //加载成PropertySource对象，并添加到Environment环境中 environment.getPropertySources.addLast(loadProfiles(resource)); } } //加载单个配置文件 privatePropertySource<?> loadProfiles(Resource resource) { if(!resource.exists) { thrownewIllegalArgumentException( "资源"+ resource + "不存在"); } if(resource.getFilename.contains( ".yml")){ returnloadYaml(resource); } else{ returnloadProperty(resource); } } /** * 加载properties格式的配置文件 * @paramresource * @return */ privatePropertySource loadProperty(Resource resource){ try{ //从输入流中加载一个Properties对象 Properties properties = newProperties; properties.load(resource.getInputStream); returnnewPropertiesPropertySource(resource.getFilename, properties); } catch(Exception ex) { thrownewIllegalStateException( "加载配置文件失败"+ resource, ex); } } /** * 加载yml格式的配置文件 * @paramresource * @return */ privatePropertySource loadYaml(Resource resource){ try{ YamlPropertiesFactoryBean factory = newYamlPropertiesFactoryBean; factory.setResources(resource); //从输入流中加载一个Properties对象 Properties properties = factory.getObject; returnnewPropertiesPropertySource(resource.getFilename, properties); } catch(Exception ex) { thrownewIllegalStateException( "加载配置文件失败"+ resource, ex); } } } 接着，在 resources 资源目录下，我们还需求创建一个文件 META-INF/spring.factories ，经过 spi 方式，将自定义环境处置类加载到 Spring 处置器里面，当项目启动时，会自动调用这个类！ #启用我们的自定义环境处置类 org.springframework.boot.env.EnvironmentPostProcessor=com.example.property.env.MyEnvironmentPostProcessor
这种自定义环境处置类方式，相对会更佳灵活，首先编写一个通用的配置文件解析类，支持 properties 和 yml 文件的读取，然后将其注入到 Spring 容器里面，基本上能够做到一劳永逸！ 2.5、最后，我们来引见一下 yml 文件读取 在上文中，我们大部分都是以 properties 为案例中止引见，可能有的人曾经踩过坑了， 在项目中运用 @PropertySource 注解来加载 yml 文件，结果启动直接报错，缘由是 @PropertySource 不支持直接解析 yml 文件，只能解析 properties 文件 。 那假如，我想单独解析 yml 文件，也不想弄一个【自定义环境处置类】这种方式来读取文件，应该如何处置呢 ？ 操作方式也很简单，以自定义的 blog.yml 文件为例！ blog.yml 文件内容： pzblog: name: helloWorld 然后，创建一个读取 yml 文件的配置类 @Configuration publicclassConfigYaml{ /** * 加载YML格式自定义配置文件 * @return */ @Bean publicstaticPropertySourcesPlaceholderConfigurer properties{ PropertySourcesPlaceholderConfigurer configurer = newPropertySourcesPlaceholderConfigurer; YamlPropertiesFactoryBean yaml = newYamlPropertiesFactoryBean; yaml.setResources( newClassPathResource( "blog.yml")); configurer.setProperties(yaml.getObject); returnconfigurer; } } 读取数据的方式，与之相似！ @RestController publicclassHelloController{ @Value( "${pzblog.name}") privateString pzblogName; @GetMapping( "pzblogName") publicString pzblogName{ returnJSON.toJSONString(pzblogName); } } 三、小结 本文主要盘绕 SpringBoot 加载配置文件的几种完成方式，做了一次内容总结，假如有遗漏的中央，欢送网友批判指出！ 四、参考 1、springBoot 官方文档 -End- 最近有一些小同伴，让我辅佐找一些 面试题 资料，于是我翻遍了珍藏的 5T 资料后，汇总整理出来，能够说是程序员面试必备！ 一切资料都整理到网盘了，欢送下载！ 面试题】即可获取 在看点这里好文分享给更多人↓↓ |
名表回收网手机版
