SpringBoot 配置的加载

2020 年 9 月 20 日
筆記
Config, JAVA, Spring Boot, 知识笔记

SpringBoot 配置的加载

SpringBoot配置及环境变量的加载提供许多便利的方式，接下来一起来学习一下吧!

本章内容的源码按实战过程采用小步提交，可以按提交的节点一步一步来学习，仓库地址：//github.com/zhouweixin/spring-boot-configuration。

环境：

java: 1.8.0_265
gradle: 6.6.1

1 准备

用你喜欢的方式创建一个SpringBoot工程，并写一个hello的接口，及相应的集成测试，进行实验吧！

1.1 hello接口代码

HelloController.java

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello world!";
    }
}

1.2 hello集成测试代码

HelloControllerTest.java

@SpringBootTest
@AutoConfigureMockMvc
class HelloControllerTest {
    @Autowired
    MockMvc mockMvc;

    @Test
    void hello() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("//localhost:8080/hello"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.jsonPath("$", Matchers.is("Hello world!")));
    }
}

2 注解@Value

2.1 介绍

@Value通过直接注解在属性上为属性设置

如下所示，为name设置值为tangseng

HelloController.java

@Value("tangseng")
private String name;

2.2 加载配置文件

当然，上面的写法不涉及配置文件的读取，但是从配置文件加载数据也是同样简单

如下所示，在${}中用json的方式设置配置文件中设置的key值

HelloController.java

@Value("${value.string}")
private String valueString;

配置文件的内容为

application.properties

value.string=sunwukong

2.3 数据类型转换

当然，@Value的功能还远不止于此，它可以实现数据类型的转换

即，在配置文件中配置的所有内容是没有数据类型的，@Value会根据属性的类型，实现自动转换

如下所示，基本数据类型@Value注解都是可以正确转换的，使用起来有没有感觉很简单呢？

application.properties

value.int=1
value.float=1.11
value.string=sunwukong
value.bool=true

HelloController.java

@Value("${value.int}")
private int valueInt;

@Value("${value.float}")
private float valueFloat;

@Value("${value.string}")
private String valueString;

@Value("${value.bool}")
private boolean valueBool;

2.4 默认值

写到这里，你肯定认为@Value注解的功能就结束了

然而，并没有，@Value还可以设置默认值

即，假如配置文件中没有配置该属性，也可以有默认值兜底的

默认值的设置格式如下所示

HelloController.java

@Value("${value.double:2.22}")
private double valueDouble;

2.5 时间转换

这次，你一定又一次认为@Value的学习结束了，但是想再分享@Value对时间的处理，因为实际项目中经常会配置超时时间等类似的时间，比较实用

假如配置文件里配置了timeout=60，你认为是60s呢还是60ms，或是60m，是不是有点不清楚呢？

因此，多是配置成timeout=60s, 利用@DurationUnit进行单位的转换

还是看个例子比较直观些

首先配置一个10分钟

application.properties

value.time=10m

然后用秒去解析，看看结果是否正确，这里悄悄告诉你，结果依然是正确的，转成了600s

HelloController.java

@Value("${value.time}")
@DurationUnit(ChronoUnit.SECONDS)
private Duration time;

2.6 集成测试

接下来，写个接口及集成测试，测试一下结果

HelloController.java

@GetMapping("/helloValue")
public Object helloValue() {
    Map<String, Object> map = new HashMap<>();
    map.put("name", name);
    map.put("valueInt", valueInt);
    map.put("valueFloat", valueFloat);
    map.put("valueString", valueString);
    map.put("valueBool", valueBool);
    map.put("valueDouble", valueDouble);
    return map;
}

HelloControllerTest.java

@Test
void helloValue() throws Exception {
    mockMvc.perform(MockMvcRequestBuilders.get("//localhost:8080/helloValue"))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.name", Matchers.is("tangseng")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.valueInt", Matchers.is(1)))
            .andExpect(MockMvcResultMatchers.jsonPath("$.valueFloat", Matchers.is(1.11)))
            .andExpect(MockMvcResultMatchers.jsonPath("$.valueString", Matchers.is("sunwukong")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.valueBool", Matchers.is(true)))
            .andExpect(MockMvcResultMatchers.jsonPath("$.valueDouble", Matchers.is(2.22)))
            .andExpect(MockMvcResultMatchers.jsonPath("$.time", Matchers.is("600s")));
}

当然也可以用请求查看一下结果

$ curl //localhost:8080/helloValue
{"valueString":"sunwukong","name":"tangseng","valueDouble":2.22,"time":"600s","valueInt":1,"valueFloat":1.11,"valueBool":true}

3 注解@ConfigurationProperties

3.1 介绍

@ConfigurationProperties实现了更加丰富的功能，但是该属性需要配置@ConfigurationPropertiesScan使用

即，首先需要将@ConfigurationPropertiesScan注解到启动类上，即XxxApplication.java

然后便可以利用@ConfigurationProperties上

@ConfigurationProperties是用来注解类上，用来批量从配置文件中加载数据

比如，配置中有如下属性

application.properties

student.name=xiaoming
[email protected]
student.age=18

便可以定义Student类，并将@ConfigurationProperties注解其上

注意：属性名需要和配置文件里对应的名字相同，你肯定观察到了

Student.java

@ConfigurationProperties("student")
public class Student {
    private String name;
    private String email;
    private int age;
    
    // ... 省略setter, getter方法， setter方法必须有
}

3.2 加载集合数据

@ConfigurationProperties除了可以读单值数据，也可以读List和Map数据

比如，配置文件里有如下配置

application.properties

# class.list
student.friends[0]=zhubajie
student.friends[1]=shaheshang

# class.map
student.parent.father=tangseng
student.parent.mother=nverguoguowang

只需要在Student类中再添加两个属性即可，不要忘记setter和getter方法哟

Student.java

private List<String> friends;
private Map<String, String> parent;

添加getStudent接口

HelloController.java

@GetMapping("/getStudent")
public Student getStudent() {
    return student;
}

3.3 集成测试

HelloControllerTest.java

@Test
void getStudent() throws Exception {
    mockMvc.perform(MockMvcRequestBuilders.get("//localhost:8080/getStudent"))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.name", Matchers.is("xiaoming")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.email", Matchers.is("[email protected]")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.age", Matchers.is(18)))
            .andExpect(MockMvcResultMatchers.jsonPath("$.friends[0]", Matchers.is("zhubajie")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.friends[1]", Matchers.is("shaheshang")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.parent.father", Matchers.is("tangseng")))
            .andExpect(MockMvcResultMatchers.jsonPath("$.parent.mother", Matchers.is("nverguoguowang")));
}

直接求观测也是可以的

$ curl //localhost:8080/getStudent
{"name":"xiaoming","email":"[email protected]","age":18,"friends":["zhubajie","shaheshang"],"parent":{"father":"tangseng","mother":"nverguoguowang"}}

Tags: Config JAVA Spring Boot 知识笔记