SpringBoot 配置文件給實體註入值方式

Posted on by

配置文件給實體註入值

SpringBoot 默認的全局配置文件有兩個 application.properties 和application.yml

properties用法

# 例如修改端口號 直接賦值
server.port=8888

yaml用法

# 例如修改端口號
server:
    port: 8888
  • YML中賦值是以鍵值對的形式，且利用縮進表示層級關系，同一級縮進必須一致
  • 大小寫敏感，支持松散寫法，且冒號後面必須有一個空格

通過配置文件給實體類註入屬性

// 實體類
@Component // 把實體類放入到spring容器中
@ConfigurationProperties(prefix = "student") // 識別配置文件
public class Student {
    private String name;
    private int age;
    private boolean sex;
    private Date birthday;
    private Map<String, Object> location;
    private String[] hobbies;
    private List<String> skills;
    private Pet pet;
    
    // .... set/get/toString
}

# yml 配置文件
student: 
	name: zs
	age: 23
	sex: true
	birthday: 2020/10/1
	location: {province: 湖北,city: 武漢, zone: 洪山}
	hobbies: [足球, 籃球]
	skills: [編程, 金融]
	pet: 
		nickName: wc
		strain: hsq

在這裡註意不同數據類型的寫法，簡單的數據直接賦值

# map類型和對象類型 的兩種寫法
# 1.行內寫法
location: {province: 湖北,city: 武漢, zone: 洪山}
pet: {nickName: wc, strain: hsq}
# 2.分行寫
location:
	province: 湖北
	city: 武漢
	zone: 洪山
pet: 
	nickName: wc
	strain: hsq

# 數組、list、set
# 1、行內寫法, 其中中括號還可以省略
hobbies: [足球, 籃球]
skills: [編程, 金融]
# 2、分行寫
hobbies:
	- 足球
	- 籃球
skills: 
	- 編程
	- 金融

到 SpringBoot 測試文件中測試輸出

    @Autowired
    Student student;
    @Test
    void contextLoads() {
        System.out.println(student);
    }

結果

Student{name='zs', age=23, sex=true, birthday=Thu Oct 01 00:00:00 CST 2020, location={province=湖北, city=武漢, zone=洪山}, hobbies=[足球，籃球], skills=[編程, 金融], pet=Pet{nickName='wc', strain='hsq'}}

上面yml中註意

# 如果對字符串加單引號，雙引號會有什麼區別
location: {province: "湖北",city: '武漢', zone: 洪山}
# 如果引號中隻是字符串時沒什麼區別
location: {province: "湖\n北",city: '武\n漢', zone: 洪\n山}
# 此時雙引號中的轉義字符會被識別，會換行，單引號和不加引號會原樣輸出

也可以使用properties註入

student.name=ls
student.age=24
...

其中properties文件和yml文件中的值可以互相引用。兩個配置文件可以互補，properties文件優先級高於yml

另外如果要註入的值不在這兩個默認配置文件中，這是需要使用@PropertySource註解，遺憾的是該註解隻支持properties文件，不支持yml文件

@PropertySource(value = {"classpath:conf.properties"})
public class Student {
    ...

配置文件值註入方式

1.1 從全局配置文件中讀取配置到實體類 (@ConfigurationProperties)

配置文件 (application.yml)(寫在application.properties也可以，格式變一下即可)

person:
  lastName: Mary
  age: 16
  birthDate: 2004/01/01
  maps: {one:1,two:2,three:3}
  lists:
    - 1
    - 2
    - 3
  pet:
    name: wangcai
    age: 3

實體類（javaBean）：

/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件中
 *
 * @Component：
 *     隻有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
 *
 * @ConfigurationProperties：
 *     告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定(默認配置文件為application.properties與      
 *     application.yml)；
 *
 * prefix = "person"：
 *       配置文件中哪個下面的所有屬性進行一一映射
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Date birthDate;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Pet pet;
    //省略get，set方法
    @Override
    public String toString() {
        String mapValue = "";
        
        if(this.maps!=null){
            for(String key:this.maps.keySet()){
                Object value = this.maps.get(key);
                mapValue += key+"\t"+value+"\t";
            }
        }
        return "lastName:"+this.lastName+
                "\nage:"+this.age+
                "\nbirthDate:"+this.birthDate+
                "\nmaps:"+mapValue+
                "\nlists:"+this.lists+
                this.pet;
    }
}

public class Pet {
    private String name;
    private Integer age;
    //省略get，set方法
    
    @Override
    public String toString() {
        return "\nPet:\n\tPet name:"+this.name+
                "\n\tPet age:"+this.age+"\n";
    }
}

我們可以導入配置文件處理器，以後編寫配置就有提示瞭（pom.xml)

<!--導入配置文件處理器，配置文件進行綁定就會有提示-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

測試

@SpringBootTest
class DemoApplicationTests {
    @Autowired
    Person person;
    @Test
    void contextLoads() {
        System.out.println(person.toString());
    }
}

1.2 全局配置文件註入值(@Value)

@Value 其實是Spring中的註解，其功能使用xml文件描述是這樣的：

 <bean class="Person">
     <property name="lastName" value="字面量/${key}從環境變量、配置文件中獲取值/#{SpEL}"></property>
 <bean/>

其中property表示的是Person類中的各項屬性，name用於指定具體屬性，value用於指定值。

value的值主要有3種：

  • 字面量，也就是數字（1,2…）、字符串（abc）、佈爾變量（true、false）等常量
  • ${key}，從環境變量、配置文件中獲取值
  • #{SpEL}, Spring的表達式語言，可以執行一些計算，調用一些函數
@Component
public class Person {
    @Value("${person.last-name}")  //@Value("#{'Lily'.toUpperCase()}")
    private String lastName;
    @Value("#{11*2}")
    private Integer age;
    private Date birthDate;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Pet pet;    
    //省略get,set和toString    
}

1.3 從指定文件讀取並配置實體類(@PropertySource+@ConfigurationProperties)

在 resources 目錄下創建 person.properties

person.lastName = Lily
person.age = 20
person.birthDate = 2000/01/01
person.maps.one = 1
person.maps.two = 2
person.lists = a,b,ch
person.pet.name = wangcai
person.pet.age = 3

更改 Person 類中的註解

@Component
@PropertySource(value = {"classpath:person.properties"})
@ConfigurationProperties(prefix = "person")
public class Person {
    //...省略屬性，get,set,toString
}

要註意的是，PropertySource 隻支持properties文件，不支持yml文件讀取。

1.4 從指定文件讀取並註入值(@PropertySource+@Value)

創建配置文件

更改註釋

@Component
@PropertySource(value = {"classpath:person.properties"})
public class Person {    
    @Value("${person.last-name}")
    private String lastName;    
    //...省略屬性，get,set,toString
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：