SpringBoot配置文件

配置文件的作用

整个项目中所有重要的数据都是在配置⽂件中配置的，比如：

• 数据库的连接信息（包含用户名和密码的设置）
• 项目的启动端口
• 第三方系统的调用秘钥等信息
• 用于发现和定位问题的普通日志和异常日志等

如果没有配置信息，那么 Spring Boot 项目就不能连接和操作数据库，甚至是不能保存可以用于排查问题的关键日志，所以配置文件的作用是非常重要的

配置文件的格式

Spring Boot 配置文件主要分为以下两种格式：

• .properties
• .yml

如图所示：

为什么会有两种格式的配置文件？

.properties 和 .yml 都是 Spring Boot 支持的两种配置文件，它们可以看作是 Spring Boot 在不同时期的两款“产品”。在 Spring Boot 时代已经不需要使用 XML 文件格式来配置项目了，取而代之的是 .properties 或 .yml 文件。

.properties 配置文件属于早期，也是目前创建 Spring Boot（2.x）项目时默认的配置文件格式，而 .yml可以看做是对 .properties 配置文件的升级，属于 Spring Boot 的“新版”配置文件。

特殊说明

1. 理论上讲 .properties 可以和 .yml ⼀起存在于⼀个项目当中，当 .properties 和 .yml ⼀起存在⼀个项目中时，如果配置文件中出现了同样的配置，比如 .properties 和 .yml 中都配置了“server.port”，那么这个时候会以 .properties 中的配置为主，也就是 .properties 配置文件的优先级最高，但加载完 .properties 文件之后，也会加载 .yml 文件的配置信息
2. 虽然理论上来讲 .properties 可以和 .yml 共存，但实际的业务当中，我们通常会采取⼀种统⼀的配置文件格式，这样可以更好的维护（降低故障率）

.properties 配置文件说明

.properties 配置文件是最早期的配置⽂件格式，也是创建 Spring Boot 项目默认的配置⽂件

.properties 基本语法

.properties 配置文件的基本用法如下：

# 配置项目启动端口号
server.port=8081
# 开启调试模式
debug=true
# 配置数据连接信息
spring.datasource.url=jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root

配置文件中使用“#”来添加注释信息
从上述配置文件可以看出：.properties 是以键值的形式配置的，key 和 value 之间是以“=”连接的

关于 .properies 中文乱码的问题处理：

将步骤3和步骤4都选择UTF-8

不仅要配置当前文件，还需要配置新创建项目的乱码问题

都配置完成后，将原来的 application. properies 删除掉，重新再创建一个application. properies。
因为之前的配置文件已经是不支持中文编码的文件格式化，设置编码再创建 application.properies 之后，后设置的编码不会改变原来旧的 application.properies 文件，所以需要先将之前的配置文件删除掉重新创建。

经过以上步骤后，无论是当前 application.properies 文件还是新创建项目的 application.properies 文件，都将支持中文编码

.properies 读取配置信息

如果在项目中，想要主动的读取配置文件中的内容，可以使用 @Value 注解来实现

@Value 注解使用“${}”的格式读取，如下代码所示：

@Controller
public class UserController {

    @Value("${server.port}")
    private String port;

    @ResponseBody // 表示返回一个非静态页面的数据
    @RequestMapping("sayhi") //设置路由地址 sayhi，建议写成小写
    public String sayHi() {
        return "hello Spring Boot | port:" + port;
    }
}

从上述配置key看出，.properties 配置文件中会有很多的冗余的信息，例如：

想要解决这个问题，就可以使使用 .yml 配置文件的格式化了

.yml 配置说明

.yml 是⼀个可读性高，易于理解，用来表达数据序列化的格式。它的语法和其他高级语⾔类似，并且可以简单表达清单（数组）、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件等。

yml 最大的优势是可以跨语言，不止是 Java 中可以使用 golang、python 都可以使用 .yml 作为配置文件

.yml 基本语法

.yml 是树形结构的配置⽂件，它的基础语法是“key: value”，注意 key 和 value 之间使用英⽂冒号加空格的方式组成的，其中的空格不可省略

使用 .yml 配置连接数据库信息

spring:
  datasource:
    url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8
    username: root
    password: root

和 .properties 配置连接数据库信息确实要简略不少

.yml 进阶使用

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

# 字符串
string.value: Hello
# 布尔值，true或false
boolean.value: true
boolean.value1: false
# 整数
int.value: 10
int.value1: 0b1010_0111_0100_1010_1110 # ⼆进制
# 浮点数
float.value: 3.14159
float.value1: 314159e-5 # 科学计数法
# Null，~代表null
null.value: ~

使用 .yml 配置对象

student:
  id: 1
  name: fl
  age: 22

或者是使用行内写法（与上的写法作用⼀致）

student: {id: 1,name: fl,age: 22}

使用 .yml配置集合

配置文件也可以配置 list 集合，例如：

dbtypes:
  name:
    - mysql
    - sqlserver
    - db2

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

dbtypes: {name: [mysql,sqlserver,db2]}

.yml 读取配置信息

myyml:
  String: hello,yml

读取方式也是 @Value 注解使用“${}”

@Controller
public class UserController {

    @Value("${myyml.string}")
    private String ymlstr;

    @ResponseBody // 表示返回一个非静态页面的数据
    @RequestMapping("/sayhi") //设置路由地址 sayhi，建议写成小写
    public String sayHi() {
        return "hello Spring Boot | myyml.string:" + ymlstr;
    }
}

.yml 单双引号的问题

.yml 中配置如下信息：

string:
  str1: Hello \n .yml
  str2: 'Hello \n .yml'
  str3: "Hello \n .yml"

读取程序实现代码如下：

@Controller
public class UserController {
    
    @Value("${string.str1}")
    private String str1;
    
    @Value("${string.str2}")
    private String str2;

    @Value("${string.str3}")
    private String str3;
    
    @ResponseBody // 表示返回一个非静态页面的数据
    @RequestMapping("/sayhi") //设置路由地址 sayhi，建议写成小写
    public void sayHi() {
        System.out.println(str1);
        System.out.println(str2);
        System.out.println(str3);
    }
}

结果：

从上述结果可以看出：
字符串默认不用加上单引号或者双引号。
单引号不会转义特殊字符，特殊字符最终只是⼀个普通的字符串数据。
双引号会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思。

读取配置中的对象不能再使用 @Value，而要使用另⼀个注解 @ConfigurationProperties来读取

.yml 中的配置信息：

student:
  id: 1
  name: fl
  age: 22

在demo目录下新建一个 Student 类，并且加上注解 @ConfigurationProperties(prefix = “student”)，代码如下：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Data
@ConfigurationProperties(prefix = "student")
@Component
public class Student {
    private int id;
    private String name;
    private int age;
}

采用五大类注解，将对象注入，打印类代码如下：

@Data
@Controller
public class UserController {
    @Autowired
    private Student student;

    @ResponseBody // 表示返回一个非静态页面的数据
    @RequestMapping("/sayhi") //设置路由地址 sayhi，建议写成小写
    public String sayHi() {
        return "student:" + student;
    }
}

最终结果：

集合的读取和对象⼀样，也是使用 @ConfigurationProperties(prefix = “dbtypes”) 来读取的，具体实现如下：

.yml 配置信息：

dbtypes:
  name:
    - mysql
    - sqlserver
    - db2

@Component
@ConfigurationProperties("dbtypes")
@Data
public class ListConfig {
    private List<String> name;
}

采用五大类注解，将对象注入，打印类代码如下：

@Data
@Controller
public class UserController {
    @Autowired
    private ListConfig listConfig;

    @ResponseBody // 表示返回一个非静态页面的数据
    @RequestMapping("/sayhi") //设置路由地址 sayhi，建议写成小写
    public String sayHi() {
        return "ListConfigName:" + listConfig.getName();
    }
}

最终结果：

.properties VS .yml

• .properties 是以 key=value 的形式配置的键值类型的配置文件，而 .yml 使用的是类似 json 格式的树形配置方式进行配置的，.yml 层级之间使用换行缩进的方式配置，key 和 value 之间使用“ : ”英⽂冒号加空格的方式设置，并且空格不可省略。
• .properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使用 .yml 可以很好的解决数据冗余的问题。
• .yml 通用性更好，支持更多语言，如 Java、Go、Python 等，如果是云服务器开发，可以使用⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件。
• .yml 虽然可以和 .properties 共存，但⼀个项目中建议使用统⼀的配置类型文件