SpringBoot读取配置文件

前文叙述

开发过程中遇到这样一个需求，因为项目部署在客户内网，每次打包都需重新刻盘、登记等。一些诸如变量、算法路径的调整每次都需要重新打包，很是麻烦。因此研究了一波直接将他们提取到配置文件中，代码应用的地方读取配置文件（application.yml ）中配置的变量或对象，从而达到线上灵活调整的目的。
本文将会围绕 SpringBoot 读取配置文件常用的几种方式进行用法介绍。

方式一、@value

只能读取纯量类型。（纯量：是最基本的、不可再分的值。如支持字符串、布尔值、整数、浮点数、Null、时间、日期。）

1.1 在application.yml文件：

# 纯量类型
name: Java
person: man
age: 18

1.2 HelloController中使用：

@RequestMapping("/hello")
@RestController
public class HelloController {

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

    @Value("${person}")
    private String person;

    @Value("${age}")
    private int age;

    @GetMapping("/test")
    public Object readTest() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("name", name);
        result.put("person", person);
        result.put("age", age);
        return result;
    }
}

1.3 实现效果

方式二、Environment

Environment 也是只能读取纯量类型。（纯量：是最基本的、不可再分的值。如支持字符串、布尔值、整数、浮点数、Null、时间、日期。）

2.1 在application.yml文件：

# 纯量类型
book: 画江湖之不良人
visited: 全体不良人
price: 18.8

2.2 HelloController中使用：

@RequestMapping("/hello")
@RestController
public class HelloController {

        @Autowired
    private Environment environment;

    @RequestMapping("/test2")
    public Object test2() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("book", environment.getProperty("book"));
        result.put("visited", environment.getProperty("visited"));
        result.put("price", environment.getProperty("price"));
        return result;
    }
}

2.3 实现效果

运行之后访问，如果视图出现如下乱码问题的话就需要设置一下 idea 的编码格式（不乱码忽略设置就好）：

设置如下：

最终实现效果：

方式三、@ConfigurationProperties + @EnableConfigurationProperties

将属性抽取到一个公共的属性类中，实现代码复用。（注意：也可单纯使用 @ConfigurationProperties 注解在需要读取的 Controller 文件中使用，记得一定要提供属性的 set 方法哈，这种也算是一种方式，而方式三相当于此方式的优化升级版）

3.1 在application.yml文件：

# 复杂对象
books:
  bookName: 画江湖之不良人
  content: 李星云、袁天罡、不良人、女帝等，内容蕴意颇深，值得观看和推敲
  bookPrice: 9.9
  mainMan:
    - 李星云
    - 不良帅
    - 袁天罡
    - 女帝
    - 女主

3.2 公共属性类BookProperties：

/**
 * 必须提供 set 方法。
 */
@Data
@ConfigurationProperties(prefix = "books")
public class BookProperties {

    private String bookName;
    private String content;
    private Double bookPrice;
    private List<String> mainMan; // 也可以数组: private String[] mainMan;

}

3.3 HelloController中使用：

@RequestMapping("/hello")
@RestController
@EnableConfigurationProperties(BookProperties.class) // 指定某类生成 Bean
public class HelloController {

    @Autowired
    private BookProperties bookProperties;
    @RequestMapping("/test3")
    public Object test3() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("bookName", bookProperties.getBookName());
        result.put("content", bookProperties.getContent());
        result.put("bookPrice", bookProperties.getBookPrice());
        result.put("mainMan", bookProperties.getMainMan());
        return result;
    }
}

3.4 实现效果