源码网商城,靠谱的源码在线交易网站 我的订单 购物车 帮助

源码网商城

在SpringBoot下读取自定义properties配置文件的方法

  • 时间:2020-02-18 08:32 编辑: 来源: 阅读:
  • 扫一扫,手机访问
摘要:在SpringBoot下读取自定义properties配置文件的方法
SpringBoot工程默认读取application.properties配置文件。如果需要自定义properties文件,如何读取呢? [b]一、在resource中新建.properties文件[/b] 在resource目录下新建一个config文件夹,然后新建一个.properties文件放在该文件夹下。如图remote.properties所示 [img]http://img.1sucai.cn/uploads/article/2018010710/20180107100104_0_4920.png[/img] [b]二、编写配置文件[/b]
remote.uploadFilesUrl=/resource/files/
remote.uploadPicUrl=/resource/pic/
[b]三、新建一个配置类RemoteProperties.java[/b]
@Configuration
@ConfigurationProperties(prefix = "remote", ignoreUnknownFields = false)
@PropertySource("classpath:config/remote.properties")
@Data
@Component
public class RemoteProperties {
  private String uploadFilesUrl;
  private String uploadPicUrl;
}
其中 @Configuration 表明这是一个配置类 @ConfigurationProperties(prefix = "remote", ignoreUnknownFields = false) 该注解用于绑定属性。prefix用来选择属性的前缀,也就是在remote.properties文件中的“remote”,ignoreUnknownFields是用来告诉SpringBoot在有属性不能匹配到声明的域时抛出异常。 @PropertySource("classpath:config/remote.properties") 配置文件路径 @Data 这个是一个lombok注解,用于生成getter&setter方法,详情请查阅lombok相关资料 @Component 标识为Bean [b]四、如何使用? [/b] 在想要使用配置文件的方法所在类上表上注解EnableConfigurationProperties(RemoteProperties.class) 并自动注入
@Autowired
RemoteProperties remoteProperties;
在方法中使用 remoteProperties.getUploadFilesUrl()就可以拿到配置内容了。
@EnableConfigurationProperties(RemoteProperties.class)
@RestController
public class TestService{
  @Autowired
  RemoteProperties remoteProperties;

  public void test(){
    String str = remoteProperties.getUploadFilesUrl();
    System.out.println(str);
  }
}
这里str就是配置文件中的”/resource/files/”了。 [b]PS:下面看下 Spring-boot中读取config配置文件的两种方式[/b] 了解过spring-Boot这个技术的,应该知道Spring-Boot的核心配置文件application.properties,当然也可以通过注解自定义配置文件的信息。 Spring-Boot读取配置文件的方式: [b]一.读取核心配置文件信息application.properties的内容[/b]      核心配置文件是指在resources根目录下的application.properties或application.yml配置文件,读取这两个配置文件的方法有两种,都比较简单。 核心配置文件application.properties内容如下:
test.msg=Hello World SpringBoot 
[b]方式一:使用@Value方式(常用)[/b]
package Solin.controller; 
import org.springframework.beans.factory.annotation.Value; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
@RestController 
public class WebController { 
  @Value("${test.msg}") 
  private String msg; 
  @RequestMapping("/index1")  
  public String index1(){ 
    return "方式一:"+msg; 
  } 
} 
注意:在@Value的${}中包含的是核心配置文件中的键名。在Controller类上加@RestController表示将此类中的所有视图都以JSON方式显示,类似于在视图方法上加@ResponseBody。 访问:[url=http://localhost:8088/index1]http://localhost:8088/index1[/url]时得到:"方式一:Hello World SpringBoot" [b]方式二:使用Environment方式[/b]
package Solin.controller; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.beans.factory.annotation.Value; 
import org.springframework.core.env.Environment; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
@RestController 
public class WebController { 
  @Autowired 
  private Environment env; 
   
  @RequestMapping("/index2")  
  public String index2(){ 
    return "方式二:"+env.getProperty("test.msg"); 
  } 
}
注意:这种方式是依赖注入Evnironment来完成,在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入,然后使用env.getProperty("键名")即可读取出对应的值。 访问:[url=http://localhost:8088/index2]http://localhost:8088/index2[/url]时得到:"方式二:Hello World SpringBoot" [b]二.读取自定义配置文件信息,例如:author.properties[/b] 为了不破坏核心文件的原生态,但又需要有自定义的配置信息存在,一般情况下会选择自定义配置文件来放这些自定义信息,这里在resources目录下创建配置文件author.properties resources/author.properties内容如下:
author.name=Solin 
author.age=22 
创建管理配置的实体类:
package Solin.controller; 
 
import org.springframework.boot.context.properties.ConfigurationProperties; 
import org.springframework.context.annotation.Configuration; 
import org.springframework.stereotype.Component; 
 
//加上注释@Component,可以直接在其他地方使用@Autowired来创建其实例对象 
@Component 
@ConfigurationProperties(prefix = "author",locations = "classpath:author.properties")   
public class MyWebConfig{ 
  private String name; 
  private int age; 
  public String getName() { 
    return name; 
  } 
  public void setName(String name) { 
    this.name = name; 
  } 
  public int getAge() { 
    return age; 
  } 
  public void setAge(int age) { 
    this.age = age; 
  } 
} 
[b]注意:[/b]     在@ConfigurationProperties注释中有两个属性: locations:指定配置文件的所在位置 prefix:指定配置文件中键名称的前缀(我这里配置文件中所有键名都是以author.开头)     使用@Component是让该类能够在其他地方被依赖使用,即使用@Autowired注释来创建实例。 创建测试Controller
package Solin.controller; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.ResponseBody; 
@Controller  
public class ConfigController { 
  @Autowired 
  private MyWebConfig conf; 
   
  @RequestMapping("/test")  
  public @ResponseBody String test() { 
    return "Name:"+conf.getName()+"---"+"Age:"+conf.getAge();  
  } 
} 
注意:由于在Conf类上加了注释@Component,所以可以直接在这里使用@Autowired来创建其实例对象。 访问:[url=http://localhost:8088/test]http://localhost:8088/test[/url]时得到:"Name:Solin---Age:22" [b]总结[/b] 以上所述是小编给大家介绍的在SpringBoot下读取自定义properties配置文件的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对编程素材网网站的支持!
  • 全部评论(0)
联系客服
客服电话:
400-000-3129
微信版

扫一扫进微信版
返回顶部