SpringBoot Starter 分析及编写自己的Starter

最新推荐文章于 2023-02-14 11:26:08 发布
最新推荐文章于 2023-02-14 11:26:08 发布
阅读量253 收藏 1
点赞数 1
分类专栏： Java 文章标签： spring boot spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wu1308156206/article/details/126047520
版权

SpringBoot Starter 分析

一、SpringBoot Starter作用

在不使用springboot开发项目的时候，或者说springboot还没有出来的时候。我们要在项目中引用某一个功能，比如redis。

  1. 首先你得去下载一个redis连接的jar包,如jedis，选择好版本。
  2. 接着你还要去下载一个和上面jedis版本对应的spring-data-redis。版本得对应上，不然会出现很多奇怪的错误。
  3. 在spring的applicationContext.xml文件中配置redis相关的信息。

在一个完整的项目中，还会引入很多其他的jar包，要和spring进行整合。每一种jar包都要把上面的步骤重复一般，是很繁琐的。
springboot的中的starter机制就是为了解决上述问题的。

二、认识starter

我们先来看看starter长什么样

  1. spring官方的starter
    在这里插入图片描述
    spring官方的starter的命名是spring-boot-starter-xxx，注意看上面截图中jar包里面没有代码，也没有pom.xml文件。那这些jar用来干啥呢。
    了解过springboot自动配置原理应该知道，它的自动配置功能全部是放在spring-boot-autoconfigure这个jar包中的。这可能也是它的约定优于配置原则的体现。
    所以使用官方starter的流程是依赖spring-boot-starter-parent 这个包,spring-boot-starter-parent又依赖spring-boot-dependencies，然后spring-boot-dependencies这个包里面包含了spring-boot-autoconfigure。
  2. 第三方的starter
    再看看我们经常使用的mybatis的starter
    在这里插入图片描述
    里面也没有代码，但是有一个pom.xml文件,看看里面的依赖
    在这里插入图片描述里面有一个mybatis-spring-boot-autoconfigure的包。看看这个包里面的内容
    在这里插入图片描述
    这个包里面有代码，mybatis-spring-boot-starter的功能就是在这里面实现的。我们来分析下这里面的文件
    • pom.properties 配置maven所需的项目version、groupId和artifactId
    • pom.xml 配置所依赖的jar包
    • additional-spring-configuration-metadata.json 手动添加IDE提示功能
    • MANIFEST.MF 这个文件描述了该Jar文件的很多信息
    • spring.factories 自动配置要读取的文件
    • spring-autoconfigure-metadata.properties pom文件中引入spring-boot-autoconfigure-processor这个jar包后自动生成的文件
    • spring-configuration-metadata.json 在pom文件中引入了spring-boot-configuration-processor这个jar包后自动生成的IDE提示功能文件,和上面的additional-spring-configuration-metadata.json作用一样，最终会合并为一个。在yml配置文件中有提示功能。
    • ConfigurationCustomizer 自定义Configuration回调接口
    • MybatisAutoConfiguration 配置类
    • MybatisProperties 属性类
    • SpringBootVFS 扫描嵌套的jar包中的类

重点看看MybatisProperties、MybatisAutoConfiguration、spring.factories这三个文件

  • MybatisProperties属性类
    在这里插入图片描述
    mybatis提供出来的配置全部定义在这里。
@ConfigurationProperties(prefix = MybatisProperties.MYBATIS_PREFIX)
public class MybatisProperties {

  public static final String MYBATIS_PREFIX = "mybatis";

从上面这几行代码可以看出，mybatis的配置是以 mybatis开始的，大概向下面这样
在这里插入图片描述

  • MybatisAutoConfiguration 配置类
    在这里插入图片描述
    在这里插入图片描述

上面截图只截了一部分,类上面的注解决定这个配置类是否生效。最重要的是这个配置类中生成了我们经常使用的SqlSessionFactory这个Bean。

  • spring.factories
    在这里插入图片描述
    这个starter的jar包被引入到SpringBoot项目中，项目启动时，会来读取这个文件，完成自动装配和属性的自动配置。
    我们总结一下上面介绍的mybatis-spring-boot-starter这个starter的内容。
  • 以第三方的starter包的命名规则创建一个mybatis-spring-boot-starter的空项目，里面只有pom.xml和pom.properties文件。
  • pom.xml文件中包含mybatis-spring-boot-autoconfigure项目
  • mybatis-spring-boot-autoconfigure 项目中包含MybatisAutoConfiguration配置类，这个配置类中定义了一些给外部使用的Bean,并且该配置类根据一些条件注解来判断是否生效。该项目中还有一个MybatisProperties属性类，给使用者提供自定义的配置。
  • 在META-INF文件夹中编写spring.factories文件，key为org.springframework.boot.autoconfigure.EnableAutoConfiguration，value为org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
  1. 另外一种形式的第三方Starter
    再来看一下alibaba的数据源Druid的Starter
    在这里插入图片描述
    这个Starter里面包含了实现代码，没有autoconfigure项目。两种形式的第三方Starter功能都是能实现的。

三、编写自己的Starter

我们参照mybatis-spring-boot-starter的实现步骤编写一个Starter。该Starter封装了多个消息发送渠道，业务模块只需引入该starter并配置好使用的渠道就可实现消息发送功能。

首先创建一个工程，包含三个子模块 example-spring-boot-starter、example-spring-boot-autoconfigure、example-spring-boot-test，目录结构如下:
在这里插入图片描述

example-spring-boot-autoconfigure

先来看看 example-spring-boot-autoconfigure ，这是功能实现的模块
ExampleProperties类

@ConfigurationProperties(prefix = ExampleProperties.EXAMPLE_PREFIX)
public class ExampleProperties {
    public static final String EXAMPLE_PREFIX = "example";

    private Integer type;

    public Integer getType() {
        return type;
    }

    public void setType(Integer type) {
        this.type = type;
    }
}

这个类提供了使用者可配置的属性。我们这里就一个简单的type，及消息发送渠道类型。

ExampleMessageSendService类

public class ExampleMessageSendService {

    private static Map<Integer,String> messageMap = new HashMap<>();

    static {
        messageMap.put(1,"短信消息");
        messageMap.put(2,"微信公众号消息");
        messageMap.put(3,"邮件消息");
    }

    private Integer type;

    public ExampleMessageSendService(Integer type){
        this.type = type;
    }

    public void sendMsg(){
        if(!messageMap.containsKey(type)){
            System.out.println("当前消息渠道未实现");
            return;
        }
        System.out.println("发送" + messageMap.get(type) + "成功");
    }
}

这个类是具体的功能逻辑实现类，根据使用者的配置信息选择消息渠道发送消息。注意，这个类只是一个普通的类，没有使用@Service等注解。是在配置类中被加载为Bean的。

ExampleAutoConfigure类

@ConditionalOnClass(ExampleProperties.class)
@EnableConfigurationProperties(ExampleProperties.class)
@Configuration
public class ExampleAutoConfigure {

    @Autowired
    private ExampleProperties properties;

    @Bean
    public ExampleMessageSendService exampleMessageSendService(){
        return new ExampleMessageSendService(properties.getType());
    }
}

这个类是配置类，自动配置功能会扫描到它。它的主要功能就是生成功能实现类的Bean，并将该Bean和属性配置类联系起来。

spring.factories 文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.autoconfigure.ExampleAutoConfigure

这个文件指定 ExampleAutoConfigure 类是需要被扫描的配置类。

pom.xml

<?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">
    <parent>
        <artifactId>example</artifactId>
        <groupId>springboot-starter-example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>example-spring-boot-autoconfigure</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
    </dependencies>
</project>

example-spring-boot-starter

example-spring-boot-starter模块中没有功能实现，只在pom文件中引入了example-spring-boot-autoconfigure模块

<?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">
    <parent>
        <artifactId>example</artifactId>
        <groupId>springboot-starter-example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>example-spring-boot-starter</artifactId>

    <dependencies>
        <dependency>
            <groupId>springboot-starter-example</groupId>
            <artifactId>example-spring-boot-autoconfigure</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

example-spring-boot-test

测试模块。
先在pom.xml文件中引入starter:

<?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">
    <parent>
        <artifactId>example</artifactId>
        <groupId>springboot-starter-example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>example-spring-boot-test</artifactId>

    <dependencies>
        <dependency>
            <groupId>springboot-starter-example</groupId>
            <artifactId>example-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

Application.yml配置

example:
  type: 1

Application启动类：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

TestRuuner类,在项目启动后验证功能

@Component
public class TestRuuner implements ApplicationRunner {

    @Autowired
    private ExampleMessageSendService exampleMessageSendService;

    public void run(ApplicationArguments args) throws Exception {
        exampleMessageSendService.sendMsg();
    }
}

以上，就是SpringBoot Starter的分析以及自己编写Starter的实现。

wu1308156206
关注
专栏目录
【Springboot】| 从深入自动配置原理到实现 自定义Springboot starter
狮子也疯狂的博客
08-27 3460
是SpringBoot的一个重要概念，是“一站式服务 (one-stop)”的依赖 Jar 包包含 Spring 以及相关技术(比如 Redis)的所有依赖提供了自动配置的功能，开箱即用提供了良好的依赖管理，避免了包遗漏、版本冲突等问题。简单来说， Springboot starter 提供了一种自动配置的机制，我们只需要将需要的Starter引入项目中，它就会自动为我们配置相关的依赖和配置。这使得开发人员可以更加关注业务逻辑的实现；现在我们来学习一下它的原理，以便后面能更清晰地实现。这个技能对你有用么。
教你如何开发一个 SpringBoot starter
ywl470812087的博客
12-25 1288
starter 是 SpringBoot 的一个重要的组成部分，它相当于一个集成的模块，比如你想用 Mybatis 和 lombok，但是在 pom 文件中需要写两个依赖，如果你将他们集成为一个 starter（或者将更多你需要的依赖集成进去），那么你只需要在 pom 文件中写一个 starter 依赖就可以了，这对于一个可复用模块的开发和维护都极为有利。当然我当时确实水平不足，连 Java 的 SPI 都忘了是啥，后来又捡了起来，原来我在大学的时候就用过 Java 的 SPI，悔之晚矣！
一个简单的springboot starter例子
dang7758的博客
01-30 422
文档的意义在于以后方便自己回忆 可执行例子点我  官方文档点我 springboot starter 的作用感觉就是定义一些公用对象或者是常用设置，导入对应的starter后，你就可以使用它们仿佛就是自己定义的一样。 app 启动的，没啥用，启动后，可以http://localhost:8080/theclass 点击使用 resource是模拟第三方资源的，没啥用 autoconf...
手把手带你编写属于自己的 Starter
Q54665642ljf的博客
08-12 292
编写 starter 之前我们先了解一下什么是 starter，一个 starter 其实就是对一个功能的集成封装，然后对外提供一个依赖，让业务去使用，像我们熟悉的 Redis，mongo，mybatis 等。在一些大公司特别是一些中间件或者中台团队，很多时候都是提供各种工具的 starter 来给业务团队使用的，毕竟很多重复的功能如果每个业务团队都自己开发的话，完全是浪费资源，通过中台团队统一封装 starter，让各个业务团队拿来就用快速搭建业务即可。第一步在 pom 文件中增加依赖。...
SpringBoot自定义Starter
yuhui666666的博客
09-15 455
52 log.info("\n描述：{}\n路径: {}\n方法: {}\n参数：{}\n耗时：{}", methodDesc, requestUri, methodName, parameters, expendTime);实际的做法的1,2都合并为starter 所以会出现一旦引入starter就需要，属性中配置，不配置会出现为空的情况。2,自动依赖项目，依赖自动装配项目，集成一个小功能的所有依赖（会使用到自动装配）---例如切面记录日志。
spring starter原理和实例
守正出奇
01-06 8456
spring starter原理和实例背景spring starter实现原理自定义starter 背景 springboot的一个优势就是starter，利用starter，可以避免一些的繁琐的配置，将starter里面的功能开箱即用。例如：spring-boot-starter-jpa等，只需要配置一下数据连接信息，就可以进行数据库操作。当然starter技术也没有想象的高大上，最终也是一行行代码实现的，目前就让我们一起看一下接下面纱的starter。 spring starter实现原理 在META-
官方spring-boot-starter和自定义starter异同分析
最新发布
weixin_39527642的博客
02-14 343
对照谈-官方spring-boot-starter和自定义starter异同分析
SpringBoot Starter模板
11-26
8. **测试支持**：Spring Boot也提供了丰富的测试支持，`@SpringBootTest`、`@WebMvcTest`等注解可以帮助我们编写单元测试和集成测试。 通过SpringBoot Starter模板，开发者可以快速构建起一个功能完备的Spring ...
springboot starter实现包
12-31
通过分析这个例子，我们可以更深入地理解SpringBoot Starter的工作原理和用法。 总结来说，SpringBoot Starter是SpringBoot简化项目配置的关键，它将一系列相关的依赖和服务打包在一起，使得开发者能够快速地构建和...
springboot手写一个自己的starter
08-25
SpringBoot 手写一个自己的 Starter SpringBoot 的强大之处就在于其自动配置机制，而这个机制的实现正是依赖于那些starter。starter 是 SpringBoot 的核心组件之一，它提供了一种非常便捷的方式来配置和实现自动...
spring-boot-starter-parent看不到里面的源码问题
weixin_45641100的博客
01-08 557
ctrl+左键/ctrl+B打不开spring-boot-starter-parent的源码，需要下载Documentation。
spring-boot-starters里为什么没有代码
梦倚栏杆的博客
07-03 1659
官方文档：https://docs.spring.io/spring-boot/docs/2.1.3.RELEASE/reference/htmlsingle/#boot-features-custom-starter 官方推荐： 一个starter应该包含两部分：autoconfigure, starter; starter中包含相关的依赖， autoconfigure是自动配置的代码； 当然也可以两个都放在一个模块，starter里 所以我们看springboot里发现start
超简单 定义一个自己的starter
不会骑摩托的程序员不是好的摄影师
10-13 2855
从mybatis提供的自定义的starter结构可以看出，starter就是一个普通的maven项目，引入了需要配置的模块后，帮用户写好接入Spring需要的配置操作，再进行一次封装。用户就可以省去配置的过程，做到引入就自动配置。这一点也符合Spring在官网上，对SpringBoot的介绍_ Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "ju
如何使用SpringBoot写一个属于自己的Starter
Java鱼仔的博客
03-09 5078
写一个starter原来并不难
RedisTemplate 切换 Jedis 实现 以及 Jedis 常用 API
蚩尤后裔-汪茂雄
11-28 4092
目录 RedisTemplate 切换 Jedis 实现 使用底层 Jedis API 操作 Redis RedisTemplate 切换 Jedis 实现 1、Spring Boot 为 Lettuce 和 Jedis 客户端库提供基本的自动配置，默认情况下，使用 Lettuce 作为客户端，如果想要切换 Jedis 客户端，则分为如下两步： 一：切换依赖：排除掉 spring-boot-starter-data-redis 中默认的 lettuce 依赖，然后引入 jedis 依赖。
Spring Boot 中使用 MyBatis-Spring-Boot-Starter
热门推荐
ljinest
01-04 1万+
Spring Boot 中使用 MyBatis-Spring-Boot-Starter 本文将使用 MyBatis-Spring-Boot-Starter 在Spring Boot中建立 Mybatis 应用。 本文将实现： 构建一个独立应用 将JDBC模板代码减少到最小值（接近0） 更少的XML配置 版本要求 MyBatis-Spring-Boot-Starter MyBatis-Spring Spring Boot Java 2.2 2.0(2.0.6以上解锁所有功能) 2.5或以上
史上最全的Spring-Boot-Starter开发手册
weixin_33811961的博客
04-14 1801
1.文章前言 我们都知道可以使用SpringBoot快速的开发基于Spring框架的项目。由于围绕SpringBoot存在很多开箱即用的Starter依赖，使得我们在开发业务代码时能够非常方便的、不需要过多关注框架的配置，而只需要关注业务即可。 例如我想要在 SpringBoot 项目中集成 Redis，那么我只需要加入 spring-data-redis-starter 的依赖，...
如何实现自己的spring boot starter（二）
蓝天之枫
10-14 325
我们在SpringBoot中使用redis的时候，直接引用 spring-boot-starter-data-redis 的pom，然后配置 spring.redis.host = localhost spring.redis.port = 6379 spring.redis.password = 123456 就可以使用在我们的业务系统里注入redisTemplate来操作redis了，但是他是怎么工作的呢？ 让我们走进SpringBoot的源码，看几张截图： 在 spring-boot-a
SpringBoot下打包后里面没有jar包的问题
龙企阁
11-12 1万+
原文：https://blog.csdn.net/qq_39796023/article/details/81261281  第一种：如果你的POM是继承spring-boot-starter-parent的话，只需要下面的指定就行   &lt;parent&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&g...
自定义SpringBoot Starter教程
"本文将介绍如何在SpringBoot中封装自己的Starter，以便于在不同的项目中复用，降低项目的配置复杂度。我们将以一个短信业务的实现为例，讲解创建自定义Starter的步骤和注意事项。" SpringBoot封装自己的Starter是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值