如何定制化Spring Boot Starter,这次我终于学会了

news/2024/12/2 21:54:44/

image.png

文章目录

  • 什么是Spring Boot Starter
  • 实现步骤
    • 启动器
    • 自动配置包
  • 总结自定义Starter的实现逻辑

Spring Boot Starter官网描述:Spring Boot Starter官方介绍

什么是Spring Boot Starter

Starters可以理解为启动器,它包含了一系列可以集成到应用里面的依赖包,可以一站式集成 Spring和其他技术,而不需要到处找示例代码和依赖包。Spring Boot Starter的工作原理是:Spring Boot在启动时扫描项目所依赖的JAR包,寻找包含spring.factories文件的JAR包,根据spring.factories配置加载AutoConfigure类,根据@Conditional注解的条件,进行自动配置并将Bean注入Spring Context

为什么要自定义Spring Boot Starter?

在Spring Boot官网为了简化我们的开发,已经提供了非常多场景的Starter来为我们使用,即便如此,也无法全面的满足我们实际工作中的开发场景,这时我们就需要自定义实现定制化的Starter。

image.png

实现步骤

1.首先,创建一个Maven空工程,添加两个模块

启动器

启动器中没有任何的源代码,只是告诉我们当前场景需要引入哪些依赖即可!

创建启动器模块为maven工程,命名为
xiaozhao-hello-spring-boot-starter,对应的依赖文件

<groupId>com.zhao</groupId>
<artifactId>xiaozhao-hello-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>

自动配置包

自动配置包中实现了所有的自动配置功能!

创建自动配置包模块为SpringBoot初始化工程,命名为xiaozhao-hello-spring-boot-starter-autoconfigure

image.png

最终的项目模块如下:

image.png

2.模块创建完成后,需要在启动器中引入自动配置模块(别人引入场景启动器,自动配置包就会自动引入)

<dependencies><dependency><groupId>com.zhao</groupId><artifactId>xiaozhao-hello-spring-boot-starter-autoconfigure</artifactId><version>0.0.1-SNAPSHOT</version></dependency>
</dependencies>

3.编写自动配置模块。

  • 创建自定义的Properties文件
@ConfigurationProperties("xiaozhao.hello")
public class HelloProperties {private String prefix;private String suffix;public String getPrefix() {return prefix;}public void setPrefix(String prefix) {this.prefix = prefix;}public String getSuffix() {return suffix;}public void setSuffix(String suffix) {this.suffix = suffix;}
}
  • 创建业务类读取Properties文件中的值
public class HelloService {@AutowiredHelloProperties helloProperties;public String sayHello(String userName){return helloProperties.getPrefix() + ":" + userName + ">" + helloProperties.getSuffix();}
}
  • 再个自动配置类,自动进行类加载
@Configuration
@ConditionalOnMissingBean(HelloService.class)
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {@Beanpublic HelloService helloService(){HelloService helloService = new HelloService();return helloService;}
}

最终的效果如下:

image.png

4.在resources目录下创建META-INF/spring.factories添加如下配置信息

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.zhao.hello.auto.HelloServiceAutoConfiguration

image.png
5.装hello-spring-boot-starter-autoconfigure模块和xiaozhao-hello-spring-boot-starter

image.png

image.png

6.装完成后,创建新的项目来引入创建好的starter.新的的项目名为hello-test的Spring Boot初始化项目。

image.png

引入我们之前定义的Starter启动器和Spring Boot自带的Web启动器

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>com.zhao</groupId><artifactId>xiaozhao-hello-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version></dependency>
</dependencies>

image.png
7.在hello-test项目中创建测试Controller

@RestController
public class HelloController {@AutowiredHelloService helloService;@GetMapping("/hello")public String sayHello() {String str = helloService.sayHello("李四");return str;}
}

编写配置文件

xiaozhao.hello.prefix=hello
xiaozhao.hello.suffix=666

image.png

8.启动项目,测试一下

image.png

总结自定义Starter的实现逻辑

  1. 首先引入自定义的Starter:xiaozhao-hello-spring-boot-starter,在这个Starter中引入自定义的自动配置场景
  2. 当自动配置场景启动时,会去寻找spring.factories文件,去自动加载HelloServiceAutoConfiguration类文件
  3. 加载完自动配置类后,@ConditionalOnMissingBean(HelloService.class)通过这个注解,当容器中没有HelloService时,去自动添加一个HelloService组件。
  4. HelloService组件的所有属性,通过HelloProperties配置文件进行绑定的,@ConfigurationProperties("xiaozhao.hello"),通过xiaozhao.hello。xxx进行绑定。
  5. 如果自己在容器中注入一个HelloService组件,使用的就不是自动配置的,而是重新注入的。

http://www.ppmy.cn/news/6707.html

相关文章

shell脚本四剑客之awk详解

文章目录awk的介绍awk能够干什么awk的格式工作原理&#xff1a;记录和域内建变量的用法1. FS2. OFS3.RS4. ORS5. NF6. NRBEGIN 和END语句块常见案例1. 使用NR行号提取ip2. 打印UID小于10的账号名称和UID信息3. 数学运算4. AWK打印硬盘设备名称&#xff0c;默认以空格为分割&…

买不到的数目(蓝桥杯C/C++A组真题详解)

题目详细&#xff1a; 题目思路&#xff1a; 对于这个题有一个定理 如果 a,b 均是正整数且互质&#xff0c;那么由 axby&#xff0c;x≥0&#xff0c;y≥0 不能凑出的最大数是 &#xff1a; a*b-a-b 具体的证明过程这里就不赘述 感兴趣的同学可以自行查找 这里就提供一种思…

Python常见问题整理

Python常见问题整理   日常使用python时&#xff0c;经常遇到的各种解决不了、头疼的问题&#xff0c;都可以记录到这里&#xff0c;大家群策群力&#xff0c;积极补充~  序号问题标题问题现象原因解决方法参考文章添加人报错截图0ModuleNotFoundError代码运行报错ModuleNot…

IMX6ULL学习笔记(15)——GPIO输出接口使用【官方SDK方式】

一、GPIO简介 i.MX6ULL 芯片的 GPIO 被分成 5 组,并且每组 GPIO 的数量不尽相同&#xff0c;例如 GPIO1 拥有 32 个引脚&#xff0c; GPIO2 拥有 22 个引脚&#xff0c; 其他 GPIO 分组的数量以及每个 GPIO 的功能请参考 《i.MX 6UltraLite Applications Processor Reference M…

人员工装未穿戴识别检测 opencv

人员工装未穿戴识别检测基于OpenCvyolo计算机视觉深度学习技术对现场画面中人员行为着装穿戴实时监测识别&#xff0c;发现不按要求着装违规行为立即抓拍存档同步后台。OpenCV-Python使用Numpy&#xff0c;这是一个高度优化的数据库操作库&#xff0c;具有MATLAB风格的语法。所…

【C语言进阶】想用好C++?那就一定要掌握动态内存管理

目录 &#x1f929;前言&#x1f929;&#xff1a; 一、动态内存概述⚔️&#xff1a; 1.什么是动态内存&#xff1a; 2.动态内存分配的意义&#xff1a; 二、常用的动态内存函数&#x1f3f9;&#xff1a; 1. malloc 和 free函数&#xff1a; ①. malloc 函数&#xff1a; …

Windows和Mac系统实现本地部署WebPageTest工具

在项目开发或者测试的过程中&#xff0c;由于没有上线&#xff0c;我们在公网上无法访问我们的网站&#xff0c;但同时我们又需要查看浏览器性能&#xff0c;这样我们就需要在本地部署WebPageTest工具以协助进行性能测试 具体实现步骤&#xff1a; Windows系统&#xff1a; …

关于 Camera 开始 Tuning 时的一些注意事项

1、问题背景&#xff1a; 最近有调试一个体感游戏机上带 Camera 的项目&#xff0c;原定搭配 ov13855 这颗 sensor, 但由于各种各样的问题&#xff0c;导致做了很多无用功&#xff0c;且各种延期。 本文主要总结下此次项目遇到的问题&#xff0c;及产品开始 tuning 时的一些注意…