如何自定义个一个开箱即用并可以配置属性的SpringBoot的starter

最新推荐文章于 2024-10-07 08:57:49 发布
最新推荐文章于 2024-10-07 08:57:49 发布
阅读量1.7k 收藏 45
点赞数 23
分类专栏： 成长 文章标签： spring boot java 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_56426811/article/details/141721448
版权

如何自定义个一个开箱即用可以配置的SpringBoot的starter
记录如何创建一个自定义（输出请求地址ip）开箱即用的starter，我目前使用的SpringBoot的版本是2.6的版本，代码比较简单涉及的文件比较多所以选择直接截图的方式记录了

目录

一、创建一个SpringBoot项目

命名按照正常的starter来定义就行（xxx-spring-boot-starter），当然也可以随意命名，没什么大影响，添加两个所需依赖

请添加图片描述

lombok不用解释了吧，另外一个依赖是为了你在写配置文件的时候有提示比较方便的
请添加图片描述

二、编码自定义starter

1.自定义starter中引用所需的pom文件

刚才少添加了一个web的starter，记得加回来不然没法使用Spring的注入接口，这几个就足够了，也可以根据自己的starter需求添加对应依赖
自定义starter中的pom文件

2.新建一个接口和实现类

新建api包并创建PrintIpService接口和PrintIpServiceImpl实现类，在实现类里面书写我们主要的核心功能
在这里插入图片描述

3.新建configure包并创建configure配置类，实例化对象

在这里插入图片描述

4.将配置类引入到spring环境中

resource -> META-INF -> spring.factories
在resource中创建META-INF文件夹，然后再文件夹内创建spring.factories文件，并在文件中添加下面一句话，等号后面的值是自己配置类的全路径包名

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xiaoliu.configure.PrintIpAutoConfigure

三、将starter放到Maven仓库中，双击install

在这里插入图片描述
到此一个简单的输出请求ip的starter就创建完成了

四、创建测试工程PrintIp-test

1.添加starter依赖

创建测试工程就不贴图和之前黑丝一样的，在测试工程的pom文件中添加我们自定义的依赖。这里依赖就是我们自定义starter项目的pom文件的前几行代码，把groupId和artifactId以及version对应起来就行了
在这里插入图片描述

2.编写一个简单的接口并在其中注入我们的PrintIpService

在这里插入图片描述

五、启动测试工程PrintIp-test并访问mystarter接口

在这里插入图片描述
测试成功，控制台能正确输出我们的请求IP
在这里插入图片描述

此时的自定义starter还不能够满足开箱即用的特点，即便引入了相关依赖还需要我们在需要的地方手动的注入，下面我们将借助interceptor拦截器来帮我们实现开箱即用的特点，并且添加调用方可配置的输出格式

六、添加拦截器

在starter项目中添加拦截器PrintIpInterceptor和SpringMvcConfig类将自定义拦截器加到Spring中，将之前在测试工程的接口中注入和手动调用PrintIpService方法的代码放到拦截器中
在这里插入图片描述
在这里插入图片描述
到这里就已经实现了开箱即用的特点，无需调用方在手动编写代码，只要引入我们自己定义的starter依赖即可实现请求ip的输出

七、增加属性配置项

通过配置文件可以修改starter的输出格式

1.创建一个样式配置类PrintIpStyleConfig和一个样式枚举类

在这里插入图片描述

在这里插入图片描述

2.修改PrintIpServiceImpl中打印功能代码

根据调用方配置的不同值显示不同的样式，默认是default在这里插入图片描述

3.重新install自定义的starter

八、在Print-test工程中刷新Maven然后添加配置代码

根据配置的Style的值来控制输出格式，不配置走默认样式
在这里插入图片描述

九、重启测试工程进行测试

默认样式，不配置也是当前样式因为在starter中配了默认值在这里插入图片描述

配置详情样式
在这里插入图片描述
到目前为止一个简单的开箱即用可以配置的输出请求IP的自定义starter就完成了，可以按照个人需求去定义个性化的starter

十、最终项目目录结构

1.最终自定义starter项目目录结构

在这里插入图片描述

2.最终测试工程项目目录结构

在这里插入图片描述

习惯搬砖
关注
专栏目录
【Springboot】| 从深入自动配置原理到实现 自定义Springboot starter
狮子也疯狂的博客
08-27 3451
是SpringBoot的一个重要概念，是“一站式服务 (one-stop)”的依赖 Jar 包包含 Spring 以及相关技术(比如 Redis)的所有依赖提供了自动配置的功能，开箱即用提供了良好的依赖管理，避免了包遗漏、版本冲突等问题。简单来说， Springboot starter 提供了一种自动配置的机制，我们只需要将需要的Starter引入项目中，它就会自动为我们配置相关的依赖和配置。这使得开发人员可以更加关注业务逻辑的实现；现在我们来学习一下它的原理，以便后面能更清晰地实现。这个技能对你有用么。
SpringBoot自定义starter（starter的命名规范、starter的结构、自定义starter、为配置属性添加描述信息、检验配置属性）
聂可以的博客
09-06 1012
SpringBoot自定义starter（starter的命名规范、starter的结构、自定义starter、为属性添加描述信息、检验配置属性）
Springboot开发自定义starter
m0_48480302的博客
03-16 196
springboot通过一个@SpringBootApplication注解启动项目，springboot在项目启动的时候，会将项目中所有声明为Bean对象（注解、xml）的实例信息全部加载到ioc容器当中。 除此之外也会将所有依赖到的starter里的bean信息加载到ioc容器中，从而做到所谓的零配置，开箱即用。
编写SpringBoot的自定义starter包
糖拌西红柿
07-23 1093
SpringBoot的starter开发，如果开发自己的starter，starter的标准目录结构
SpringBoot如何自定义starter启动器？看这里
一一哥
10-21 2825
!-- 1.引入我们自定义的场景启动器 -->通过测试发现，我们已经可以在其他项目中使用自定义的starter，并使用自动配置好的组件功能了！现在你知道该怎么自定义starter了吗？如果你还有其他问题，可以在评论区留言或私信哦。关注Java架构栈，干货天天都不断！
实现自定义SpringBoot的Starter组件
DayDayUp的博客
02-07 2238
springboot通过一个@SpringBootApplication注解启动项目，springboot在项目启动的时候，会将项目中所有声明为Bean对象（注解、xml）的实例信息全部加载到ioc容器当中。 除此之外也会将所有依赖到的starter里的bean信息加载到ioc容器中，从而做到所谓的零配置，开箱即用。
在SpringBoot中如何自定义starter
记录并分享
12-28 723
SpringBoot 提供了很多开箱即用的starter依赖，将其称为场景启动器，使得我们在开发业务代码时能够非常方便的、快速的完成框架的引入，为我们省去了之前很多的配置操作，无需过多关注框架的配置，摆脱了各种依赖库的处理和配置各种信息的困扰，甚至有些功能的开启只需要在启动类或配置类上增加一个注解即可完成。SpringBoot会自动发现符合上下文场景的Bean对象，并注册到IOC容器中
SpringBoot自动配置原理，以及如何编写自定义的starter
m0_71777195的博客
09-15 248
ImportSelector是一个接口，该接口提供了一个selectImports方法，用来返回全类名数组；可以通过这种方式，动态导入N个bean创建普通类kotlin复制代码} ​ }typescript复制代码} ​ }实现ImportSelector接口typescript复制代码} ​ }创建一个配置类，导入实现了ImportSelector接口的类less复制代码} } }控制台输出结果简介。
案例实操|带你学会自定义SpringBoot starter启动器
威哥爱编程，CSDN 博客专家、全栈领域新星创作者、华为 HDE，愿交天下 IT 技术爱好者
11-28 370
开发人员只需要在项目的POM文件中导入对应的场景依赖，并编写少量的配置，即可快速实现当前场景的应用开发，真正的实现开箱即用。今天建哥会通过这篇文章，并结合一个具体的案例来给各位小伙伴介绍一下，我们该如何自定义一个自己的SpringBoot场景启动器，毕竟有时候官方提供的starter不能完全满足我们所有的需求。上面我们定义了一个组件HelloService，它有一个非常简单的功能，就是能够根据调用者传递的名字返回一个打招呼的信息，返回的信息内容可以根据配置的前缀和后缀进行指定格式的设置。
Springboot集成JPA，开箱即用.pdf
12-30
### Spring Boot集成JPA，开箱即用 #### 1. 概述 Spring Boot集成JPA（Java Persistence API）可以极大地简化数据访问层的开发工作。JPA提供了一种对象关系映射的方式，允许开发者将Java对象直接映射到数据库表上...
SpringBoot Starter模板
11-26
Spring Boot通过Starters提供了一种“开箱即用”的体验，使得开发者可以快速地构建基于Spring的应用。在这个模板中，你无需从零开始创建项目结构，而是可以直接利用预配置的依赖来启动开发。 首先，让我们深入了解...
Spring Boot 进阶-浅析SpringBoot中如何完成数据校验
最新发布
初学者
10-07 1144
JSR-303规则是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator，这个实现与Hibernate ORM 没有任何关系。JSR 303 用于对 Java Bean 的字段值进行验证。Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。也可以通过使用注解的方式进行验证。那么在Spring Boot中如何使用呢？
Spring Boot新闻推荐：实时数据处理
2401_85439108的博客
10-04 1025
在整个系统测试中，根据需求文档和设计文档，逐一对功能进行检测并写好测试用例，有效避免残片缺陷，因为产品出现缺陷不仅影响功能，而且可以导致数据的不准确，导致产品质量的降低，经过测试，才能使得产品的稳定性和成熟度得到极大的提升，产品质量也才有保证。近来，软件工程界趋向于一种新的观点，即认为软件生命周期每一阶段中都应包含测试，从而检验本阶段的成果是否接近预期的目标，尽可能早的发现错误并加以修正，如果不在早期阶段进行测试，错误的延时扩散常常会导致最后成品测试的巨大困难。至此，在功能的测试上也已经比较圆满的完成了。
Spring Boot项目的创建与使用
zhzjn的博客
10-05 506
【代码】Spring Boot项目的创建与使用。
利用Spring Boot构建足球青训管理平台
2402_85762143的博客
10-01 1056
Spring Boot是一个简化程序设置的拥有开箱即用的框架，它主要的优点是根据程序员不同的设置而生成不同的代码配置文件，这样开发人员就不用每个项目都配置相同的文件，从而减低了开发人员对于传统配置文件的时间，提高了开发效率。综上所述，该系统具有技术可行性。在设计之初，我在网上参考了许多相关系统的界面布局设计，发现该系统界面展示比较简单，功能罗列齐全，操作流程简单明了，系统用户不用担心不会操作，系统各个功能模块都会有相应的提示，一看就明白，实在不知道的话，稍微指点就能上手，上手速度很快，时间不会耽误太多。
构建高效服装销售平台：Spring Boot与“衣依”案例
2401_85743969的博客
10-03 1076
同时，一个大型的计算机网站系统，必须有一个正确的设计指导思想，通过合理选择数据结构、网络结构、操作系统以及开发环境，构成一个完善的网络体系结构，才能充分发挥计算机信息管理的优势。目前，界面设计已经成为对软件质量进行评价的一条关键指标，一个好的用户界面可以使用户使用系统的信心和兴趣增加，从而使工作效率提高，JSP技术是将JAVA语言作为脚本语言的，JSP网页给整个服务器端的JAVA库单元提供了一个接口用来服务HTTP的应用程序。输入数据的收集和录入是比较麻烦的，需要非常多的人力和一定设备，而且经常出错。
Spring Boot驱动的智能新闻推荐引擎
2401_85339615的博客
10-04 796
6、网络上的客户端和服务器可以用来编程任何独立的编程环境，也有中国，GB2312，BIG5，日文写作，一般基金，用于支持多国语言，并且可以嵌入在数据表和其他软件shift_jis访问柱可以用作的名称。2、支持多种操作系统AIX的，FreeBSD下，HP-UX，Linux和Mac OS中，Novell公司的Netware，OpenBSD系统，OS/2裹时，Solaris，Windows等。编程语言，如C, C ++，Python和Java的，的Perl，PHP，埃菲尔铁塔，Ruby和Tcl的。
足球青训俱乐部后台：Spring Boot开发策略
2401_85761003的博客
10-01 1079
采用B/S体系结构开发的应用软件仅仅需要在客户端安装谷歌浏览器或者其他浏览器就可以操作，对于维护和升级操作则在服务器端就能完成，不用在客户端进行操作，这样就节省了许多开销，B/S模式能够保证软件应用的跨平台性和通用性，采用它开发软件是最佳选择。数据库在整个系统中，就是这个系统的基础。系统结构设计是整个系统设计中重要的一部分，在结构设计过程中，首先对系统进行需求分析，然后进行系统初步设计，将系统功能模块细化，具体分析每一个功能模块具体应该首先哪些功能，最后将各个模块进行整合，实现系统结构的最终设计。
Springboot快速集成JPA：实战教程与定制Repository
本文档主要介绍了如何在Spring Boot项目中集成JPA（Java Persistence API）并实现“开箱即用”的开发体验。首先，文章关注于设置Spring Boot项目的起步，通过在`pom.xml`文件中添加`spring-boot-starter-data-jpa`...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值