主要介绍:
1. SpringBoot配置⽂件的格式以及对应的语法 2. 了解两个配置⽂件格式的差异1. 配置⽂件作⽤
计算机上有数以千计的配置⽂件, 我们使⽤的绝⼤多数软件, ⽐如浏览器, 微信, Idea, 甚⾄电脑, ⼿机, 都 离不开配置⽂件. 配置⽂件主要是为了解决硬编码带来的问题, 把可能会发⽣改变的信息, 放在⼀个集中的地⽅, 当我们启 动某个程序时, 应⽤程序从配置⽂件中读取数据, 并加载运⾏. 就比如字体大小的问题, 不同的⽤⼾有不同的偏好, 我们可以把⼿机字体的⼤⼩放在配置⽂件中, 当程序启动时, 读取配 置, 以⽤⼾设置的字体⼤⼩来显⽰. SpringBoot配置⽂件 SpringBoot⽀持并定义了配置⽂件的格式, 也在另⼀个层⾯达到了规范其他框架集成到SpringBoot的 ⽬的. 很多项⽬或者框架的配置信息也放在配置⽂件中, ⽐如: • 项⽬的启动端⼝ • 数据库的连接信息(包含⽤⼾名和密码的设置) • 第三⽅系统的调⽤密钥等信息 • ⽤于发现和定位问题的普通⽇志和异常⽇志等2. 配置⽂件快速⼊⼿
SpringBoot内置了Tomcat服务器, 默认端⼝号是8080, 但是⽤⼾电脑上8080端⼝号有可能就被其他 应⽤程序占⽤了, 所以SpringBoot需要⽀持让⽤⼾⾃定义端⼝号 修改 application.properties ⽂件1 server.port = 9090
3. 配置⽂件的格式
Spring Boot 配置⽂件有以下三种: • application.properties • application.yml • application.yaml 注意: yml 为yaml的简写, 实际开发中出现频率最⾼,使用方式是一样的 当应⽤程序启动时, Spring Boot会⾃动从classpath路径找到并加载 application.properties 和 application.yml ⽂件. 注意: 1. 理论上讲 .properties 和 .yml 可以并存在于⼀个项⽬中,当 .properties 和 .yml 并存时,两个配置都会加载. 如果配置⽂件内容有冲突, 则以 .properties 为主, 也就是 .properties 优先级更⾼. 2. 虽然理论上来讲 .properties 可以和 .yml 共存,但实际的业务当中,我们通常会采取⼀种 统⼀的配置⽂件格式,这样可以更好的维护(降低故障率)4. properties 配置⽂件说明
properties 配置⽂件是最早期的配置⽂件格式,也是创建 SpringBoot 项⽬默认的配置⽂件4.1 properties 基本语法
properties 是以键值的形式配置的,key 和 value 之间是以"="连接的,如:1 # 配置项⽬端⼝号
2 server.port=8080
3 #配置数据库连接信息
4 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8&
5 spring.datasource.username=root
6 spring.datasource.password=root
PS:⼩技巧:配置⽂件中使⽤“#”来添加注释信息。
4.2 读取配置⽂件
如果在项⽬中,想要主动的读取配置⽂件中的内容,可以使⽤ @Value 注解来实现。 @Value 注解使⽤" ${} "的格式读取,如下代码所⽰: properties 配置如下:1 mykey.key1 = bite
1 import org.springframework.beans.factory.annotation.Value;
2 import org.springframework.web.bind.annotation.RequestMapping;
3 import org.springframework.web.bind.annotation.RestController;
4
5 @RestController
6 public class PropertiesController {
7 @Value("${mykey.key1}")
8 private String key1;
9
10 @RequestMapping("/key")
11 public String key(){
12 return "读取到值:"+key1;
13 }
14 }
4.3 properties 缺点分析
properties 配置⽂件中会有很多的冗余的信息
5. yml 配置⽂件说明
5.1 yml 基本语法
yml 是树形结构的配置⽂件,它的基础语法是"key: value". key 和 value 之间使⽤英⽂冒号加空格的⽅式组成, 空格不可省略 基础语法如下: 使⽤ yml 连接数据库1 spring:
2 datasource:
3 url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false
4 username: root
5 password: root
5.2 yml 使⽤进阶
5.2.1 yml 配置不同数据类型及 null
1 # 字符串
2 string.value: Hello
3
4 # 布尔值,true或false
5 boolean.value: true
6 boolean.value1: false
7
8 # 整数
9 int.value: 10
10
11 # 浮点数
12 float.value: 3.14159
13
14 # Null,~代表null
15 null.value: ~
16
17 # "" 空字符串
18 #, 直接后⾯什么都不加就可以了, 但这种⽅式不直观, 更多的表⽰是使⽤引号括起来
19 empty.value: ''
20
5.2.1.1 yml 配置读取
yml 读取配置的⽅式和 properties 相同,使⽤ @Value 注解即可,实现代码如下: yml配置:1 string:
2 hello: bite
1 @RestController
2 public class ReadYml {
3 @Value("${string.hello}")
4 private String hello;
5
6 @RequestMapping("/ymlKey")
7 public String key(){
8 return "读取到值:"+hello;
9 }
10 }
5.2.1.2 注意事项:value 值加单双引号
字符串默认 不⽤加上单引号或者双引号 ,如果加英⽂的单双引号可以表⽰ 特殊的含义 。 尝试在 application.yml 中配置如下信息:1 string:
2 str1: Hello \n Spring Boot.
3 str2: 'Hello \n Spring Boot.'
4 str3: "Hello \n Spring Boot."
读取程序实现代码如下
1 @RestController
2 public class ReadYml {
3 @Value("${string.str1}")
4 private String str1;
5 @Value("${string.str2}")
6 private String str2;
7 @Value("${string.str3}")
8 private String str3;
9
10 @RequestMapping("/yml")
11 public String readYml(){
12 System.out.println(str1);
13 System.out.println(str2);
14 System.out.println(str3);
15 return "yml";
16 }
17 }
PS:
字符串默认不⽤加上单引号或者双引号。 使⽤单引号会转义, 就是说, \n 不再表⽰换⾏了, ⽽是表⽰⼀个普通的字符串 使⽤双引号不会转义, 表⽰ \n 表⽰的是它本⾝的含义, 就是换⾏5.2.2 配置对象
1 student:
2 id: 1
3 name: Java
4 age: 18
这个时候就不能⽤ @Value 来读取配置中的对象了,此时要使⽤另⼀个注解
@ConfigurationProperties
来读取,具体实现如下:
1 import lombok.Data;
2 import org.springframework.boot.context.properties.ConfigurationProperties;
3 import org.springframework.stereotype.Component;
4
5 @ConfigurationProperties(prefix = "student")
6 @Component
7 @Data
8 public class Student {
9 private int id;
10 private String name;
11 private int age;
12 }
调⽤类的实现如下:
1 @RestController
2 public class StudentController {
3 @Autowired
4 private Student student;
5
6 @RequestMapping("/readStudent")
7 public String readStudent(){
8 return student.toString();
9 }
10 }
5.2.3 配置集合
配置⽂件也可以配置 list 集合,如下所⽰:1 dbtypes:
2 name:
3 - mysql
4 - sqlserver
5 - db2
集合的读取和对象⼀样,也是使⽤
@ConfigurationProperties
来读取的,具体实现如下:
1 @Component
2 @ConfigurationProperties("dbtypes")
3 @Data
4 public class ListConfig {
5 private List<String> name;
6 }
访问集合的实现如下:
1 @RestController
2 public class ReadYml2 {
3 @Autowired
4 private ListConfig listConfig;
5
6 @RequestMapping("/readList")
7 public String readList(){
8 return listConfig.toString();
9 }
10 }
5.2.4 配置Map
配置⽂件也可以配置 map,如下所⽰:1 maptypes:
2 map:
3 k1: kk1
4 k2: kk2
5 k3: kk3
Map的读取和对象⼀样,也是使⽤
@ConfigurationProperties
来读取的,具体实现如下:
1 @Component
2 @ConfigurationProperties("maptypes")
3 @Data
4 public class MapConfig {
5 private HashMap<String,String> map;
6 }
打印类的实现如下:
1 @RestController
2 public class ReadYml2 {
3 @Autowired
4 private MapConfig mapConfig;
5
6 @RequestMapping("/readMap")
7 public String readStudent(){
8 return mapConfig.toString();
9 }
10 }
5.3 yml优缺点
优点: 1. 可读性⾼,写法简单, 易于理解 2. ⽀持更多的数据类型, 可以简单表达对象, 数组, List,Map等数据形态 3. ⽀持更多的编程语⾔, 不⽌是Java中可以使⽤, 在Golang, Python, Ruby, JavaScript中也可以使⽤ 缺点: 1. 不适合写复杂的配置⽂件 ⽐如properties格式如下1 keycloak.realm = demo
2 keycloak.resource = fm-cache-cloud
3 keycloak.credentials.secret = d4589683-Oce7-4982-bcd3
4 keycloak.security[0].authRoles[0]= user
5 keycloak.security[0].collections[0].name = ssologinurl
6 keycloak.security[0].collections[0].patterns[0] = /login/*
7
转换为yml
1 keycloak:
2 realm: demo
3 resource: fm-cache-cloud
4 credentials:
5 secret: d4589683-Oce7-4982-bcd3
6 security:
7 - authRoles:
8 - user
9 collections:
10 - name: ssologinurl
11 patterns:
12 - /login/*
2.
对格式有较强的要求(空格!)
标签:SpringBoot,配置,yml,private,properties,public,读取
From: https://blog.csdn.net/qq_66333706/article/details/140412991