SpringBoot【配置文件】

时间：2022-12-16 22:53:19

SpringBoot【配置文件】

????一.配置文件

Spring的 生态系统我们了解即可之后的学习我们都会遇到
SpringBoot【配置文件】

????1.1 配置文件作用

整个项⽬中所有重要的数据都是在配置⽂件中配置的，⽐如：
●数据库的连接信息（包含⽤户名和密码的设置）

●项⽬的启动端⼝

●第三⽅系统的调⽤秘钥等信息

●⽤于发现和定位问题的普通⽇志和异常⽇志等

想象⼀下如果没有配置信息，那么 Spring Boot 项⽬就不能连接和操作数据库，甚⾄是不能保存可以⽤于排查问题的关键⽇志，所以配置⽂件的作⽤是⾮常重要的

????1.2 配置⽂件的格式

Spring Boot 配置⽂件主要分为以下两种格式：
● properties(老版)

● yml(新版 类似于json格式)

SpringBoot【配置文件】
这就好像连锁店⾥⾯的统⼀服装⼀样，有两种不同的款式，properties 类型的配置⽂件就属于⽼款“服饰”，也是创建 Spring Boot 项⽬时默认的⽂件格式（主要是由于仓库⾥还有库存），而 yml 属于新版款式，如果⽤户了解情况直接指定要新款服饰，那么就直接发给他

  1. 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中，当 properties 和 yml ⼀起存在⼀个项⽬中时，如果配置⽂件中出现了同样的配置，⽐如 properties 和 yml 中都配置了“server.port”，那么这个时候会以 properties 中的配置为主，也就是 .properties 配置⽂件的优先级最⾼，但加载完 .properties ⽂件之后，也会加载 .yml ⽂件的配置信息

  2. 虽然理论上来讲 .properties 可以和 .yml 共存，但实际的业务当中，我们通常会采取⼀种统⼀的配置⽂件格式，这样可以更好的维护（降低故障率）。这就好像连锁店的服饰⼀样，不管是⽼款的服装还是新款的服装，⼀定要统⼀了才好看特殊说明

????二.properties 配置文件

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

????2.1 properties 基本语法

properties 是以键值的形式配置的，key 和 value 之间是以“=”连接的，如在我们设置端口号和数据库连接端口时：
SpringBoot【配置文件】
配置⽂件中使⽤“#”来添加注释信息

????2.2 properties快捷生成插件(spring tools)

大家记得下载后进行重启
SpringBoot【配置文件】

????2.3 读取properties 配置文件

如果在项⽬中，想要主动的读取配置⽂件中的内容，可以使⽤ @Value 注解来实现。@Value 注解使⽤“${}”的格式读取，如下代码所示：

@Controller
public class UserController {

    @Value("${server.port}")
    private Integer port;
    @ResponseBody  //返回一个非静态页面的数据
    @RequestMapping("/sayhi") //设置路由url/第一路径
    
    public String sayHi(){
        return "hello:" + port;
    }
}

SpringBoot【配置文件】
SpringBoot【配置文件】

????2.4 解决properties的乱码问题

解决properties的乱码问题
SpringBoot【配置文件】
配置项目中中文乱码的问题
SpringBoot【配置文件】
SpringBoot【配置文件】
因为.properties文件是在我们设置之前就已经创建了的,所有我们需要将之前创建好的.properties文件删除重新进行创建才能解决中午乱码创建问题

????2.5 properties 缺点分析

properties 配置是以 key-value 的形式配置的，如下代码所示：

spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=UTF8&autoReconnect=true&useSSL=false
spring.datasource.name=root
spring.datasource.password=jj1432644716

从上述配置key看出，properties 配置⽂件中会有很多的冗余的信息，⽐如这些：
SpringBoot【配置文件】
想要解决这个问题，就可以使⽤ yml 配置⽂件的格式化了

????三.yml 配置文件

yml 是 YAML 是缩写，它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语⾔”

yml 优点分析:
● yml 是⼀个可读性⾼，写法简单、易于理解，它的语法和 JSON 语⾔类似

● yml ⽀持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩

● 符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等

● yml ⽀持更多的编程语⾔，它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中

????3.1 yml 基本语法

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

其中第⼀项的配置为正确的，key 也是⾼亮显示的，⽽第⼆项没有空格是错误的使⽤⽅式，第⼆项的key 也没有⾼亮显示

yml连接数据库示例:
SpringBoot【配置文件】

????3.2 yml 进阶语法

????3.2.1 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: ~

这里我们获取对象的名在@Value中是不能重复的会报错
SpringBoot【配置文件】

yml 读取配置的⽅式和 properties 相同，使⽤ @Value 注解即可，实现代码如下：

@Controller
public class UserController {


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

    @Value("${boolean.value}")
    private Boolean value2;

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


    @Autowired
    private Student student;
    @PostConstruct
    public void postConstruct() {
        System.out.println("Read YML,Hello:" + value +" " + value2 + " " + string);
    }
}

SpringBoot【配置文件】

????3.2.2 " " 与 ’ ’ 与 无引号区别

字符串默认不⽤加上单引号或者双引号，如果加英⽂的单双引号可以表示特殊的含义。尝试在 application.yml 中配置如下信息：

string:
 str1: Hello \n Spring Boot.
 str2: 'Hello \n Spring Boot.'
 str3: "Hello \n Spring Boot."

读取程序实现代码如下：

Hello \n Spring Boot.
Hello \n Spring Boot.
Hello 
Spring Boot.

从上述结果可以看出：

● 字符串默认不⽤加上单引号或者双引号

● 单引号会转义特殊字符，特殊字符最终只是⼀个普通的字符串数

● 双引号不会转义字符串⾥⾯的特殊字符；特殊字符会作为本身想表示的意思

????3.2.3 yml配置对象

我们还可以在 yml 中配置对象，如下配置：

# 对象写法
student:
  id: 1
  name: 张三
  age: 18

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致,内容不复杂建议这样写）：

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

这个时候就不能⽤ @Value 来读取配置中的对象了，此时要使⽤另⼀个注解@ConfigurationProperties 来读取，具体实现如下：
注意：以上代码中的 getter 和 setter ⽅法不能省略

@Data
//访问配置文件中的对象
@ConfigurationProperties(prefix = "student")
@Component
public class Student {
    private int id;
    private String name;
    private int age;

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}


@Controller
public class UserController {
    @Autowired
    private Student student;
    @PostConstruct
    public void postConstruct() {
        System.out.println("Read YML,Hello:" + student);
    }

SpringBoot【配置文件】

????3.2.4 yml配置集合

配置⽂件也可以配置 list 集合，如下所示：

# 集合写法
dbtypes: {name: [mysql,sqlserver,dp2]}

或者这样写

dbtypes:
 name:
 - mysql
 - sqlserver
 - db2

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

@Component
@Data
@ConfigurationProperties(prefix = "dbtypes")//读取配置文件中的集合
public class ReadList {
     private List<String> name;

}

打印类的实现如下：

@Controller
public class UserController {

    @Autowired
    private ReadList readList;
    
    @PostConstruct
    public void postConstruct() {
        System.out.println("Read YML,Hello:" + readList);
    }

SpringBoot【配置文件】

想要查看 Spring Boot 更多系统配置项，访问官⽹

????四.总结

????4.1 properties VS yml 区别

● 键值对类型:properties 是以 key=value 的形式配置的键值类型的配置⽂件，⽽ yml 使⽤的是类似 json 格式的树形配置⽅式进⾏配置的，yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”英⽂冒号加空格的⽅式设置，并且空格不可省略

● 文件格式:properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的解决数据冗余的问题

●语言通用性:yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使⽤⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件

●支持数据类型:yml ⽀持更多的数据类型(集合,对象等)

SpringBoot【配置文件】

标签：

相关文章