【Java从0到架构师】SpringBoot - 入门_配置文件_YAML

约定不等于承诺〃 2022-09-04 03:52 130阅读 0赞

### SpringBoot - 入门\_配置文件\_YAML ###

*  SpringBoot - 入门
 *   *  @SpringBootApplication
     *  可运行 jar - spring-boot-maven-plugin
     *  热部署 - devtools
 *  配置文件 - application
 *   *  配置文件默认加载路径
     *  运行参数、VM 选项
     *  配置文件的内容
     *  YAML
     *  提高开发效率的依赖
     *  属性绑定 - @ConfigurationProperties
     *  构造方法绑定 - @ConstructorBinding
     *  宽松绑定 (Relaxed Binding) - 概念
     *  拆分配置文件
     *  banner

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/04\_SpringBoot][https_gitee.com_szluyu99_mj_java_frame_tree_master_04_SpringBoot]

--------------------

JavaEE 开发存在的问题（即使使用了 SSM）

*  配置繁多、部署复杂、集成第三方库并不简单
 *  SpringBoot 可以很好地解决上述问题

官网：[https://spring.io/projects/spring-boot][https_spring.io_projects_spring-boot]

*  本课程使用的版本：2.3.4.RELEASE

SpringBoot 的特点

*  内置了很多常用配置，让 JavaEE 开发更加简单
 *  项目可以独立运行，无须额外依赖 web 容器（内置了 web 容器）
 *  …

# SpringBoot - 入门 #

入门项目：[Gitee 代码][Gitee]

pom.xml：

<parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.3.4.RELEASE</version>
    </parent>
    
    
    <dependencies>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

controller：

@RestController
    public class TestController { 
        @GetMapping("/test")
        public String test() { 
            return "Hello SpringBoot";
        }
    }

程序入口：

@SpringBootApplication
    public class Application { 
        public static void main(String[] args) { 
            SpringApplication.run(Application.class, args);
        }
    }

执行 main 方法后，在浏览器输入：http://localhost:8080/test  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70]

## @SpringBootApplication ##

`@SpringBootApplication` 中包含了 3 个注解：

*  `@EnableAutoConfiguration`：可以根据 maven 依赖自动构建相关环境  
    比如为 spring-boot-starter-web 构建 web 容器环境等
 *  `@componentScan`：默认会扫描当前包以及子包中的所有类
 *  `@SpringBootConfiguration`  
    从 SpringBoot 2.2.1 开始，被 SpringBoot 扫描到的 `@Component` 不用添加 `@Configuration`

## 可运行 jar - spring-boot-maven-plugin ##

如果希望通过 `mvn package` 打包出一个可运行的 jar，需要增加一个插件：

<build>
        <finalName>sb_hw</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

也可以使用插件的 run 功能，直接运行 SpringBoot 应用：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 1]

## 热部署 - devtools ##

增加依赖（ Debug 模式下，它可以监控 classpath 的变化）

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
    </dependency>

重新编译项目（2 种方式）

*  手动编译（Build Project、Build Module）
 *  自动编译

> 需要注意的是：使用了 spring-boot-devtools 后可能会执行 2 次 main 方法
> 
>  *  不用在意，因为 devtools 仅限于开发调试阶段使用

需要使用热部署还需要在 Idea 开启以下设置：

*  Build project automatically：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 2]
 *  Ctrl \+ Shift \+ Alt \+ /  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 3]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 4]

以上配置的效果为： 当 Idea 失去焦点时，会进行自动编译（会有点延迟）

# 配置文件 - application #

## 配置文件默认加载路径 ##

SpringBoot 默认会去加载一个**应用程序配置文件**，文件名为 application

> 应用程序配置文件（Application Property Files）

application 配置文件默认可以存放的位置如下所示（按照优先级从高到低排序）

*  **file:./****config/**
 *  **file:./****config/\*/**
 *  **file:./**
 *  **classpath:/****config/**
 *  **classpath:/**

> 注： **file:./** 代表项目根路径（jar 包）， **classpath:/** 代表 resources 目录

最常见的做法就是：**classpath:/**，即直接在 resources 下放配置文件

--------------------

注：application 配置文件的内容可以直接通过 `@Value` 进行注入  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 5]

> 注意：Map 类型的注入比较特殊，后面有介绍

> 如果是其他配置文件需要 `@PropertySource` 引入配置文件
> 
>  *  由于 application 在 SpringBoot 项目中必然会被加载，因此无需引入，可以直接注入

## 运行参数、VM 选项 ##

可以通过运行参数或 VM 选项，指定配置文件的文件名、位置：

java -jar myproject.jar --spring.config.name=mj

java -jar myproject.jar --spring.config.location=F:/mj.properties

--------------------

在 Idea 中启动配置中可以配置**运行参数**、**VM 选项**：

*  通过运行参数或 VM 选项，可以覆盖配置文件的内容  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 6]

--------------------

运行参数会传递给 main 方法的 args 参数：

> `--spring.config.name=mj` 是运行参数

--------------------

System.getProperty、Ststem.getProperties 可以获取 VM 选项：

> `-Dspring.config.name=mj` 是 VM 选项

## 配置文件的内容 ##

在 application 配置文件中，关于服务器的配置内容都可以从下面找到：

*  spring-boot-autoconfigure.jar / META-INF / spring.factories
 *  ServletWebServerFactoryAutoConfiguration
 *  ServerProperties  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 7]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 8]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 9]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 10]

## YAML ##

YAML（YAML Ain’t a Markup Language，YAML 不是一种标记语言）

*  **SpringBoot 更推荐使用 YAML 作为配置文件**
 *  文件拓展名是 .yml  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 11]
 *  YAML 使用空格或 TAB 作为层级缩进
 *  冒号 `:` 与后面紧跟的内容之间必须要有空格或 TAB
 *  字符串可以不用加引号。如果有转义字符，可以使用双引号括住字符串

# \n会作为字符串输出
    name1: m\nj
    # \n会被转移为换行输出
    name2: "m\nj"

## 提高开发效率的依赖 ##

为了更快捷的完成绑定工作，可以添加 2 个依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
    </dependency>
    
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>

注意：

*  spring-boot-configuration-processor 需要代码重新编译后，才会生成提示
 *  Lombok 仅仅在编译期间使用即可，所以 scope 设置为 provided 即可

仅仅引入 Lombok 依赖，虽然使用了 `@Data` 会自动生成 Getter、Setter 方法，但是在开发期间不会有代码提示，需要代码提示还需要安装 Lombok 插件：[Lombok官网][Lombok]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 12]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 13]

## 属性绑定 - @ConfigurationProperties ##

> 属性绑定（JavaBean properties binding）

使用了 `@ConfigurationProperties("student")` 指定了配置文件中的前缀，通过这个注解可以**将配置文件中的值直接读取到指定类中**（类名与前缀对应）：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 14]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 15]  
使用了 `@EnableConfigurationProperties` 后，Student 就不用就加 `@Component` 了

> 再倒回去看 ServletWebServerFactoryAutoConfiguration，可以理解的更加深刻  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]

--------------------

`@ConfigurationProperties` 也可以用在 `@Bean` 上：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]

## 构造方法绑定 - @ConstructorBinding ##

> 构造方法绑定（Constructor binding）

构造方法绑定只能用 `@EnableConfigurationProperties`，不能使用 `@Component` 的方式  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]

## 宽松绑定 (Relaxed Binding) - 概念 ##

配置文件中的属性名格式比较宽松，有多种风格：

*  **Kebab 格式（烤肉串格式），推荐这种写法**：

acme.my-project.person.first-name

*  驼峰写法：

acme.myProject.person.firstName

*  下划线写法：

acme.my_project.person.first_name

*  变量名大写：使用系统环境变量时建议使用

ACME_MYPROJECT_PERSON_FIRSTNAME

## 拆分配置文件 ##

文件名 `application-*` 的后半部分默认就是文档名

# application.yml
    spring:
      profiles:
      	active: [cat, student]
      	
    person:
      age: 11
      name: Person-{ person.age}

# application-cat.yml
    cat:
      age: 22
      name: Cat-${ cat.age}

# application-student.yml
    student:
      age: 33
      name: Student-${ student.age}

在 application.yml 中引入了 application-cat.yml 和 application-student.yml，相当于如下效果：

# application.yml
    person:
      age: 11
      name: Person-{ person.age}
    
    cat:
      age: 22
      name: Cat-${ cat.age}
    
    student:
      age: 33
      name: Student-${ student.age}

## banner ##

参考：[官网文档][Link 1]

Banner 生成：[http://patorjk.com/software/taag][http_patorjk.com_software_taag]

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[https_gitee.com_szluyu99_mj_java_frame_tree_master_04_SpringBoot]: https://gitee.com/szluyu99/mj_java_frame/tree/master/04_SpringBoot
[https_spring.io_projects_spring-boot]: https://spring.io/projects/spring-boot
[Gitee]: https://gitee.com/szluyu99/mj_java_frame/tree/master/04_SpringBoot/41_SpringBoot01_HW
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70]: /images/20220829/663dd75d45a2426494fb7a127388e26e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 1]: /images/20220829/a590df3517c04116a723fb3dd4cffbb4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 2]: /images/20220829/cfed70ce1a104a52b0b13b9189c6f07e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 3]: /images/20220829/f9605ee400c24ae3a0f57a68cba93c9a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 4]: /images/20220829/ca38a15003c745faac8d9f6ba7fb4f34.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 5]: /images/20220829/717bc6dc9426435b83a40fed3a4c5e61.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 6]: /images/20220829/5109ce95d6034bb9bc7f4a0b3ef82374.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 7]: /images/20220829/d56fb16a6fd247aeb0dfb5e694fb656e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 8]: /images/20220829/e6b56a12104d48ada5da0515c31b503f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 9]: /images/20220829/d7d7c7c0c5cd4e3c921acfaa4566d14f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 10]: /images/20220829/0b430b65e432415d9bcc2c5d3c8264ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 11]: /images/20220829/624d359770e5421d95d775cd954e56f3.png
[Lombok]: https://projectlombok.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 12]: /images/20220829/14ec9cdcfe04441fba8c51409da38106.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 13]: /images/20220829/f0a05f5cb0d2423aa4d760c40d2b96a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 14]: /images/20220829/565378d61c1243ac8cd50bb65c9da39f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 15]: /images/20220829/4a6cedbae55b40389e29f451a6cda467.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]: /images/20220829/39b4b10fccb54d78ae53793f8a00a852.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]: /images/20220829/5d470793a2df4c8e8958161494bac3b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]: /images/20220829/389acb527f134e8fb3c46ca8ffec812f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]: /images/20220829/c2fefaff853d42089a4c61cbbf7989b1.png
[Link 1]: https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#boot-features-banner
[http_patorjk.com_software_taag]: http://patorjk.com/software/taag