Spring Boot简明教程--Spring Boot 属性注入

@Value注入

//application.yml中配置
user.name=admin 
// 属性类代码
@Component
public class MyBean {

    @Value("${user.name}")
    private String name;

    // ...应有属性的getter、setter方法

}

注意:

  • 属性类上的@Component一定要加上,只有加上该注解,这个属性类才会被加载到Spring的容器中,才可被注入使用。
  • 注入和之前将的一样有JavaBean 属性绑定和构造器绑定,通常设置该属性类的getter、setter方法即可,否则属性值不能进行绑定
  • 需要注入的属性是写在配置文件中的,但是不排除通过命令行执行的时候注入情况java -jar app.jar --user.name="Spring"
  • 配置不一定写在application.yml中也可能单独新建一个配置文件,这时候步骤为:1)在resource目录下新建user.yml文件,写入配置属性。2)使用@PropertySource("classpath:user.yml")定义配置文件位置
// 属性类代码
@Component
@PropertySource("classpath:user.yml")
public class MyBean {

    @Value("${user.name}")
    private String name;

    // ...应有属性的getter、setter方法

}

类型安全的属性注入

使用@Value(“ $ {property}”)批注来注入配置属性有时会很麻烦,尤其是使用多个属性或数据本质上是分层时。 Spring Boot提供了一种使用属性的替代方法,该方法使强类型的Bean可以管理和验证应用程序的配置。
在MyBean上加上注解:@ConfigurationProperties(prefix = "user")

// 属性类代码
@Component
@PropertySource("classpath:user.yml")
@ConfigurationProperties(prefix = "user")
public class MyBean {

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

    // ...应有属性的getter、setter方法

}

注入复杂数据类型

上面描述的都是简单的数据类型注入方法,那么复杂的数据类型应该怎么在配置文件中定义呢?假如有一个MyPojo 有name和description两个属性,在AcmeProperties定义MyPojo的List和Map值。

List

单纯的List

  • application.yml
//list: [111,222]也是可以的
zp:
  list:
    - 111
    - 222
  name: 666
  • Zp.java
@ConfigurationProperties(prefix = "zp")
@Data
@Component
public class Zp {
    private List<String> list;
}
  • controller
@RequiredArgsConstructor
@RestController
public class HelloController {
//    @Autowired
    private final Zp zp;
    @Value("${zp.name}")
    private String name;
    @RequestMapping("/test")
    public List<String> hello(){
        return zp.getList();
    }
    @RequestMapping("/test1")
    public String hello1(){
        return name;
    }
}

包含类的List

  • application.yml
zp:
  list:
    - name: "my name"
      description: "my description"
    - name: "another name"
      description: "another description"
  • application.properties
zp.list[0].name=my name
zp.list[0].description=my description
zp.list[1].name=another name
zp.list[1].description=another description
  • Zp.java
@ConfigurationProperties(prefix = "zp")
@Data
@Component
public class Zp {
    private List<MyPojo> list;

    @Data
    public static class  MyPojo{
        private String name;
        private String description;
    }
}

Map

  • application.yml
zp:
  map:
    key1:
      name: "dev name 1"
    key2:
      name: "dev name 2"
      description: "dev description 2"
  • application.properties
zp.map.key1.name=dev name 1
zp.map.key2.name=dev name 2
zp.map.key2.description=dev description 2
  • Zp.java
@ConfigurationProperties(prefix = "zp")
@Data
@Component
public class Zp {
    private Map<String, MyPojo> map;

    @Data
    public static class  MyPojo{
        private String name;
        private String description;
    }
}

补充知识

SpEL(Spring Expression Language)即Spring表达式语言,可以在运行时查询和操作数据。使用#{...}作为定界符, 所有在大括号中的字符都将被认为是 SpEL。

#{…}和${…}

${…}用于获取属性文件中对应的值,但是如果属性文件中没有这个属性,则会报错。可以通过赋予默认值解决这个问题

@Value("${zp.host:127.0.0.1}")

#{…}{}里面的内容必须符合SpEL表达式,常见的如

@Value("#{'Hello World'.concat('!')}")
@Value("#{'Hello World'.bytes.length}")
@Value("#{'${words}'.split('\\|')}")
/**
 * 注入其他Bean属性:注入config对象的属性tool
 */
@Value("#{config.tool}")

参考文献

https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-typesafe-configuration-properties

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

推荐阅读更多精彩内容