Bootstrap

如何写一个springboot-starter

使用场景

在目前广泛的微服务治理环境下,我们所开发的代码模块,越来越关注于某一项功能而不是宽泛的整个系统的功能。

所以在我们进行服务拆分的时候,经常会遇到这么一个问题,某些会被不同的模块重复使用,为了避免代码重复,我们往往会把这些功能性的代码单独提取出来封装成一个组件供给各个模块使用。

springboot-starter相比于普通的组件来说,多了一个自动加载bean的功能,我们只需要注意两点,便能自己写一个starter出来

demo

starterdemo代码结构
在这里插入图片描述
这里我封装了一个简单的demo,叫做common,里面定义了一些订单相关的接口,从controller到service到mapper。
我们只需要做两点操作,这个模块便可以被其他项目所引用

1、修改打包方式

一般starter都是没有主函数的,所以我们的打包方式要改成release方式
修改pom文件:

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-release-plugin</artifactId>
                <version>2.5.3</version>
            </plugin>
        </plugins>
    </build>

2、定义starter里的bean

一般来说,starter里面会定义各种bean,当主项目引用starter的时候,需要知道程序启动的时候需要加载哪些bean,怎么做呢
首先我们定义一个配置文件:

@Configuration
@ComponentScan(basePackages = {"com.sharding.common"})
@MapperScan(basePackages = "com.sharding.common.mapper")
public class CommonConfiguration {
}

在这个配置文件上面标注好,需要加载哪些bean

然后添加spring.factories 文件,这个文件是干嘛用的就不用多说了吧,相信大家背八股文时里面有一个问springboot-starter的工作原理的问题,都应该见过吧

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.sharding.common.config.CommonConfiguration

指向我们的配置类即可。

到此,一个简单的springboot-starter就开发完成了

;