前言:
大家好,我是良辰丫,上一篇文章中我们已经学习了Spring Boot项目的的创建,今天我们会学习Spring Boot的配置文件,在今天的学习中我们会遇到许多我们不认识的注解,这些注解是Spring MVC中的,我们后续会介绍,大家先不用管这些注解是什么意思
.那么,为什么不先学习MVC呢?我想让大家先接触注解,最起码有个印象,后面学习起来也就变得简单了.💌💌💌
🧑个人主页:良辰针不戳
📖所属专栏:javaEE进阶篇之框架学习
🍎励志语句:生活也许会让我们遍体鳞伤,但最终这些伤口会成为我们一辈子的财富。
💦期待大家三连,关注,点赞,收藏。
💌作者能力有限,可能也会出错,欢迎大家指正。
💞愿与君为伴,共探Java汪洋大海。
目录
- 1. 初识Spring Boot配置文件
- 2. 配置文件的格式
- 3. properties配置文件
- 3.1 properties 的用法
- 3.2 代码读取配置文件
- 3.3 properties的缺点
- 4. yml配置文件
- 4.1 初识yml
- 4.2 yml的用法
- 4.3 yml不同的数据类型
- 4.4 yml 配置读取
- 4.5 三种字符串的区别
- 4.6 yml配置对象
- 4.6.1 块级写法
- 4.6.2 行内写法
- 4.7 配置集合,简单了解
- 5. properties 与 yml 的比较
1. 初识Spring Boot配置文件
- 在spring中我们认识了pom.xml配置文件,这个配置文件是为了引入我们的依赖.
- 配置文件是为了配置项目中的一些数据,比如端口,数据库等信息.
配置文件通常分为两种:
- 系统使用的配置文件,比如端口的设置等.
- 用户自定义配置文件.
2. 配置文件的格式
在我们的Spring Boot中,通常使用两种配置文件,我们的这两种配置文件放在resources文件中.
- properties文件.
- yml文件.
为什么要有这两种配置文件呢?
- 两种配置文件可以理解为不同的样式,两种文件都可以实现相应的配置功能.
- 我们之前学过前后端交互,约定相应的格式,可以选择各种各样的格式,但是约定好了,前后端要有相同的约定格式,才能进行交互.回到我们spring boot这里,两种不同的配置文件是两种风格,大家可以选择自己喜欢的去使用.
- 那么,两种配置文件可以同时出现嘛?可以同时出现,但是properties的优先级比yml的高.如果两个配置文件都要修改容器的端口,那么会按照properties修改的为准.
- 理论上,两者配置文件可以同时出现,但是在我们实际的项目中一般只会采用其中的一种即可.
3. properties配置文件
properties 配置⽂件是最早期的配置⽂件格式,也是创建 Spring Boot 项⽬默认的配置⽂件.比较古老,但是在我们的项目中也经常使用.
3.1 properties 的用法
- properties 是以键值的形式配置的,key 和 value 之间是以“=”连接的
- 井号后面加注释.
# 配置项⽬端⼝号
server.port=6666
从运行的结果看,端口号已经被成功修改为6666.
6666端口无法通过浏览器访问页面,端口可能被占用,我们换一个8888端口.
3.2 代码读取配置文件
- 在项⽬中,想要主动的读取配置⽂件中的内容,可以使⽤ @Value 注解来实现。
- @Value 注解使⽤“${}”的格式读取.
- 还有一点需要注意的是我们在导入包的时候别导错,Lombok里面也有一个value包,导入这个无法使用我们下面语句的value.
properties配置文件
# 设置端口号
server.port=8888
# 自定义配置文件
name= zhangsan
password= 12345
package com.example.demo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.beans.factory.annotation.Value;
import javax.annotation.PostConstruct;
@Controller // 当前类为控制器
@ResponseBody // 返回的是数据,而非页面
public class User2 {
@Value("${name}")
private String name;
@Value("${password}")
private String password;
@RequestMapping("/user2")
public String get(){
return "name: "+name+"<br>"+
"password: "+password;
}
}
3.3 properties的缺点
- properties是key-value的形式.
- 从上面的截图中我们可以得出,一级配置,二级配置等等 N级配置,没用一次就要重复写一次,非常冗余.
- 那么我们有办法可以做到不冗余嘛?下面我们将学习yml配置文件,这种配置就可以做到不冗余.
4. yml配置文件
4.1 初识yml
yml 是 YAML 是缩写,它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语⾔”。
- yml 是⼀个可读性⾼,写法简单、易于理解,它的语法和 JSON 语⾔类似。
- yml ⽀持更多的数据类型,它可以简单表达清单(数组)、散列表,标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊,特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
- yml ⽀持更多的编程语⾔,它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中.
4.2 yml的用法
yml 是树形结构的配置⽂件,它的基础语法是“key: value”,注意 key 和 value 之间使⽤英⽂冒汗加空格的⽅式组成的.
下面的截图足以说明yml配置文件相比于上面的配置文件,减少了冗余性.
4.3 yml不同的数据类型
暂时先简单了解.
# 字符串
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: ~
4.4 yml 配置读取
# 自定义配置文件
name: 李四
password: 12345
package com.example.demo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.beans.factory.annotation.Value;
//import javax.annotation.PostConstruct;
@Controller // 当前类为控制器
@ResponseBody // 返回的是数据,而非页面
public class User2 {
@Value("${name}")
private String name;
@Value("${password}")
private String password;
@RequestMapping("/user2")
public String get(){
return "name: "+name+"<br>"+
"password: "+password;
}
}
- yml支持中文的读写.
- 两种配置读取其实大同小异.
4.5 三种字符串的区别
经过测试,三种字符串的形式可以如下.
- 直接写字符串
- 单引号的字符串
- 双引号的字符串
我们来通过一个构造方法,直接在控制台上打印.
# yml配置文件
str1: 你好,叶良辰
str2: '你好,叶良辰'
str3: "你好,叶良辰"
package com.example.demo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.annotation.PostConstruct;
@Controller // 当前类为控制器
@ResponseBody // 返回的是数据,而非页面
public class User3 {
@Value("${str1}")
private String str1;
@Value("${str2}")
private String str2;
@Value("${str3}")
private String str3;
@PostConstruct
public void postConstruct() {
System.out.println("string.str1:" + str1);
System.out.println("string.str2:" + str2);
System.out.println("string.str3:" + str3);
}
}
通过运行结果我们可以得知,此时三种形式没有区别,那么如果我们加一个转义字符呢?
# yml配置文件
str1: 你好,\n叶良辰
str2: '你好,\n叶良辰'
str3: "你好,\n叶良辰"
通过运行结果我们可以看出,双引号的字符串被转义了换行,那么我们在改造一下,给双引号里面多加一个斜杠,然后再来观察运行结果.
此时我们可以发现三种运行结果相同.
小结 :
- 字符串默认不⽤加上单引号或者双引号。
- 单引号会转义特殊字符,特殊字符最终只是⼀个普通的字符串数据。
- 双引号不会转义字符串⾥⾯的特殊字符;特殊字符会作为本身想表示的意思。
4.6 yml配置对象
4.6.1 块级写法
student:
id: 1
name: 张三
age: 18
package com.example.demo;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties("student")
@Data
public class Student {
private int id;
private String name;
private int age;
@Override
public String toString() {
return "Student{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
'}';
}
}
package com.example.demo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.annotation.PostConstruct;
@Controller // 当前类为控制器
@ResponseBody // 返回的是数据,而非页面
public class User3 {
@Autowired
private Student student;
@PostConstruct
public void postConstruct() {
System.out.println(student);
}
}
4.6.2 行内写法
student: {id: 1,name: 张三,age: 18}
这个时候就不能⽤ @Value 来读取配置中的对象了,此时要使⽤另⼀个注解@ConfigurationProperties 来读取.
4.7 配置集合,简单了解
yml配置,两种配置都可以
dbtypes:
name:
- 张三
- 李四
- 王五
dbtypes: {name: [张三,李四,王五]}
java文件
package com.example.demo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class User4 {
@Autowired
private ListConfig listConfig;
@PostConstruct
public void post(){
System.out.println(listConfig.getName());
}
}
package com.example.demo;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
@ConfigurationProperties("dbtypes")
@Data
public class ListConfig {
private List<String> name;
}
5. properties 与 yml 的比较
- properties 是以 key=value 的形式配置的键值类型的配置⽂件,⽽ yml 使⽤的是类似 json 格式的树形配置⽅式进⾏配置的,yml 层级之间使⽤换⾏缩进的⽅式配置,key 和 value 之间使⽤“: ”英⽂冒号加空格的⽅式设置,并且空格不可省略。
- properties 为早期并且默认的配置⽂件格式,但其配置存在⼀定的冗余数据,使⽤ yml 可以很好的解决数据冗余的问题。
- yml 通⽤性更好,⽀持更多语⾔,如 Java、Go、Python 等,如果是云服务器开发,可以使⽤⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件。
- yml ⽀持更多的数据类型。
总而言之,我们需要记住properties是老版配置,yml是新版配置,yml的功能更完善,且支持中文.