springboot自动配置原理及手写starter

本文是向大家介绍springboot的精髓部分-自动装配,掌握自动装配能让你更深的去理解boot框架,学会启动器(starter)的开发,能让你的开发更加便捷、得心应手、效率加倍。

1.自动配置原理

在springboot的启动类上我们可以看到有 @SpringBootApplication注解

点击去看我们发现

这是一个组合注解

@SpringBootApplication中有3个主要注解

1.@SpringBootConfiguration

2.@ComponentScan

3.@EnableAutoConfiguration

我们依次讲解:

首先讲解一下

@SpringBootConfiguration

这个注解 这个其实和 @Configuration 的注解一样用于定义bean的,springboot的启动类其实也就是作为spring的一个bean注入到spring容器中

@ComponentScan

是spring中的注解 主要就是定义扫描的路径从中找出标识了需要装配的类自动装配到spring的bean容器中

接下里就是 @EnableAutoConfiguration

这个注解 这个是开启自动装配的核心注解,他的作用就是获取配置类 扫描并注入IOC容器中进行管理,他也是组合注解 我们点进去看又能看到

@AutoConfigurationPackage@Import 这2个注解

@AutoConfigurationPackage

添加该注解的类所在的package 作为 自动配置 package 进行管理,个人的理解吧  我觉得这个注解的含义就是扫描 springboot 所在包 将其配置类交给IOC管理

@Import({AutoConfigurationImportSelector.class})

这个导入AutoConfigurationImportSelector.class这个类,将其注入spring容器 而这个导入的类的作用可以帮助将所有符合条件的@Configuration配置交给spring的IOC容器进行注入

进入 AutoConfigurationImportSelector 类里面有 selectImports 方法,该方法中调用了 getAutoConfigurationEntry 进入这个方法

该方法中调用了 getCandidateConfigurations 这个将获取  META-INF/spring.factories 中配置文件中的需要自动装配的类名,配置文件如下图

这些类基本都是被@Configuration注解的

简而言之,就是Spring Boot在启动的时候就是从类路径下的META-INF/spring.factories中获取需要自动装配的类 (一些配置组件),找到这些类(XXXAutoConfiguration),通过SpringFactoriesLoader机制创建对应的bean,注入到容器中,完成了自动注入spring容器,本来需要在spring的xml配置文件中去配置bean的操作就免去了 ,也就是springboot完成了自动装配

2.手写starter

知道了上面的配置原理我们可以仿照上面自己写一个starter

写一个jedis的starter

我们创建一个工程 my_starter

pom中引入依赖

<dependencies>

    <dependency>

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

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

    </dependency>

    <dependency>

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

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

        <scope>test</scope>

    </dependency>

    <!--jedis依赖-->

    <dependency>

        <groupId>redis.clients</groupId>

        <artifactId>jedis</artifactId>

        <version>3.3.0</version>

    </dependency>

    <dependency>

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

        <artifactId>spring-boot-configuration-processor</artifactId>

        <optional>true</optional>

    </dependency>

    <dependency>

        <groupId>org.projectlombok</groupId>

        <artifactId>lombok</artifactId>

        <optional>true</optional>

    </dependency>

</dependencies>

resources/META-INF 下面新建一个 spring.factories

spring.factories 配置写上

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.chris.autoconfiguration.jedis.JedisAutoConfiguration

写上我们的配置类

package com.chris.autoconfiguration.jedis;

import lombok.Data;

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

@ConfigurationProperties(prefix = "jedis.config")

@Data

public class JedisProperties {

    private String host = "127.0.0.1";

    private int  port = 6379;

    private String password;

    private int maxTotal = 8;

    private int maxIdle = 8;

    private int minIdle = 0;

    private int timeout = 1000;

}

写一个我们的功能类

package com.chris.autoconfiguration.jedis;

import redis.clients.jedis.Jedis;

import redis.clients.jedis.JedisPool;

import java.util.Objects;

import java.util.function.Consumer;

public class JedisCore {

    private JedisPool jedisPool;

    public JedisCore(JedisPool jedisPool) {

        this.jedisPool = jedisPool;

    }

    public void executeJedis(Consumer<Jedis> consumer){

        if (Objects.isNull(jedisPool)) {

            throw new RuntimeException("jedisPool为空");

        }

        try (Jedis jedis = jedisPool.getResource()) {

            consumer.accept(jedis);

        }catch (Exception e) {

            throw new RuntimeException("jedis错误");

        }

    }

}

将功能类自动装配进ioc

package com.chris.autoconfiguration.jedis;

import org.springframework.beans.factory.annotation.Autowired;

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;

import redis.clients.jedis.JedisPool;

import redis.clients.jedis.JedisPoolConfig;

@Configuration

@EnableConfigurationProperties(JedisProperties.class)

@ConditionalOnProperty(prefix = "jedis", name = "enable", havingValue = "true") // 取jedis.enable的配置和 havingValue 后的值对比 相同的话则生效启用

public class JedisAutoConfiguration {

    @Autowired

    private JedisProperties properties;

    @Bean

    @ConditionalOnMissingBean(JedisPool.class)

    public JedisPool jedisPool() {

        JedisPoolConfig config = new JedisPoolConfig();

        config.setMinIdle(properties.getMinIdle());

        config.setMaxIdle(properties.getMaxIdle());

        config.setMaxTotal(properties.getMaxTotal());

        JedisPool pool = new JedisPool(config,

                properties.getHost(),

                properties.getPort(),

                properties.getTimeout(),

                properties.getPassword());

        return pool;

    }

    @Bean

    @ConditionalOnMissingBean(JedisCore.class)

    public JedisCore jedisCore(JedisPool jedisPool) {

        JedisCore jedisCore = new JedisCore(jedisPool);

        return jedisCore;

    }

}

ok 以上我们就写完了一个jedis的starter

3.使用自定义的starter

新建一个springboot工程

pom中引入 我们自己的starter

<dependency>

    <groupId>com.chris</groupId>

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

    <version>0.0.1-SNAPSHOT</version>

</dependency>

配置文件如下:

4.运行测试

浏览器访问 http://localhost:1234/test/jedis

然后在redis工具中访问redis

可以看到 结果success

代码地址 https://gitee.com/chrishaha/my_starter.git

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

推荐阅读更多精彩内容