怎么做一个SpringBoot Starter

第一步:初始化

先是点击创建新项目:

导入代码补全包,这个包可以让你的包被导入别的项目时有代码提示:

打开pom文件删除以下配置(ps:打包成功的要点所在):

 

第二步:配置

在原本启动类中原来将的@SpringBootApplication注解替换成以下的注解(@ConfigurationProperties(“api.common”)就是你希望使用者在yml文件下配置的参数,在配置类中定义的变量,也就是使用者在yml中需要配置的变量):

在resource目录下新建以下文件 

配置路径(这里主要是配置你启动类的路径,方便导入坐标时,springBoot项目可以自动扫描到配置类并加载响应的bean)

第三步:打包

点击maven里的生命周期下的install

如果出现以下的报错:

可以点击跳过测试 

最后打包成功:

### 创建自定义 Spring Boot Starter 的步骤 #### 添加 Maven 或 Gradle 依赖项 为了使项目能够识别并使用其他组件,需要先设置构建工具中的依赖管理。对于Maven而言,在`pom.xml`文件中添加必要的依赖来支持Spring Boot应用的开发[^1]。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> ``` 此部分确保了基础的支持功能被引入到项目当中。 #### 定义自动配置类 创建一个新的Java类作为自动配置的核心逻辑载体,并标注上`@Configuration`注解表明这是一个配置类。该类负责根据条件判断是否应该激活某些特定的行为或者服务注入。例如: ```java @Configuration @ConditionalOnClass(SomeService.class) public class MyStarterAutoConfig { } ``` 这里通过`@ConditionalOnClass`确保只有当classpath下存在`SomeService`时才执行后续操作[^2]。 #### 编写 `META-INF/spring.factories` 按照Spring Boot的规定,在资源目录下的路径`/META-INF/spring.factories`处放置一个名为`sprinf.factories`的文件[^3]。其内容应指向之前编写的自动配置类,格式如下所示: ``` org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.MyStarterAutoConfig ``` 这一步骤使得Spring Boot可以在应用程序启动期间发现并应用这些自动化配置[^4]。 #### 提供默认属性 (可选) 可以通过在项目的resource文件夹里增加application.properties或application.yml的形式给用户提供一组合理的缺省参数设定。比如: ```yaml my.starter.property=default-value ``` 这样即使用户未做任何额外配置也能正常工作,同时也方便他们基于实际需求调整行为模式。 完成以上几个方面的工作之后,就成功地制作了一个简单的Spring Boot Starter模块。将其打发布至私有仓库或其他公共平台后便可以像官方提供的starters一样轻松集成进各种项目之中。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值