如何自定义starter

背景

使用过Spring Boot的小伙伴都应该知道,一个Spring Boot 项目就是由一个一个 starter 组成的,一个 starter 代表该项目的 Spring Boot 启动依赖,除了官方已有的 starter,我们可以根据自己的需要自定义新的starter。

我们经常会看到或者使用到各种***-starter。比如下面几种:

  1. spring-boot-starter-web:嵌入Tomcat和web开发需要的相关jar包
  2. spring-boot-starter-data-redis:redis数据库支持
  3. mybatis-spring-boot-starter:第三方的mybatis集成的starter
  4. spring-boot -starter-test:用于测试 Spring 引导应用程序
  5. spring-boot-starter-AOP :这个 starter 用于使用 AspectJ 和 Spring AOP 进行面向方面的编程

starter有何用呢?

在我们的日常开发工作中,经常会有一些独立于业务之外的配置模块,我们经常将其放到一个特定的包下,然后如果另一个工程需要复用这块功能的时候,需要将代码硬拷贝到另一个工程,重新集成一遍,麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter,复用的时候只需要将其在pom中引用依赖即可,Spring Boot为我们完成自动装配,简直不要太爽。

比如我们之前做MVC时要引入日志组件,那么需要去找到log4j的版本,然后引入,现在有了Starter之后,直接用这个之后,log4j就自动引入了,也不用关心版本这些问题。

比如我们要在Spring Boot中引入Web MVC的支持时,我们通常会引入这个模块spring-boot-starter-web,而这个模块如果解压包出来会发现里面什么都没有,只定义了一些POM依赖。

Spring Boot starter机制

  Spring Boot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,Spring Boot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。Spring Boot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。Spring Boot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。

自定义starter的条件

如果想自定义Starter,首选需要实现自动化配置,而要实现自动化配置需要满足以下两个条件:

  1. 能够自动配置项目所需要的配置信息,也就是自动加载依赖环境;
  2. 能够根据项目提供的信息自动生成Bean,并且注册到Bean管理容器中;

自定义starter代码部分

pom.xml依赖

<dependencies>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.0.0.RELEASE</version>
 </dependency>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <version>2.0.0.RELEASE</version>
    <optional>true</optional>
  </dependency>
</dependencies>

根据需要自定义Starter的实现过程大致如下(以我定义的Starter为例):

定义XxxProperties类,属性配置类,完成属性配置相关的操作,比如设置属性前缀,用于在application.properties中配置。

TianProperties代码:

import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "spring.tian")
public class TianProperties {
    // 姓名
    private String name;
    // 年龄
    private int age;
    // 性别
    private String sex = "M";

    //get and set
}

创建XxxService类,完成相关的操作逻辑 。

TianService代码:

public class TianService {

    private TianProperties properties;

    public TianService() {
    }

    public TianService(TianProperties userProperties) {
        this.properties = userProperties;
    }
    public void sayHello(){
        System.out.println("hi, 我叫: " + properties.getName() +
        ", 今年" + properties.getAge() + "岁"
         + ", 性别: " + properties.getSex());
    }
}

定义XxxConfigurationProperties类,自动配置类,用于完成Bean创建等工作。

TianServiceAutoConfiguration代码:

@Configuration
@EnableConfigurationProperties(TianProperties.class)
@ConditionalOnClass(TianService.class)
@ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true)
public class TianServiceAutoConfiguration {

    @Autowired
    private TianProperties properties;

    @Bean
    @ConditionalOnMissingBean(TianService.class)
    public TianService tianService() {
        return new TianService(properties);
    }
}

在resources下创建目录META-INF,在 META-INF 目录下创建 spring.factories,在SpringBoot启动时会根据此文件来加载项目的自动化配置类。

spring.factories中配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration

把上面这个starter工程打成jar包

项目中使用自定义starter

创建一个Spring Boot项目test

在项目中把自定义starter添加pom依赖

<dependency>
    <groupId>com.tian</groupId>
    <artifactId>spring-boot-tian-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

TestApplication启动类

@SpringBootApplication
@EnableEurekaServer
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
}

application.properties中配置

spring.tian.name=tian
spring.tian.age=22
spring.tian.sex=M

写一个TestController.java

RestController
@RequestMapping("/my")
public class TestController {

    @Resource
    private TianService tianService;

    @PostMapping("/starter")
    public Object starter() {
        tianService.sayHello();
        return "ok";
    }
}

jar以来进来后,可以看到

多了一个json的文件

最后启动项目,输入

http://localhost:9091/my/starter

后台打印

hi, 我叫: tian, 今年22岁, 性别: M

这就成功的现实了自定义的starter。

总结

  1. Spring Boot在启动时扫描项目所依赖的JAR包,寻找包含spring.factories文件的JAR包,
  2. 然后读取spring.factories文件获取配置的自动配置类AutoConfiguration,
  3. 然后将自动配置类下满足条件(@ConditionalOnXxx)的@Bean放入到Spring容器中(Spring Context)
  4. 这样使用者就可以直接用来注入,因为该类已经在容器中了

本文分享自微信公众号 - Java后端技术栈(t-j20120622),作者:田老师

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-05-16

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【原创】Spring Boot 如何手写stater

    很多人可能会觉得这种starter方式很牛B,添加一个starter就搞定了很多事情。今天咱们也来搞一个自己的starter。

    田维常
  • 一套简单通用的Java后台管理系统,拿来即用,非常方便(附项目地址)

    这套Base Admin是一套简单通用的后台管理系统,主要功能有:权限管理、菜单管理、用户管理,系统设置、实时日志,实时监控,API加密,以及登录用户修改密码、...

    田维常
  • 快速掌握并发编程---细说ReentrantLock和AQS

    面试时常会被问synchronized和ReentrantLock的区别,我们前面文章中已经讲过synchronized同步锁关键字的相关知识点,今天就来聊聊R...

    田维常
  • 高级框架-SpringBoot【悟空教程】

    Spring 诞生时是 Java 企业版(Java Enterprise Edition,JEE,也称 J2EE)的轻量级代替品。无需开发重量级的 Enterp...

    Java帮帮
  • Spring Boot 开箱即用

    新建一个工程需要做很多的基础工作,依赖包引入,基础组件的配置。在微服务大行其道的今天,建立一个新工程是一个家常便饭的事情。其中的工作繁琐且容易出错。在Sprin...

    李鸿坤
  • 一起玩转微服务(12)——揭密starter

    Spring Boot的starter主要用来简化依赖用的,对于企业级开发中的与第三方的集成,可以通过一段简单的配置来完成,这样开发人员无需再对包依赖的问题头疼...

    cloudskyme
  • 安云艺术家带您走进集线画法的动物世界!- 腾讯ISUX

    腾讯ISUX
  • Julia机器学习核心编程.6

    数组是对象的可索引集合,例如整数、浮点数和布尔值,它们被存储在多维网格中。Julia中的数组可以包含任意类型的值。在Julia中本身就存在数组这个概念。

    云深无际
  • 深入了解MD4,MD5,SHA哈希密码算法与破解技术

    密码(password)是最广泛使用的认证系统之一,防止未经授权的用户访问系统,无论是离线还是在线。在大多数系统中,密码是通过加密存储的,以便为每个用户提供安全...

    HACK学习
  • 小谈python里 列表 的几种常用用法

    在python中列表的常用方法主要包括增加,删除,查看和修改。下面以举例子的方法具体说明,首先我们创建两个列表,列表是用[ ]表示的,里面的元素用逗号隔开。

    py3study

扫码关注云+社区

领取腾讯云代金券