2021-03-01_SpringBoot源码学习笔记之自定义boot-starter

SpringBoot源码学习笔记之自定义boot-starter

1概述

遵循springboot官方建议,对于非官方的starter命名方式为xxx-spring-boot-starter,所以本工程名为hello-spring-boot-starter。

SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。

SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。

1.1原理

我们知道使用一个公用的starter的时候,只需要将相应的依赖添加的Maven的配置文件当中即可,免去了自己需要引用很多依赖类,并且SpringBoot会自动进行类的自动配置。那么 SpringBoot 是如何知道要实例化哪些类,并进行自动配置的呢,分如下三步骤:

  1. SpringBoot 在启动时会去依赖的starter包中寻找 resources/META-INF/spring.factories 文件,然后根据文件中配置的Jar包去扫描项目所依赖的Jar包,这类似于 Java 的 SPI 机制。

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

    com.kikop.boot.HelloServiceAutoConfiguration

  2. 根据自定义starter中的spring.factories 自动配置类加载AutoConfiguration类。

  3. 根据 @Conditional注解的条件,判断是否进行自动配置并将Bean实例化注入Spring ApplicationContext 上下文当中。

    我们也可以使用@ImportAutoConfiguration({HelloServiceAutoConfiguration.class}) 指定自动配置哪些类。

1.2自定义starter应用

2实现步骤

2.1maven依赖

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

    <!--1.基于Spring-boot 2.1.4,不能添加该parent-->
    <!--<parent>-->
        <!--<groupId>org.springframework.boot</groupId>-->
        <!--<artifactId>spring-boot-starter-parent</artifactId>-->
        <!--<version>2.1.4.RELEASE</version>-->
    <!--</parent>-->

    <groupId>com.kikop.boot</groupId>
    <artifactId>hello-spring-boot-starter</artifactId>
    <version>2.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>

        <!--1.configuration-processor-->
         <!--作用是编译时生成 spring-configuration-metadata.json ,-->
        <!--此文件主要给IDE使用。如当配置此jar相关配置属性在 application.yml ,-->
        <!--你可以用ctlr+鼠标左键点击属性名,IDE会跳转到你配置此属性的类中。-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.1.4.RELEASE</version>
            <optional>true</optional>
        </dependency>

        <!--2.spring-mytech-autoconfigure 重点是要添加这个依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.1.4.RELEASE</version>
        </dependency>

        <!--3.spring-mytech-starter-->
        <!--<dependency>-->
            <!--<groupId>org.springframework.boot</groupId>-->
            <!--<artifactId>spring-boot-starter</artifactId>-->
        <!--</dependency>-->

    </dependencies>

    <build>
        <plugins>
        <!--添加 maven-plugin,需设置skip,否则会编译失败-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.1.4.RELEASE</version>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2.2实体类映射配置信息

package com.kikop.mytech.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author kikop
 * @version 1.0
 * @project Name: hello-spring-bootstarter
 * @file Name: HelloServiceProperties
 * @desc 功能描述 实体类映射配置信息
 * 对应yml配置文件总的属性,配置此注解可以自动导入application.properties配置文件中的属性
 * 它不但能映射成String或基本类型的变量。还可以映射为List,Map等数据结构
 * @date 2020/2/20
 * @time 7:33
 * @by IDE: IntelliJ IDEA
 */
@ConfigurationProperties(prefix = HelloServiceProperties.PREFIX)
public class HelloServiceProperties {

    public static final String PREFIX = "mytech.demo";

    // 定义jar包中默认的配置属性:name
    private String name = "kikop";

    // 定义jar包中默认的配置属性:hobby

    private String hobby = "run";

    // 定义jar包中默认的配置属性:place
    private String place = "China";

    public String getPlace() {
        return place;
    }

    public void setPlace(String place) {
        this.place = place;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getHobby() {
        return hobby;
    }

    public void setHobby(String hobby) {
        this.hobby = hobby;
    }
}

2.3业务Handler类

package com.kikop.mytech.service;


/**
 * @author kikop
 * @version 1.0
 * @project Name: hello-spring-bootstarter
 * @file Name: HelloService
 * @desc 功能描述 Starter要实现的功能(已基于业务转化的包装类)
 * @date 2020/2/20
 * @time 7:36
 * @by IDE: IntelliJ IDEA
 */
public class HelloService {

    public String strName;
    public String strHobby;

    public HelloService(String strName, String strHobby) {
        this.strName = strName;
        this.strHobby = strHobby;
    }

    public String say() {
        return this.strName + "----  " + strHobby;
    }
}

2.4自动配置类

package com.kikop.mytech.config;

import com.kikop.mytech.properties.HelloServiceProperties;
import com.kikop.mytech.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author kikop
 * @version 1.0
 * @project Name: hello-spring-bootstarter
 * @file Name: HelloServiceAutoConfiguration
 * @desc 功能描述 自动配置类,有条件的进行Bean注入
 * @date 2020/2/20
 * @time 7:37
 * @by IDE: IntelliJ IDEA
 */
// 1.Configuration 表明此类是一个配置类,定义beans,被spring进行管理
@Configuration
// 2.启用属性配置,将读取 HelloServiceProperties 里面的属性
@EnableConfigurationProperties(HelloServiceProperties.class)
// 3.当类路径下面有 HelloServiceInfo类时,自动配置
@ConditionalOnClass(HelloService.class)
// 4.判断指定的属性是否具备指定的值(放类上)
//@ConditionalOnProperty(prefix = HelloServiceProperties.PREFIX, value = "enabled", matchIfMissing = true)
public class HelloServiceAutoConfiguration {

    /**
     * 注入配置
     */
    @Autowired
    private HelloServiceProperties helloServiceProperties;

    /**
     * 注入Bean(已基于业务转化的类)
     *
     * @return
     */
    @Bean
    @ConditionalOnMissingBean(HelloService.class)
    // 4.判断指定的属性是否具备指定的值(放Bean上)
    // 当配置文件中 mytech.demo.enabled=true
//    @ConditionalOnProperty(prefix = HelloServiceProperties.PREFIX, value = "enabled", matchIfMissing = true)
    public HelloService helloServiceInfo() {

        HelloService helloService = new HelloService(helloServiceProperties.getName(),
                helloServiceProperties.getHobby());
        return helloService;
    }

}

2.4spring.factories

// 文件位置:resources/META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 com.kikop.mytech.config.HelloServiceAutoConfiguration

3测试

3.1maven依赖

<dependency>
   <groupId>com.kikop.boot</groupId>
   <artifactId>hello-spring-boot-starter</artifactId>
   <version>2.0-SNAPSHOT</version>
</dependency>

3.2测试类

package com.kikop.demo;

import com.kikop.mytech.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@SpringBootApplication
public class DemoApplication {

    @Autowired
    private HelloService helloService;

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);

    }

    @RequestMapping("/say")
    public String say() {
        return helloService.say();
    }

}

3.3配置

// resources\application.properties
mytech.demo.name=kikop
mytech.demo.hobby=swim

参考

1.SpringBoot应用篇(一):自定义starter

https://www.cnblogs.com/hello-shf/p/10864977.html

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

推荐阅读更多精彩内容