2. 程式人生 > >spring boot 配置檔案properties,yml語法學習及屬性獲取@ConfigurationProperties和@Value

spring boot 配置檔案properties,yml語法學習及屬性獲取@ConfigurationProperties和@Value

阿新 • • 發佈：2018-11-23

1 概述

SpringBoot使用一個全域性的配置檔案，配置檔名是固定的；當我們建立一個專案時會在resource目錄下出現一個預設的配置檔案application.properties 我們可以在裡面進行一些引數的配置，當然還有另外一種方式yml檔案application.yml（YAML Ain’t Markup Language）,他們之間寫法不同，作用都是一樣的，下面我們就來進行學習，可以根據自己的愛好進行選擇。

配置檔案的作用：修改SpringBoot自動配置的預設值；SpringBoot在底層都給我們自動配置好；

我們寫一個簡單的例子看看它們之間的區別：配置埠號

  • application.properties
server.port=8081
  • application.yaml
server:
  port: 8081

那如果是以前的xml呢？

<server>
  <port>8081</port>
</server>

以前的配置檔案；大多都使用的是 xxxx.xml檔案；而YAML：以資料為中心，比json、xml等更適合做配置檔案；但是剛開始使用的時候一定要注意語法問題，一不小心少個空格就會報錯哈。

2 YML語法

1、基本語法

k:(空格)v：表示一對鍵值對 （空格必須有）

；

以空格的縮排來控制層級關係；只要是左對齊的一列資料，都是同一個層級的，空格可以是一個或者多個，但是同一層級一定要對齊。

server:
    port: 8081
    path: /hello

屬性和值也是大小寫敏感；

2、值的寫法
字面量：普通的值（數字，字串，布林）

​ k: v：字面直接來寫；

字串預設不用加上單引號或者雙引號；

  • “”：雙引號；不會轉義字串裡面的特殊字元；特殊字元會作為本身想表示的意思
    ​name: “zhangsan \n lisi”：輸出；zhangsan 換行 lisi

  • ‘’：單引號；會轉義特殊字元，特殊字元最終只是一個普通的字串資料
    name: ‘zhangsan \n lisi’：輸出；zhangsan \n lisi

物件、Map（屬性和值）（鍵值對）：

​ k: v：在下一行來寫物件的屬性和值的關係；注意縮排

​ 物件還是k: v的方式

friends:
	name: zhangsan
	age: 20

行內寫法：

friends: {name: zhangsan,age: 18}
陣列（List、Set）：

用- 值表示陣列中的一個元素

pets:
 - cat
 - dog
 - pig

行內寫法

pets: [cat,dog,pig]

3 通過配置檔案注入屬性 @ConfigurationProperties

  • person實體類
package cn.zhangyu.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

/**
 * 將配置檔案中配置的每一個屬性的值，對映到這個元件中
 * @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置檔案中相關的配置進行繫結；
 *      prefix = "person"：配置檔案中哪個下面的所有屬性進行一一對映
 *
 * 只有這個元件是容器中的元件，才能容器提供的@ConfigurationProperties功能；
 * 所以配置@Component註解
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    //人的屬性
    private String name;
    
    private int age;
    
    private String sex;

    //map
    private Map<String , Object> maps;

    //list
    private List<Dog> list;

    private 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 String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Dog> getList() {
        return list;
    }

    public void setList(List<Dog> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                ", maps=" + maps +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}
  • Dog實體類
package cn.zhangyu.bean;


public class Dog {

    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;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}
  • yml配置屬性
person:
  name: zhangsan
  age: 20
  sex: male
  maps: {k1: v1,k2: v2}
  list:
   - {name: 小黑, age: 22}
   - name: 小白
   - age: 33
  dog:
    name: 大黃
    age: 12
  • 下面通過test類進行測試結果
package cn.zhangyu;

import cn.zhangyu.bean.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot1ApplicationTests {

	@Autowired
	private Person person;

	@Test
	public void contextLoads() {
		System.out.println(person);
	}

}

結果 ：

Person{name='zhangsan', age=20, sex='male', maps={k1=v1, k2=v2}, list=[Dog{name='小黑', age=22}, Dog{name='小白', age=0}, Dog{name='null', age=33}], dog=Dog{name='大黃', age=12}}

其中list中放入的是dog類，我們看看結果是什麼樣的：list張放入了三隻狗，dog中如果有多個屬性就要用{ }括起來。

  • properties配置檔案
person.name=小明
person.age=20
person.sex=male

person.maps.k1=v1
person.maps.k2=v2


person.list[0].name=小顧
person.list[0].age=22

person.list[1].name=旺財
person.list[1].age=10

person.dog.name=旺旺
person.dog.age=30
  • 結果：
Person{name='小明', age=20, sex='male', maps={k1=v1, k2=v2}, list=[Dog{name='小顧', age=22}, Dog{name='旺財', age=10}], dog=Dog{name='旺旺', age=30}}

注意： 這裡大家可能出現亂碼問題因為properties配置檔案在idea中預設utf-8可能會亂碼，但是我們idea的預設設定是gbk，所以要進行修改，如下圖所示：
在這裡插入圖片描述

3 @Value 屬性注入

我們寫個簡單的controller進行測試@Value屬性，@Value屬性可以說增加了屬性注入的靈活性可以單個屬性進行配置。

  • HelloController
package cn.zhangyu.bean.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Value("${person.name}")
    //@Value("#{person.name}")
    private String name;

    //計算表示式
    @Value("#{11*2}")
    private int age;

    //引入一個物件
    @Value("#{person}")
    private Person person;

    @RequestMapping(method = RequestMethod.GET ,path = "/sayHello")
    public String sayHello(){
        return "hello "+ name+" 我的年齡是： "+age+"\n" + person;
    }
}
  • yml中加一個name屬性
person.name: 小雨
  • 看看結果
    訪問頁面http://localhost:8081/sayHello我這裡埠號配置的是8081
    結果:hello 小明 我的年齡是： 22

這裡@Value註解是支援SpEL的。

什麼是SpEL？

  1. Spring 表示式語言(簡稱SpEL)：是一個支援執行時查詢和操作物件圖的強大的表示式語言。

  2. 語法類似於 EL：SpEL 使用 #{…} 作為定界符 , 所有在大括號中的字元都將被認為是 SpEL , SpEL 為 bean 的屬性進行動態賦值提供了便利。

通過 SpEL 可以實現：

通過 bean 的 id 對 bean 進行引用。
呼叫方式以及引用物件中的屬性。
計算表示式的值
正則表示式的匹配。
1SpEL 實現：
整數：#{8}
小數：#{8.8}
科學計數法：#{1e4}
String：可以使用單引號或者雙引號作為字串的定界符號。
Boolean：#{true}
SpEL引用bean , 屬性和方法：

引用其他物件:#{car}
引用其他物件的屬性：#{car.brand}
呼叫其它方法 , 還可以鏈式操作：#{car.toString()}
呼叫靜態方法靜態屬性：#{T(java.lang.Math).PI}
 SpEL支援的運算子號：

算術運算子：+，-，*，/，%，^(加號還可以用作字串連線)
比較運算子：< , > , == , >= , <= , lt , gt , eg , le , ge
邏輯運算子：and , or , not , |
if-else 運算子(類似三目運算子)：？:(temary), ?:(Elvis)
正則表示式：#{admin.email matches '[a-zA-Z0-9._%+-][email protected][a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}'}

4 @Value獲取值和@ConfigurationProperties獲取值比較

註解 @ConfigurationProperties @Value
功能 批量注入配置檔案中的屬性 一個個指定
鬆散繫結（鬆散語法） 支援 不支援
SpEL 不支援 支援
JSR303資料校驗 支援 不支援
複雜型別封裝 支援 不支援

鬆散繫結 ：如果使用@ConfigurationProperties註解一個類其中一個屬性為
private String myName;
我們通過yml進行配置如果我寫成這樣是否可以呢？

person:
  my-name: zhangsan

答案是可以的，這就是鬆散繫結 ，我可以寫成my-name也可以myName
@ConfigurationProperties支援而@Vlaue不支援

JSR303資料校驗：
通過一個例子來看看什麼是JSR303資料校驗

  • 我們在person類中加入:@Validated和@Email兩個註解
package cn.zhangyu.bean;

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.List;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //人的屬性
    @Email
    private String myName;

    private int age;

    private String sex;

    //map
    private Map<String , Object> maps;

    //list
    private List<Dog> list;

    private Dog dog;

    public String getMyName() {
        return myName;
    }

    public void setMyName(String myName) {
        this.myName = myName;
    }


    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Dog> getList() {
        return list;
    }

    public void setList(List<Dog> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "Person{" +
                "myName='" + myName + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                ", maps=" + maps +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}

啟動後發現報錯：

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'person' to cn.zhangyu.bean.Person failed:

    Property: person.myName
    Value: zhangsan
    Origin: class path resource [application.yml]:6:12
    Reason: 不是一個合法的電子郵件地址

這也就是JSR303資料校驗。填寫正確的電子郵件。而@Vlaue是不支援的。

複雜型別：
我們上面知道了@ConfigurationProperties是支援複雜型別的list、map等。 現在我們測試@Value是否支援

@Value("${person.maps}")
    private Map<String , Object> maps;

把person中map屬性加上@Value註解啟動發現報錯;
Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'person.maps' in value "${person.maps}".
所以@ConfigurationProperties是支援複雜型別的list、map等而@Value是不支援的，這是非常重要的一點。*

相關推薦

spring boot 配置檔案properties,yml語法學習及屬性獲取@ConfigurationProperties和@Value

1 概述 SpringBoot使用一個全域性的配置檔案，配置檔名是固定的；當我們建立一個專案時會在resource目錄下出現一個預設的配置檔案application.properties 我們可以在裡面進行一些引數的配置，當然還有另外一種方式yml檔案application.yml（

Spring Boot配置檔案properties資料庫密碼加密

Spring Boot配置檔案資料庫密碼加密 pom新增依賴 <!-- 資料庫加密 --> <dependency> &l

Spring Boot 配置檔案詳解：自定義屬性、隨機數、多環境配置等

相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強大功能，還能實現快速開發的便捷。我們在Spring Boot使用過程中，最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容，替代它的是在pom.xml中引入模組化的Starter POMs，其中各個模組都有自己的預

Spring boot 配置檔案詳解 (properties 和yml )

從其他框架來看 我們都有自己的配置檔案， hibernate有hbm，mybatis 有properties， 同樣， Spring boot 也有全域性配置檔案。 Springboot使用一個全域性的配置檔案，而且配置檔案的名字是固定的。 有兩種 application.properties

Spring Boot 配置檔案 yml與properties （二）

1、配置檔案 SpringBoot使用一個全域性的配置檔案，配置檔名是固定的； •application.properties •application.yml 配置檔案的作用：修改SpringBoot自動配置的預設值；SpringBoot在底層都給我們自動配

spring boot配置檔案：application.yml （yml與properties檔案優缺對比）

現在我們的application.properties檔案內容是： server.port=8090   server.session-timeout=30   server.context-path=   server.tomcat.max-threads=0

SpringBoot學習第二篇：Spring Boot配置檔案詳解

原文首發於：https://www.fangzhipeng.com/springboot/2017/07/11/springboot2-config-file/ 本文出自方誌朋的部落格 springboot採納了建立生產就緒Spring應用程式的觀點。 Spring Boot優先於配置的慣例，旨

《深入理解Spring Cloud與微服務構建》學習筆記(二)~使用Spring Boot配置檔案

接上一章demo： 一、IDEA在建立完Spring Boot專案時，會在src/main/resources目錄下生成一個application.properties檔案，使用者進行系統屬性配置，預設為空。Spring Boot也支援yml格式的檔案配置，當前使用yml檔案

SpringBoot學習筆記——Spring Boot配置檔案

    SpringBoot工程建立時會自動生成application.properties檔案，這個檔案專門存放配置資訊。    但是目前預設的配合檔案已經不能滿足我了，需要自己配置一些資訊。    第一、application.properties有一些預設的也是固定的屬

Spring Boot2 系列教程(四)理解Spring Boot 配置檔案 application.properties

在 Spring Boot 中，配置檔案有兩種不同的格式，一個是 properties ，另一個是 yaml 。 雖然 properties 檔案比較常見，但是相對於 properties 而言，yaml 更加簡潔明瞭，而且使用的場景也更多，很多開源專案都是使用 yaml 進行配置（例如 Hexo）。除了簡潔

SpringBoot非官方教程 ｜ 第二篇：Spring Boot配置檔案詳解

springboot採納了建立生產就緒Spring應用程式的觀點。 Spring Boot優先於配置的慣例，旨在讓您儘快啟動和執行。在一般情況下，我們不需要做太多的配置就能夠讓spring boot正常執行。在一些特殊的情況下，我們需要做修改一些配置，或者需要有自己的配置屬性。 當我們

Spring Boot配置檔案和常見操作

Spring Boot配置檔案和常見操作 Spring Boot專案釋出成jar包 Spring Boot配置方式 命令列方式 應用程式屬性檔案: application.properties 參考文獻 Sp

Spring Boot 配置檔案設定(三)

簡介 上篇我們做了一些簡單的執行檔案的配置，本篇帶領大家來認識常用的一些配置，當然了關於Spring Boot 這些配置太多太多了，如果想了解更多的話直接上官網參考一下，瞭解相關案例如本篇的配置。 application.properties配置官方指南參考。

Spring Boot配置檔案詳解-ConfigurationProperties和Value優缺點-（轉）好文

文章轉自 http://www.cnblogs.com/itdragon/p/8686554.html Spring Boot提供了兩種常用的配置檔案，分別是properties檔案和yml檔案。他們的作用都是修改Spring Boot自動配置的預設值。相對於properties檔案而言，yml檔

spring boot 配置檔案中引數的使用

自定義引數 book.name=springBoot book.author=spring @可以通過@Value 註解來載入這些自定義引數： public class Book{ @Value("${book.name}") private String name

Spring Boot配置檔案全面詳解

Spring Boot在工作中是用到的越來越廣泛了，簡單方便，有了它，效率提高不知道多少倍。Spring Boot配置檔案對Spring Boot來說就是入門和基礎，經常經常會用到，所以寫下做個總結以便日後檢視。 1.配置檔案 當我們構建完Spring Boot專案後，會在resources目錄下給我們一

第一篇 Spring boot 配置檔案筆記

　　spring boot 不需要配置太多檔案程式便可正常執行，特殊情況需要我們自己配置檔案。 　　專案以IDEA寫例項，系統會預設在src/main/java/resources目錄下建立application.properties檔案,配置檔案支援兩種格式properties/yml。 prop

spring Boot 配置檔案：Profile

1、多Profile 我們在主配置檔案編寫的時候，檔名可以是 application-{profile}.properties/yml 預設使用application.properties的配置； 2 yml檔案---代表不同的doucement          啟

企業級 SpringBoot 教程 （二）Spring Boot配置檔案詳解

springboot採納了建立生產就緒Spring應用程式的觀點。 Spring Boot優先於配置的慣例，旨在讓您儘快啟動和執行。在一般情況下，我們不需要做太多的配置就能夠讓spring boot正常執行。在一些特殊的情況下，我們需要做修改一些配置，或者需要有自己的配置屬性

第二篇：Spring Boot配置檔案詳解

Spring Boot採納了建立生產就緒Spring應用程式的觀點。 Spring Boot優先於配置的慣例，旨在讓您儘快啟動和執行。在一般情況下，我們不需要做太多的配置就能夠讓Spring Boot正常執行。在一些特殊的情況下，我們需要做一些配置修改，或者配置自定義屬性。 自定義屬