SpringBoot及其配置文件

最新推荐文章于 2024-08-12 04:51:41 发布

whiteInJava

最新推荐文章于 2024-08-12 04:51:41 发布

阅读量1.5k

点赞数 3

分类专栏： JavaEE 文章标签： spring boot spring java

本文链接：https://blog.csdn.net/weixin_64450588/article/details/130687308

版权

JavaEE 专栏收录该内容

27 篇文章 0 订阅

订阅专栏

3.2.1 properties配置文件——写

3.2.2 properties配置文件——读

3.2.3 properties配置文件——缺点

3.5 yml和properties配置文件的比较

1.SpringBoot简介

与Spring的诞生是为了简化Java开发类似，SpringBoot的诞生就是为了简化Spring开发。这从他的名字就可以理解，SpringBoot直译过来就是Spring脚手架，那有了脚手架能干嘛呢——提高工程效率，简化开发。

既然能简化开发，那SpringBoot是怎么简化的呢？怎么提高效率的呢？我们来看看SpringBoot和我们以往项目比较起来的优点：

SpringBoot能够快速集成各种框架。省去了以往项目手动添加依赖的繁琐步骤，我们能够在创建项目或者项目中快速添加依赖并且不用考虑各框架版本间的适配问题。
SpringBoot内置了WEB容器，像之前我们用到的Tomcat；并且支持快速方便的部署项目。
可以省去配置XML文件的繁琐，直接使用注解开发。
能够支持更多的监控指标，有助于帮助程序猿更好的了解项目的运行情况。
...

2.第一个SpringBoot项目

SpringBoot项目的创建:

到这里，项目就创建完成了，我们来测试下项目是否创建成功：

那么，SpringBoot项目的目录结构又是怎样的呢？

接下来让我们一起学习下SpringBoot项目的配置文件。

3.SpringBoot配置文件

在此之前，我们先来理清楚用户自定义配置和系统配置：

像端口号的配置，数据库连接信息的url,用户名，密码等的都称为系统配置
用户自定义配置就是用户自己起名的配置信息

3.1 配置文件介绍

😄在之前的学习中，我们一致提到配置文件。它包含了我们项目中依赖的重要的外部数据，一个优秀的项目离不开一组优秀的配置文件。那么SpringBoot为我们提供了哪些配置文件呢？

😄SpringBoot为我们提供的配置文件共有两类：application.properties和application.yml。这两者都可以用于SpringBoot的开发，并且properties格式要较yml的年龄更大些。

.properties
.yml

3.2 properties配置文件

3.2.1 properties配置文件——写

properties格式的SpringBoot配置文件出现要比yml格式早很多，同时它也是SpringBoot项目默认的配置文件格式，properties文件中的内容是以key=value的格式配置信息的。

比如，通过properties格式的配置文件来配置我们项目启动的端口号和数据库连接信息：
# 系统配置
server.port=8888

# 系统配置-数据库连接信息
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=xxxx
3.2.2 properties配置文件——读

在SpringBoot中读取properties格式文件的做法为在：为读取配置文件的类加上一个类属性，在这个属性的上方使用Value注解导入配置文件中的对应值。

@Value("${key}")

3.2.3 properties配置文件——缺点

properties配置文件在SpringBoot中主要有以下三点缺陷：

😄1.由于properties文件内容格式是以key=value的形式组织的，因此当配置一些系统配置项时，会造成大量的重复冗余书写，如下：

😄2.properties配置文件支持的编程语言还不算太多，在做一些微服务项目时使用properties配置文件会具有一些局限性。

😄3.SpringBoot中读取properties配置文件可能会出现中文配置项乱码。

😄那么SpringBoot中有没有一种配置文件能够帮助我们规避以下properties格式配置文件的局限呢？那就是yml格式的配置文件了！

3.3 yml配置文件

😄yml是YAML的缩写，YAML是Yet Another Markup Language的缩写。

3.3.2 yml配置文件——初阶写

😄yml作为一种树形结构的配置文件，采用key: value的格式组织配置项，同时value与左侧的英文冒号之间必须要有空格隔开，否则会存在语法错误从而也导致我们的程序出错。yml的格式如下所示：

😄比如，通过yml格式的配置文件来配置我们项目启动的端口号和数据库连接信息：
# 系统配置——端口号
server:
  port: 8888

# 系统配置——数据库连接
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8
    username: root
    password: xxxx
3.3.2 yml配置文件——初阶读

😄yml的单个配置项读取方法与properties的读取方法类似：

😄在读取yml中的字符串时，带有双引号的字符串中的转义字符会被转义：

3.3.3 yml配置文件——进阶读、写

😄yml配置、读取对象

我们可以在yml按如下格式在配置文件中配置对象，如下：
# 在yml配置文件中配置对象（以下两种写法一致）：

# 自定义配置——对象（写法一）
person:
  name: 小白的白白
  age: 20
  sex: man


# 自定义配置——对象（写法二）
person: { name: 小白的白白,age: 20,sex: man }
接着对上面配置的对象进行读取，这里的读取与上面的初阶读不太一样：

我们需要用到注解ConfigurationProperties(prefix="objName")
定义一个类，同时要让类中的每一个成员属性与yml配置文件的对象中的属性名称相同，为类添加五大注解之一交给Spring进行管理
同时为自定义类添加getter和setter方法

😄yml配置、读取集合

我们也可以在yml中按照以下格式配置集合：
# 在yml中配置集合（以下两种写法一致）

# 自定义配置——集合（写法1）
plKinds:
  name:
    - Java
    - PHP
    - GoLang
    - C++

# 自定义配置——集合（写法2）
plKinds1: { name: [ Java,PHP,GoLang,C++ ] }
接着对上面配置的集合进行读取，同样，读取方法与对象读取类似，也分为上边yml对象读取的三步：

😄！！！但是刚开始的时候，我将集合的属性名写成了大驼峰格式，然后试图在ConfigurationProperties注解中进行读取，发现它的命名不能为大驼峰格式，会被提示不满足前缀规范。这里一定要注意，太细节了哈哈哈~下面是我的错误：

😄正确地读取配置集合：

3.3.4 yml配置文件——优缺点

😄根据上边写的内容，我们首先来总结yum配置文件的优点：

yml配置文件格式与json语言类似，可读性高，写法简单，便于理解。
yml格式的配置文件支持更多的编程语言种类，这对微服务项目提供了莫大的便利。
yml支持更多的数据类型，像我们上面提高的集合、对象...

😔同时，yml配置文件也有自己的缺点：

写法上的细节较多，对新手不太友好。

3.4 不同环境下的配置文件

😔在实际的项目开发过程中，我们可能有测试环境、开发环境、部署环境，这些环境下使用的数据库连接或者项目启动的端口号可能都不太相同，只有一份配置文件，如果在不同的环境下运行程序的话就需要我们频繁地去修改配置文件，如果修改的配置项目少还好；如果多呢？不仅效率低，还可能出错。那么我们应该怎么解决这种这种问题呢？

😄在SpringBoot中为我们提供了不同环境下的配置文件格式，在不同的开发环境下我们可以在主配置文件配置对应环境下的配置文件即可，大大提高了便利性，各种配置文件的约定如下：

😄我们来感受一下这种不同环境下的配置文件带来的便利：

3.5 yml和properties配置文件的比较

首先，二者配置项的格式不同。yml配置项采用的是类似json格式的树形配置，层级之间采用换行缩进的方式进行配置的，其key和value之间以英文冒号可开，并且value和冒号之间一定要有空格。而properties的配置项是以key=value的形式组织的，层级之间通过点号递进。
properties出现时期早于yml格式的配置文件，并且yml配置文件很好的解决了使用properties配置文件带来的写法冗余问题。
与properties相比，yml支持更多的编程语言种类，其适用性更好，比如在作为微服务的配置文件时，Java和PHP和python甚至可以公用相同的yml配置文件。
yml配置文件较properties支持更多的数据类型，比如我们上面提到的集合、对象等.