脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot读取properties文件

详解SpringBoot读取resource目录下properties文件的常见方式

 更新时间：2021年02月07日 10:56:11   作者：SZH勿忘初心  
这篇文章主要介绍了SpringBoot读取resource目录下properties文件的常见方式,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

个人理解

在企业开发中，我们经常需要自定义一些全局变量/不可修改变量或者参数来解决大量的变量重复问题，当需要这个全局变量时，只需要从配置文件中读取即可，根据开发中常见的情况，可以分为以下两种情况，分别是:

  • 配置文件为SpringBoot默认的application.properties文件中的自定义参数
  • 加载自定义properties文件中的自定义参数，比如xxx.properties的自定义参数

加载SpringBoot默认的application.properties

准备工作

server.port=8081

# 自定义参数->都是person.变量名的形式

person.id=1
person.name=szh

# list/set/数组->两种写法
person.hobby=play,read,write
person.family[0]=father
person.family[1]=mother

# map->两种写法
person.map.key1=value1
person.map[key2]=value2

# Entity对象->Pet实体类
person.pet.type=dog
person.pet.name=旺财
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;

@NoArgsConstructor
@AllArgsConstructor
@Data
public class Pet implements Serializable {
 private String type;
 private String name;
}

方式一 ： @ConfigurationProperties

开发中如果获取整个以xxx开头的所有参数，那么推荐使用第一种方式，如果获取单个参数，那么建议使用第二种获取参数方式。

import com.szh.test.entity.Pet;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "person")
@Data
public class PersonConfig {
 private int id;
 private String name;
 private List hobby;
 private String[] family;
 private Map map;
 private Pet pet;

}

测试使用代码:

@Autowired
 private PersonConfig personConfig;

 @RequestMapping("/hello1")
 public void hello1() {
 System.out.println(personConfig.getFamily());
 System.out.println(personConfig.getHobby());
 System.out.println(personConfig.getMap());
 System.out.println(personConfig.getId());
 System.out.println(personConfig.getName());
 System.out.println(personConfig.getPet().getName());
 }

方式二：@Value

@Value("${person.id}")
 private int id;
 @Value("${person.name}")
 private String name;
 @Value("${person.hobby}")
 private List hobby;
 @Value("${person.family}")
 private String[] family;
 @Value("${person.map}")
 private Map map;
 @Value("${person.pet}")
 private Pet pet;

方式三：使用Environment获取

@Autowired
 private Environment env;

 @RequestMapping("/hello1")
 public void hello1() throws UnsupportedEncodingException {

 String id = env.getProperty("person.id");
 // 中文
 String name = new String(env.getProperty("person.name").getBytes("ISO-8859-1"), "UTF-8");
 List hobby = new ArrayList();
 hobby.add(env.getProperty("person.hobby[0]"));
 hobby.add(env.getProperty("person.hobby[1]"));
 String[] family;
 Map<String,String> map = new HashMap<String,String>();
 map.put("key1", env.getProperty("person.map.key1"));
 map.put("key2", env.getProperty("person.map.key2"));

 Pet pet = new Pet(env.getProperty("person.pet.type"),env.getProperty("person.pet.name"));
 }

加载自定义properties文件

准备工作:在resource/目录下新建一个自定义配置文件szh.properties

person.id=1
person.name=szh

# list/set/数组->两种写法
person.hobby=play,read,write
person.family[0]=father
person.family[1]=mother

# map->两种写法
person.map.key1=value1
person.map[key2]=value2

# Entity对象
person.pet.type=dog
person.pet.name=旺财

方式一: @PropertySource+@ConfigurationProperties

@Component
@PropertySource(value = "classpath:szh.properties")
@ConfigurationProperties(prefix = "person")
@Data
public class PersonConfig {
 private int id;
 private String name;
 private List hobby;
 private String[] family;
 private Map map;
 private Pet pet;

}

方式二：@PropertySource+@Value

@Component
@PropertySource(value = "classpath:szh.properties")
@Data
public class PersonConfig {
 @Value("${person.id}")
 private int id;
 @Value("${person.name}")
 private String name;
 @Value("${person.hobby}")
 private List hobby;
 @Value("${person.family}")
 private String[] family;
 @Value("${person.map}")
 private Map map;
 @Value("${person.pet}")
 private Pet pet;

}

方式三：Properties加载

//读取资源配置文件
 InputStream is = Bean.class.getClassLoader().getResourceAsStream("szh.properties");
 prop = new Properties();
 String className = "person.name";//可以作为一个函数的变量
 try {
  prop.load(is);
  String pathName = prop.getProperty(className);
 } catch (Exception e) {
  throw new RuntimeException("xxxx");
 }

到此这篇关于SpringBoot读取resource目录下properties文件的常见方式的文章就介绍到这了,更多相关SpringBoot读取properties文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • spring batch线上异常定位记录

    spring batch线上异常定位记录

    这篇文章主要为大家介绍了spring batch线上异常定位记录及异常解决，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
    2022-03-03
  • Spring Boot启动及退出加载项的方法

    Spring Boot启动及退出加载项的方法

    这篇文章主要介绍了Spring Boot启动及退出加载项的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • Netty分布式编码器写buffer队列逻辑剖析

    Netty分布式编码器写buffer队列逻辑剖析

    这篇文章主要介绍了Netty分布式编码器写buffer队列逻辑剖析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-03-03
  • MybatisPlus字段自动填充失效,填充值为null的解决方案

    MybatisPlus字段自动填充失效,填充值为null的解决方案

    这篇文章主要介绍了MybatisPlus字段自动填充失效,填充值为null的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Spring加载properties文件的两种方式实例详解

    Spring加载properties文件的两种方式实例详解

    这篇文章主要介绍了Spring加载properties文件的两种方式,需要的朋友可以参考下
    2018-02-02
  • 解决SpringBoot项目在启动后自动关闭的问题

    解决SpringBoot项目在启动后自动关闭的问题

    今天搭建了一个SpringBoot项目,但是在启动之后就自行关闭了,下面通过本文给大家介绍SpringBoot项目在启动后自动关闭问题及解决方法,需要的朋友可以参考下
    2023-08-08
  • java开发中使用IDEA活动模板快速增加注释的方法

    java开发中使用IDEA活动模板快速增加注释的方法

    这篇文章主要介绍了java开发中使用IDEA活动模板快速增加注释,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-12-12
  • 新手初学Java面向对象

    新手初学Java面向对象

    这篇文章主要介绍了Java语言面向对象编程思想之类与对象实例详解，还是十分不错的，这里给大家分享下，需要的朋友可以参考，希望能帮到你
    2021-07-07
  • 一文搞懂Mybatis中Mapper配置文件获取参数的五种方式

    一文搞懂Mybatis中Mapper配置文件获取参数的五种方式

    这篇文章主要介绍了Mybatis中Mapper配置文件获取参数的五种方式,文中通过代码示例讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-03-03
  • SpringCloud微服务续约实现源码分析详解

    SpringCloud微服务续约实现源码分析详解

    这篇文章主要介绍了SpringCloud微服务续约实现源码分析，服务续期和服务注册非常相似，服务注册在Eureka Client程序启动之后开启，并同时开启服务续期的定时任务
    2022-11-11

最新评论