【SpringBoot配置文件】：yaml和properties和幾類配置註解

文章目錄

三. 配置文件值注入

一. 配置文件

SpringBoot使用一個全局的配置文件，配置文件名是固定的；
•application.properties
•application.yml
配置文件的作用：修改SpringBoot自動配置的默認值；

標記語言：
以前的配置文件；大多都使用的是 xxxx.xml文件；
YAML：以數據爲中心，比json、xml等更適合做配置文件；
YAML：配置例子

server:
port: 8081

XML：

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

二. YAML語法：

1. 基本語法

k:(空格)v：表示一對鍵值對（空格必須有）；
以空格的縮進來控制層級關係；只要是左對齊的一列數據，都是同一個層級的

server:
    port: 8081
    path: /hello

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

2. 值的寫法

2.1 字面量：普通的值（數字，字符串，布爾）

k: v：字面直接來寫；
　字符串默認不用加上單引號或者雙引號；
　　""：雙引號；不會轉義字符串裏面的特殊字符；特殊字符會作爲本身想表示的意思
　　　name: “zhangsan \n lisi”：輸出；zhangsan 換行 lisi
　　''：單引號；會轉義特殊字符，特殊字符最終只是一個普通的字符串數據
　　　name: ‘zhangsan \n lisi’：輸出；zhangsan \n lisi

2.2 對象、Map（屬性和值）（鍵值對）

k: v：在下一行來寫對象的屬性和值的關係；注意縮進
　　對象還是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行內寫法：

friends: {lastName: zhangsan,age: 18}

2.3 數組（List、Set）

用- 值表示數組中的一個元素

pets:
 - cat
 - dog
 - pig

行內寫法：

pets: [cat,dog,pig]

三. 配置文件值注入

1. 在application.yml中寫配置

Person類對象的配置文件：application.yml

	person:
	  lastName: zhangsan
	  age: 19
	  boss: false
	  birth: 2020/2/20
	  maps: {k1: v1,k2: v2}
	  lists:
	    - lisi
	    - ahua
	  dog:
	    name: 小狗
	    age: 2

javaBean：

/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件（Person)中
 * @ConfigurationProperties:可以將配置文件中的配置綁定到一個類中
 * @ConfigurationProperties:告訴springboot將本類中的所有屬性和配置文件中相關的配置進行綁定
 * prefix = "person"：配置文件中哪個相關屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能使用容器提供的@ConfigurationProperties功能
 * 所以需要使用@Component註解把當前類存入Spring的IOC容器中
 */
@Data
@ConfigurationProperties(prefix = "person")
@Component
public class Person {
    private String lastName;
    private int age;
    private boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

說明1：如果只加入@ConfigurationProperties(prefix = "person")會報紅，這個註解使用的前提是當前類在IOC容器中，必須和其他註解聯合使用。把類加入到IOC容器中的註解有：@Component，@Repository，@Service，@Controller，這裏是實體類不屬於三層模型的任何一層因此建議使用@Component。
說明2：因爲不想重寫getter()，setter()，toString()等方法，使用了lombok插件，使用這個插件需要導入依賴：

	<!--導入lombok，可以不用寫setter/getter/..方法 -->
       <dependency>
           <groupId>org.projectlombok</groupId>
           <artifactId>lombok</artifactId>
       </dependency>

導入依賴後在當前類上加入@Data註解即可
說明3：導入配置文件處理器，配置文件進行綁定就會有提示

  	<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-configuration-processor</artifactId>
       <optional>true</optional>
    </dependency>

在加入新的配置文件後，最好重新導入配置文件：

使用SpringBoot單元測試：

@RunWith(SpringRunner.class)
@SpringBootTest
class Springboot02ConfigurationsApplicationTests {
    @Autowired
    Person person;

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

輸出：

Person(lastName=zhangsan, age=19, boss=false, birth=Thu Feb 20 00:00:00 CST 2020, 
maps={k1=v1, k2=v2}, lists=[lisi, ahua], dog=Dog(name=小狗, age=2))

說明：在高版本中自動創建的項目@Runwith註解無法識別，
解決方法：將pom中原來的這段配置刪除掉（也可以在pom文件中換成低版本）

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
     <scope>test</scope>
     <exclusions>
         <exclusion>
             <groupId>org.junit.vintage</groupId>
             <artifactId>junit-vintage-engine</artifactId>
         </exclusion>
     </exclusions>
 </dependency>

添加新的配置：

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
   </dependency>

2. 在application.properties中寫配置

除了在application.yml中寫配置文件，同樣也可以在application.properties中寫配置：

	# 配置person的值
	person.last-name=張三
	person.age=12
	person.birth=2020/12/12
	person.boss=false
	person.maps.k1=v1
	person.maps.k2=v2
	person.lists=a,b,c
	person.dog.name=dog
	person.dog.age=3

運行SpringBoot測試類輸出結果：發現中文亂碼

Person(lastName=ï¿½ï¿½ï¿½ï¿½, age=12, boss=false, birth=Sat Dec 12 00:00:00 
CST 2020, maps={k1=v1, k2=v2}, lists=[a, b, c], dog=Dog(name=dog, age=3))

解決方法：idea的默認編碼爲utf-8，修改這個配置

3. @Value獲取值和@ConfigurationProperties獲取值比較

除了@ConfigurationProperties註解從配置文件中獲取值，還可以使用@Value註解。

	person.last-name=張三
	person.age=12
	person.birth=2020/12/12
	person.boss=false
	person.maps.k1=v1
	person.maps.k2=v2
	person.lists=a,b,c
	person.dog.name=dog
	person.dog.age=3

在xml中進行配置屬性名和屬性值：

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

如果不想使用xml，就可以使用@Value註解：

@Component
public class Person {
    @Value("#{person.last-name}")
    private String lastName;
    @Value("${age}")
    private int age;
    @Value("true")
    private boolean boss;

由此可見，@Value註解只能一個個獲取屬性的值，@ConfigurationProperties可以批量獲取配置文件中屬性的值

使用@Value註解，要使得key與配置文件中的key保持一致。但是如果使用@ConfigurationProperties註解下面的語法都可以：

person.last-name=張三
person.last_name=張三
person.lastName=張三

@ConfigurationProperties支持數據校驗，但是@Value註解不支持

@ConfigurationProperties(prefix = "person")
@Component
@Validated//加入數據校驗
public class Person {
    @Email //lastName必須是一個郵箱格式
    private String lastName;
    @Value("${age}")
    private int age;
    @Value("true")
    private boolean boss;

@Value註解在複雜類型的封裝時不支持：比如下面就會報錯

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

總結：

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
鬆散綁定（鬆散語法）	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持	不支持
複雜類型封裝	支持	不支持

配置文件yml和properties他們都能獲取到值；
如果說，我們專門編寫了一個javaBean來和配置文件進行映射，我們就直接使用@ConfigurationProperties；
如果說，我們只是在某個業務邏輯中需要獲取一下配置文件中的某項值，使用@Value；

@RestController
public class HelloController {

    @Value("${person.last-name}")
    private String name;

    @RequestMapping("/sayHello")
    public String sayHello(){
        return "hello"+name;
    }
}

4. @PropertySource&@ImportResource&@Bean

@ConfigurationProperties：默認加載全局配置文件applicaiton.properties；
@PropertySource：加載指定的配置文件；例如將Person類的信息配置在person.properties中而不是application.properties中，就要加載這個配置文件

@Data
@ConfigurationProperties(prefix = "person")
@Component
@PropertySource(value={"classpath:person.properties"})
public class Person {
    private String lastName;
    private int age;
    private boolean boss;
    private Date birth;

@ImportResource：導入Spring的配置文件，讓配置文件裏面的內容生效；
例如：

配置Spring的配置文件bean.xml文件：

<?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.hh.springboot.service.HelloService"/>
</beans>

在Springboot的測試類中驗證是否含有helloService這個類：

    @Autowired
    ApplicationContext ioc;

    @Test
    public void testHelloService(){
        boolean b = ioc.containsBean("helloService");
        System.out.println(b);//false
    }

結果爲false，是因爲Spring Boot裏面沒有Spring的配置文件，我們自己編寫的配置文件，也不能自動識別；想讓Spring的配置文件生效，就要將@ImportResource標註在一個配置類上。

@ImportResource(locations = "classpath:bean.xml")
@SpringBootApplication
public class Springboot02ConfigurationsApplication {
    public static void main(String[] args) {
        SpringApplication.run(Springboot02ConfigurationsApplication.class, args);
    }
}

但是在實際開發中，爲了給容器加組件，不可能自己寫一個Spring的配置文件，再把配置文件導進來，這樣太麻煩了。

SpringBoot推薦全註解方式來給容器中添加組件：

package com.hh.springboot.config;
/**
 * @Configuration:指明當前類是一個配置類
 *
 * 在Spring配置文件中使用bean標籤來給容器添加組件
 * 在SpringBoot中使用Bean註解
 */
@Configuration
public class MyAppConfig {

    /**
     *  @Bean:將方法的返回值添加到容器中,容器默認的id就是方法名
     * 本題返回的對象類型是HelloService
     */
    @Bean
    public HelloService helloService(){
        return new HelloService();
    }
}

【SpringBoot配置文件】：yaml和properties和幾類配置註解

文章目錄

一. 配置文件

二. YAML語法：

1. 基本語法

2. 值的寫法

2.1 字面量：普通的值（數字，字符串，布爾）

2.2 對象、Map（屬性和值）（鍵值對）

2.3 數組（List、Set）

三. 配置文件值注入

1. 在application.yml中寫配置

2. 在application.properties中寫配置

3. @Value獲取值和@ConfigurationProperties獲取值比較

4. @PropertySource&@ImportResource&@Bean

[轉帖]使用NMT和pmap解決JVM資源泄漏問題原創

Python實現大麥網搶票的四大關鍵技術點解析

Python 安裝庫指令大全

salesforce零基礎學習（一百三十八）零碎知識點小總結（十）

一款開源的.NET程序集反編譯、編輯和調試神器

關於接口協議，你必須要知道這些！

基於 Milvus + LlamaIndex 實現高級 RAG

【2024-05-21】以茶會友

【Redis高級】redis事務

【Redis高級】刪除策略

Redis:五大基本數據類型詳解

【redis高級】一、持久化

說一下 Future 和 FutureTask，以及他們之前的區別

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結