springboot 加载配置,spring boot加载自定义配置文件

　　一.导言二守则实务2.1。参数加载2.2带@value批注，参数加载2.3带@ConfigurationProperties批注，配置文件加载2.4带@PropertySource批注，配置文件加载2.5带自定义环境处理类。最后，我们将介绍yml文件读取III。总结。

　　00-1010在实际的项目开发过程中，我们经常需要从代码中提取一些变量放在配置文件中，以便更加统一灵活地管理服务配置信息。比如数据库、eureka、zookeeper、redis、mq、kafka等服务组件的连接参数配置，以及我们自定义的项目参数配置变量。

　　当然，其实根据目前的业务需求，我们往往会自定义参数，然后注入到代码中灵活使用！

　　今天就来说说SpringBoot加载配置文件的几种方式！

　　SpringBoot项目启动时，默认加载前两个配置文件bootstrap.properties或bootstrap.yml(这两个优先级最高)；然后将加载application.properties或application.yml如果配置了变量spring.profiles，则相应的应用程序-{profile}。属性或应用程序-{profile}。yml文件也将被加载。Profile是对应的环境变量，比如dev。如果没有配置，将加载profile=default的配置文件。

　　虽然说配置项都写在同一个配置文件里没问题，但是很多时候我们还是希望可以分开写，这样会更清晰。比如zookeeper的配置写在zookeeper.properties，数据库相关的配置写在datasource.properties等等。所以需要设置和加载外部配置文件！

　　如何实现？我们来看看吧！

目录

　　00-1010当我们想给类注入一个变量的时候，可以简单的通过@value标注注入参数！

　　比如在application.properties文件中，配置一个config.name的变量键，值为张三；

　　//参数定义config.name=zhangsan然后在对应的类中，通过参数@value注入！

　　@ RestControllerpublic class hello controller { @ Value( $ { config . name } )私有字符串配置；@ get mapping( config )public String config(){ return JSON . tojsonstring(config)；}}使用@value注释注入配置。通常有一个要求，注释中的变量必须事先在application.properties文件中定义好，否则启动时会报错！

　　当然，如果我们不希望它出错，我们可以给它一个默认值xxx，比如：

　　@Value(${config.name:xxx} )私有字符串配置；这样SpringBoot项目启动时就不会报错了！

　　00-1010在某些场景下，@值标注并不能满足我们所有的需求。比如参数配置的数据类型是对象或者数组，此时使用@ConfigurationProperties会是更好的选择！

　　配置一个对象类型的参数

　　例如，在application.properties文件中，当我们想要配置一个对象类型的参数时，我们可以这样做！

　　//参数定义Config2 . name=demo _ 1 config 2 . value=demo _ value _ 1然后，创建一个配置类config 2，用于将定义的变量映射到配置类中。

　　@ Component @ configuration properties(前缀=config2 )公共类Config2 {公共字符串名称；公共字符串值；//.get，set}读取数据的方式也很简单，直接注入到对应的类中即可；

　　ss="brush:java;">@RestControllerpublic class HelloController { @Autowired private Config2 config2; @GetMapping("config2") public String config2(){ return JSON.toJSONString(config2); }}配置一个Map类型的参数

　　例如在application.properties文件里，当我们想配置一个 Map 类型的参数，我们可以这样操作!

//参数定义config3.map1.name=demo_id_1_nameconfig3.map1.value=demo_id_1_valueconfig3.map2.name=demo_id_2_nameconfig3.map2.value=demo_id_2_value

然后，创建一个配置类Config3，用于将定义的变量映射到配置类里面。

@Component@ConfigurationProperties(prefix = "config3")public class Config3 { private Map<String, String> map1 = new HashMap<>(); private Map<String, String> map2 = new HashMap<>(); //...get、set}

读取数据的方式，与之类似!

@RestControllerpublic class HelloController { @Autowired private Config3 config3; @GetMapping("config3") public String config3(){ return JSON.toJSONString(config3); }}

配置一个List类型的参数

　　例如在application.properties文件里，当我们想配置一个 List 类型的参数，我们可以这样操作!

//参数定义config4.userList[0].enable=maillist_1_enableconfig4.userList[0].name=maillist_1_nameconfig4.userList[0].value=maillist_1_valueconfig4.userList[1].enable=maillist_2_enableconfig4.userList[1].name=maillist_2_nameconfig4.userList[1].value=maillist_2_valueconfig4.userList[2].enable=maillist_3_enableconfig4.userList[2].name=maillist_3_nameconfig4.userList[2].value=maillist_3_value

然后，创建一个配置类Config4，用于将定义的变量映射到配置类里面。

@Component@ConfigurationProperties(prefix = "config4")public class Config4 { private List<UserEntity> userList; public List<UserEntity> getUserList() { return userList; } public void setUserList(List<UserEntity> userList) { this.userList = userList; }}

public class UserEntity { private String enable; private String name; private String value; //...get、set}

读取数据的方式，与之类似!

@RestControllerpublic class HelloController { @Autowired private Config4 config4; @GetMapping("config4") public String config4(){ return JSON.toJSONString(config4); }}

2.3、通过@PropertySource注解实现配置文件加载

正如我们最开始所介绍的，很多时间，我们希望将配置文件分卡写，比如zookeeper组件对应的服务配置文件是zookeeper.properties，redis组件对应的服务配置文件是redis.properties等等。

　　这种自定义的配置文件，我们应该如何加载到Spring容器里面呢?

　　其实方法也很简单，通过@PropertySource就可以实现!

　　首先，我们在resources资源文件夹下，创建两个配置文件test.properties和bussiness.properties，内容如下!

　　test.properties文件内容：

aaa.a1=aa1123aaa.a2=aa2123aaa.a3=aa3123aaa.a4=aa4123

bussiness.properties文件内容：

bbbb.a1=bb1123bbbb.a2=bb2123bbbb.a3=bb3123bbbb.a4=bb4123

在SpringBoot启动类上加载配置文件即可!

@SpringBootApplication@PropertySource(value = {"test.properties","bussiness.properties"})public class PropertyApplication { public static void main(String[] args) { SpringApplication.run(PropertyApplication.class, args); }}

读取数据的方式，与之类似!

@RestControllerpublic class HelloController { @Value("${aaa.a2}") private String a2; @Value("${bbbb.a1}") private String bbbbA1; @GetMapping("a2") public String a2(){ return JSON.toJSONString(a2); } @GetMapping("bbbbA1") public String bbbbA1(){ return JSON.toJSONString(bbbbA1); }}

如果我们只是在业务中需要用到自定义配置文件的值，这样引入并没有什么问题;但是如果某些自定义的变量，在项目启动的时候需要用到，这种方式会存在一些问题，原因如下：

　　翻译过来的意思就是说：

　　虽然在@SpringBootApplication上使用@PropertySource似乎是在环境中加载自定义资源的一种方便而简单的方法，但我们不推荐使用它，因为SpringBoot在刷新应用程序上下文之前就准备好了环境。使用@PropertySource定义的任何键都加载得太晚，无法对自动配置产生任何影响。

　　因此，如果某些参数是启动项变量，建议将其定义在application.properties或application.yml文件里面，这样就不会有问题!

　　或者，采用【自定义环境处理类】来实现配置文件的加载!

2.4、通过自定义环境处理类，实现配置文件的加载

实现方法也很简单，首先，创建一个实现自EnvironmentPostProcessor接口的类，然后自行加载配置文件。

public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { //自定义配置文件 String[] profiles = { "test.properties", "bussiness.properties", "blog.yml" }; //循环添加 for (String profile : profiles) { //从classpath路径下面查找文件 Resource resource = new ClassPathResource(profile); //加载成PropertySource对象，并添加到Environment环境中 environment.getPropertySources().addLast(loadProfiles(resource)); } } //加载单个配置文件 private PropertySource<?> loadProfiles(Resource resource) { if (!resource.exists()) { throw new IllegalArgumentException("资源" + resource + "不存在"); } if(resource.getFilename().contains(".yml")){ return loadYaml(resource); } else { return loadProperty(resource); } } /** * 加载properties格式的配置文件 * @param resource * @return */ private PropertySource loadProperty(Resource resource){ try { //从输入流中加载一个Properties对象 Properties properties = new Properties(); properties.load(resource.getInputStream()); return new PropertiesPropertySource(resource.getFilename(), properties); }catch (Exception ex) { throw new IllegalStateException("加载配置文件失败" + resource, ex); } } /** * 加载yml格式的配置文件 * @param resource * @return */ private PropertySource loadYaml(Resource resource){ try { YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean(); factory.setResources(resource); //从输入流中加载一个Properties对象 Properties properties = factory.getObject(); return new PropertiesPropertySource(resource.getFilename(), properties); }catch (Exception ex) { throw new IllegalStateException("加载配置文件失败" + 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文件的配置类

@Configurationpublic class ConfigYaml { /** * 加载YML格式自定义配置文件 * @return */ @Bean public static PropertySourcesPlaceholderConfigurer properties() { PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer(); YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean(); yaml.setResources(new ClassPathResource("blog.yml")); configurer.setProperties(yaml.getObject()); return configurer; }}

读取数据的方式，与之类似!

@RestControllerpublic class HelloController { @Value("${pzblog.name}") private String pzblogName; @GetMapping("pzblogName") public String pzblogName(){ return JSON.toJSONString(pzblogName); }}

三、小结

本文主要围绕 SpringBoot 加载配置文件的几种实现方式，做了一次内容总结，如果有遗漏的地方，欢迎网友批评指出!

　　以上就是SpringBoot加载配置文件的实现方式总结的详细内容，更多关于SpringBoot加载配置文件的资料请关注盛行IT其它相关文章！

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。