Spring Boot Starter原理及实现

Spring Boot Starter是在SpringBoot组件中被提出来的一种概念。传统的 Spring 项目想要运行,需要导入各种依赖和配置,十分繁琐。而Spring Boot 能简化配置、开箱即用、快速集成,主要归功于SpringBoot 的 starter 机制。通过starter,我们能够快速的引入一个功能组件。本文将对 stater 进行介绍。

1 starter概述

starter会把所有用到的依赖都给包含进来,避免了开发者自己去引入依赖所带来的麻烦。
starter中使用ConfigurationProperties来保存配置,这些配置都可以有默认值,帮助用户减少了无谓的配置操作。同时starter一般会预留自定配置选项,只需要在application.properties中设置相关参数,就可以实现配置的个性话。

这里简单介绍下starter实现自动化配置的流程。
引入starter依赖后,spring-boot启动的时候会找到starter jar包中的resources/META-INF/spring.factories文件,根据spring.factories文件中的配置,找到需要自动配置的类

2 Starter创建和使用步骤

2.1 starter创建

  • 创建一个starter项目

  • 创建一个ConfigurationProperties,用于保存配置信息

  • 创建一个AutoConfiguration(Configuration)
    AutoConfiguration中实现所有starter应该完成的操作;
    AutoConfiguration 并且把这个类加入spring.factories配置文件中进行声明

  • 配置spring.factories
    把AutoConfiguration类加入spring.factories配置文件中进行声明。通过该配置,才能SpringBoot来自动加载AutoConfiguration类。

  • 打包项目

2.2 starter使用

在项目里使用starter非常简单:

  • 引入starter依赖
  • 添加配置(如果需要的话)
  • 注入需要的service

3 实现一个Spring Boot Starter项目

3.1 创建Starter项目

SpringBoot系列定义jar包的名称是:
spring-boot-starter-xxx.jar
而自己的项目定义的jar通常是:
xxx-spring-boot-starter.jar

这里我们创建一个husky-spring-boot-starter项目,pom主要如下

  <groupId>com.dc.husky</groupId>
    <artifactId>husky-spring-boot-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>

3.2 创建ConfigurationProperties

ConfigurationProperties用于保存配置信息:

@ConfigurationProperties(prefix = "husky")
@Getter
@Setter
public class HuskyProperties {
    private String character;
}

3.3 创建AutoConfiguration

@Configuration
@EnableConfigurationProperties(HuskyProperties.class)
public class HuskyAutoConfiguration {
    @Bean
    public Husky husky(HuskyProperties properties){
        Husky husky = new Husky(properties.getCharacter());
        return husky;
    }
}

HuskyAutoConfiguration 主要的业务功能定义Husky如下

public class Husky {
    private  String character;
    private String name = "husky";

    public Husky(String character) {
        this.character = character;
    }

    public void tellSecret(){
        if ("lovely".equals(character)){
            System.out.println("Congratulation! You have a lovely husky.");
        } else {
            System.out.println("What a pity! You have a naughty husky.");
        }
    }
}

3.4 配置spring.factories

在resources/META-INF/下创建spring.factories文件,并添加下列配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.dc.husky.starter.HuskyAutoConfiguration

3.4 打包项目,生成jar包

image.png

3.5 使用spring-boot-starter

maven引入husky-spring-boot-starter的jar包

       <dependency>
            <groupId>com.dc.husky</groupId>
            <artifactId>husky-spring-boot-starter</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

在 resources/application.properties文件添加自定义的配置

husky.character=lovely

测试输出

@SpringBootTest
@Slf4j
class ApplicationTests {   
    @Autowired
    private Husky husky;
    @Test
    void test() {
        husky.tellSecret();
    }
}

输出结果如下

2022-10-15 19:21:57.115  INFO 90145 --- [main] c.d.a.s.ApplicationTests    : Started ApplicationTests in 4.353 seconds (JVM running for 7.676)
Congratulation! Your have a lovely husky.

4 原理

我们引入starter的依赖,会将自动配置的类的jar引入。主要的逻辑如下:

  • 在SpringBoot的启动类会加上@SpringBootApplication注解。这个注解默认会引入@EnableAutoConfiguration注解。

  • @EnableAutoConfiguration注解使用@Import引入了AutoConfigurationImportSelector类。

  • AutoConfigurationImportSelector的selectImports方法最终会通过SpringFactoriesLoader.loadFactoryNames加载META-INF/spring.factories文件。

  • spring.factories包含了所有需要装配的XXXConfiguration类的全限定名。其中就有我们自己定义的HuskyAutoConfiguration。这些configuration类定义的bean根据配置信息进行初始化,并加入到spring到容器中。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容