陆陆续续,零零散散,栈长已经写了几十篇 Spring Boot 系列文章了,其中有介绍到 Spring Boot Starters 启动器,使用的、介绍的都是第三方的 Starters ,那如何开发一个自己的 Spring Boot Starter 呢?

下面带大家开发一个年轻人的第一个 Spring Boot Starter!

不知道 Starters 为何物的请进这个传送门===>

Spring Boot Starters 启动器,看完有了学习基础,我们再继续下面的自定义 Starter 实战!

一、自定义 Starter 必备组件

一个完整的 Spring Boot Starter 需要包含以下组件:

  • 包含自动配置代码的自动配置模块;参考:Spring Boot自动配置原理、实战
  • Starter模块提供对自动模块的依赖关系,和相关依赖库,以及任何需要用到的依赖。简而言之,就是,添加一个 Starter 就应该提供使用该 Starter 所需的一切;

二、创建一个自定义Starter

怎么创建 Spring Boot 项目就不说了,之前也分享过,参考:年轻人的第一个 Spring Boot 应用!

这个自定义 Starter 就实现一个根据属性的值是否配置Bean。

1、创建自动配置类

package cn.javastack.springboot.starter.config;

import cn.javastack.springboot.starter.service.TestService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; @Configuration
@ConditionalOnProperty(prefix = "javastack.starter", name = "enabled", havingValue = "true")
public class TestServiceAutoConfiguration { @Bean
public TestService testService() {
return new TestService();
} }

这个自动配置类很简单,就是根据是否有 javastack.starter.enabled=true 这个参数的值再配置一个Bean。

TestService示例如下:

package cn.javastack.springboot.starter.service;

public class TestService {

    public String getServiceName() {
return "Java技术栈";
} }

这个类就有一个方法 getServiceName,它就返回一个字符串:Java技术栈

2、允许自动配置

创建 META-INF/spring.factories 文件,添加这个允许自动配置的类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.javastack.springboot.starter.config.TestServiceAutoConfiguration

三、测试这个自定义Starter

上面的自定义 Starter 项目建好后,可以来测试一下它是否生效了。

一般是把它打成 jar 包上传到 Maven 仓库,供其他同事调用,这里我们本报打完包之后再引用它。

1、添加依赖

新建一个 Spring Boot 测试项目,添加这个自定义 Starter 依赖,Maven 依赖如下:

<dependencies>
<dependency>
<groupId>cn.javastack</groupId>
<artifactId>javastack-spring-boot-starter</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
</dependencies>

2、添加测试方法

package cn.javastack.springboot.starter.sample;

import cn.javastack.springboot.starter.service.TestService;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean; /**
* 微信公众号:Java技术栈
*/
@SpringBootApplication
public class Application { public static void main(String[] args) {
SpringApplication.run(Application.class);
} @Bean
public CommandLineRunner commandLineRunner(TestService testService) {
return (args) -> {
System.out.println(testService.getServiceName());
};
} }

这个方法的作用是,项目启动后,调用 TestService 的实例方法,输出方法的值。

关于 CommandLineRunner 有不懂的可以看这篇文章:Spring Boot Runner 启动器

3、开启配置

我们知道这个自定义 Starter 中需要有 javastack.starter.enabled=true 这个参数的值的,所以我们在 application.yml 配置文件中添加这个配置:

javastack:
starter:
enabled: true

4、运行测试

运行 Application 类的 main 方法,最后会输出结果:Java技术栈。

当我们把配置改为:

javastack:
starter:
enabled: false

此时,运行报错,因为没有这个实例啊,自动配置类只有为 true 时才会配置。

四、总结

本章栈长简单演示了如何自定义一个 Spring Boot Starter,根据某个参数的值来决定是否自动配置,其实还可以根据是否有某个类、某个Bean……等,可以看下《Spring Boot 最核心的 25 个注解》这篇文章对应的 ConditionOnXXX 系列注解。

其实了解了 Spring Boot 自动配置的原理,自定义一个 Starter 并不难,你可以在这个实例基础上灵活扩展。

本文完整的代码实例 Github 地址:

https://github.com/javastacks/spring-boot-best-practice

赶紧关注加星吧,已经更新一大堆教程了,后续这个教程会持续更新……

年轻人的第一个自定义 Spring Boot Starter!的更多相关文章

  1. 最详细的自定义Spring Boot Starter开发教程

    1. 前言 随着Spring的日渐臃肿,为了简化配置.开箱即用.快速集成,Spring Boot 横空出世. 目前已经成为 Java 目前最火热的框架了.平常我们用Spring Boot开发web应用 ...

  2. 自定义spring boot starter 初尝试

    自定义简单spring boot starter 步骤 从几篇博客中了解了如何自定义starter,大概分为以下几个步骤: 1 引入相关依赖: 2 生成属性配置类: 3 生成核心服务类: 4 生成自动 ...

  3. Spring Boot(3)---自定义spring boot starter 问题

    1. "Failed to process import candidates for configuration class [com.simple.....]": 主要原因: ...

  4. Sping Boot入门到实战之实战篇(一):实现自定义Spring Boot Starter——阿里云消息队列服务Starter

    在 Sping Boot入门到实战之入门篇(四):Spring Boot自动化配置 这篇中,我们知道Spring Boot自动化配置的实现,主要由如下几部分完成: @EnableAutoConfigu ...

  5. 自定义 Spring Boot Starter

    关于Starter Spring Boot秉承"约定大于配置"的开发方式,使得我们基于Spring Boot开发项目的效率变得十分高.相信使用过Spring Boot的小伙伴都会发 ...

  6. Spring Boot Starter 开发指南

    Spring Boot Starter是什么? 依赖管理是任何复杂项目的关键部分.以手动的方式来实现依赖管理不太现实,你得花更多时间,同时你在项目的其他重要方面能付出的时间就会变得越少. Spring ...

  7. Spring Boot (一): Spring Boot starter自定义

    前些日子在公司接触了spring boot和spring cloud,有感于其大大简化了spring的配置过程,十分方便使用者快速构建项目,而且拥有丰富的starter供开发者使用.但是由于其自动化配 ...

  8. 自定义的Spring Boot starter如何设置自动配置注解

    本文首发于个人网站: 在Spring Boot实战之定制自己的starter一文最后提到,触发Spring Boot的配置过程有两种方法: spring.factories:由Spring Boot触 ...

  9. Spring Boot Starter自定义实现三步曲

    实现自定义的spring boot starter,只需要三步: 1.一个Bean 2.一个自动配置类 3.一个META-INF/spring.factories配置文件 下面用代码演示这三步. 项目 ...

随机推荐

  1. vue中对象数组去重

    其实很简单,一般的数组去重可以直接用 new Set() 方法即可,但是数组对象的话,比较复杂,不能直接用,我们可以采取间接的方法来去重 unique(arr) { const res = new M ...

  2. 在win10、Ubuntu双系统下,卸载Ubuntu

    一.Win下确定ubuntu的磁盘分区 这个步骤是为了删除Ubuntu的系统分区,这种直接删除的方式来重新安装ubuntu的低版本比较省事. (1)右键计算机->管理->磁盘管理,打开磁盘 ...

  3. Vue第一天

    什么是 Vue.js? Vue.js是前端的主流框架之一,与 Angular.js.React.js一起,并称为前端三大主流框架 Vue.js是一套构建用户界面的框架,只关注视图层,它不仅易上手,还便 ...

  4. ObjC: 源文件的组织

    转自:http://marshal.easymorse.com/tech/objc-%e6%ba%90%e6%96%87%e4%bb%b6%e7%9a%84%e7%bb%84%e7%bb%87 最简单 ...

  5. springboot 单元测试 指定启动类

    问题 在做单元测试时,写了一个工具类,用于注入spring的上下文. public class AppBeanUtil implements ApplicationContextAware { pri ...

  6. c#时间与时间戳互转13位

    Unix时间戳(Unix timestamp),或称Unix时间(Unix time).POSIX时间(POSIX time),是一种时间表示方式,定义为从格林威治时间1970年01月01日00时00 ...

  7. Cookie 跨域 和 SSO

    cookie是不能跨域访问的,但是在二级域名是可以共享cookie cookie的四个可选属性: 1. cookie的生存期属性:expires; 默认情况下,cookie只在浏览器会话期存在.退出浏 ...

  8. 开发基础之牛逼哄哄的 Lambda 表达式,简洁优雅就是生产力

    什么是Lambda? 我们知道,对于一个Java变量,我们可以赋给其一个“值”. 如果你想把“一块代码”赋给一个Java变量,应该怎么做呢? 比如,我想把右边那块代码,赋给一个叫做aBlockOfCo ...

  9. eclipse解决中文字体太小问题(转载)

    最近新装了Win7,打开eclipse3.7中文字体很小,简直难以辨认.在网上搜索发现这是由于Eclipse 3.7 用的字体是 Consolas,显示中文的时候默认太小了.   解决方式有两种:一. ...

  10. graylog-docker安装

    Graylog安装(docker) 1.安装docker jdk1.8 2.下载docker镜像 docker pull mongo docker pull docker.elastic.co/ela ...