SpringBoot原理篇,主要偏向于底层原理。
包括这么三个部分:
配置优先级:SpringBoot项目当中属性配置的常见方式以及不同配置的优先级
Spring IOC容器中Bean的管理
剖析SpringBoot的底层原理
如果我们通过多种方式配置了同一个属性,到底是哪种方式生效?
SpringBoot项目当中支持的三类配置文件:
application.properties
application.yaml
application.yml
在SpringBoot项目当中,我们要想配置一个属性,可以通过这三种方式当中的任意一种来配置都可以。
那么如果项目中同时存在这三种配置文件,且都配置了同一个属性,如:Tomcat端口号,到底哪一份配置文件生效呢?
application.properties
server.port=8081
application.yaml
server:
port: 8082
application.yml
server:
port: 8083
我们启动SpringBoot程序,测试下三个配置文件中哪个Tomcat端口号生效:
properties、yaml、yml三种配置文件同时存在
结论:properties、yaml、yml三种配置文件,优先级最高的是properties
yaml、yml两种配置文件同时存在
配置文件优先级排名(从高到低):
properties配置文件
yml配置文件
yaml配置文件
注意事项:虽然SpringBoot支持多种格式配置文件,但是在项目开发时,推荐统一使用一种格式的配置。(yml是主流)
在SpringBoot项目当中除了以上3种配置文件外,SpringBoot为了增强程序的扩展性,除了支持配置文件的配置方式以外,还支持另外两种常见的配置方式:
1. Java系统属性配置 - VM options(格式: -Dkey=value)
-Dserver.port=9000
2. 命令行参数 - Program arguments(格式:--key=value)
--server.port=10010
那在IDEA当中运行程序时,如何来指定Java系统属性和命令行参数呢?
编辑启动程序的配置信息
重启服务,同时配置Tomcat端口(三种配置文件、系统属性、命令行参数),测试哪个Tomcat端口号生效:
思考:如果项目已经打包上线了,这个时候我们又如何来设置Java系统属性和命令行参数呢?
java -Dserver.port=9000 -jar XXXXX.jar --server.port=10010
下面我们来演示下打包程序运行时指定Java系统属性和命令行参数:
执行maven打包指令package,把项目打成jar文件
使用命令:java -jar 方式运行jar文件程序
SpringBoot项目进行打包时,需要引入插件 spring-boot-maven-plugin (基于官网骨架创建项目,会自动添加该插件)
在实际的项目开发中,一个项目通常会存在多个环境,例如:开发环境、测试环境和生产环境/线上环境等。不同环境的配置也不尽相同,例如开发环境使用的是开发数据库,测试环境使用的是测试数据库,而生产环境使用的是线上的正式数据库等。
在SpringBoot当中,它就给我们提供了多环境的配置方式,对于当前项目,我们可以定义多套环境对应的配置文件,比如:
多环境配置文件的命名格式:
提问:此时我项目一启动,到底用哪套环境呢?
回答:SpringBoot在启动的时候,它所加载的配置文件或者说它所使用的配置文件无非是application.properties或者是application.yml/yaml,此时就需要在主配置文件application.yml当中来指定一个参数,来指定我们到底要使用哪套环境的配置文件
复习:什么是Bean?
复习:我们可以通过Spring当中提供的注解@Component以及它的三个衍生注解(@Controller、@Service、@Repository)来声明IOC容器中的bean对象,同时我们也学习了如何为应用程序注入运行时所需要依赖的bean对象,也就是依赖注入DI。
我们今天主要学习IOC容器中Bean的其他使用细节,主要学习以下四方面:
如何从IOC容器中手动的获取到bean对象
bean的作用域配置
bean的生命周期相关的两个注解
如何管理第三方的bean对象
先来学习第一方面,从IOC容器中获取bean对象。
而在Spring容器中提供了一些方法,可以主动从IOC容器中获取到bean对象,下面介绍3种常用方式: 都是getBean()方法
1. 根据name获取bean / 根据bean的名称来获取bean
Object getBean(String name)
2. 根据bean的类型来获取bean
T getBean(Class requiredType)
3. 根据name获取bean(带类型转换) / 根据bean的名称以及类型来获取bean
T getBean(String name, Class requiredType)
思考:要从IOC容器当中来获取到bean对象,需要先拿到IOC容器对象,怎么样才能拿到IOC容器 呢?
想获取到IOC容器,直接将IOC容器对象注入进来就可以了
测试方法:从IOC容器中获取bean对象
@Autowired
private ApplicationContext applicationContext; // IOC容器对象
@Test
public void testGetBean() {
// 根据bean的名称获取
DeptController bean1 = (DeptController) applicationContext.getBean("deptController");
System.out.println(bean1);
// 根据bean的类型获取
DeptController bean2 = applicationContext.getBean(DeptController.class);
System.out.println(bean2);
// 根据bean的名称及类型获取
DeptController bean3 = applicationContext.getBean("deptController", DeptController.class);
System.out.println(bean3);
}
运行测试方法后,看控制台输出:
答案:只有一个。(默认情况下,IOC中的bean对象是单例)
那么能不能将bean对象设置为非单例的(每次获取的bean都是一个新对象)?
注意事项:
上述所说的 【Spring项目启动时,会把其中的bean都创建好】还会受到作用域及延迟初始化影响,这里主要针对于默认的单例非延迟加载的bean而言。
提问:既然SpringBoot启动类的run方法的返回值ConfigurableApplicationContext就是Spring / IOC容器对象,那为什么不直接在SpringBoot项目的启动类/引导类当中来获取bean呢?
补充:在根据bean的名称来获取bean对象时,如果故意把bean的名称首字母大写,那么运行后 会报什么错?
在前面我们提到的在Spring/IOC容器当中,默认bean对象是单例模式(只有一个实例对象)。
那么如何设置bean对象为非单例呢?
作用域 | 说明 |
---|---|
singleton | 代表在整个Spring容器当中/内,同名称的bean对象只有一个实例(单例)(默认) |
prototype | 每次使用该bean时会创建新的实例(非单例) |
request | 每个请求范围内会创建新的实例(web环境中,了解) |
session | 每个会话范围内会创建新的实例(web环境中,了解) |
application | 每个应用范围内会创建新的实例(web环境中,了解) |
知道了bean的5种作用域了,我们要怎么去设置一个bean的作用域呢?
可以借助Spring中的@Scope注解来进行配置作用域
1). 测试一
控制器
//默认bean的作用域为:singleton (单例)
@Lazy //延迟加载/延迟初始化(第一次使用bean对象时,才会创建bean对象并交给ioc容器管理)
@RestController
@RequestMapping("/depts")
public class DeptController {
@Autowired
private DeptService deptService;
public DeptController(){
System.out.println("DeptController constructor ....");
}
//省略其他代码...
}
测试类
@SpringBootTest
class SpringbootWebConfig2ApplicationTests {
@Autowired
private ApplicationContext applicationContext; //IOC容器对象
//bean的作用域
@Test
public void testScope(){
for (int i = 0; i < 10; i++) {
DeptController deptController = applicationContext.getBean(DeptController.class);
System.out.println(deptController);
}
}
}
重启SpringBoot服务,运行测试方法,查看控制台打印的日志:
IOC容器中的bean默认使用的作用域:singleton (单例)
IOC容器中管理的bean默认都是singleton单例的!
默认singleton的bean,在容器启动时被创建,可以使用@Lazy注解来延迟初始化(延迟到第一次使用时),饿汉单例模式!
2). 测试二
修改控制器DeptController代码:
@Scope("prototype") //bean作用域为非单例
@Lazy //延迟加载/延迟初始化/懒加载(第一次使用bean对象时,才会创建bean对象并交给ioc容器管理)
@RestController
@RequestMapping("/depts")
public class DeptController {
@Autowired
private DeptService deptService;
public DeptController(){
System.out.println("DeptController constructor ....");
}
//省略其他代码...
}
重启SpringBoot服务,再次执行测试方法,查看控制台打印的日志:
提问:什么时候IOC容器 / Spring容器会销毁bean的实例对象呢?
回答:服务器关闭的时候会自动销毁!
代码:
// Bean的生命周期的两个方法,方法要求不能有任何参数,否则运行会报错
/**
* 在bean实例化之后,依赖注入完成之后自动执行该初始化操作
*/
@PostConstruct // 该注解标识的方法,会在构造函数运行之后 自动执行。
public void init() {
System.out.println("DeptController init...");
}
/**
* 在bean对象销毁之前自动执行一些清理操作
*/
@PreDestroy // 该注解标识的方法会在bean对象销毁之前自动执行,只执行一次
public void destroy() {
System.out.println("DeptController destroy...");
}
如果该方法里面有参数,看看运行后会报什么错?
被@PostConstruct或者@PerDestroy注解标识的生命周期的方法需要一个无参数的方法!
在pom.xml文件中,引入dom4j:
org.dom4j
dom4j
2.1.3
当我们需要使用到SAXReader对象时,直接进行依赖注入是不是就可以了呢?
按照我们之前的做法,需要在SAXReader类上添加一个注解@Component(将当前类交给IOC容器管理)
结论:第三方提供的类是只读的。无法在第三方类上添加@Component注解或衍生注解。
如果要管理的bean对象来自于第三方(不是自定义的),是无法用@Component 及衍生注解声明bean的,因为没办法修改源码,此时就需要用到@Bean注解。
解决方案1:在启动类 / 引导类上添加@Bean标识的方法
@SpringBootApplication
public class SpringbootWebConfig2Application {
public static void main(String[] args) {
SpringApplication.run(SpringbootWebConfig2Application.class, args);
}
//声明第三方bean
@Bean //将当前方法的返回值对象交给IOC容器管理, 成为IOC容器当中的bean,并且该方法在项目启动时会自动调用
public SAXReader saxReader(){
return new SAXReader();
}
}
说明:以上在启动类中声明第三方Bean的作法,不建议 / 推荐使用(项目中要保证启动类的纯粹性 => 单一职责原则)
解决方案2:单独定义一个配置类,在配置类中定义@Bean标识的方法
如果需要定义第三方Bean时, 通常会单独定义一个配置类
package com.gch.config;
import org.dom4j.io.SAXReader;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 在配置类当中对第三方bean进行集中的配置管理
*/
@Configuration // 该注解标识当前类是Spring当中的配置类,@Configuration注解的底层是@Component注解
public class CommonConfig {
/**
* 声明第三方Bean
* @Bean注解的作用:将当前方法的返回值对象交给IOC容器管理,成为IOC容器当中的Bean,并且该方法在项目启动时会自动调用
* 通过@Bean注解的name/value属性来指定Bean的名称,如果未指定,默认是方法名
* @return
*/
@Bean
public SAXReader saxReader(){
return new SAXReader();
}
}
在方法上加上一个@Bean注解,Spring 容器在启动的时候,它会自动的调用这个方法,并将方法的返回值声明为Spring容器当中的Bean对象。
通过@Bean注解的name或value属性可以声明bean的名称,如果不指定,默认bean的名称就是方法名。
如果第三方bean需要依赖其它bean对象,直接在bean定义方法中设置形参即可,容器会根据类型自动装配。
如果是在项目当中我们自己定义的类,想将这些类交给IOC容器管理,我们直接使用@Component以及它的衍生注解来声明就可以。
如果这个类它不是我们自己定义的,而是引入的第三方依赖当中提供的类,而且我们还想将这个类交给IOC容器管理。此时我们就需要单独定义一个配置类(@Configuration),在配置类当中来定义一个方法,在方法上加上一个@Bean注解,通过这种方式来声明第三方的bean对象。
基于SpringBoot进行web程序的开发是非常简单、非常高效的。
SpringBoot使我们能够集中精力地去关注业务功能的开发,而不用过多地关注框架本身的配置使用。
而我们前面所学习的都是面向应用层面的技术,接下来我们开始学习SpringBoot的原理,这部分内容偏向于底层的原理分析。
回顾一下Spring家族的框架:
Spring是目前世界上最流行的Java框架,它可以帮助我们更加快速、更加容易的来构建Java项目。而在Spring家族当中提供了很多优秀的框架,而所有的框架都是基于一个基础框架的SpringFramework(也就是Spring框架)。而前面我们也提到,如果我们直接基于Spring框架进行项目的开发,会比较繁琐。
这个繁琐主要体现在两个地方:
在pom.xml中依赖配置比较繁琐,在项目开发时,需要自己去找到对应的依赖,还需要找到依赖它所配套的依赖以及对应版本,否则就会出现版本冲突问题。
在使用Spring框架进行项目开发时,需要在Spring的配置文件中做大量的配置,这就造成Spring框架入门难度较大,学习成本较高。
基于Spring存在的问题,官方在Spring框架4.0版本之后,又推出了一个全新的框架:SpringBoot。
通过 SpringBoot来简化Spring框架的开发(是简化不是替代)。我们直接基于SpringBoot来构建Java项目,会让我们的项目开发更加简单,更加快捷。
官方也推荐我们直接基于SpringBoot来进行一个快速入门,原因见上。
SpringBoot框架之所以使用起来更简单更快捷,是因为SpringBoot框架底层提供了两个非常重要的功能:一个是起步依赖,一个是自动配置。
学习SpringBoot的原理就是来解析SpringBoot当中的起步依赖与自动配置的原理。我们首先来学习SpringBoot当中起步依赖的原理。
假如我们没有使用SpringBoot,用的是Spring框架进行web程序的开发,此时我们就需要引入web程序开发所需要的一些依赖。
原始的Spring框架进行Web程序的开发如果我们使用了SpringBoot,就不需要像上面这么繁琐的引入依赖了。我们只需要引入一个依赖就可以了,那就是web开发的起步依赖:springboot-starter-web。
为什么我们只需要引入一个web开发的起步依赖,web开发所需要的所有的依赖都有了呢?
因为Maven的依赖传递。
在SpringBoot给我们提供的这些起步依赖当中,已提供了当前程序开发所需要的所有的常见依赖(官网地址:Spring Boot Reference Documentation)。
比如:springboot-starter-web,这是web开发的起步依赖,在web开发的起步依赖当中,就集成了web开发中常见的依赖:json、web、webmvc、tomcat等。我们只需要引入这一个起步依赖,其他的依赖都会自动的通过Maven的依赖传递进来。
结论:起步依赖的原理就是Maven的依赖传递。
回顾:SpringBoot当中起步依赖的原理,就是Maven的依赖传递。
接下来我们解析下自动配置的原理,我们要分析自动配置的原理,首先要知道什么是自动配置。
SpringBoot的自动配置就是当Spring容器启动后,一些配置类、bean对象就自动存入到了IOC容器中,不需要我们手动去声明,从而简化了开发,省去了繁琐的配置操作。
下面我们打开idea,一起来看下自动配置的效果:
运行SpringBoot启动类
由于在CommonConfig配置类上添加了一个注解@Configuration,而@Configuration底层就是@Component,所以配置类最终也是SpringIOC容器当中的一个bean对象。
在IOC容器中除了我们自己定义的bean以外,还有很多配置类,这些配置类都是SpringBoot在启动的时候加载进来的配置类。这些配置类加载进来之后,它也会生成很多的bean对象。
当我们想要使用这些配置类中生成的bean对象时,可以使用@Autowired就自动注入了:
@Autowired
private Gson gson; // 谷歌提供改的一个用来JSON处理的工具包
@Test
public void testJson() {
// GSON可以将一个对象直接转为JSON格式的数据
System.out.println(gson.toJson(Result.success()));
}
问题:在当前项目中我们并没有声明谷歌提供的Gson这么一个bean对象,然后我们却可以通过@Autowired从Spring容器中注入bean对象,那么这个bean对象怎么来的?
答案:SpringBoot项目在启动时通过自动配置完成了bean对象的创建。
体验了SpringBoot的自动配置了,下面我们就来分析自动配置的原理。其实分析自动配置原理就是来解析在SpringBoot项目中,在引入依赖之后是如何将依赖jar包当中所定义的配置类以及bean加载到SpringIOC容器中的。
我们知道了什么是自动配置之后,接下来我们就要来剖析自动配置的原理。解析自动配置的原理就是分析在 SpringBoot项目当中,我们引入对应的依赖之后,是如何将依赖jar包当中所提供的bean以及配置类直接加载到当前项目的SpringIOC容器当中的。
接下来,我们就直接通过代码来分析自动配置原理。
异常信息描述: 没有com.example.TokenParse类型的bean
说明:在Spring容器中没有找到com.example.TokenParse类型的bean对象
思考:手动引入进来的第三方依赖当中的bean以及配置类为什么没有生效?
原因在我们之前学习IOC的时候有提到过,在类上添加@Component注解来声明bean对象时,还需要保证@Component注解能被Spring的组件@ComponentScan扫描到。
SpringBoot项目中的@SpringBootApplication注解,具有包扫描的作用,但是它只会扫描启动类所在的当前包以及子包。
那么如何解决以上问题的呢?
方案1:在启动类上添加@ComponentScan 组件扫描
方案2:在SpringBoot引导类上添加@Import注解 导入(使用@Import注解导入的类会被Spring加载到IOC容器中)
@ComponentScan组件扫描:一旦手动指定,就把原来的包扫描默认值覆盖掉了。
@SpringBootApplication
// @ComponentScan(basePackages = {"com.gch"})
@ComponentScan({"com.gch","com.example"}) //指定要扫描的包
public class SpringbootWebConfig2Application {
public static void main(String[] args) {
SpringApplication.run(SpringbootWebConfig2Application.class, args);
}
}
- 大家可以想象一下,如果采用以上这种方式来完成自动配置,那我们进行项目开发时,当需要引入大量的第三方的依赖,就需要在启动类上配置N多要扫描的包,这种方式会很繁琐。而且这种大面积的扫描性能也比较低。
缺点:
使用繁琐
扫描包越多,性能越低
结论:SpringBoot中并没有采用以上这种方案。
@Import注解导入:使用@Import注解导入的类会被Spring加载到IOC容器当中!
导入形式主要有以下几种:
导入 普通类{没有加任何注解的类}
导入 配置类{类上面加了@Configuration注解的类}
导入 ImportSelector接口实现类
1)演示使用@Import注解导入普通类:
package com.gch;
import org.springframework.context.annotation.Import;
/**
被@Import注解导入的类会被Spring加载到IOC容器当中
*/
// 导入普通类
@Import(WebConfig.class)
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class, args);
}
}
2). 使用@Import注解导入配置类:
package com.gch;
import org.springframework.context.annotation.Import;
/**
被@Import注解导入的类会被Spring加载到IOC容器当中
*/
// 导入配置类,配置类当中所有的bean都会导入进来,被加载到Spring的IOC容器当中
@Import({CommonConfig.class, WebConfig.class})
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class, args);
}
}
3). 使用@Import注解导入ImportSelector接口实现类:
ImportSelector接口实现类
package com.gch;
import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;
/**
* ImportSelector接口实现类
*/
public class MyImportSelector implements ImportSelector {
/**
* @param importingClassMetadata
* @return 字符数组当中封装了哪些类应该被导入到IOC容器当中,字符数组当中封装了类的全类名
*/
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
//返回值字符串数组(数组中封装了全限定名称的类)
return new String[]{"com.gch.config.CommonConfig"};
}
}
启动类
package com.gch;
/**
被@Import注解导入的类会被Spring加载到IOC容器当中
*/
// 导入ImportSelector接口实现类,相当于批量导入
@Import(MyImportSelector.class)
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class, args);
}
}
我们使用@Import注解通过这三种方式都可以导入第三方依赖中所提供的bean或者是配置类。
思考:如果基于以上方式完成自动配置,当要引入一个第三方依赖时,是不是还要知道第三方依 赖中有哪些配置类和哪些Bean对象?
答案:是的。 (对程序员来讲,很不友好,而且比较繁琐)
思考:当我们要使用第三方依赖,依赖中到底有哪些bean和配置类,谁最清楚?
答案:第三方依赖自身最清楚。
结论:我们不用自己指定要导入哪些bean对象和配置类了,让第三方依赖它自己来指定。
怎么让第三方依赖自己指定bean对象和配置类?
比较常见的方案就是第三方依赖给我们提供一个注解,自己去封装一个注解,这个注解一般都以@EnableXxxx开头的注解,注解中封装的就是@Import注解
4). 使用第三方依赖提供的 @EnableXxxxx注解
第三方依赖中提供的注解 / 自定义的注解
package com.gch;
import org.springframework.context.annotation.Import;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 自定义注解
* 该注解指定要导入哪些bean对象和配置类,该注解封装了@Import注解
* 使用@Import注解导入ImportSelector接口实现类,指定要导入哪些bean对象或者是配置类
* 被@Import注解导入的类会被Spring加载到IOC容器当中
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(MyImportSelector.class)
public @interface EnableImport {
}
在使用时只需在启动类上加上@EnableXxxxx注解即可
package com.gch;
/**
被@Import注解导入的类会被Spring加载到IOC容器当中
*/
// 使用第三方依赖提供的Enable开头的注解
@EnableImport
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class, args);
}
}
以上四种方式都可以完成导入操作,但是第4种方式会更方便更优雅,而这种方式也是SpringBoot当中所采用的方式。
前面我们学习了在项目当中引入第三方依赖之后,如何加载第三方依赖中定义好的bean对象以及配置类,从而完成自动配置操作。
那下面我们通过源码跟踪的形式来剖析下SpringBoot底层到底是如何完成自动配置的。
源码跟踪技巧:
- 在跟踪框架源码的时候,一定要抓住关键点,找到核心流程。一定不要从头到尾一行代码去看,一个方法的去研究,一定要找到关键流程,抓住关键点,先在宏观上对整个流程或者整个原理有一个认识,有精力再去研究其中的细节。
我们要运行所有的SpringBoot项目,首先分析入口在哪里?
又提问:怎么标识这是一个启动类呢?
要搞清楚SpringBoot的自动配置原理,要从SpringBoot启动类上使用的核心注解@SpringBootApplication开始分析:
在@SpringBootApplication注解中包含了:
元注解(不再解释)
@SpringBootConfiguration:底层封装了@Configuration注解,用来标识当前类是一个SpringBoot的配置类,我们可以把第三方bean配置到启动类当中,原因就是因为启动类是一个配置类。
@EnableAutoConfiguration:Enable开头的注解,用于启用SpringBoot的自动配置机制,它会根据应用的依赖和配置情况,自动配置和装配Spring应用程序的各种组件,简化了SpringBoot应用程序的配置过程,并提供了默认的配置。
@ComponentScan:组件扫描注解
这些注解的组合使得@SpringBootApplication注解可以快速启动一个SpringBoot应用程序,自动配置Spring应用程序的各种组件,扫描并加载相关的其它组件。
我们先来看第一个注解:@SpringBootConfiguration
接下来再先看@ComponentScan注解:
最后我们来看看@EnableAutoConfiguration注解(自动配置核心注解):
AutoConfigurationImportSelector类中重写了ImportSelector接口的selectImports()方法:
selectImports()方法底层调用getAutoConfigurationEntry()方法,获取可自动配置的配置类信息集合