分享一下yaml不同配置类型的使用(常见类型、列表、Map、嵌套等)

在 Spring Boot 中,YAML 配置文件可以映射到不同类型的 Java 配置类。根据 YAML 配置的不同数据类型,你需要使用相应的 Java 数据类型来进行映射。以下是常见的 YAML 数据类型及其对应的 Java 配置类映射。

YAML 配置类型 示例 YAML 配置 示例 Java 配置类
字符串、数字、布尔值
app:
name: "My Application"
timeout: 3000
enabled: true

private String name;
private int timeout;
private boolean enabled;
列表、数组
app:
servers:
- "server1.example.com"
- "server2.example.com"

private List<String> servers;
private String[] servers;
映射 (Map)
app:
tokens:
-1: "xxxx"
-2: "yyyy"

private Map<String, String> tokens;
嵌套对象
app:
database:
url: "jdbc:mysql://xxx"
username: "user"
password: "pass"

private Database database;
public static class Database { ... }
多层嵌套对象
app:
server:
address: "localhost"
port: 8080
ssl:
enabled: true
certificate: "/path/to/cert"

private Server server;
public static class Server { ... }
日期和时间
app:
startDate: "2024-01-01"

private LocalDate startDate;

1. 字符串、数字、布尔值

YAML 配置

app:
  name: MyApplication
  timeout: 3000
  maxRetries: 5
  enabled: true

Java 配置类

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

@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
    private String name;
    private int timeout;
    private int maxRetries;
    private boolean enabled;
}
  • 对于字符串,配置可使用引号" '(单引号或双引号)包含。对应java类型是String
  • 对于数字类型,你可以映射成 int, long, double 等基本数据类型,或者包装类型 Integer, Long, Double 等。
  • 布尔值对应的 Java 类型是 boolean 或 Boolean。

使用这些简单类型的如果只有一个值也可以直接使用@Value的方法引入,还可以在@Value中配置中指定默认值,如

@Service
public class OrderService {

    @Value("${app.name:defultAppName}")
    private String appName;

    public void printAppName() {
        System.out.println("appName: " +appName);
     }         
}

2. 列表 (List)、 数组 (Array)

YAML 配置

app:
  servers:
    - "server1.example.com"
    - "server2.example.com"
    - "server3.example.com"

Java 配置类

1)使用列表进行映射

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
*  
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
    private List<String> servers;
}

2)使用数组进行映射


import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
*  使用数组进行映射
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
     private String[] servers;
}

  • 当配置为多项时,可以使用列表List<String>,或者数组String[]进行映射。

3. Map

YAML 配置

app:
  tokens:
    1: "xxxx"
    2: "yyyy"

Java 配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
*  
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
  private Map<String, String> tokens;
}
  • 对应的 Java 类型是 Map<K, V>,其中 KV分别是键和值的类型。

4. 嵌套对象 (Nested Objects)

YAML 配置

app:
  database:
    url: "jdbc:mysql://localhost:3306/mydb"
    username: "user"
    password: "pass"
  xxx:
    xx:  123

Java 配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
*  
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
    private Database database;
    private Xxx xxx;

    @Data
    public static class Database {
        private String url;
        private String username;
        private String password;
    }
    @Data
    public static class XXX{
        private String xx;
    }
}
  • 对应的 Java 类型是一个嵌套类或一个独立的 Java Bean 类。
  • Spring Boot 会自动将嵌套的 YAML 配置映射到 Java 类的嵌套对象。

5. 多层嵌套对象 (Nested Objects with Multiple Levels)

YAML 配置

app:
  server:
    address: "localhost"
    port: 8080
    ssl:
      enabled: true
      certificate: "/path/to/cert"

Java 配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
*  
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
    private Server server;
    @Data
    public static class Server {
        private String address;
        private int port;
        private Ssl ssl;
        @Data
        public static class Ssl {
            private boolean enabled;
            private String certificate;
        }
    }
}
}
  • 对应的 Java 类型是多层嵌套的 Java 类。
  • Spring Boot 支持多级嵌套的配置映射到对应的 Java 对象。

6. 日期和时间 (Date, LocalDate, LocalDateTime...)

YAML 配置

app:
  startDate: "2025-01-01"

Java 配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.time.LocalDate;
/**
*  
*/
@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
@Data
public class AppConfig {
    private LocalDate startDate;
}
  • Spring Boot 可以自动将 YAML 中的日期和时间字符串映射到 java.time.LocalDate, LocalDateTime, Instant 等类型。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,752评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,100评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,244评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,099评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,210评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,307评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,346评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,133评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,546评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,849评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,019评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,702评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,331评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,030评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,260评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,871评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,898评论 2 351

推荐阅读更多精彩内容