学习自定义【Spring Boot Starter】这一篇就够了

目录

  • 1. starter介绍
  • 2. starter原理
    • 2-1. 起步依赖
    • 2-2. 自动配置
      • 基于Java代码的Bean配置
      • 自动配置的条件依赖
      • Bean参数获取
      • Bean的发现
      • Bean的加载
      • 自动配置总结
  • 3. 自定义starter案例
    • 3-1. 开发starter
    • 3-2. 使用starter

1. starter介绍

我们知道Spring Boot大大简化了项目初始搭建以及开发过程,而这些都是通过Spring Boot提供的starter来完成的。

spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。

Spring官方提供了很多starter,第三方也可以定义starter。为了加以区分,starter从名称上进行了如下规范:

  1. Spring官方提供的starter名称为:spring-boot-starter-xxx 例如:spring-boot-starter-web
  2. 第三方提供的starter名称为:xxx-spring-boot-starter 例如:mybatis-spring-boot-starter

2. starter原理

Spring Boot之所以能够帮我们简化项目的搭建和开发过程,主要是基于它提供的起步依赖自动配置

2-1. 起步依赖

起步依赖,其实就是将具备某种功能的坐标打包到一起,可以简化依赖导入的过程。例如,我们导入spring-boot-starter-web这个starter,则和web开发相关的jar包都一起导入到项目中了。如下图所示:

在这里插入图片描述

2-2. 自动配置

自动配置,就是无须手动配置xml自动配置并管理bean,可以简化开发过程。那么Spring Boot是如何完成自动配置的呢?

自动配置涉及到如下几个关键步骤:

  • 基于Java代码的Bean配置
  • 自动配置条件依赖
  • Bean参数获取
  • Bean的发现
  • Bean的加载

我们可以通过一个实际的例子mybatis-spring-boot-starter来说明自动配置的实现过程。

基于Java代码的Bean配置

当我们在项目中导入了mybatis-spring-boot-starter这个jar后,可以看到它包括了很多相关的jar包,如下图:
在这里插入图片描述
其中在mybatis-spring-boot-autoconfigure这个jar包中有如下一个MybatisAutoConfiguration自动配置类:

在这里插入图片描述

打开这个类,截取的关键代码如下:

在这里插入图片描述

  • @Configuration 注解的类可以看作是能生产让Spring IOC容器管理的Bean实例的工厂。

  • @Bean 注解的方法返回的对象可以被注册到Spring容器中。

  • @Configuration@Bean这两个注解一起使用就可以创建一个基于Java代码的配置类,可以用来替代传统的xml配置文件。

自动配置的条件依赖

MybatisAutoConfiguration这个类中使用的注解可以看出,要完成自动配置是有依赖条件的。

在这里插入图片描述
所以要完成Mybatis的自动配置,需要在类路径中存在SqlSessionFactory.classSqlSessionFactoryBean.class这两个类,同时需要存在DataSource这个bean且这个bean完成自动注册。

这些注解是spring boot特有的,常见的条件依赖注解有:

注解功能说明
@ConditionalOnBean仅在当前上下文中存在某个bean时,才会实例化这个Bean
@ConditionalOnClass某个class位于类路径上,才会实例化这个Bean
@ConditionalOnExpression当表达式为true的时候,才会实例化这个Bean
@ConditionalOnMissingBean仅在当前上下文中不存在某个bean时,才会实例化这个Bean
@ConditionalOnMissingClass某个class在类路径上不存在的时候,才会实例化这个Bean
@ConditionalOnNotWebApplication不是web应用时才会实例化这个Bean
@AutoConfigureAfter在某个bean完成自动配置后实例化这个bean
@AutoConfigureBefore在某个bean完成自动配置前实例化这个bean

Bean参数获取

要完成mybatis的自动配置,需要我们在配置文件中提供数据源相关的配置参数,例如数据库驱动连接url数据库用户名密码等。那么spring boot是如何读取yml或者properites配置文件的的属性来创建数据源对象的?

在我们导入mybatis-spring-boot-starter这个jar包后会传递过来一个spring-boot-autoconfigure包,在这个包中有一个自动配置类DataSourceAutoConfiguration,如下所示:

在这里插入图片描述
我们可以看到这个类上加入了EnableConfigurationProperties这个注解,继续跟踪源码DataSourceProperties这个类,如下:

在这里插入图片描述
可以看到这个类上加入了ConfigurationProperties注解,这个注解的作用就是把yml或者properties配置文件中的配置参数信息封装到ConfigurationProperties注解标注的bean(即DataSourceProperties)的相应属性上。

@EnableConfigurationProperties注解的作用是使@ConfigurationProperties注解生效。

Bean的发现

spring boot默认扫描启动类所在的包下的主类与子类的所有组件,但并没有包括依赖包中的类,那么依赖包中的bean是如何被发现和加载的?

我们需要从Spring Boot项目的启动类开始跟踪,在启动类上我们一般会加入SpringBootApplication注解,此注解的源码如下:

在这里插入图片描述
重点介绍如下三个注解:

  • SpringBootConfiguration:作用就相当于Configuration注解,被注解的类将成为一个bean配置类

  • ComponentScan:作用就是自动扫描并加载符合条件的组件,最终将这些bean加载到spring容器中

  • EnableAutoConfiguration :这个注解很重要,借助@Import的支持,收集和注册依赖包中相关的bean定义

继续跟踪EnableAutoConfiguration注解源码:

在这里插入图片描述
AutoConfigurationImportSelector类源码如下:

在这里插入图片描述
AutoConfigurationImportSelector类的getCandidateConfigurations方法中的调用了SpringFactoriesLoader类的loadFactoryNames方法,继续跟踪源码:

在这里插入图片描述
在这里插入图片描述

SpringFactoriesLoaderloadSpringFactories静态方法可以从所有的jar包中读取META-INF/spring.factories文件,而自动配置的类就在这个文件中进行配置:

在这里插入图片描述

这个文件里面的内容如下:
在这里插入图片描述

这样Spring Boot就可以加载到MybatisAutoConfiguration这个配置类了。

Bean的加载

在Spring Boot应用中要让一个普通类交给Spring容器管理,通常有以下方法:

1、使用 @Configuration与@Bean 注解

2、使用@Controller @Service @Repository @Component 注解标注该类并且启用@ComponentScan自动扫描

3、使用@Import 方法

其中Spring Boot实现自动配置使用的是@Import注解这种方式,AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名,这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。

自动配置总结

我们可以将自动配置的关键几步以及相应的注解总结如下:

1、@Configuration与@Bean:基于Java代码的bean配置

2、@Conditional:设置自动配置条件依赖

3、@EnableConfigurationProperties与@ConfigurationProperties:读取配置文件转换为bean

4、@EnableAutoConfiguration与@Import:实现bean发现与加载

3. 自定义starter案例

3-1. 开发starter

第一步:创建starter工程digest-spring-boot-starter并配置pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.iteng</groupId><artifactId>digest-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><!--  提供自动装配所依赖的注解  --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId><version>2.7.6</version><optional>true</optional>      <!--  不进行依赖传递  --></dependency><!--apache 加密--><dependency><groupId>commons-codec</groupId><artifactId>commons-codec</artifactId><version>1.15</version></dependency></dependencies></project>

第二步:创建配置属性类DigestProperty

package com.iteng.digest.config;import org.springframework.boot.context.properties.ConfigurationProperties;/**读取配置文件转换为bean* */
@ConfigurationProperties(prefix = "digest")
public class DigestProperty {private String type;public String getType() {return type;}public void setType(String type) {this.type = type;}
}

第三步:创建业务类Digest 以及实现类Md5DigestShaDigest

service

public interface Digest {String digest(String raw);
}

impl

public class Md5Digest implements Digest {@Overridepublic String digest(String raw) {System.out.println("Md5加密生成摘要");return DigestUtils.md5Hex(raw);}
}
public class ShaDigest implements Digest {@Overridepublic String digest(String raw) {System.out.println("Sha加密生成摘要");return DigestUtils.sha256Hex(raw);}
}

第四步:创建自动配置类DigestAutoConfiguration

@Configuration
// 使@ConfigurationProperties注解生效
@EnableConfigurationProperties(DigestProperty.class)
// 只有类路径下有DigestUtils.class时,DigestConfiguration配置类才配置
@ConditionalOnClass(DigestUtils.class) 
public class DigestAutoConfiguration {private DigestProperty digestProperty;//通过构造方法注入配置属性对象DigestProperty, 也可以使用@Autowired注解注入public DigestAutoConfiguration(DigestProperty digestProperty) {this.digestProperty = digestProperty;}@Bean@ConditionalOnMissingBean // 没有Digest这个Beab时,才装配Digest Bean// 只有当yml中的digest.type == md5时,才装配Digest Bean。// matchIfMissing = true:表示yml没有写digest.type时,也装配Digest Bean@ConditionalOnProperty(prefix = "digest", name = "type", havingValue = "md5", matchIfMissing = true)public Digest md5Digest() {return new Md5Digest();}@Bean@ConditionalOnMissingBean@ConditionalOnProperty(prefix = "digest", name = "type", havingValue = "sha")public Digest shaDigest() {return new ShaDigest();}
}

第五步:(Spring Boot 2.7 及以上)在resources目录下创建META-INF文件夹,在META-INF文件夹里面创建一个spring文件夹。在spring文件夹中创建org.springframework.boot.autoconfigure.AutoConfiguration.imports的文件。文件内容写自动配置类的全限名

com.iteng.digest.config.DigestAutoConfiguration

(Spring Boot 2.7 以下)在resources目录下创建META-INF文件夹,在文件夹中创建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.iteng.digest.config.DigestAutoConfiguration

至此starter已经开发完成了,可以将当前starter安装到本地maven仓库供其他应用来使用。

3-2. 使用starter

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/580778.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

取消终端代理

1. 查看当前的代理设置 首先&#xff0c;你可以使用 echo 命令来检查当前是否设置了代理环境变量。在终端中执行以下命令&#xff1a; echo $http_proxy echo $https_proxy如果这些命令返回了代理地址或者相关的信息&#xff0c;那就意味着代理已经设置。 2. 取消代理设置 …

C语言之进制转换

C语言之进制转换 一、引言二、十进制与二进制、八进制、十六进制三、二进制与八进制、十六进制四、八进制与十六进制 一、引言 在C语言中&#xff0c;经常使用的整数的进制有十进制、二进制、十六进制&#xff08;在C语言中以0x或0X为前缀&#xff09;、八进制&#xff08;在C…

SpringBoot实用开发(三)-- Redis提供API接口 -- StringRedisTemplate

引言: 由于redis内部不提供java对象的存储格式,因此当操作的数据以对象的形式存在时,会进行转码,转换成字符串格式后进行操作。为了方便开发者使用基于字符串为数据的操作,springboot整合redis时提供了专用的API接口StringRedisTemplate,你可以理解为这是RedisTe…

自动驾驶代客泊车AVP路径规划详细设计

目 录 1 背景... 1 2 名词解释... 2 3 路径规划及控制总体设计&#xff08;SMPC&#xff09;... 3 4 路径规划及控制详细设计... 4 4.1 决策场景... 4 4.2 接口定义... 4 4.2.1 目标车道线的巡航场景... 4 4.2.2 目标车道线与动态障碍物的混合场景... 4 4.2.3 垂直泊车…

uniapp 创建项目

uniapp 是一款基于 Vue 框架的跨平台应用开发框架。 创建 uniapp 项目 一、打开 HbuilderX 编辑器&#xff0c;点击新建项目。 二、选择 uniapp 项目、自定义项目名称、选择默认模板、选择 Vue 版本、点击创建。 三、这样 uniapp 项目就创建完毕啦&#xff01; 运行 uniapp …

2023年秋季学期《算法分析与设计》练习16 OJ-1425 算法分析与设计练习16,使用python

N皇后问题 使用回溯法求解N后问题。 输入 皇后的个数。 输出 每一种方案及总方案数。 样例输入 Copy 4 样例输出 Copy 0 1 0 0 0 0 0 2 3 0 0 0 0 0 4 0 ---------------- 0 0 1 0 2 0 0 0 0 0 0 3 0 4 0 0 ---------------- 总方案数为&#xff1a;2 def dfs(row, n)…

安防视频监控系统EasyCVR实现H.265视频在3秒内起播的注意事项

可视化云监控平台/安防视频监控系统EasyCVR视频综合管理平台&#xff0c;采用了开放式的网络结构&#xff0c;可以提供实时远程视频监控、视频录像、录像回放与存储、告警、语音对讲、云台控制、平台级联、磁盘阵列存储、视频集中存储、云存储等丰富的视频能力&#xff0c;同时…

spdlog中的异步日志方案

日志方案 同步日志方案&#xff1a;立即输出日志记录的方案才能继续执行其他任务。 异步日志方案&#xff1a;先抛出一个日志记录的任务到某个地方&#xff0c;不马上执行打印也不影响往下执行其他任务。 二者关键区别是产生日志记录并调用相关的日志任务接口之后&#xff0…

若依报500异常,只有前端没有后端

1.在vue.config.js中target的网址为https://vue.ruoyi.vip, process.env.VUE_APP_BASE_API]: { target: https://vue.ruoyi.vip,}2.pathRewrite单引号中加入 /prod-api pathRewrite: { ^ process.env.VUE_APP_BASE_API]: /prod-api3.在.env.development中变更 VUE_APP_BASE…

【Python】Python 输出中文乱码问题解决

Python 中文乱码的解决方法 1. 理解编码和解码 Python的字符编码遵循Unicode标准,但在不同的操作系统和编程环境下会有不同的默认字符编码,导致中文输出出现乱码等问题。解决中文输出乱码的问题,需要先理解编码和解码的概念。 编码: 把字符转换成字节序列的过程。因为计算…

CMMI认证办理流程以及需要参与的人员

CMMI&#xff08;Capability Maturity Model Integration&#xff09;认证是衡量软件企业过程管理成熟度的一种标准&#xff0c;它由美国卡内基-梅隆大学软件工程研究中心与美国国防部共同开发。CMMI认证分为五个等级&#xff0c;从低到高依次为1级到5级。以下是办理CMMI证书的…

数据结构-汇总

时间复杂度-汇总 一、二叉树 1、树的结构-初期 2、二叉树的分类-平衡树-红黑树 二叉树的旋转-LL\RR\RL\LR 3、二叉树的旋转-高级一步到位 4、红黑树特征、删除、插入

test mock-01-什么是 mock? Mockito/EasyMock/PowerMock/JMockit/Spock mock 框架对比

拓展阅读 test 之 jmockit-01-overview jmockit-01-test 之 jmockit 入门使用案例 mockito-01-overview mockito 简介及入门使用 PowerMock Mock Server ChaosBlade-01-测试混沌工程平台整体介绍 jvm-sandbox 入门简介 单元测试中的 mock 单元测试是一种验证代码单元&…

K8S网络类型

k8s的网络类型 k8s的通信模式 1 pod内部之间容器与容器之间的通信&#xff0c;在同一个pod中容器是共享资源和网络&#xff0c;使用同一个网络命名空间&#xff0c;可以直接通信 2 同一个node节点之内&#xff0c;不同pod之间的通信&#xff0c;每个pod都有一个全局的真实ip地…

AI 领域代币市场趋势:探索最热门投资领域的前沿动向

作者&#xff1a;lesleyfootprint.network 数据源&#xff1a;Token Sector Dashboard ChatGPT 的热潮点燃了 AI 领域&#xff0c;AI 与区块链技术的融合成为市场关注的焦点。因为区块链的一个显著特征是它能够在链上安全地存储大量数据&#xff0c;这与 AI 模型对数据的密集…

mysql面试题:索引(B+树、聚集索引、二级索引、回表查询、覆盖索引、超大分页查询、索引创建原则)

索引 概念 索引&#xff08;index&#xff09;是帮助MySQL高效获取数据的数据结构(有序)。在数据之外&#xff0c;数据库系统还维护着满足特定查找算法的数据结构**&#xff08;B树&#xff09;**&#xff0c;这些数据结构以某种方式引用&#xff08;指向&#xff09;数据&am…

安装虚拟机在虚拟机里面安装WindowsServer2012与步骤

目录 一、VMware介绍 1.1、概念讲解 1.2、VMware虚拟机的安装讲解 1.3、具体操作步骤 二、虚拟机安装WindowsServer2012演示 2.1、在虚拟机里配置具体步骤 (相当于制作启动U盘) 2.2、安装windows server2012步骤演示 三、Windows Server2012激活步骤演示 四、思维导…

golang并发安全-sync.map

sync.map解决的问题 golang 原生map是存在并发读写的问题&#xff0c;在并发读写时候会抛出异常 func main() {mT : make(map[int]int)g1 : []int{1, 2, 3, 4, 5, 6}g2 : []int{4, 5, 6, 7, 8, 9}go func() {for i : range g1 {mT[i] i}}()go func() {for i : range g2 {mT[…

【SpringBoot篇】优惠券秒杀 — 添加优惠劵操作(基本操作 | 一人仅一张券的操作)

文章目录 &#x1f354;发放优惠券&#x1f386;基本操作&#x1f384;数据库表&#x1f6f8;思路&#x1f339;代码实现 &#x1f386;完善后的操作&#x1f6f8;乐观锁&#x1f339;代码实现 &#x1f354;一人仅一张优惠券&#x1f6f8;思路&#x1f339;代码⭐代码分析 &am…

git远程操作,推送【push】,拉取【pull】,忽略特殊文件,配置别名,标签管理

文章目录 前言&#xff1a;新建远程仓库克隆推送【push】拉取【pull】 配置git忽略特殊文件给命令配置别名 标签管理理解标签创建标签操作标签 前言&#xff1a; 大家如果没有看过前几章git的基础操作的话&#xff0c;推荐先看一下&#xff0c;看完再来看这个远程操作&#xf…