目錄
- 一、SpringBoot配置文件
- 二、yaml概述
- 三、配置文件值注入
- 四、@Value獲取值和@ConfigurationProperties獲取值比較
- 五、JSR303校驗
- 六、多環境切換 Profile
一、SpringBoot配置文件
跳轉到目錄
SpringBoot使用一個全局的配置文件
, 配置文件名稱是固定的;
-
application.properties
- 語法結構 :key=value
-
application.yml
- 語法結構 :key:空格 value
配置文件的作用 :修改SpringBoot自動配置的默認值,因爲SpringBoot在底層都給我們自動配置好了;
比如我們可以在配置文件中修改Tomcat 默認啓動的端口號!測試一下!
server.port=8081
二、yaml概述
跳轉到目錄
YAML是 “YAML Ain’t a Markup Language” (YAML不是一種標記語言)的遞歸縮寫。在開發的這種語言時,YAML 的意思其實是:“Yet Another Markup Language”(仍是一種標記語言)
這種語言以數據作爲中心,而不是以標記語言爲重點!
- 以前的配置文件,大多數都是使用xml來配置;比如一個簡單的端口配置,我們來對比下yaml和xml
yaml配置:
server:
port: 8081
傳統xml配置:
<server>
<port>8081</port>
</server>
yaml語法
跳轉到目錄
說明:語法要求嚴格!
1、空格不能省略
2、以縮進來控制層級關係,只要是左邊對齊的一列數據都是同一個層級的。
3、屬性和值的大小寫都是十分敏感的。
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:
lastName: zhangsan
age: 20
行內寫法:
friends: {lastName: zhangsan,age: 18}
數組(List、Set):
用- 值表示數組中的一個元素
pets:
- cat
- dog
- pig
行內寫法
pets: [cat,dog,pig]
三、配置文件值注入
跳轉到目錄
yaml文件更強大的地方在於,他可以給我們的實體類直接注入匹配值!
yaml注入配置文件
1、在springboot項目中的resources目錄下新建一個文件 application.yml
2、編寫一個實體類 Dog;
package com.sunny.springboot.pojo;
@Component //註冊bean到容器中
public class Dog {
private String name;
private Integer age;
private Boolean eat;
//有參無參構造、get、set方法、toString()方法
}
3、思考,我們原來是如何給bean注入屬性值的!@Value,給狗狗類測試一下:
/**
*
* @Value()註解的作用同下
*
* <bean class="Dog">
* <property name="name" value="字面量" / ${字面量}從環境變量,配置文件中獲取值 / #{SpEL} ></property>
* </bean>
*/
//@Value("${Dog.last-name}")
@Value("阿黃")
private String name;
@Value("#{1*18}")
private Integer age;
@Value("false")
private Boolean eat;
4、在SpringBoot的測試類下注入狗狗輸出一下;
@SpringBootTest
class DemoApplicationTests {
@Autowired //將狗狗自動注入進來
Dog dog;
@Test
public void contextLoads() {
System.out.println(dog); //打印看下狗狗對象
}
}
結果成功輸出,@Value注入成功,這是我們原來的辦法對吧。
5、我們在編寫一個複雜一點的實體類:Person 類
@Component //註冊bean到容器中
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
//有參無參構造、get、set方法、toString()方法
}
6、我們來使用yaml配置的方式進行注入,大家寫的時候注意區別和優勢,我們編寫一個yaml配置!
person:
name: qinjiang
age: 3
happy: false
birth: 2000/01/01
maps: {k1: v1,k2: v2}
lists:
- code
- girl
- music
dog:
name: 旺財
age: 1
7、我們剛纔已經把person這個對象的所有值都寫好了,我們現在來注入
到我們的類中!
@ConfigurationProperties(prefix = "bean的id")
這個組件必須在容器中,才能使用該註解的功能;
/*
@ConfigurationProperties作用:
將配置文件中配置的每一個屬性的值,映射到這個組件中;
告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定
參數 prefix = “person” : 將配置文件中的person下面的所有屬性一一對應
*/
@Component //註冊bean
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
8、IDEA 提示,springboot配置註解處理器沒有找到,讓我們看文檔,我們可以查看文檔,找到一個依賴!
<!-- 導入配置文件處理器,配置文件進行綁定就會有提示,需要重啓 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
9、確認以上配置都OK之後,我們去測試類中測試一下:
@SpringBootTest
class DemoApplicationTests {
@Autowired
Person person; //將person自動注入進來
@Test
public void contextLoads() {
System.out.println(person); //打印person信息
}
}
yaml配置注入到實體類完全OK!
10、除了使用yaml配置,也可以使用application.properties
全局配置文件:
person.last-name=zhangsan
person.age=18
person.birth=2020/3/25
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=4
同樣使用@ConfigurationProperties:
告訴SpringBoot將本類中的所有屬性和配置文件中的相關配置進行綁定; 這樣也同樣可以和yaml同樣的效果!
【注意】properties配置文件在寫中文的時候,會有亂碼 , 我們需要去IDEA中設置編碼格式爲UTF-8;
settings–>FileEncodings 中配置;
11、除了全局的配置文件外,如果要加載指定的配置文件
@PropertySource 註解
在resources目錄下新建一個person.properties文件
person.last-name=zhangsan
person.age=18
person.birth=2020/3/25
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=4
此時需要使用@PropertySource(value = "classpath:person.properties")
這個註解; 並配合@Value
註解來使用;
舉個栗子: 這是一個配置類(和spring.xml實現同樣的功能)
@Configuration
@ComponentScan("com.sunny")
@PropertySource("classpath:db.properties")
@EnableTransactionManagement // 事務處理的註解
public class AppConfig {
@Value("${jdbc.driverClassName}")
private String driverClassName;
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.username}")
private String username;
@Value("${jdbc.password}")
private String password;
@Value("${jdbc.initialSize}")
private int initialSize;
// 連接池對象
@Bean // bean的id就是dataSource,也可以起一個
public DataSource dataSource(){
DruidDataSource ds = new DruidDataSource();
ds.setDriverClassName(driverClassName);
ds.setUrl(url);
ds.setUsername(username);
ds.setPassword(password);
ds.setInitialSize(initialSize);
return ds;
}
// 事務管理器對象;這裏傳的ds對象,就是上面的連接池對象,它會自動找ds對象
@Bean
public DataSourceTransactionManager txManager(DataSource ds){
return new DataSourceTransactionManager(ds);
}
}
db.properties
#key=value
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/springmvc
jdbc.username=root
jdbc.password=1111
jdbc.initialSize=2
注意:
- 將配置文件的key 值 和 屬性的值設置爲不一樣,則結果輸出爲null,注入失敗
- 在配置一個person2,然後將 @ConfigurationProperties(prefix = “person2”) 指向我們的person2;
四 、@Value獲取值和@ConfigurationProperties獲取值比較
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的屬性 | 一個個指定 |
鬆散綁定(鬆散語法) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303數據校驗 | 支持 | 不支持 |
複雜類型封裝 | 支持 | 不支持 |
1、@ConfigurationProperties只需要寫一次即可 , @Value則需要每個字段都添加
2、鬆散綁定:這個什麼意思呢? 比如我的yml中寫的last-name,這個和lastName是一樣的, - 後面跟着的字母默認是大寫的。這就是鬆散綁定。可以測試一下
3、JSR303數據校驗 , 這個就是我們可以在字段是增加一層過濾器驗證 , 可以保證數據的合法性
4、複雜類型封裝,yml中可以封裝對象 , 使用value就不支持
結論:
-
配置yml和配置properties都可以獲取到值 , 強烈推薦 yml;
-
如果我們在某個業務中,只需要獲取配置文件中的某個值,可以使用一下
@Value
; -
如果說,我們專門編寫了一個JavaBean來和配置文件進行一一映射,就直接
@configurationProperties
;
1、配置文件注入值數據校驗
@Validated 註解
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
/**
* <bean class="Person">
* <property name="lastName" value="字面量/${key}從環境變量、配置文件中獲取值/#{SpEL}"></property>
* <bean/>
*/
//lastName必須是郵箱格式
@Email
//@Value("${person.last-name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
2、@PropertySource&@ImportResource&@Bean
跳轉到目錄
@PropertySource
:加載指定的配置文件;
/**
* 將配置文件中配置的每一個屬性的值,映射到這個組件中
* @ConfigurationProperties:告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定;
* prefix = "person":配置文件中哪個下面的所有屬性進行一一映射
*
* 只有這個組件是容器中的組件,才能容器提供的@ConfigurationProperties功能;
* @ConfigurationProperties(prefix = "person")默認從全局配置文件中獲取值;
*
*/
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
/**
* <bean class="Person">
* <property name="lastName" value="字面量/${key}從環境變量、配置文件中獲取值/#{SpEL}"></property>
* <bean/>
*/
//lastName必須是郵箱格式
// @Email
//@Value("${person.last-name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
@ImportResource
:導入Spring的配置文件,讓配置文件裏面的內容生效;
Spring Boot裏面沒有Spring的配置文件,我們自己編寫的配置文件,也不能自動識別;
想讓Spring的配置文件生效,加載進來;@ImportResource標註在一個配置類上
//導入Spring的配置文件讓其生效
@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
不來編寫Spring的配置文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>
SpringBoot推薦給容器中添加組件的方式;推薦使用全註解的方式
1、配置類@Configuration------>Spring配置文件
2、使用@Bean給容器中添加組件
/**
* @Configuration:指明當前類是一個配置類;就是來替代之前的Spring配置文件
*
* 在配置文件中用<bean><bean/>標籤添加組件
*
*/
@Configuration
public class MyAppConfig {
//將方法的返回值添加到容器中;容器中這個組件默認的id就是方法名
@Bean
public HelloService helloService02(){
System.out.println("配置類@Bean給容器中添加組件了...");
return new HelloService();
}
}
SpringBoot 自動裝配都是用的配置類!
3、配置文件佔位符
- 隨機數
- 佔位符獲取之前配置的值,如果沒有可以是用:
指定默認值
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
Person:
name: gzy${random.uuid}
age: ${random.int}
happy: false
birth: 1998/2/11
maps: {k1: v1, k2: v2}
lists:
- code
- girl
- music
dog:
# 使用Person.hello這個配置的值,如果沒有這個配置,則使用指定的默認值hello
name: ${Person.hello:hello}_旺財
age: 1
五、JSR303校驗
-
Springboot中可以用
@validated
來校驗數據,如果數據異常則會統一拋出異常,方便異常中心統一處理。 -
使用數據校驗,可以保證數據的
正確性
;
常見參數:
@NotNull(message="名字不能爲空")
private String userName;
@Max(value=120,message="年齡最大不能查過120")
private int age;
@Email(message="郵箱格式錯誤")
private String email;
空檢查
@Null 驗證對象是否爲null
@NotNull 驗證對象是否不爲null, 無法查檢長度爲0的字符串
@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大於0,只對字符串,且會去掉前後空格.
@NotEmpty 檢查約束元素是否爲NULL或者是EMPTY.
Booelan檢查
@AssertTrue 驗證 Boolean 對象是否爲 true
@AssertFalse 驗證 Boolean 對象是否爲 false
長度檢查
@Size(min=, max=) 驗證對象(Array,Collection,Map,String)長度是否在給定的範圍之內
@Length(min=, max=) string is between min and max included.
日期檢查
@Past 驗證 Date 和 Calendar 對象是否在當前時間之前
@Future 驗證 Date 和 Calendar 對象是否在當前時間之後
@Pattern 驗證 String 對象是否符合正則表達式的規則
.......等等
除此以外,我們還可以自定義一些數據校驗規則
六、多環境切換 Profile
- profile是Spring對
不同環境
提供不同配置功能的支持,可以通過激活
不同的環境版本,實現快速切換環境
;
1、多配置文件
- 我們在主配置文件編寫的時候,文件名可以是 application-{profile}.properties/yml用來指定多個環境版本;
例如:
application-test.properties 代表測試環境配置
application-dev.properties 代表開發環境配置
-
但是Springboot並不會直接啓動這些配置文件,它默認使用
application.properties
主配置文件; -
我們需要通過一個配置來選擇需要激活的環境:
#比如在配置文件中指定使用dev環境,我們可以通過設置不同的端口號進行測試;
#我們啓動SpringBoot,就可以看到已經切換到dev下的配置了;
spring.profiles.active=dev
2、yaml的多文檔塊
- 和
properties
配置文件中一樣,但是使用yml
去實現不需要創建多個配置文件,更加方便了 !
server:
port: 8081
spring:
profiles:
active: dev
---
server:
port: 8083
spring:
profiles: dev # 配置環境的名稱
---
server:
port: 8084
spring:
profiles: prod
注意:如果yml和properties同時都配置了端口,並且沒有激活其他環境 , 默認會使用properties
配置文件的!
3、配置文件的加載位置
-
官方外部配置文件說明參考文檔
-
springboot 啓動會掃描以下位置的application.properties或者application.yml文件作爲Spring boot的
默認配置
文件:
優先級1:項目路徑下的config文件夾配置文件
優先級2:項目路徑下配置文件
優先級3:資源路徑下的config文件夾配置文件
優先級4:資源路徑下配置文件
- 優先級由高到底,高優先級的配置會覆蓋低優先級的配置;
SpringBoot會從這四個位置全部加載主配置文件;互補配置
;
我們在最低級的配置文件
中設置一個項目訪問路徑的配置來測試互補問題;
#配置項目的訪問路徑
server.servlet.context-path=/zy
- 我們還可以通過spring.config.location來改變默認的配置文件位置
項目打包好以後,我們可以使用命令行參數的形式,啓動項目的時候來指定配置文件的新位置;這種情況,一般是後期運維做的多,相同配置,外部指定的配置文件優先級最高;
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties