本篇文章为你整理了在SpringBoot下怎么读取自定义properties配置文件（springboot读取自定义yml）的详细内容，包含有springboot读取指定properties文件 springboot读取自定义yml 如何读取springboot项目的应用配置 springboot获取自定义配置 在SpringBoot下怎么读取自定义properties配置文件，希望能帮助你了解 在SpringBoot下怎么读取自定义properties配置文件。
这篇文章主要介绍“在SpringBoot下怎么读取自定义properties配置文件”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“在SpringBoot下怎么读取自定义properties配置文件”文章能帮助大家解决问题。
一、在resource中新建.properties文件
在resource目录下新建一个config文件夹，然后新建一个.properties文件放在该文件夹下。如图remote.properties所示
二、编写配置文件
remote.uploadFilesUrl=/resource/files/
remote.uploadPicUrl=/resource/pic/
三、新建一个配置类RemoteProperties.java
@Configuration
@ConfigurationProperties(prefix= remote ,ignoreUnknownFields=false)
@PropertySource( classpath:config/remote.properties )
@Data
@Component
publicclassRemoteProperties{
privateStringuploadFilesUrl;
privateStringuploadPicUrl;
}
其中
@Configuration 表明这是一个配置类
@ConfigurationProperties(prefix = remote , ignoreUnknownFields = false) 该注解用于绑定属性。prefix用来选择属性的前缀，也就是在remote.properties文件中的“remote”，ignoreUnknownFields是用来告诉SpringBoot在有属性不能匹配到声明的域时抛出异常。
@PropertySource( classpath:config/remote.properties ) 配置文件路径
@Data 这个是一个lombok注解，用于生成getter setter方法
@Component 标识为Bean
四、如何使用？
在想要使用配置文件的方法所在类上表上注解EnableConfigurationProperties(RemoteProperties.class)
并自动注入
@Autowired
RemotePropertiesremoteProperties;
在方法中使用 remoteProperties.getUploadFilesUrl()就可以拿到配置内容了。
@EnableConfigurationProperties(RemoteProperties.class)
@RestController
publicclassTestService{
@Autowired
RemotePropertiesremoteProperties;
publicvoidtest(){
Stringstr=remoteProperties.getUploadFilesUrl();
System.out.println(str);
}
}
这里str就是配置文件中的”/resource/files/”了。
PS：下面看下 Spring-boot中读取config配置文件的两种方式
了解过spring-Boot这个技术的，应该知道Spring-Boot的核心配置文件application.properties，当然也可以通过注解自定义配置文件的信息。
Spring-Boot读取配置文件的方式：
一.读取核心配置文件信息application.properties的内容
核心配置文件是指在resources根目录下的application.properties或application.yml配置文件，读取这两个配置文件的方法有两种，都比较简单。
核心配置文件application.properties内容如下：
test.msg=HelloWorldSpringBoot方式一：使用@Value方式（常用）
packageSolin.controller;
importorg.springframework.beans.factory.annotation.Value;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;
@RestController
publicclassWebController{
@Value( ${test.msg} )
privateStringmsg;
@RequestMapping( /index1 )
publicStringindex1(){
return 方式一: +msg;
}
}
注意：在@Value的${}中包含的是核心配置文件中的键名。在Controller类上加@RestController表示将此类中的所有视图都以JSON方式显示，类似于在视图方法上加@ResponseBody。访问：http://localhost:8088/index1时得到： 方式一:Hello World SpringBoot
方式二：使用Environment方式
packageSolin.controller;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.beans.factory.annotation.Value;
importorg.springframework.core.env.Environment;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;
@RestController
publicclassWebController{
@Autowired
privateEnvironmentenv;
@RequestMapping( /index2 )
publicStringindex2(){
return 方式二: +env.getProperty( test.msg
}
}
注意：这种方式是依赖注入Evnironment来完成，在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入，然后使用env.getProperty( 键名 )即可读取出对应的值。访问：http://localhost:8088/index2时得到： 方式二:Hello World SpringBoot
二.读取自定义配置文件信息，例如：author.properties
为了不破坏核心文件的原生态，但又需要有自定义的配置信息存在，一般情况下会选择自定义配置文件来放这些自定义信息，这里在resources目录下创建配置文件author.properties
resources/author.properties内容如下：
author.name=Solin
author.age=22
创建管理配置的实体类：
packageSolin.controller;
importorg.springframework.boot.context.properties.ConfigurationProperties;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.stereotype.Component;
//加上注释@Component，可以直接在其他地方使用@Autowired来创建其实例对象
@Component
@ConfigurationProperties(prefix= author ,locations= classpath:author.properties )
publicclassMyWebConfig{
privateStringname;
privateintage;
publicStringgetName(){
returnname;
}
publicvoidsetName(Stringname){
this.name=name;
}
publicintgetAge(){
returnage;
}
publicvoidsetAge(intage){
this.age=age;
}
}
注意：
在@ConfigurationProperties注释中有两个属性：
locations：指定配置文件的所在位置
prefix：指定配置文件中键名称的前缀（我这里配置文件中所有键名都是以author.开头）
使用@Component是让该类能够在其他地方被依赖使用，即使用@Autowired注释来创建实例。
创建测试Controller
packageSolin.controller;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Controller;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.ResponseBody;
@Controller
publicclassConfigController{
@Autowired
privateMyWebConfigconf;
@RequestMapping( /test )
public@ResponseBodyStringtest(){
return Name: +conf.getName()+ --- + Age: +conf.getAge();
}
}
注意：由于在Conf类上加了注释@Component，所以可以直接在这里使用@Autowired来创建其实例对象。
访问：http://localhost:8088/test时得到： Name:Solin---Age:22
关于“在SpringBoot下怎么读取自定义properties配置文件”的内容就介绍到这里了，感谢大家的阅读。如果想了解更多行业相关的知识，可以关注亿速云行业资讯频道，小编每天都会为大家更新不同的知识点。
推荐阅读：
以上就是在SpringBoot下怎么读取自定义properties配置文件（springboot读取自定义yml）的详细内容，想要了解更多 在SpringBoot下怎么读取自定义properties配置文件的内容，请持续关注盛行IT软件开发工作室。
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。