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 list;
}

controller

@RequiredArgsConstructor
@RestController
public class HelloController {
//    @Autowired
    private final Zp zp;
    @Value("${zp.name}")
    private String name;
    @RequestMapping("/test")
    public List 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 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 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