快捷導(dǎo)航

springboot讀取yml文件中的list列表、數(shù)組、map集合和對(duì)象方法實(shí)例

更新時(shí)間：2023年02月24日 10:32:08 作者：是阿俏同學(xué)吖

在平時(shí)的yml配置文件中,我們經(jīng)常使用到配置基本數(shù)據(jù)類(lèi)型的字符串,下面這篇文章主要給大家介紹了關(guān)于springboot讀取yml文件中的list列表、數(shù)組、map集合和對(duì)象的相關(guān)資料,需要的朋友可以參考下

前言

springboot配置文件yml類(lèi)型簡(jiǎn)單的風(fēng)格，十分受大家的歡迎，支持字符string類(lèi)型，支持列表list類(lèi)型，支持集合map類(lèi)型，支持?jǐn)?shù)組array類(lèi)型，支持類(lèi)對(duì)象類(lèi)型，下面我們來(lái)實(shí)戰(zhàn)下這些形式的配置如何取值

application.yml定義list集合

第一種方式使用@ConfigurationProperties注解獲取list集合的所有值

type:
  code:
    status:
      - 200
      - 300
      - 400
      - 500

編寫(xiě)配置文件對(duì)應(yīng)的實(shí)體類(lèi),這里需要注意的是，定義list集合，先定義一個(gè)配置類(lèi)Bean，然后使用注解@ConfigurationProperties注解來(lái)獲取list集合值，這里給大家講解下相關(guān)注解的作用

@Component 將實(shí)體類(lèi)交給Spring管理
@ConfigurationProperties(prefix = “type.code”) 讀取yml文件中的list
@Data 自動(dòng)生成getter和setter方法

如下圖所示

package com.o2o.data;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "type.code") // 配置文件的前綴
@Data
public class TypeCodeConfig {
    private List<String> status;

    public void setStatus(List<String> status){
        this.status = status;
    }
    public List<String> getStatus(){
        return status;
    }
}

然后在要使用的地方自動(dòng)注入，我是直接在啟動(dòng)類(lèi)中讀取這個(gè)list，需要注意，使用yml中配置的list需要先將對(duì)象注入，然后通過(guò)get方法讀取配置文件中的的值。

@Autowired private TypeCodeConfig typeCodeConfig; 使用注解將對(duì)象注入
System.out.println(typeCodeConfig.getStatus()); 調(diào)用getter方法讀取值

package com.o2o;

import com.o2o.data.TypeCodeConfig;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@MapperScan("com.o2o.mapper")
public class AutoTestApplication implements CommandLineRunner {

	public static void main(String[] args) {
		SpringApplication.run(AutoTestApplication.class, args);
	}

	@Autowired
	private TypeCodeConfig typeCodeConfig;

	@Override
	public void run(String... args) throws Exception {
		System.out.println(typeCodeConfig.getStatus());

啟動(dòng)springboot我們已經(jīng)從控制臺(tái)成功讀取到y(tǒng)ml文件中l(wèi)ist集合的所有值了

第二種方式使用@value注解獲取list集合的所有值

yml文件配置如下

student:
  ids:
    - 7
    - 8
    - 9

然后創(chuàng)建一個(gè)實(shí)體類(lèi)

@Data
public class Student {
    @Value("${student.ids}")
    private List<Integer> ids;

}

再新建一個(gè)對(duì)list屬性的配置類(lèi)

@Component
@ConfigurationProperties(prefix = "student")
@Data
public class TypeCodeConfig {

private List<Integer> ids;

   public void setIds(List<Integer> ids) {
       this.ids = ids;
   }
      public  List<Integer> getIds(){
       return ids;
}

在啟動(dòng)類(lèi)中注入

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@MapperScan("com.o2o.mapper")
public class AutoTestApplication implements CommandLineRunner {

	public static void main(String[] args) {
		SpringApplication.run(AutoTestApplication.class, args);
	}

	@Autowired
	private TypeCodeConfig typeCodeConfig;
	
	@Override
	public void run(String... args) throws Exception {

		System.out.println(typeCodeConfig.getIds());
	}

啟動(dòng)springboot我們已經(jīng)從控制臺(tái)成功讀取到y(tǒng)ml文件中l(wèi)ist集合的所有值了

application.yml定義數(shù)組類(lèi)型

yml配置文件如下圖所示

dataSync: enable: true type: - "1" - "2" - "3"

通過(guò)@value注解獲取數(shù)組值

@Value("${dataSync.enable.type}")
 private String[] type;

也可以通過(guò)創(chuàng)建配置類(lèi)bean，使用@ConfigurationProperties注解獲取，如下圖所示：

@Data
@Component
@ConfigurationProperties(prefix = "dataSync.enable") // 配置 文件的前綴
public class InterceptorPathBean
{  
    private String[] type;
}

yml文件還可以存放對(duì)象和對(duì)象的集合，使用方法與基本類(lèi)型類(lèi)似。
簡(jiǎn)單舉例：

定義map集合配置

interceptorconfig:
  path:
    maps:
      name: 小明
      age: 24

通過(guò)創(chuàng)建配置類(lèi)bean，使用@ConfigurationProperties注解獲取map值，如下圖所示

@Data
@Component
@ConfigurationProperties(prefix = "interceptorconfig.path") // 配置 文件的前綴
public class InterceptorPathBean
{
    private Map<String , String> maps;
}

使用對(duì)象配置

student:
  id: 1
  name: Bruce
  gender: male

使用對(duì)象集合配置

students: 
  - id: 1
    name: Bruce
    gender: male
  - id: 2
    name: ...
    ...

這里我給大家總結(jié)一些需要重要的點(diǎn)：

1、list類(lèi)型的yml配置文件中，需要使用"-"來(lái)組成一個(gè)列表集合。

2、yml中的前綴沒(méi)有層級(jí)限制，如果是多層級(jí)，比如這里的demo/code，在java類(lèi)中配置ConfigurationProperties注解的prefix就寫(xiě)作"demo.code"

3、屬性名稱(chēng)在yml文件中支持連字符"-"，比如four-span，在java類(lèi)中配置屬性就需要轉(zhuǎn)為駝峰式，fourSpan。

4、java類(lèi)屬性需要配置set,get方法。

總結(jié)

到此這篇關(guān)于springboot讀取yml文件中的list列表、數(shù)組、map集合和對(duì)象的文章就介紹到這了,更多相關(guān)springboot讀取yml文件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: