为你的组件开发Spring Boot Starter

如果你开发了一个组件/模块,提供给其他项目使用,那你还需要附带一份配置说明: 依赖哪些jar、设置哪些配置参数、如何初始化入口类、以及ComponentScan和MapperScan需要加入哪些路径... 无疑增加了上手门槛。如何能让组件/模块自身完成自动配置呢?开发对应的Spring Boot Starter。

开发Starter的步骤

1. 新建一个Maven项目

  • 指定你的starter相关的groupId,artifactId,version等
  • 指定pom的parent为spring-boot-starter-parent
  • 添加你的starter依赖的jar

pom主体内容示例如下:

    <!-- 指定pom的parent为spring-boot-starter-parent -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/>
    </parent>

    <!-- 指定你的starter相关的groupId,artifactId,version -->
    <groupId>com.diboot</groupId>
    <artifactId>diboot-core-boot-starter</artifactId><!-- artifactId中你的标识前置,如xx-spring-boot-starter,以免跟Spring官方starter冲突 -->
    <version>2.0.1</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- 添加你的starter依赖的jar -->
        <dependency>
            <groupId>com.diboot</groupId>
            <artifactId>diboot-core</artifactId>
            <version>2.0.1</version>
        </dependency>

    </dependencies>

2. 开发自己的配置类

就像你在项目中使用组件/模块的配置一样,你需要的相关配置部分可以配置在你的starter中。

@Configuration
public class CustomAutoConfiguration{
    //...
}

比如我需要配置@ComponentScan和@MapperScan扫描我的组件中的package,那自动配置类就类似如下样例:

@Configuration
//@ConditionalOnWebApplication //可以指定环境条件
@ComponentScan(basePackages={"com.diboot.core"}) //你的组件/模块需要扫描的Component包
@MapperScan(basePackages = {"com.diboot.core.mapper"}) //你的组件/模块需要扫描的Mapper包
public class CustomAutoConfiguration{

}

然后我可以初始化某个Bean,如

...
public class CustomAutoConfiguration{

    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
       ... //初始化MyService类
    }
}

在自动装配中初始化的Bean,一般情况下需要依赖特定的条件(比如配置参数),这就需要我们创建ConfigurationProperties类。(如果不需要配置参数可直接跳过步骤3)

3. 创建ConfigurationProperties类

示例:

@ConfigurationProperties(prefix = "diboot.core") //配置参数前缀
public class MyModuleProperties {
    // 对应配置参数项为: diboot.core.xx-enabled
    private boolean xxEnabled = true;
    // getter, setter ...
}

配置类中使用:

...
@EnableConfigurationProperties(MyModuleProperties.class) //启用配置
public class CustomAutoConfiguration{
    // 注入配置
    @Resource
    private MyModuleProperties properties;

    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
       boolean enabled = properties.isXxEnabled();
       ... //初始化MyService类
    }
}

4. 创建 spring.factories 配置文件

配置文件放置于resources/META-INF/下,将EnableAutoConfiguration指向你的自动配置类,示例如下:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xx.starter.CustomAutoConfiguration

5. 执行Maven install,将starter安装至本地库

6. 新建一个Maven项目,pom里加入你的starter依赖,

如:

<dependency>
    <groupId>com.diboot</groupId>
    <artifactId>diboot-core-boot-starter</artifactId>
    <version>2.0.1</version>
</dependency>

启动项目,验证你的组件中初始化是否正常。


diboot 简单高效的轻代码开发框架 (求star)

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

推荐阅读更多精彩内容