java编程
搜索
分类

SpringBoot 如何从配置文件读取值到对象中

作者：无暇浅安时光 时间：2023-10-13 15:43:15　

一、实现方式

@ConfigurationProperties 注解

（最好加上前缀prefix=“person”,标明是和配置文件中哪个开头的属性匹配）

推荐使用用在类上，从配置文件读取属性值，放到对象里面，复杂的结构也适用例如map,list，对象。支持校验:@Validated

@Valid注解

用在属性上，需要每个属性逐个绑定通过@value注解获取配置文件的值,不适合做复杂类型（map,list ,对象）值得获取不支持@Validated

二、两者区别

SpringBoot 如何从配置文件读取值到对象中

三、代码演示

使用@ConfigurationProperties注解


package com.wx.springboot20190911.demo.model;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 从配置文件读取属性值，放到对象里面
* 2.通过@value注解获取配置文件的值
*/
@Component//perosn 需要纳入spring ioc 容器里
@ConfigurationProperties(prefix = "person")//使用前缀标明具体的属性
@Validated
public class Person {
   @Email
   String email;
   String hello;
   String name;
   int age;
   boolean boss;
   Date birth;
   Map<String,String> maps;
   List<String> list;
   Dog dog;
   @Override
   public String toString() {
       return "Person{" +
               "email='" + email + '\'' +
               ", hello='" + hello + '\'' +
               ", name='" + name + '\'' +
               ", age=" + age +
               ", boss=" + boss +
               ", birth=" + birth +
               ", maps=" + maps +
               ", list=" + list +
               ", dog=" + dog +
               '}';
   }
   public String getEmail() {
       return email;
   }
   public void setEmail(String email) {
       this.email = email;
   }
   public String getHello() {
       return hello;
   }
   public void setHello(String hello) {
       this.hello = hello;
   }
   public Dog getDog() {
       return dog;
   }
   public void setDog(Dog dog) {
       this.dog = dog;
   }
   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;
   }
   public boolean isBoss() {
       return boss;
   }
   public void setBoss(boolean boss) {
       this.boss = boss;
   }
   public Date getBirth() {
       return birth;
   }
   public void setBirth(Date birth) {
       this.birth = birth;
   }
   public Map<String, String> getMaps() {
       return maps;
   }
   public void setMaps(Map<String, String> maps) {
       this.maps = maps;
   }
   public List<String> getList() {
       return list;
   }
   public void setList(List<String> list) {
       this.list = list;
   }
}
package com.wx.springboot20190911.demo.model;
public class Dog {
   String name;
   String color;
   int age;
   public String getName() {
       return name;
   }
   public void setName(String name) {
       this.name = name;
   }
   public String getColor() {
       return color;
   }
   public void setColor(String color) {
       this.color = color;
   }
   public int getAge() {
       return age;
   }
   public void setAge(int age) {
       this.age = age;
   }
   @Override
   public String toString() {
       return "Dog{" +
               "name='" + name + '\'' +
               ", color='" + color + '\'' +
               ", age=" + age +
               '}';
   }
}

使用@Value注解


package com.wx.springboot20190911.demo.model;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 从配置文件读取属性值，放到对象里面，推荐使用，复杂的结构也适用例如map,list对象,
* 支持 校验@Validated
* 2.通过@value注解获取配置文件的值,不适合做复杂类型值得获取,不支持@Validated，支持
*/
@Component//perosn 需要纳入spring ioc 容器里
//@ConfigurationProperties(prefix = "person")
@Validated
public class Person1 {
   @Email
   @Value("${person1.email}")
   String email;
   @Value("${person1.hello}")
   String hello;
   @Value("${person1.name}")
   String name;
   @Value("#{12*3}")//支持计算
   int age;
   @Value("${person1.boss}")
   boolean boss;
   @Value("${person1.birth}")
   Date birth;
   Map<String,String> maps;
   List<String> list;
   Dog dog;
   public String getHello() {
       return hello;
   }
   public void setHello(String hello) {
       this.hello = hello;
   }
   public Dog getDog() {
       return dog;
   }
   public void setDog(Dog dog) {
       this.dog = dog;
   }
   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;
   }
   public boolean isBoss() {
       return boss;
   }
   public void setBoss(boolean boss) {
       this.boss = boss;
   }
   public Date getBirth() {
       return birth;
   }
   public void setBirth(Date birth) {
       this.birth = birth;
   }
   public Map<String, String> getMaps() {
       return maps;
   }
   public void setMaps(Map<String, String> maps) {
       this.maps = maps;
   }
   public List<String> getList() {
       return list;
   }
   public void setList(List<String> list) {
       this.list = list;
   }
   public String getEmail() {
       return email;
   }
   public void setEmail(String email) {
       this.email = email;
   }
   @Override
   public String toString() {
       return "Person1{" +
               "email='" + email + '\'' +
               ", hello='" + hello + '\'' +
               ", name='" + name + '\'' +
               ", age=" + age +
               ", boss=" + boss +
               ", birth=" + birth +
               ", maps=" + maps +
               ", list=" + list +
               ", dog=" + dog +
               '}';
   }
}

配置类（application.properties）代码


person.hello=luck
person.name=吴
#乱码的话 就setting设置下file encoding
person.list=ww,xx,rr
person.maps.k1=v1
person.maps.k2=v2
person.dog.name=cat
person.dog.color=red
person.dog.age=1
person.age=12
person.birth=2019/01/11
person.boss=false
person.email=www@qq.com
person1.hello=luck
person1.name=吴
#乱码的话 就setting设置下file encoding
person1.list=ww,xx,rr
person1.age=12
person1.birth=2019/01/11
person1.boss=false
person1.email=www

配置类(application.yml)代码:这种方式更加结构化


person:
 name: 霞
 age: 16
 boss : false
 birth: 2012/09/12
 maps: {k1: v1,k2: v2}
 list: [dog,cat ,house,rabbits]
 dog:
   name: ${person.hello}
   age: ${random.int(10)}
   color: white
 hello: yula

打印结果：使用第一种方式时，如果email不是"www@qq.com"这种格式，是不能运行成功的，但是使用@Value 不会校验，如下面是"www",一样能运行成功

Person{email='www@qq.com', hello='luck', name='吴', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}

Person1{email='www', hello='luck', name='吴', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}

四、@PropertySource 读取指定配置文件


package com.wx.springboot20190911.demo.model;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 1.ConfigurationProperties注解 从配置文件读取属性值，放到对象里面
* 2.通过@value注解获取配置文件的值
*/
@PropertySource(value={"classpath:person.properties"})//指定读取person.properties配置文件
@Component//perosn 需要纳入spring ioc 容器里
@ConfigurationProperties(prefix = "person")//使用前缀标明具体的属性
@Validated
public class Person2 {
   @Email
   String email;
   String hello;
   String name;
   int age;
   boolean boss;
   Date birth;
   Map<String,String> maps;
   List<String> list;
   Dog dog;
   @Override
   public String toString() {
       return "Person{" +
               "email='" + email + '\'' +
               ", hello='" + hello + '\'' +
               ", name='" + name + '\'' +
               ", age=" + age +
               ", boss=" + boss +
               ", birth=" + birth +
               ", maps=" + maps +
               ", list=" + list +
               ", dog=" + dog +
               '}';
   }
   public String getEmail() {
       return email;
   }
   public void setEmail(String email) {
       this.email = email;
   }
   public String getHello() {
       return hello;
   }
   public void setHello(String hello) {
       this.hello = hello;
   }
   public Dog getDog() {
       return dog;
   }
   public void setDog(Dog dog) {
       this.dog = dog;
   }
   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;
   }
   public boolean isBoss() {
       return boss;
   }
   public void setBoss(boolean boss) {
       this.boss = boss;
   }
   public Date getBirth() {
       return birth;
   }
   public void setBirth(Date birth) {
       this.birth = birth;
   }
   public Map<String, String> getMaps() {
       return maps;
   }
   public void setMaps(Map<String, String> maps) {
       this.maps = maps;
   }
   public List<String> getList() {
       return list;
   }
   public void setList(List<String> list) {
       this.list = list;
   }
}

这里虽然指定了读取person.properties配置文件，但是由于prefix=“person”,导致还是读取了application.properties配置文件，因为application.properties权限最高，要想读取person.properties配置文件，就得改前缀名，例如改成prefix=“person2” person.properties配置文件的内容如下：

SpringBoot 如何从配置文件读取值到对象中

没改前缀名的结果演示：

Person{email='www@qq.com', hello='luck', name='吴', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}

Person1{email='www', hello='luck', name='吴', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}

Person{email='www@qq.com', hello='luck', name='吴', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}

改前缀名的代码演示：

SpringBoot 如何从配置文件读取值到对象中 SpringBoot 如何从配置文件读取值到对象中

改了前缀名的结果演示：这时候读取的就是指定的配置文件的值

Person{email='www@qq.com', hello='luck', name='吴', age=12, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps={k1=v1, k2=v2}, list=[ww, xx, rr], dog=Dog{name='cat', color='red', age=1}}

Person1{email='www', hello='luck', name='吴', age=36, boss=false, birth=Fri Jan 11 00:00:00 CST 2019, maps=null, list=null, dog=null}

Person{email='12345@qq.com', hello='springboot', name='指定读取配置文件', age=12, boss=false, birth=Wed Sep 11 00:00:00 CST 2019, maps={k2=v2, k1=v1}, list=[@Value, @PropertySource], dog=Dog{name='cat', color='red', age=1}}

注：只能读取 .properties 文件，无法读取 .yml 文件

五、@ImportResource:导入Spring配置文件

让配置文件里面的内容生效

Springboot 里没有Spring 的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来，需使用该注解

写一个Person3 类，如图所示：

SpringBoot 如何从配置文件读取值到对象中

自定义一个Spring配置文件，如图所示：

SpringBoot 如何从配置文件读取值到对象中

在启动类上注解

SpringBoot 如何从配置文件读取值到对象中

测试：自定义的这个配置文件是否生效

SpringBoot 如何从配置文件读取值到对象中

演示结果：生效了

2019-09-11 22:15:12.247 INFO 7824 --- [ main] c.w.s.demo.DemoApplicationTests : Started DemoApplicationTests in 8.558 seconds (JVM running for 10.882)

Person{email='null', hello='null', name='null', age=0, boss=false, birth=null, maps=null, list=null, dog=null}

六、思维导图

SpringBoot 如何从配置文件读取值到对象中

来源：https://blog.csdn.net/baidu_35160588/article/details/100749171

标签：SpringBoot,配置文件,读取值,对象
0
投稿

猜你喜欢

  • Android自定义View圆形图片控件代码详解

    2022-05-15 12:00:53

  • Spring Boot中如何使用Convert接口实现类型转换器

    2023-05-09 20:28:37

  • 简单记事本java源码实例

    2023-11-26 02:03:17

  • Android自定义Toolbar使用方法详解

    2022-03-26 14:47:10

  • Java如何实现对称加密

    2021-07-01 09:29:11

  • C#引用类型转换的常见方式总结

    2022-03-02 16:53:58

  • 初识Java环境变量配置及IDEA

    2022-09-20 06:46:41

  • 公共POI导出Excel方法详解

    2023-09-10 22:51:31

  • Android自定义Seekbar滑动条 Pop提示跟随滑动按钮滑动

    2021-11-02 20:32:06

  • Android编程开发之EditText中inputType属性小结

    2022-04-13 10:03:11

  • OpenCV中C++函数imread读取图片的问题及解决方法

    2023-12-02 11:25:50

  • 详解 Java中日期数据类型的处理之格式转换的实例

    2021-12-29 05:17:49

  • java基础-数组扩容详解

    2022-05-24 00:34:58

  • 实例详解Android解决按钮重复点击问题

    2023-10-16 09:10:12

  • java排查一个线上死循环cpu暴涨的过程分析

    2022-07-20 01:27:08

  • 计算一个Java对象占用字节数的方法

    2022-06-14 18:05:21

  • Android自定义View之组合控件实现类似电商app顶部栏

    2023-07-26 22:14:10

  • Android Compose 属性动画使用探索详解

    2022-08-07 11:06:57

  • C语言实现扫雷小游戏完整算法详解(附完整代码)

    2021-10-30 05:06:58

  • Java 通过API操作GraphQL

    2021-12-24 03:21:49
    • asp之家 软件编程 m.aspxhome.com