01【SpringBoot快速入门、yml语法、自动配置、整合框架】

目录

一、SpringBoot简介

1.1 Spring优缺点

1.1.1 Spring的优点

1.1.2 Spring的缺点

1.2 SpringBoot的概述

1.2.1 SpringBoot概述

1.2.2 SpringBoot的核心功能

二、SpringBoot快速入门

2.1 创建Maven工程

2.2 添加起步依赖

2.3 编写Controller

2.4 编写SpringBoot引导类

三、SpringBoot的配置文件

3.1 yml配置文件

3.1.1 yml配置文件的语法

1）配置普通数据

2）配置对象数据

3）配置Map数据

4）配置数组（List、Set）数据

3.2 修改默认配置

3.3 配置信息查询

3.4 配置多个Profile

3.4.1 配置多文档块Profile

3.4.2 配置yml多profile

四、SpringBoot自动配置原理

4.1 起步依赖原理

4.1.1 版本锁定

4.1.2 起步依赖

4.2 自动配置原理

4.2.1 @SpringBootApplication源码

4.2.2 @SpringBootConfiguration源码

4.2.3 @EnableAutoConfiguration源码

1）Registrar

2）AutoConfigurationImportSelector

4.2.4 @ComponentScan

1）AutoConfigurationExcludeFilter

2）TypeExcludeFilter

3）自定义排除器

4.3 自动配置类

4.3.1 自动配置类说明

4.3.2 @Conditional派生注解

4.3.3 自定义自动配置类

4.4 属性配置类

4.4.1 属性配置类说明

4.4.2 自定义属性配置类

4.5 自定义场景启动器

4.5.1 场景启动器包含内容

4.5.2 搭建自动配置工程

4.5.2.1 依赖

4.5.2.2 自动配置类

4.5.2.3 属性配置类

4.5.2.4 具体配置的类

4.5.2.5 spring.factories

4.5.3 搭建测试工程

4.5.3.1 依赖

4.5.2.2 Controller

4.5.2.3 application.yml

4.5.2.4 引导类

五、SpringBoot与整合其他技术

5.1 SpringBoot整合Mybatis

5.1.1 搭建工程

1）依赖：

2）创建表

3）创建实体Bean

4）application.yml

5）UserMapper

6）UserMapper.xml

5.1.2 测试

5.1.3 MyBatis自动配置

1）MybatisAutoConfiguration

2）MybatisProperties

5.2 SpringBoot整合Junit

5.2.1 添加Junit的场景启动器

5.2.2 编写测试类

5.3 SpringBoot整合Spring Data JPA

5.3.1 添加Spring Data JPA的起步依赖

5.3.2 jpa相关配置

5.3.3 建立映射

5.3.3 编写UserDao

5.3.4 编写测试类

5.4 SpringBoot整合Redis

5.4.1 添加Redis的起步依赖

5.4.2 Redis相关配置

5.4.3 测试类

---

一、SpringBoot简介

1.1 Spring优缺点

1.1.1 Spring的优点

Spring是Java企业版（Java Enterprise Edition，JEE，也称J2EE）的轻量级代替品。无需开发重量级的Enterprise JavaBean（EJB），Spring为企业级Java开发提供了一种相对简单的方法，通过依赖注入和面向切面编程

简单来说，Spring是一个JavaEE轻量级的一站式开发框架。

1.1.2 Spring的缺点

虽然Spring的组件代码是轻量级的，但它的配置却是重量级的。我们在整合MyBatis时需要配置SqlSessionFactory以及一些其他的配置，整合Jpa时需要配置LocalContainerEntityManagerFactoryBean等....

所有配置都代表了开发时的损耗。因为在思考Spring特性配置和解决业务问题之间需要进行思维切换，所以编写配置挤占了编写应用程序逻辑的时间。和所有框架一样，Spring实用，但与此同时它要求的回报也不少。

除此之外，项目的依赖管理也是一件耗时耗力的事情。在环境搭建时，需要分析要导入哪些库的坐标，而且还需要分析导入与之有依赖关系的其他库的坐标，一旦选错了依赖的版本，随之而来的不兼容问题就会严重阻碍项目的开发进度。

总结：

• 1）项目的配置编写占据了我们大量的时间（能否默认配置？）

• 2）jar包的依赖管理非常不便（能否有专人帮我们管理？）

1.2 SpringBoot的概述

1.2.1 SpringBoot概述

Spring Boot 是由 Pivotal 团队提供的全新框架。Spring Boot 是所有基于 Spring Framework 5.0 开发的项目的起点。Spring Boot 的设计是为了让你尽可能快的跑起来 Spring 应用程序并且尽可能减少你的配置文件。

SpringBoot提倡"约定大于配置"的理念让你的项目快速运行起来，即所有配置都是基于约定的（采用默认配置），这种开箱即用的方式大大提高了我们开发的效率，缩短了项目周期。

SpringBoot不是对Spring功能上的增强，而是提供了一种快速使用Spring的方式

1.2.2 SpringBoot的核心功能

• 1）起步依赖（场景启动器）

起步依赖本质上是一个Maven项目对象模型（Project Object Model，POM），定义了对其他库的传递依赖，这些东西加在一起即支持某项功能。

简单的说，起步依赖就是将具备某种功能的坐标打包到一起，并提供一些默认的功能。

• 2）自动配置

Spring Boot的自动配置是一个运行时的过程，考虑了众多因素，才决定Spring配置应该用哪个，不该用哪个。该过程是Spring自动完成的。

二、SpringBoot快速入门

2.1 创建Maven工程

创建一个普通的Mave工程（模块/项目）

2.2 添加起步依赖

SpringBoot项目要继承SpringBoot的起步依赖spring-boot-starter-parent

    org.springframework.boot
    spring-boot-starter-parent
    2.0.1.RELEASE

引入相关场景依赖：

    
        org.springframework.boot
        spring-boot-starter-web
    

2.3 编写Controller

package com.dfbz.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author lscl
 * @version 1.0
 * @intro:
 */
@Controller
public class HelloController {

    @GetMapping("/hello")
    @ResponseBody
    public String hello(){
        return "Hello SpringBoot!";
    }
}

2.4 编写SpringBoot引导类

package com.dfbz;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author lscl
 * @version 1.0
 * @intro:
 */
@SpringBootApplication          // 标注这是一个引导类
public class HelloApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.class);
    }
}

访问：http://localhost:8080/hello

就这样，我们就搭建完成了一个SpringMVC的环境；

三、SpringBoot的配置文件

SpringBoot是基于约定的，所以很多配置都有默认值，但是我们可以修改SpringBoot的默认配置

SpringBoot支持三种配置文件：

• 1）application-{profile}.yml；

• 2）application-{profile}.yaml；

• 3）application-{profile}.properties；

SpringBoot启动时默认会从classes目录以及classes/config目录下加载这三种配置文件

其中properties配置文件优先级高，其次yml，优先级最低的为yaml

3.1 yml配置文件

YML文件格式是YAML (YAML Aint Markup Language)编写的文件格式，YAML是一种直观的能够被电脑识别的的数据数据序列化格式，并且容易被人类阅读，容易和脚本语言交互的，可以被支持YAML库的不同的编程语言程序导入，比如： C/C++, Ruby, Python, Java, Perl, C#, PHP等。YML文件是以数据为核心的，比传统的xml方式更加简洁。

YML文件的扩展名可以使用.yml或者.yaml；

3.1.1 yml配置文件的语法

1）配置普通数据

语法： key: value

示例代码：

book: 《孙子兵法》

注意：value之前必须有一个空格

2）配置对象数据

语法：

key:
	key1: value1
	key2: value2

或者：

key: {key1: value1,key2: value2}

示例代码：

book:
  name: 《聊斋志异》
  author: 蒲松龄
  
#或者
book: {name: 《聊斋志异》,author: 蒲松龄}

3）配置Map数据

book:
  name: 《三国志》
  author: 陈寿

4）配置数组（List、Set）数据

语法：

key:
	- value1
	- value2

或者：

key: [value1,value2]

示例代码：

books:
  - 《三国演义》
  - 《西游记》
  - 《红楼梦》
  - 《水浒传》
#或者
cities: [武汉,长沙,南昌,合肥]
#集合中的元素是对象形式
books:
  - name: 《三国演义》
    author: 罗贯中
    
  - name: 《西游记》
    author: 吴承恩
    
  - name: 《红楼梦》
    addr: 曹雪芹
  
  - name: 《水浒传》
  	author: 施耐庵

注意：value与之间的 - 之间存在一个空格

3.2 修改默认配置

我们可以通过配置application.poperties 或者 application.yml 来修改SpringBoot的默认配置

例如：

application.properties文件

server.port=8888
server.servlet.context-path=/demo

application.yml文件

server:
 port: 8888
 servlet:
   context-path: /demo

3.3 配置信息查询

SpringBoot的配置文件，主要的目的就是对配置信息进行修改的，但在配置时的key从哪里去查询呢？我们可以查阅SpringBoot的官方文档

文档URL：

Spring Boot Reference Guide

常用的配置摘抄如下：

 ```properties
# QUARTZ SCHEDULER (QuartzProperties)
spring.quartz.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.quartz.jdbc.schema=classpath:org/quartz/impl/jdbcjobstore/tables_@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.quartz.job-store-type=memory # Quartz job store type.
spring.quartz.properties.*= # Additional Quartz Scheduler properties.


# ----------------------------------------
# WEB PROPERTIES
# ----------------------------------------
# EMBEDDED SERVER CONFIGURATION (ServerProperties)
server.port=8080 # Server HTTP port.
server.servlet.context-path= # Context path of the application.
server.servlet.path=/ # Path of the main dispatcher servlet.


# HTTP encoding (HttpEncodingProperties)
spring.http.encoding.charset=UTF-8 # Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.

# JACKSON (JacksonProperties)
spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`.


# SPRING MVC (WebMvcProperties)
spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the dispatcher servlet.
spring.mvc.static-path-pattern=/ # Path pattern used for static resources.
spring.mvc.view.prefix= # Spring MVC view prefix.
spring.mvc.view.suffix= # Spring MVC view suffix.


# DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
spring.datasource.driver-class-name= # Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.
spring.datasource.password= # Login password of the database.


# JEST (Elasticsearch HTTP client) (JestProperties)
spring.elasticsearch.jest.password= # Login password.
spring.elasticsearch.jest.proxy.host= # Proxy host the HTTP client should use.
spring.elasticsearch.jest.proxy.port= # Proxy port the HTTP client should use.
spring.elasticsearch.jest.read-timeout=3s # Read timeout.
spring.elasticsearch.jest.uris=http://localhost:9200 # Comma-separated list of the Elasticsearch instances to use.
spring.elasticsearch.jest.username= # Login username.

3.4 配置多个Profile

SpringBoot默认支持的配置文件有.yml、.yaml、.properties，其命名格式都为application-{profile}，我们可以配置多档环境，在开发过程中可以轻松切换

3.4.1 配置多文档块Profile

server:
  port: 8080
spring:
  profiles:
    active: test		# 激活test环境

---
server:
  port: 8081
spring:
  profiles: dev			# 指定所属环境

---
server:
  port: 8082
spring:
  profiles: prod
 
---
server:
  port: 8083
spring:
  profiles: test

3.4.2 配置yml多profile

• application-dev.yml：

server:
  port: 8081
spring:
  profiles: dev

application-prod.yml：

server:
  port: 8082
spring:
  profiles: prod

• application-test.yml：

server:
  port: 8083
spring:
  profiles: test

• application.yml：

server:
  port: 8080
spring:
  profiles:
    active: dev     # 激活dev

Tips：当多个配置文件产生互补配置；即application.yml配置与被激活的yml配置同时生效，如有冲突则以被激活的yml文件为准；

四、SpringBoot自动配置原理

SpringBoot能够快速项目运行起来，不需要我们自己来搭建框架所属的环境，其核心原因是SpringBoot在项目启动时即帮我们搭建好了所需环境，做到开箱即用，接下来我们重点探究一下SpringBoot是如何做到让项目快速运行起来的！

4.1 起步依赖原理

4.1.1 版本锁定

SpringBoot项目都是继承于spring-boot-starter-parent工程的，我们点进去看看这个工程中配置了什么？

    org.springframework.boot
    spring-boot-dependencies
    2.0.1.RELEASE
    ../../spring-boot-dependencies


...

    UTF-8
    1.8
    @
    ${java.version}
    UTF-8
    ${java.version}



    
        
            org.jetbrains.kotlin
            kotlin-maven-plugin
            ${kotlin.version}
        
        ...
    

我们发现spring-boot-starter-parent工程是继承于spring-boot-dependencies工程，在spring-boot-starter-parent工程中锁定了部分插件使用的版本：

我们继续点进spring-boot-dependencies工程：

        5.15.3
        2.7.7
        1.9.63
        2.4.0
        1.8.13
        3.9.1
        4.0.6
        2.1.4
    .....



        
            
                org.springframework.boot
                spring-boot
                2.0.1.RELEASE
            
            
                org.springframework.boot
                spring-boot-test
                2.0.1.RELEASE
            
            
                org.springframework.boot
                spring-boot-test-autoconfigure
                2.0.1.RELEASE
            
            
                org.springframework.boot
                spring-boot-actuator
                2.0.1.RELEASE
            
            
            ....
    

从上面的spring-boot-starter-dependencies的pom.xml中我们可以发现，一部分坐标的版本、依赖管理、插件管理已经定义好，所以我们的SpringBoot工程继承spring-boot-starter-parent后已经具备版本锁定等配置了（解决了版本冲突问题）。

这些版本的搭配经过了SpringBoot官方团队的测试，我们在使用过程中，采用SpringBoot搭配的版本匹配，就避免了版本冲突、不稳定等因素；

4.1.2 起步依赖

在继承的父工程中我们并没有看到依赖的引入（只是版本的锁定），真正的依赖是在我们引入场景启动器时引入的，我们点击spring-boot-starter-web场景启动器查看：

    
        org.springframework.boot
        spring-boot-starter
        2.0.1.RELEASE
        compile
    
    
        org.springframework.boot
        spring-boot-starter-json
        2.0.1.RELEASE
        compile
    
    
        org.springframework.boot
        spring-boot-starter-tomcat
        2.0.1.RELEASE
        compile
    
    
        org.hibernate.validator
        hibernate-validator
        6.0.9.Final
        compile
    
    
        org.springframework
        spring-web
        5.0.5.RELEASE
        compile
    
    
        org.springframework
        spring-webmvc
        5.0.5.RELEASE
        compile
    

我们发现在spring-boot-starter-web依赖中引入了大量web场景需要的依赖，如Spring-web、Spring-webmvc、json转换、tomcat等，SpringBoot中的场景启动器（starter）对场景的依赖进行"打包"，这样以后我们的项目只需要引入对应场景的starter即可；

• 官方提供的场景命名规则为：spring-boot-starter-xxx

• 第三方提供场景命名规则为：xxx-spring-boot-starter

4.2 自动配置原理

我们在前面说到过，SpringBoot所有的配置基于约定理念，并不是不需要配置，而是SpringBoot在项目启动时帮我们配置了，所有的配置基于约定的参数已经配置好了；那么SpringBoot是如何做到"自动配置"的呢？

我们点击标注在引导类上的@SpringBootApplication注解：

@SpringBootApplication          // 标注这是一个引导类
public class HelloApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.class);
    }
}

4.2.1 @SpringBootApplication源码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    ...

}

• 1）@Target({ElementType.TYPE})：元注解，标注这个注解只能在类上使用

• 2）@Retention(RetentionPolicy.RUNTIME)：元注解，标注这个注解的生命周期是RUNTIME，可以在运行时解析到这个注解

• 3）@Documented ：元注解，表明这个注解应该被 javadoc工具记录

• 4）@Inherited ：元注解，标注在类上面时，该类的子类会自动继承此注解

4.2.2 @SpringBootConfiguration源码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

上面三个都是元注解

@Configuration ：Spring提供的注解，表示这是一个配置类

也就是说标注了@SpringBootApplication、@SpringBootConfiguration等注解的类都可以当做一个配置类使用

4.2.3 @EnableAutoConfiguration源码

@EnableAutoConfiguration是SpringBoot自动配置的核心；

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class[] exclude() default {};

    String[] excludeName() default {};
}

标注了两个注解：@AutoConfigurationPackage、@Import({AutoConfigurationImportSelector.class})

1）Registrar

• 1）@AutoConfigurationPackage：在该注解上标注了@Import注解，导入了一个Registrar导入器，开启包的自动导入配置，扫描注解标注类所在的包及其下面的子包

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}

往容器中注册了一个Registrar，查看Registrar：

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata,
                                        BeanDefinitionRegistry registry) {
        // 配置包注册(注册标注了AutoConfigurationPackage注解的类所在的全路径下面的所有类)
        register(registry, new PackageImport(metadata).getPackageName());
    }

    @Override
    public Set