SpringBoot自定义场景启动器(starter)

1.场景启动器的原理是什么?

xxx-spring-boot-starter的作用是负责导入xxx-spring-boot-starter-autoconfigure的依赖,而场景启动器真正的逻辑其实都在xxx-spring-boot-starter-autoconfigure当中。

xxx-spring-boot-starter-autoconfigure中会使用一个XXXProperties的类去绑定application.yaml或者application.properties中的某个前缀的配置,并将该组件导入到容器当中。这样后续我们想要配置文件中的内容,只需要从容器中拿到这个类就可以拿到相关的配置。

XXXAutoConfiguration配置类负责给容器中导入相应的组件,一般使用条件装配的方式进行导入,也就是如果用户自定义了相关的组件,那么我们就不导入相关的组件,而如果我们没有自定义相关的组件,那么容器中就通过配置文件的配置信息(XXXProperties),给容器中装配一个组件。

比如我们来看Spring-Data-Redis的自动装配:

image.png

2.开始自定义场景启动器

2.1 创建一个项目test,并建立两个模块

两个模块一般叫xxx-spring-boot-starterxxx-spring-boot-starter-autoconfigure

image.png

2.2 引入相关依赖

xxx-spring-boot-starter里引入xxx-spring-boot-starter-autoconfigure的依赖

    <dependencies>
        <dependency>
            <groupId>com.wanna</groupId>
            <artifactId>wanna-spring-boot-starter-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

xxx-spring-boot-starter-autoconfigure中引入spring-boot-starter的依赖

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

2.3 开始编写代码

xxx-spring-boot-starter中什么都不做...只需要写xxx-spring-boot-starter-autoconfigure的逻辑

编写一个HelloService类,简单逻辑:给输入的name参数,加上指定的前缀/后缀并进行输出的sayHello方法

public class HelloService {  //默认不要放在容器中,使用条件装配进行装配
    private HelloProperties helloProperties;

    public String sayHello(String name) {
        return helloProperties.getPrefix() + ":" + name + ">>>" + helloProperties.getSuffix() + "!";
    }

    public HelloProperties getHelloProperties() {
        return helloProperties;
    }

    public void setHelloProperties(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }
}

需要注意的是,这个组件默认不要放在容器中!需要通过配置类进行条件装配!HelloProperties的建立见下文,它的主要作用是和配置文件中指定前缀的配置进行绑定。

@ConfigurationProperties(prefix = "wanna.hello")
public class HelloProperties {
    private String prefix;
    private String suffix;

    public String getSuffix() {
        return suffix;
    }

    public void setSuffix(String suffix) {
        this.suffix = suffix;
    }

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }
}

下面就到了关键环节,编写一个自动配置类,一般叫XXXAutoConfiguration

@Configuration
@EnableConfigurationProperties(HelloProperties.class)  //开启配置注解,这个组件中的所有属性将从配置文件中获取,并把组件放到容器中
public class HelloServiceAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean({HelloService.class})  //在容器中缺少这个Bean的时候才往容器中注入,如果容器中已经有了就不用注入了
    public HelloService helloService(@Autowired HelloProperties helloProperties) {
        HelloService helloService = new HelloService();
        helloService.setHelloProperties(helloProperties);
        return helloService;
    }
}

使用@EnableConfigurationProperties注解开启属性绑定,将配置文件中指定前缀的配置文件和HelloProperties进行绑定(绑定配置文件的类一般叫XXXProperties)。并使用@ConditionalOnMissingBean注解标明,只有在缺少我们自定义的Bean的时候才将该组件导入到容器当中。

完成了代码的编写之后,我们需要完成的是,需要往容器中导入哪些自动配置类的相关配置:

image.png

在resources文件夹下建立META-INF文件夹,建立一个spring.factories配置文件
往其中添加如下内容,用来标明我们想要往容器中导入的XXXAutuConfiguration组件的全类名

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.wanna.hello.auto.HelloServiceAutoConfiguration

2.4 打包进maven本地仓库

依次完成xxx-spring-boot-starter-autoconfigurexxx-spring-boot-starter模块的打包,就放到我们maven本地仓库当中。

image.png

2.5 重新创建一个项目进行测试

引入我们刚刚打包好的xxx-spring-boot-starter的依赖(并且引入Web的场景启动器方便进行测试)

        <dependency>
            <groupId>com.wanna</groupId>
            <artifactId>wanna-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

编写application.yaml或者application.properties配置文件,配置我们自动装配包中需要提供的前缀的配置:

wanna.hello.prefix=hello
wanna.hello.suffix=666

编写测试的Controller

 @RestController
public class HelloController {

    HelloService helloService;

    @Autowired
    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    @RequestMapping("/sayHello/{name}")
    public String sayHello(@PathVariable("name") String name) {
        return helloService.sayHello(name);
    }
}

在浏览器中进行测试:

image.png

发现装配成功,既然是条件装配我们自然还得测试自己自定义给容器中导入一个 HelloService能否成功?下面编写一个Spring的配置类:

@Configuration
public class Config {

    @Bean
    public HelloService helloService() {
        HelloService helloService = new HelloService();
        HelloProperties properties = new HelloProperties();
        properties.setPrefix("666");
        properties.setSuffix("777");
        helloService.setHelloProperties(properties);
        return helloService;
    }
}

在浏览器中进行测试:

image.png

我们发现我们做到了条件装配,如果我们自己往容器中导入了相关的组件,那么自动配置类就不会导入相关的组件,而如果我们没配置,那么场景启动器会帮我们自动导入相关的组件。

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

推荐阅读更多精彩内容