【SpringBoot】之创建自定义 SpringBoot-Starter_uyatu-spring-boot-starter-优快云博客

本文链接：https://blog.youkuaiyun.com/aiwangtingyun/article/details/126557756

一、`SpringBoot Starter` 简介

1、什么是 `SpringBoot Starter`

SpringBoot 的出现让我们能够抛弃以前复杂繁杂的配置，转而将组件各种配置统一集成进 starter 中，在使用的使用只需要在 maven 中引入 starter 依赖，SpringBoot 就能自动扫描到要加载的信息并启动相应的默认配置。

Starter 让我们摆脱了各种依赖库的处理以及需要配置各种信息的困扰。因为 SpringBoot 会自动通过 classpath 路径下的类发现需要的 Bean，对其进行自动装配并注册进 IOC 容器。

SpringBoot 提供了许多我们日常开发中在各种场景所需的 spring-boot-starter 依赖模块。所有这些依赖模块都会遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循约定大于配置的理念。

想了解更多关于 SpringBoot 的知识以及 SpringBoot 是如何进行自动装配组件的，可以参考我的另一篇博客：SpringBoot】之自动配置原理分析（源码级别）

2、什么场景下需要自定义 `Starter`

在日常的开发工作中，经常会有一些独立于业务之外的配置模块，如果我们将其放到一个特定的包下，然后另一个工程需要复用这块功能的时候，就需要将代码硬拷贝到另一个工程，重新集成一遍，这样做非常的麻烦。

但如果我们将这些可独立于业务代码之外的功配置模块封装成独立的 Starter，复用的时候只需要将其在 pom 中引用依赖即可，因为 SpringBoot 的自动装配会为我们完成模块的装配，极大地方便了我们开发。

常见场景如下：

构建通用模块：比如短信、邮件发送模块
基于 AOP 技术实现日志切面
处理分布式雪花 ID：将 Long 型转为 String 型、使用 jackson2/fastjson 解决精度问题

二、创建自定义的 `SpringBoot Starter`

1、`Starter` 命令规范

每个 Starter 都会遵循标准的命名规范，其中分为官方 Starter 的命名方法和自定义 Starter 的命名方式：

SpringBoot 官方命名方式：

格式：spring-boot-starter-{模块名}
举例：spring-boot-starter-web

自定义命名方式：

格式：{模块名}-spring-boot-starter
举例：mystarter-spring-boot-starter

2、`Starter` 创建步骤

我们先回顾一下 SpringBoot 的自动装配原理：

Spring Boot 在启动时会去 classpath 中中寻找 resources/META-INF/spring.factories 文件；
根据 spring.factories 配置加载 AutoConfigure 类；
根据 @Conditional 注解的条件，进行自动配置并将 Bean 注入 Spring Context。

这个原理相当于给了我们一个借鉴，只要我们遵循了这个规范我们就可以很简单的进行创建自定义的 Starter。

步骤如下：

1）创建 Maven 项目

创建一个空的 Maven 项目：

Starter 不需要 main 启动类，一般创建空的 Maven 项目最合适，如果有生成启动类，直接删除掉。

2）添加依赖

下面市场完整的依赖：

<?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>

    <parent>
        <groupId>org.springframework.boot</groupId