Spring Boot配置文件

本文介绍了配置文件在项目中的重要性,详细讲解了.properties和.yml两种格式的配置文件,包括它们的基本语法、读取方式以及各自的优缺点。properties文件以键值对形式配置,而yml文件则提供更清晰的格式和数据类型支持。在SpringBoot中,可以通过@Value和@ConfigurationProperties注解来读取配置信息。此外,文章还提到了多环境配置和yml的高级用法。
摘要由CSDN通过智能技术生成

目录

1.配置文件的作用

2.配置文件的格式

3.properties配置文件说明 

3.1properties基本语法

3.2读取配置文件

3.3 properties缺点分析

4.yml配置文件说明

4.1yml基本语法

​编辑 4.2yml使用进阶

4.2.1yml配置不同数据及null

4.2.2yml配置文件读取

​编辑

4.2.3配置对象

4.2.4配置集合 

5.多平台配置文件

1.配置文件的作用

整个项⽬中所有重要的数据都是在配置⽂件中配置的,⽐如:
 数据库的连接信息(包含⽤户名和密码的设置);
 项⽬的启动端⼝;
 第三⽅系统的调⽤秘钥等信息;
 ⽤于发现和定位问题的普通⽇志和异常⽇志等。
想象⼀下如果没有配置信息,那么 Spring Boot 项⽬就不能连接和操作数据库,甚⾄是不能保存可以⽤于排查问题的关键⽇志,所以配置⽂件的作⽤是⾮常重要的。

2.配置文件的格式

Spring Boot 配置⽂件主要分为以下两种格式:
.properties
.yml
这就好像连锁店⾥⾯的统⼀服装⼀样,有两种不同的款式,properties 类型的配置⽂件就属于⽼款“服饰”,也是创建 Spring Boot 项⽬时默认的⽂件格式(主要是由于仓库⾥还有库存),⽽ yml 属于新版款式,如果⽤户了解情况直接指定要新款服饰,那么就直接发给他。
特殊说明:
1. 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中,当 properties 和 yml ⼀起存在⼀个项⽬中时,如果配置⽂件中出现了同样的配置,⽐如 properties 和 yml 中都配置了“server.port”,
那么这个时候会以 properties 中的配置为主,也就是 .properties 配置⽂件的优先级最⾼,但加载
完 .properties ⽂件之后,也会加载 .yml ⽂件的配置信息。
2. 虽然理论上来讲 .properties 可以和 .yml 共存,但实际的业务当中,我们通常会采取⼀种统⼀的配置⽂件格式,这样可以更好的维护(降低故障率)。这就好像连锁店的服饰⼀样,不管是⽼款的服装还是新款的服装,⼀定要统⼀了才好看。

3.properties配置文件说明 

3.1properties基本语法

properties 是以键值的形式配置的,key 和 value 之间是以“=”连接的,如:
#服务器端口号
server.port=8084
#数据库连接
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/java78?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=111111

3.2读取配置文件

配置文件的内容:

1.spring的相关配置

2.自定义配置

如果在项⽬中,想要主动的读取配置⽂件中的内容,可以使⽤ @Value 注解来实现。
@Value 注解使⽤“${}”的格式读取,如下代码所示:
@RestController
public class ValueController {
    @Value("${mykey.key1}")
    private String key1;
    @PostConstruct
    public void postConstruct(){
        System.out.println("===============");
        System.out.println(key1);
    }
    public String hi(){
        return "hi";
    }
}

3.3 properties缺点分析

properties 配置是以 key-value 的形式配置的,如下图所示:

从上述配置key看出,properties 配置⽂件中会有很多的冗余的信息。想要解决这个问题,就可以使⽤ yml 配置⽂件的格式化了。

4.yml配置文件说明

yml 是 YAML 是缩写,它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语
⾔。
yml优点分析:
●yml 是⼀个可读性⾼,写法简单、易于理解,它的语法和 JSON 语⾔类似。
yml ⽀持更多的数据类型,它可以简单表达清单(数组)、散列表,标量等数据形态。它使⽤空⽩ 符号缩进和⼤量依赖外观的特⾊,特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
yml ⽀持更多的编程语⾔,它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、
JavaScript、Perl 中。

4.1yml基本语法

yml 是树形结构的配置⽂件,它的基础语法是“key: value”,注意 key 和 value 之间使⽤英⽂冒号加空格的方式组成的,其中的空格不可省略。
基础语法如下:
server:
  port: 8080
使用yml连接数据库
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/java78?characterEncoding=utf8
    username: root
    password: 111111
yml 和 properties 连接数据库的配置对⽐

 4.2yml使用进阶

4.2.1yml配置不同数据及null

string:
  str1: Hello \n Spring boot
  str2: 'Hello \n Spring boot'
  str3: "Hello \n Spring boot"

student:
  id: 1
  name: '张三'
  age: 18
  dbtypes:
    - mysql
    - sqlserver
    - db2
  map2:
    k1: kkk
    k2: kkk

4.2.2yml配置文件读取​​​​​​​

与properties读取方法相同,使用@Value注解 

字符串默认不⽤加上单引号或者双引号,如果加英⽂的单双引号可以表示特殊的含义。

从上述结果可以看出:

字符串默认不⽤加上单引号或者双引号。
单引号会转义特殊字符,特殊字符最终只是⼀个普通的字符串数据。
双引号不会转义字符串⾥⾯的特殊字符;特殊字符会作为本身想表示的意思。

4.2.3配置对象

我们还可以在yml中配置对象:

student:
  id: 1
  name: '张三'
  age: 18

这时就不能使用@Value来读取配置中的对象,此时要使用另一个对象@ConfigurationProperties 来读取。

@ConfigurationProperties(prefix = "student")
@Component
@Data
public class Student {
    private Integer id;
    private String name;
    private Integer age;
    private List<String> dbtypes;
    private HashMap<String,String> map2;
}

其中使用@Data对象,可以自动生成set、get等方法

调⽤类的实现如下:
 @Autowired
 private Student student;

4.2.4配置集合 

配置文件也可以配置list集合,如下所示:

  dbtypes:
    - mysql
    - sqlserver
    - db2
或者是使⽤⾏内写法(与上⾯的写法作⽤⼀致):
dbtypes: {name: [mysql,sqlserver,db2]} 
集合的读取和对象⼀样,也是使⽤ @ConfigurationProperties 来读取的,具体实现如下:
@ConfigurationProperties(prefix = "student")
@Component
@Data
public class Student {
    private Integer id;
    private String name;
    private Integer age;
    private List<String> dbtypes;
    private HashMap<String,String> map2;
}

5.多平台配置文件

 先写各个环境的配置文件

application-XXX.yml

dev表示开发阶段,test表示测试阶段,prod表示测试发行阶段。

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/java78?characterEncoding=utf8
    username: root
    password: 111111

在主配置文件中设置环境参数

spring:
  profiles:
    active: dev

yml优点分析:

1.yml是一个可读性高,写法简单,易于理解,他的语法和JSON类似

2.yml支持更多的数据类型,它可以简单表达清单(数组)、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件等。

3.yml支持更多的编程语言,它不止是Java中可以使用在Golang,PHP,Python,Ruby,JavaScript,Perl中。

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小李(写代码版)

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值