SpringBoot-2-Spring Boot配置秘籍：快速掌握基础配置技巧

SpringBoot-2-Spring Boot配置秘籍：快速掌握基础配置技巧

今日目标

能够说出SpringBoot工程的三种配置文件格式

能够书写格式正确的yml配置文件

能够配置多种环境并在需要时选择使用何种环境运行

昨天已经讲解了SpringBoot项目的快速创建，已经讲解了SpringBoot启动项，依赖管理等基础内容，并且我们发现默认启动端口是8080。
思考:如果想让端口变成80怎么做?

这就用到了我们今天学习的内容SpringBoot基础配置。

1. SpringBoot基础配置

1.1 SpringBoot属性配置

SpringBoot通过配置文件application.properties就可以修改默认的配置

当前访问tomcat的默认端口是8080，好熟悉的味道，但是不便于书写，我们先改成80，通过这个操作来熟悉一下SpringBoot的配置格式是什么样的

properties文件格式：

key=value

1.1.1 通过配置文件修改启动端口

• 【步骤一】:在resources文件下创建application.properties

• 【步骤二】application.properties文件中将端口修改为80

根据提示敲回车，输入80端口，搞定

server.port=80

• 【步骤三】启动测试结果

总结

1. SpringBoot默认配置文件是application.properties

2. SpringBoot程序可以在application.properties文件中进行属性配置

3. application.properties文件中只要输入要配置的属性关键字就可以根据提示进行设置

关闭运行日志图表（banner)

spring.main.banner-mode=off

设置运行日志的显示级别

logging.level.root=debug

我们现在配置了3个信息，但是又有新的问题了。这个配置是随便写的吗？什么都能配？有没有一个东西显示所有能配置的项呢？此外这个配置和什么东西有关呢？会不会因为我写了什么东西以后才可以写什么配置呢？比如我现在没有写数据库相关的东西，能否配置数据呢？一个一个来，先说第一个问题，都能配置什么。

Application Properties对应的配置项地址

思考:SpringBoot常见的配置文件有哪几种形式？

1.2 配置文件分类

• properties格式

• yml格式

• yaml格式

• application.properties

server.port=80

• application.yml

server:
  port: 80

• application.yaml

server:
  port: 80

仔细看会发现yml格式和yaml格式除了文件名后缀不一样，格式完全一样，是这样的，yml和yaml文件格式就是一模一样的，只是文件后缀不同，所以可以合并成一种格式来看。那对于这三种格式来说，以后用哪一种比较多呢？记清楚，以后基本上都是用yml格式的。

总结

1. SpringBoot提供了3种配置文件的格式

   • properties（传统格式/默认格式）

   • yml（主流格式）

   • yaml

思考：万一我三个配置文件都写了，他们三个谁起作用？

1.3 SpringBoot配置文件加载顺序（了解）

目标:在三个配置文件都配置端口，然后我们让每个文件配置的端口号都不一样，查看谁起作用

• application.properties（properties格式）

server.port=80

• application.yml（yml格式）

server:
  port: 81

• application.yaml（yaml格式）

server:
  port: 82

启动后发现目前的启动端口为80，把80对应的文件删除掉，然后再启动，现在端口又改成了81。我们就已经知道了3个文件的加载优先顺序

• application.properties > application.yml > application.yaml

最后我们把配置文件内容给修改一下

• application.properties（properties格式）

server.port=80
spring.main.banner-mode=off

• application.yml（yml格式）

server:
  port: 81
logging: 
  level: 
    root: debug

• application.yaml（yaml格式）

server:
  port: 82

我们发现不仅端口生效了，最终显示80，同时其他两条配置也生效了，看来每个配置文件中的项都会生效，只不过如果多个配置文件中有相同类型的配置会优先级高的文件覆盖优先级的文件中的配置。如果配置项不同的话，那所有的配置项都会生效。

总结

1. 配置文件间的加载优先级 properties（最高）> yml > yaml（最低）

2. 不同配置文件中相同配置按照加载优先级相互覆盖，不同配置文件中不同配置全部保留

注意事项：

1. SpringBoot核心配置文件名为application

2. SpringBoot内置属性过多，且所有属性集中在一起修改，在使用时，通过提示键+关键字修改属性

1.4 自动提示功能消失解决方案

可能有些小伙伴会基于各种各样的原因导致配置文件中没有提示，这个确实很让人头疼，所以下面给大家说一下如果自动提示功能消失了怎么解决。

先要明确一个核心，就是自动提示功能不是SpringBoot技术给我们提供的，是我们在Idea工具下编程，这个编程工具给我们提供的。明白了这一点后，再来说为什么会出现这种现象。其实这个自动提示功能消失的原因还是蛮多的，如果想解决这个问题，就要知道为什么会消失，大体原因有如下3种：

1. Idea认为你现在写配置的文件不是个配置文件，所以拒绝给你提供提示功能

2. Idea认定你是合理的配置文件，但是Idea加载不到对应的提示信息

这里我们主要解决第一个现象，第二种现象到原理篇再讲解。

第一种现象的解决方式如下： 0. 先创建Spring的启动类，即包含了main函数和@SpringBootApplication的那个类。如果已经存在生成则忽略这步。

1. 选择File -> Project Structure

1. 选择Modules

1. 右边会出现当前模块的配置文件

1. 如果没有出现相应的配置文件，则点最右边的绿色按钮

1. 出现对话框，点左边的加号，添加新的配置文件

1. 选择相应的配置文件

1. 选择以后窗口变成如下：

1. 点确定以后显示以下窗口

1. 项目结构中文件前面的图片变成绿叶，就会有提示了。

2. yaml

思考:什么是yaml，和properties有什么区别？

• YAML（YAML Ain't Markup Language），一种数据序列化格式

• 优点：

  • 容易阅读

  • 容易与脚本语言交互

  • 以数据为核心，重数据轻格式

• YAML文件扩展名

  • .yml（主流）

  • .yaml

2.1 yaml语法规则

• 大小写敏感

• 属性层级关系使用多行描述，每行结尾使用冒号结束

• 使用缩进表示层级关系，同层级左侧对齐，只允许使用空格（不允许使用Tab键）

• 属性值前面添加空格（属性名与属性值之间使用冒号+空格作为分隔）

• #表示注释

• 核心规则：数据前面要加空格与冒号隔开

2.2 yaml数组数据

• 数组数据在数据书写位置的下方使用减号作为数据开始符号，每行书写一个数据，减号与数据间空格分隔

student:
  name: 张三
  age: 16
  address: 广州深圳市
  subject: 
    - java
    - 前端
    - 大数据

2.3 yaml数据读取

1. 使用@Value读取单个数据，属性名引用方式：${一级属性名.二级属性名……}

注：这种方式只能注入单个数值

1. 封装全部数据到Environment对象

   注：数组元素也只能一个个取出来

1. 自定义对象封装指定数据【常用】

• 将对象添加Spring容器中，在类上添加@Component注解

• 在类上添加@ConfigurationProperties(prefix="指定前缀")

• 添加get和set方法，toString方法

• 在控制器中注入下面Student对象

@Component
@Data
@ConfigurationProperties(prefix = "student")
public class Student {
    private String name;
    private Integer age;
    private String address;
    private String[] subject[];
}

注：如果使用lombok需要在pom.xml中导入坐标

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

• 当输入@ConfigurationProperties注解的时候，自定义对象封装数据警告解决方案

在pom.xml文件添加以下

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

3. 多环境开发配置

思考:在实际开发中，项目的开发环境、测试环境、生产环境的配置信息是否会一致？如何快速切换？

3.1 多环境启动配置

• yaml文件多环境启动

基本配置

新的写法

application.yml

spring:
  profiles:
    active: pro
---
spring:
  config:
    activate:
      on-profile: pro
server:
  port: 80
---
spring:
  config:
    activate:
      on-profile: dev
server:
  port: 81
---
spring:
  config:
    activate:
      on-profile: test
server:
  port: 82

• properties文件多环境启动

#主启动配置文件 application.properties
spring.profiles.active=pro

#环境分类配置文件 application-pro.properties
server.port=80

#环境分类配置文件 application-dev.properties
server.port=81

#环境分类配置文件application-test.properties
server.port=82

3.2 多环境启动命令格式

• 带参数启动SpringBoot

# 指定哪个配置名
java –jar springboot.jar --spring.profiles.active=test
# 指定具体的参数
java –jar springboot.jar --server.port=88
# 同时指定配置名 端口号
java –jar springboot.jar --server.port=88 --spring.profiles.active=test

3.3 多环境开发控制

Maven与SpringBoot多环境兼容（步骤）

先将application.properties中配置全部先注释了

1. Maven中设置多环境属性

<profiles>
    <profile>
        <id>dev_env</id>
        <properties>
            <profile.active>dev</profile.active>
        </properties>
        <!-- 默认激活 -->
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    
    <profile>
        <id>pro_env</id>
        <properties>
            <profile.active>pro</profile.active>
        </properties>
    </profile>
    
    <profile>
        <id>test_env</id>
        <properties>
            <profile.active>test</profile.active>
        </properties>
    </profile>
</profiles>

1. SpringBoot中引用Maven属性

1. 对资源文件开启对默认占位符的解析

<build>
    <plugins>
        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <configuration>
                <encoding>utf-8</encoding>
                <useDefaultDelimiters>true</useDefaultDelimiters>
            </configuration>
        </plugin>
    </plugins>
</build>

1. 启动查看控制台输出的结果

注：如果application-dev.properties中的配置也存在，则优先使用这里面的配置，再使用yml中的配置