SpringBoot场景启动器starter介绍及自定义starter

基于SpringBoot 2.6.2版本

mybatis整合starter

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.1</version>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

注意：

当你引入以上依赖而不做其他任何配置，你会发现你的项目启动不了。

因为引入mybatis-spring-boot-starter间接引入了spring-boot-starter-jdbc，当引入spring-boot-starter-jdbc，我们只能配置数据库连接或者排除数据源的自动配置。

application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/timaccount?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver
    hikari:
      idle-timeout: 60000
      maximum-pool-size: 30
      minimum-idle: 10
      connection-timeout: 10000
  application:
    name: tim-web

启动类

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class WebApp {
    public static void main(String[] args) {
        SpringApplication.run(WebApp.class, args);
    }
}

接下来我们来分析SpringBoot的starter是如何运作的。

1、pom依赖

2、指定自动装配文件位置

3、根据配置文件属性进行装配

4、获取配置文件进行属性绑定

5、springboot启动时加载springFactory

启动类注解@SpringBootApplication --> @EnableAutoConfiguration --> AutoConfigurationImportSelector。

注意：这里虽然使用了@Import导入了AutoConfigurationImportSelector，但是其实selectImports并没有被调用，而是在启动时直接调用了getAutoConfigurationEntry方法。

具体如何调用，请参考：SpringBoot是如何将自动化配置类加入到ioc容器中

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        return EMPTY_ENTRY;
    }
    //获取@EnableAutoConfiguration标注类的元信息。
    AnnotationAttributes attributes = getAttributes(annotationMetadata);
    //读取所有 classPath 下的 spring.factories
    List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    //移除重复定义的配置类（ 利用set集合的不可重复性 ）
    configurations = removeDuplicates(configurations);
    //获取排除类名单，排除类可通过 exclude = {A.class.B.class}属性来排除指定的配置类。
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    //检查被 ExcludedClasses 的类是否存在现在的 beanFacotry 中
    checkExcludedClasses(configurations, exclusions);
    configurations.removeAll(exclusions);
    configurations = getConfigurationClassFilter().filter(configurations);
    //监听器 import 事件回调
    fireAutoConfigurationImportEvents(configurations, exclusions);
    return new AutoConfigurationEntry(configurations, exclusions);
}

其中loadSpringFactories方法如下：

自定义starter

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

starter是一个集成接合器，完成两件事：

  • ① 引入相关的jar；
  • ② 自动配置；

1、springboot规范：

  • ① starter.jar 完成引入相关的jar
  • ② autoConfigure.jar 完成自动配置

2、starter命名规范

spring提供的starter：

  • spring-boot-starter-xxx-x.y.z.jar
  • spring-boot-xxx-autoconfigure-x.y.z.jar

第三方的starter：

  • xxx-spring-boot-starter-x.y.z.jar
  • xxx-spring-boot-autoconfigure-x.y.z.jar

3、starter的实现原理

SpringBoot官方的starter，和自定义的starter，基本都是利用java的SPI思想。在SpringBoot的自动装配过程中，最终会加载classpath目录下所有的META-INF/spring.factories文件，查看任一个starter，应该都有该文件。

新建一个工程

命名为demo-spring-boot-starter

pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>
    <groupId>com.demo</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-RELEASE</version>
    <name>demo-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>

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

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

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

定义一个实体类映射配置信息

@ConfigurationProperties(prefix = "demo") 它可以把相同前缀的配置信息通过配置项名称映射成实体类，比如我们这里指定 prefix = "demo" 这样，我们就能将以demo为前缀的配置项拿到了。其实这个注解很强大，它不但能映射成String或基本类型的变量。还可以映射为List，Map等数据结构。

package com.demo.starter.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 描述：配置信息 实体
 **/
@ConfigurationProperties(prefix = "demo")
public class DemoProperties {
    private String sayWhat;
    private String toWho;

    public String getSayWhat() {
        return sayWhat;
    }

    public void setSayWhat(String sayWhat) {
        this.sayWhat = sayWhat;
    }

    public String getToWho() {
        return toWho;
    }

    public void setToWho(String toWho) {
        this.toWho = toWho;
    }
}

定义一个Service

package com.demo.starter.service;

/**
 * 描述：随便定义一个Service
 *
 **/
public class DemoService {
    public String sayWhat;
    public String toWho;
    public DemoService(String sayWhat, String toWho){
        this.sayWhat = sayWhat;
        this.toWho = toWho;
    }
    public String say(){
        return this.sayWhat + "!  " + toWho;
    }
}

定义一个配置类

这里，我们将DemoService类定义为一个Bean，交给Ioc容器。

  • @Configuration 注解就不多说了。
  • @EnableConfigurationProperties 注解。该注解是用来开启 @ConfigurationProperties 注解配置Bean的支持。也就是@EnableConfigurationProperties注解告诉Spring Boot 能支持@ConfigurationProperties。当然了，也可以在 @ConfigurationProperties 注解的类上添加 @Configuration 或者  @Component 注解
  • @ConditionalOnProperty 注解控制 @Configuration 是否生效。简单来说也就是我们可以通过在yml配置文件中控制 @Configuration 注解的配置类是否生效。
package com.demo.starter.config;

import com.demo.starter.properties.DemoProperties;
import com.demo.starter.service.DemoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 描述：配置类
 *
 **/
@Configuration
@EnableConfigurationProperties(DemoProperties.class)
@ConditionalOnProperty(
        prefix = "demo",
        name = "isopen",
        havingValue = "true"
)
public class DemoConfig {
    @Autowired
    private DemoProperties demoProperties;

    @Bean(name = "demo")
    public DemoService demoService(){
        return new DemoService(demoProperties.getSayWhat(), demoProperties.getToWho());
    }
}

最重要的来了

如图，新建META-INF文件夹，然后创建spring.factories文件

在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置。

#-------starter自动装配---------
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.demo.starter.config.DemoConfig

测试

在demo-spring-boot-starter工程中执行mvn clean install 一个自定义的starter新鲜出炉。

新建测试工程，引入依赖：

<dependency>
    <groupId>com.demo</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-RELEASE</version>
</dependency>

配置文件：

demo.isopen=true
demo.say-what=hello
demo.to-who=shf

然后写个测试类：

package com.example.test.controller;

import com.demo.starter.service.DemoService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * 描述：
 *
 **/
@RestController
public class DemoController {
    @Resource(name = "demo")
    private DemoService demoService;

    @GetMapping("/say")
    public String sayWhat(){
        return demoService.say();
    }

}

浏览器

参考：
posted @   残城碎梦  阅读(275)  评论(0)  编辑  收藏  举报
相关博文：
· 【㊫SpringBoot】SpringBoot自定义starter
· 【㊫SpringBoot】Springboot自动装配以及启动原理解析
· 自定义starter
· SpringBoot的starter到底是什么？
· 如何自定义SpringBoot中的starter，并且使用它
阅读排行：
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码，我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了，比商业数据库还牛
· 白话解读 Dapr 1.15：你的「微服务管家」又秀新绝活了
· 上周热点回顾（2.24-3.2）
点击右上角即可分享
微信分享提示