一篇文章带你掌握SpringBoot配置文件的使用和理解

大家一定要记住配置文件不是添加依赖的地方,不要搞混了

1.配置文件作用

硬编码是将数据直接嵌⼊到程序或其他可执⾏对象的源代码中, 也就是我们常说的"代码写死".

⽐如⼿机字体⼤⼩.

如果采⽤硬编码的⽅式, 就直接在程序中指定字体⼤⼩, 所有的⽤⼾使⽤的都是同⼀个字体⼤⼩但是不同的⽤⼾有不同的偏好, 我们可以把⼿机字体的⼤⼩放在配置⽂件中, 当程序启动时, 读取配置, 以⽤⼾设置的字体⼤⼩来显⽰

 使⽤配置⽂件, 可以使程序完成⽤⼾和应⽤程序的交互, 或者应⽤程序与其他应⽤程序的交互.

2.配置⽂件快速⼊⼿ 

 

3.配置⽂件的格式

yml 为yaml的简写, 实际开发中出现频率最⾼. yaml 和yml 的使⽤⽅式⼀样, 课堂中只讲yml⽂件的使⽤

当应⽤程序启动时, Spring Boot会⾃动从classpath路径找到并加载

application.properties 和 application.yaml 或者 application.yml ⽂件.

也可以通过spring.config.name指定⽂件路径和名称, 参考 https://docs.spring.io/spring

boot/docs/current/reference/html/features.html#features.external-config.files

 如下图所示:

类似商品的包装⼀样, 有新⽼两款包装. properties 类型的配置⽂件就属于⽼款包装，也是创建 Spring Boot 项⽬时默认的⽂件格式（主要是因为仓库⾥还有库存)，⽽ yml 属于新版包装如果⽤⼾了解情况直接指定要新款包装，那么就直接发给他

 特殊说明

 

4.properties 配置⽂件说明

4.1 properties 基本语法

# 配置项⽬端⼝号

server.port=8080

#配置数据库连接信息

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8&

spring.datasource.username=root

spring.datasource.password=root

 PS：⼩技巧：配置⽂件中使⽤“#”来添加注释信息.

4.2 读取配置⽂件

mykey.key1 = bite

import org.springframework.beans.factory.annotation.Value;

 import org.springframework.web.bind.annotation.RequestMapping;

 import org.springframework.web.bind.annotation.RestController;

 @RestController

 public class PropertiesController {

 @Value("${mykey.key1}")

 private String key1;

 @RequestMapping("/key")

 public String key(){

 return "读取到值:"+key1;

 }

 }

 

 最终执⾏效果：

4.3 properties 缺点分析

 使⽤ yml 连接数据库

yml 使⽤⽰例：

spring:

 datasource:

 url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false

 username: root

 password: root

 yml 和 properties 连接数据库的配置对⽐

5.2 yml 使⽤进阶

5.2.1 yml 配置不同数据类型及 null

# 字符串

string.value: Hello

# 布尔值，true或false

boolean.value: true

boolean.value1: false

# 整数

int.value: 10

# 浮点数

float.value: 3.14159

# Null，~代表null

null.value: ~

# "" 空字符串

#, 直接后⾯什么都不加就可以了, 但这种⽅式不直观, 更多的表⽰是使⽤引号括起来

empty.value: ' '

5.2.1.1 yml 配置读取

string:

    hello: bite

@RestController

public class ReadYml {

@Value("${string.hello}")

private String hello;

@RequestMapping("/ymlKey")

public String key(){

return "读取到值:"+hello;

}

}

 

 

5.2.1.2 注意事项：value 值加单双引号

string:

str1: Hello \n Spring Boot.

str2: 'Hello \n Spring Boot.'

str3: "Hello \n Spring Boot."

 读取程序实现代码如下：

@RestController

public class ReadYml {

@Value("${string.str1}")

private String str1;

@Value("${string.str2}")

private String str2;

@Value("${string.str3}")

private String str3;

@RequestMapping("/yml")

public String readYml(){

System.out.println(str1);

System.out.println(str2);

System.out.println(str3);

return "yml";

}

}

 

此处的转义理解起来会有些拗⼝, \n 本意表⽰的是换⾏

使⽤单引号会转义, 就是说, \n 不再表⽰换⾏了, ⽽是表⽰⼀个普通的字符串

使⽤双引号不会转义, 表⽰ \n 表⽰的是它本⾝的含义, 就是换⾏

JavaEE的学习重在理解和使⽤, 不纠结概念和描述

 5.2.2 配置对象

student:

id: 1

name: Java

age: 18

 或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致）：

student: {id: 1,name: Java,age: 18}

 

import lombok.Data;

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

import org.springframework.stereotype.Component;

@ConfigurationProperties(prefix = "student")

@Component

@Data

public class Student {

private int id;

private String name;

private int age;

}

 调⽤类的实现如下：

@RestController

public class StudentController {

@Autowired

private Student student;

@RequestMapping("/readStudent")

public String readStudent(){

return student.toString();

}

}

访问 http://127.0.0.1:8080/readStudent 运⾏结果如下:

 

5.2.3 配置集合

dbtypes:

name:

- mysql

- sqlserver

- db2

 集合的读取和对象⼀样，也是使⽤ @ConfigurationProperties 来读取的，具体实现如下：

@Component

@ConfigurationProperties("dbtypes")

@Data

public class ListConfig {

private List<String> name;

}

 访问集合的实现如下:

@RestController

public class ReadYml2 {

@Autowired

private ListConfig listConfig;

@RequestMapping("/readList")

public String readList(){

return listConfig.toString();

}

}

 5.2.4 配置Map

maptypes:

map:

k1: kk1

k2: kk2

k3: kk3

 或者是使⽤⾏内写法(与上⾯的写法作⽤⼀致):

maptypes: {map: {k1: kk1,k2: kk2, k3: kk3}}

@Component

@ConfigurationProperties("maptypes")

@Data

public class MapConfig {

private HashMap<String,String> map;

}

 

打印类的实现如下：

 

@RestController

public class ReadYml2 {

@Autowired

private MapConfig mapConfig;

@RequestMapping("/readMap")

public String readStudent(){

return mapConfig.toString();

}

}

 5.3 yml优缺点

 转换为yml

keycloak:

realm: demo

resource: fm-cache-cloud

credentials:

secret: d4589683-Oce7-4982-bcd3

security:

- authRoles:

- user

collections:

- name: ssologinurl

patterns:

- /login/*

 转换的过程也⽐较花费精⼒, 如果配置更复杂⼀点, 可读性会更差, 代码也会更难写