【实战教程】构建可复用的 Spring Boot starter 微服务组件

案例 Demohttps://gitee.com/regexpei/coding-trainee/tree/demo/20240526_starter

介绍

在 Spring Boot 中,starter 启动依赖就像一个"开箱即用"的工具箱,它包含了第三方组件的配置和依赖,让我们无需手动配置和添加这些组件。

通过 starter,我们可以轻松地将通用的代码和配置整合成一个可复用的模块,从而简化项目搭建和代码管理,让开发人员更加专注于业务功能的开发。

那么,我们如何自定义一个 starter 呢?

步骤

  1. 创建 Maven 项目,命名规范为 xxx-spring-boot-starter

  2. 引入依赖

    xml 复制代码
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
    </dependencies>
  3. 定义 XxxProperties 属性配置类,用于绑定 application.yaml 或 application.properties 文件中的配置属性

  4. 编写业务类,根据 starter 的功能需要编写业务逻辑

  5. 配置 XxxAutoConfiguration 自动配置类

    • 使用 @Configuration 标记为配置类
    • 使用 @EnableConfigurationProperties(XxxProperties.class) 绑定配置属性类
  6. 创建 resources/META-INF/spring.factories

    factories 复制代码
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\  
    xxx.xxx.xxx.XxxAutoConfiguration
  7. 在需要使用的项目中引入 starter

    xml 复制代码
    <dependency>
        <groupId>xxx.xxx</groupId>
        <artifactId>xxx-spring-boot-starter</artifactId>
        <version>1.0.0</version>
    </dependency>
相关推荐
考虑考虑43 分钟前
JDK9中的dropWhile
java·后端·java ee
想躺平的咸鱼干1 小时前
Volatile解决指令重排和单例模式
java·开发语言·单例模式·线程·并发编程
hqxstudying1 小时前
java依赖注入方法
java·spring·log4j·ioc·依赖
·云扬·1 小时前
【Java源码阅读系列37】深度解读Java BufferedReader 源码
java·开发语言
Bug退退退1232 小时前
RabbitMQ 高级特性之重试机制
java·分布式·spring·rabbitmq
小皮侠2 小时前
nginx的使用
java·运维·服务器·前端·git·nginx·github
Zz_waiting.3 小时前
Javaweb - 10.4 ServletConfig 和 ServletContext
java·开发语言·前端·servlet·servletconfig·servletcontext·域对象
全栈凯哥3 小时前
02.SpringBoot常用Utils工具类详解
java·spring boot·后端
兮动人3 小时前
获取终端外网IP地址
java·网络·网络协议·tcp/ip·获取终端外网ip地址
呆呆的小鳄鱼3 小时前
cin,cin.get()等异同点[面试题系列]
java·算法·面试