Spring Boot Starter 剖析与实践

引言

对于 Java 开发人员来说，Spring 框架几乎是必不可少的。它是一个广泛用于开发企业应用程序的开源轻量级框架。近几年，Spring Boot 在传统 Spring 框架的基础上应运而生，不仅提供了 Spring 的全部功能，还使开发人员更加便捷地使用。在使用 Spring Boot 时，我们经常会接触到各种 Spring Boot Starter，例如 spring-boot-starter-web。只需将该依赖加入项目中，我们就可以开始开发应用；在引入 spring-boot-starter-data-jdbc 后，只需在配置文件中填写数据库连接信息，即可连接数据库。此外，您还可以随意切换数据源组件依赖，而无需修改业务代码。Spring Boot Starter 是如何适配的呢？我们能否自己实现一个 Spring Boot Starter 呢？本文将剖析 Spring Boot Starter 的原理，并自定义实现一个 Spring Boot Starter 组件。
一、Spring Boot Starter 是什么？

Spring Boot Starter 是 Spring Boot 中比较重要的概念， 是一种依赖描述符，它可以帮助您简化配置。当需要构建一个 Web 应用程序时，不必再遍历所有的依赖包，一个一个地添加到项目的依赖管理中，而是只需要一个配置spring-boot-starter-web，如以下示例：


从上面示例来看，我们使用了相当少的代码创建了一个 REST 应用程序。Spring 官方提供了许多 Starter，同时第三方也可以自定义 Starter，官方为了加以区分，Starter 从名称上进行了如下规范：spring-boot-starter-xxx；第三方提供的 starter 名称为：xxx-spring-boot-starter。
二、Spring Boot Starter 剖析

前面介绍了 Starter 的概念以及如何快速创建 REST 应用程序。只需添加一个依赖和几行代码，就能完成 REST 接口开发。那么，在没有 Spring Boot 和 Starter 的情况下，我们该如何进行开发呢？Spring Boot Starter 的工作原理又是什么？接下来，我们将通过开发 Web 服务和 Dubbo 服务作为例子，分别剖析纯 Spring 和 Spring Boot Starter。
Spring

环境依赖

• JDK 1.8
  
• Maven 3
  
• Tomcat 8（需要依靠 Web 容器服务器才能启动）
  
• spring-webmvc 4.3.30.RELEASE
  
• dubbo 2.7.23
  

开发流程

• 首先介绍一下，这是一个标准的 Maven 目录结构与demo-service依赖内容
  
  1. <dependencies>
  2.    
  3.     <dependency>
  4.         <groupId>org.springframework</groupId>
  5.         <artifactId>spring-webmvc</artifactId>
  6.         <version>4.3.30.RELEASE</version>
  7.     </dependency>
  8.     <dependency>
  9.         <groupId>javax.servlet</groupId>
  10.         <artifactId>servlet-api</artifactId>
  11.         <version>2.5</version>
  12.     </dependency>
  13.    
  14.     <dependency>
  15.         <groupId>com.fasterxml.jackson.core</groupId>
  16.         <artifactId>jackson-databind</artifactId>
  17.         <version>2.9.8</version>
  18.     </dependency>
  20.    
  21.     <dependency>
  22.         <groupId>org.apache.dubbo</groupId>
  23.         <artifactId>dubbo</artifactId>
  24.         <version>2.7.23</version>
  25.     </dependency>
  26.     <dependency>
  27.         <groupId>org.apache.curator</groupId>
  28.         <artifactId>curator-x-discovery</artifactId>
  29.         <version>5.1.0</version>
  30.     </dependency>
  31.     <dependency>
  32.         <groupId>org.apache.zookeeper</groupId>
  33.         <artifactId>zookeeper</artifactId>
  34.         <version>3.8.0</version>
  35.     </dependency>
  37.    
  38.     <dependency>
  39.         <groupId>com.demo</groupId>
  40.         <artifactId>demo-api</artifactId>
  41.         <version>1.0-SNAPSHOT</version>
  42.     </dependency>
  43. </dependencies>

  复制代码
• 由于在 Spring XML 下还需要依靠 Java Web 和 Web 容器运行，还需要web/WEB-INF/web.xmlWeb 配置文件，内容配置了 SpringMVC 入口
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
  5.          version="4.0">
  7.    
  8.     <listener>
  9.         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  10.     </listener>
  12.     <context-param>
  13.         <param-name>contextConfigLocation</param-name>
  14.         <param-value>classpath:dubbo.xml</param-value>
  15.     </context-param>
  17.     <servlet>
  18.         <servlet-name>springmvc</servlet-name>
  19.         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  21.         <init-param>
  22.             <param-name>contextConfigLocation</param-name>
  23.             <param-value>classpath:mvc.xml</param-value>
  24.         </init-param>
  25.     </servlet>
  27.     <servlet-mapping>
  28.         <servlet-name>springmvc</servlet-name>
  29.         <url-pattern>/</url-pattern>
  30.     </servlet-mapping>
  31. </web-app>

  复制代码
• SpringMVC 配置文件mvc.xml与 Dubbo 配置文件dubbo.xml
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  7.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
  9.     <context:component-scan base-package="com.demo.controller"/>
  11.    
  12.     <mvc:annotation-driven/>
  14.    
  15.     <mvc:default-servlet-handler/>
  16. </beans>

  复制代码
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  7.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
  9.     <context:component-scan base-package="com.demo.controller"/>
  11.    
  12.     <mvc:annotation-driven/>
  14.    
  15.     <mvc:default-servlet-handler/>
  16. </beans>   

  复制代码
• 编写 Controller 接口与 Dubbo RPC 接口
  1. package com.demo.controller;
  3. import org.springframework.web.bind.annotation.GetMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  6. @RestController
  7. public class HelloController {
  9.     @GetMapping(value = "/say/hello")
  10.     public HelloEntity sayHello() {
  11.         return new HelloEntity("Hello World");
  12.     }
  14. }

  复制代码
  1. package com.demo.provider;
  3. import com.demo.api.DemoService;
  4. import com.demo.dto.HelloEntity;
  6. public class DemoServiceImpl implements DemoService {
  8.     @Override
  9.     public HelloEntity sayHello() {
  10.         return new HelloEntity("Hello World");
  11.     }
  12. }

  复制代码
• 以上还无法单独运行，需要将以上打包成war包放入到 Tomcat 才可运行。
  

剖析

从上面的开发流程中，我们可以看到入口都在 web.xml 中。其中有一个监听器和一个 Servlet，以及初始化参数 dubbo.xml 和 mvc.xml。在 Spring Boot 出现之前，Spring 通常使用 XML 配置方式描述 Bean，或者在 XML 中配置注解驱动和上下文扫描方式解析 Bean。因此，我们可以看出这里有两个 XML 文件。经过分析源代码，我们整理出了以下 XML 标签解析到 Bean 解析的流程。如下：

• 由 Tomcat 启动加载web.xml并通过监听器和 Servlet 让 Spring 加载 XML 并解析。
  
• 直到BeanDefinitionParserDelegate#parseCustomElement开始解析自定义标签，找到mvc:xxx或dubbo:xxx标签找到了 XML 命名空间。
  
• DefaultNamespaceHandlerResolver处理逻辑：以懒加载方式加载所有 jar 中META-INF/spring.handlers（路径必须得是这个）并缓存到handlerMappings，通过命名空间 URI 找到与之对应的处理类，SpringMVC 与 Dubbo 命名空间处理类分别为MvcNamespaceHandler和DubboNamespaceHandler
  
• MvcNamespaceHandler和DubboNamespaceHandler都分别实现了NamespaceHandler#init方法，内容如下：
  
  
  init方法将 SpringMVC 和 Dubbo 标签对应的 BeanDefinitionParser 注册到了 NamespaceHandlerSupport#parsers 中。在上一步中，DefaultNamespaceHandlerResolver 根据标签获取到了该标签的 BeanDefinitionParser，从而将对应的 Bean 注册到了 Spring IOC 容器中。注册逻辑不是本文的重点，这里就不再赘述。至此，SpringMVC 和 Dubbo 的加载流程已经完成。
  

从以上加载流程中，我们可以看出，在没有 Spring Boot 之前，Spring 主要依靠 XML 配置来启动。它会加载 XML 中的自定义标签，找到对应的命名空间，然后扫描 classpath 下的 META-INF/spring.handlers，找到命名空间处理类来解析当前标签。
Spring Boot

环境依赖

• JDK 1.8
  
• Maven 3
  
• spring-boot 2.6.9
  
• dubbo 2.7.23
  

开发流程

• 目录结构与 Mavendemo-spring-boot依赖内容
  
  1.             org.springframework.boot        spring-boot-starter-web<?xml version="1.0" encoding="utf-8" ?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  7.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
  9.     <context:component-scan base-package="com.demo.controller"/>
  11.    
  12.     <mvc:annotation-driven/>
  14.    
  15.     <mvc:default-servlet-handler/>
  16. </beans>org.apache.dubbo        dubbo-spring-boot-starter        2.7.23                org.apache.curator        curator-x-discovery        5.1.0                org.apache.zookeeper        zookeeper        3.8.0                com.demo        demo-api        1.0-SNAPSHOT   

  复制代码
• 应用程序入口DemoSpringBootApplication
  1. @SpringBootApplication
  2. public class DemoSpringBootApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(DemoSpringBootApplication.class, args);
  6.     }
  8. }

  复制代码
• application.yml文件内容只有 Dubbo 的配置
  1. dubbo:
  2.   application:
  3.     name: demo-provider
  4.   protocol:
  5.     port: 20880
  6.     name: dubbo
  7.   registry:
  8.     address: zookeeper://127.0.0.1:2181

  复制代码
• 编写 Controller 接口与 Dubbo RPC 接口
  1. package com.demo.controller;
  3. import com.demo.dto.HelloEntity;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. @RestController
  8. public class HelloController {
  10.     @GetMapping(value = "/say/hello")
  11.     public HelloEntity sayHello() {
  12.         return new HelloEntity("Hello World");
  13.     }
  15. }

  复制代码
  1. package com.demo.provider;
  3. import com.demo.api.DemoService;
  4. import com.demo.dto.HelloEntity;
  6. @DubboService
  7. public class DemoServiceImpl implements DemoService {
  9.     @Override
  10.     public HelloEntity sayHello() {
  11.         return new HelloEntity("Hello World");
  12.     }
  13. }

  复制代码
• 由于spring-boot-starter-web已经内嵌 tomcat ，只需要直接运行DemoSpringBootApplication#main方法即可运行应用
  

剖析

从开发流程上没办法第一时间找到解析入口，唯一入口就是在DemoSpringBootApplication，经过源代码分析得出以下流程：

• 应用DemoSpringBootApplication类上有@SpringBootApplication注解，而该注解由以下三个注解组成：
  
  
  
  • @SpringBootConfiguration，标注当前类为一个配置类，与[@Configuration](https://my.oschina.net/pointdance)注解功能一致 ，被[@Configuration](https://my.oschina.net/pointdance)注解的类对应 Spring 的 XML 版的容器。
    
  • @EnableAutoConfiguration，开启启动自动装配的关键，由@AutoConfigurationPackage与@Import(AutoConfigurationImportSelector.class)组成
    
  • @ComponentScan，按照当前类路径扫描含有@Service、@Controller等等注解的类，等同于 Spring XML 中的context:component-scan。
    
  
  
• Spring Boot 自动装配由@EnableAutoConfiguration导入的AutoConfigurationImportSelector类，会调用SpringFactoriesLoader#loadFactoryNames从 ClassPath 下扫描所有 jar 包的META-INF/spring.factories内容，由于传入的EnableAutoConfiguration.class，只会返回org.springframework.boot.autoconfigure.EnableAutoConfigurationkey 的值，得到一个全限定类名字符串数组configurations。
  
  
• configurations经过去重与声明式排除后，会进行以下进行过滤自动装配：
  1. configurations = getConfigurationClassFilter().filter(configurations)

  复制代码
  分成两部分：获取过滤器和执行过滤。
  
  
  
  • getConfigurationClassFilter()，也是通过SpringFactoriesLoader#loadFactoryNames在META-INF/spring.factories找到 Key 为org.springframework.boot.autoconfigure.AutoConfigurationImportFilter的值，目前只有：OnBeanCondition、OnClassCondition、OnClassCondition三个过滤器。
    
  • 执行过滤，会根据配置类上含有@ConditionOnBean、@ConditionalOnClass、@ConditionalOnWebApplication等等条件注解来过滤掉部分配置类。比如WebMvcAutoConfiguration指定需要在@ConditionOnWebApplication下才生效。
    
    
  
  
• 在引入各类 Configuration 的配置类后，配置类结合@Bean来完成 Spring Bean 解析和注入，同时 Spring Boot 还提供了许多@ConditionalXXX给开发者完成灵活注入。
  

以上就是 Spring Boot 的自动装配过程。Spring Boot 利用被 @Configuration 注解的配置类来代替 Spring XML 完成 Bean 的注入。然后，SpringFactoriesLoader 会最终加载 META-INF/spring.factories 中的自动配置类，实现自动装配过程。依靠“约定大于配置”的思想，如果开发的 Starter 想要生效，就需要按照 Spring Boot 的约定。
小结

通过对比 Spring 与 Spring Boot 的开发流程，我们可以发现 Spring Boot 在完成 Web 与 Dubbo 独立应用开发时，使用了相对较少的代码和配置。这得益于 Spring Boot Starter 的自动装配能力，它是 Spring Boot 的主要功能。通过消除定义一些属于自动配置类部分的需求，自动配置可以帮助简化开发流程并加速开发速度。
SPI

我们从上面剖析发现，两者都使用了一项机制去加载引入的 jar 包中的配置文件从而加载对应类，那就是SPI（Service Provider Interface）
SPI （Service Provider Interface）， 是 Java 内置的一种服务提供发现机制，提高框架的扩展性。

Java SPI

Java 内置的 SPI 通过java.util.ServiceLoader类解析 Classpath 和 jar 包的META-INF/services目录下的以接口全限定名命名的文件，并加载该文件中指定的接口实现类，以此完成调用。
但是 Java SPI 会有一定不足：

• 不能做到按需加载，需要遍历所有的实现并实例化，然后在循环中找到所需要的实现。
  
• 多个并发多线程使用ServiceLoader类的实例不安全
  
• 加载不到实现类时抛出并不是真正原因的异常，错误难定位。
  

Spring SPI

Spring SPI 沿用了 Java SPI ，但是在实现上和 Java SPI 存在差异，但是核心机制相同，在不修改 Spring 源码前提下，可以做到对 Spring 框架的扩展开发。

• 在 Spring XML 中，由DefaultNamespaceHandlerResolver负责解析spring.handlers生成 namespaceUri 和 NamespaceHandler 名称的映射，等有需要时在进行实例化。
  
• 在 Spring Boot 中，由SpringFactoriesLoader负责解析spring.factories文件，并将指定接口的所有实现类/全限定类名返回。
  

Spring Boot 2.7.0

在本文中 Spring Boot 自动装配使用了 SPI 来加载到EnableAutoConfiguration所指定的自动装配的类名，但在 Spring Boot2.7.0之后自动装配 SPI 机制有所改动，META-INF/spring.factories将废弃，同时在 Spring Boot 3 以上会将相关代码移除，改动如下：

• 新的注解：@AutoConfiguration代替@Configuration
  
• 读取自动装配的类文件位置改为：META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports，并且实现类全限定类名按照一行一个
  
• 由org.springframework.boot.context.annotation.ImportCandidates#load负责解析META-INF/spring/%s.imports，其中%s是接口名的占位符
  

三、Spring Boot Stater 实践

在使用spring-boot-starter-jdbc或者spring-boot-starter-jpa等数据库操作时，通常会引入一个数据库数据源连接池，比如：HikariCP、DBCP等，同时可随意切换依赖而不需要去更改任何业务代码，开发人员也无需关注底层实现，在此我们自定义一个 Starter 同时也实现这种兼容。因为我们以开发一个分布式锁的 Starter 并拥有多个实现：Zookeeper、Redis。 在此使用 Spring Boot 2.6.9 版本。
开发

项目结构与 Maven 依赖

1. └── src
2.     ├── main
3.     │   ├── java
4.     │   │   └── com.demo.distributed.lock
5.     │   │      ├── api
6.     │   │      │   ├── DistributedLock.java
7.     │   │      │   └── LockInfo.java
8.     │   │      ├── autoconfigure
9.     │   │      │   ├── DistributedLockAutoConfiguration.java
10.     │   │      │   └── DistributedLockProperties.java
11.     │   │      ├── redis
12.     │   │      │   └── RedisDistributedLockImpl.java
13.     │   │      └── zookeeper
14.     │   │          └── ZookeeperDistributedLockImpl.java
15.     │   └── resources
16.     │       └── META-INF
17.     │           └── spring.factories

复制代码

1.                 org.springframework.boot        spring-boot-autoconfigure<?xml version="1.0" encoding="utf-8" ?>
2. <beans xmlns="http://www.springframework.org/schema/beans"
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.        xmlns:context="http://www.springframework.org/schema/context"
5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
7.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
9.     <context:component-scan base-package="com.demo.controller"/>
11.    
12.     <mvc:annotation-driven/>
14.    
15.     <mvc:default-servlet-handler/>
16. </beans>org.springframework.boot        spring-boot-configuration-processor        true<?xml version="1.0" encoding="utf-8" ?>
17. <beans xmlns="http://www.springframework.org/schema/beans"
18.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
19.        xmlns:context="http://www.springframework.org/schema/context"
20.        xmlns:mvc="http://www.springframework.org/schema/mvc"
21.        xsi:schemaLocation="http://www.springframework.org/schema/beans
22.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
24.     <context:component-scan base-package="com.demo.controller"/>
26.    
27.     <mvc:annotation-driven/>
29.    
30.     <mvc:default-servlet-handler/>
31. </beans>    org.apache.curator        curator-framework        5.1.0        provided                org.apache.curator        curator-recipes        5.1.0        provided<?xml version="1.0" encoding="utf-8" ?>
32. <beans xmlns="http://www.springframework.org/schema/beans"
33.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
34.        xmlns:context="http://www.springframework.org/schema/context"
35.        xmlns:mvc="http://www.springframework.org/schema/mvc"
36.        xsi:schemaLocation="http://www.springframework.org/schema/beans
37.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
39.     <context:component-scan base-package="com.demo.controller"/>
41.    
42.     <mvc:annotation-driven/>
44.    
45.     <mvc:default-servlet-handler/>
46. </beans>org.redisson        redisson        3.23.1        provided   

复制代码

在依赖里可以看到 Zookeeper 和 Redis 依赖关系被设置为provided，作用为编译与测试阶段使用，不会随着项目一起发布。即打包时不会带上该依赖。该设置在 Spring Boot Starter 作用较大。
分布式锁接口与实现

接口

1. public interface DistributedLock {
3.     /**
4.      * 加锁
5.      */
6.     LockInfo tryLock(String key, long expire, long waitTime);
8.     /**
9.      * 释放锁
10.      */
11.     boolean release(LockInfo lock);
13. }

复制代码

Redis 实现

1. public class RedisDistributedLockImpl implements DistributedLock {
3.     private final RedissonClient client;
5.     public RedisDistributedLockImpl(RedissonClient client) {
6.         this.client = client;
7.     }
9.     @Override
10.     public LockInfo tryLock(String key, long expire, long waitTime) {
11.         //do something
12.         return null;
13.     }
15.     @Override
16.     public boolean release(LockInfo lock) {
17.         //do something
18.         return true;
19.     }
20. }

复制代码

Zookeeper 实现

1. public class ZookeeperDistributedLockImpl implements DistributedLock {
3.     private final CuratorFramework client;
5.     public ZookeeperDistributedLockImpl(CuratorFramework client) {
6.         this.client = client;
7.     }
9.     @Override
10.     public LockInfo tryLock(String key, long expire, long waitTime) {
11.         return null;
12.     }
14.     @Override
15.     public boolean release(LockInfo lock) {
16.         return false;
17.     }
18. }

复制代码

DistributedLockAutoConfiguration 配置类

1. @EnableConfigurationProperties(DistributedLockProperties.class)
2. @Import({DistributedLockAutoConfiguration.Zookeeper.class, DistributedLockAutoConfiguration.Redis.class})
3. public class DistributedLockAutoConfiguration {
5.     @Configuration
6.     @ConditionalOnClass(CuratorFramework.class)
7.     @ConditionalOnMissingBean(DistributedLock.class)
8.     @ConditionalOnProperty(name = "distributed.lock.type", havingValue = "zookeeper",
9.             matchIfMissing = true)
10.     static class Zookeeper {
12.         @Bean
13.         CuratorFramework curatorFramework(DistributedLockProperties properties) {
14.             //build CuratorFramework client
15.             return null;
16.         }
19.         @Bean
20.         ZookeeperDistributedLockImpl zookeeperDistributedLock(CuratorFramework client) {
21.             return new ZookeeperDistributedLockImpl(client);
22.         }
23.     }
26.     @Configuration
27.     @ConditionalOnClass(RedissonClient.class)
28.     @ConditionalOnMissingBean(DistributedLock.class)
29.     @ConditionalOnProperty(name = "distributed.lock.type", havingValue = "redis",
30.             matchIfMissing = true)
31.     static class Redis {
33.         @Bean
34.         RedissonClient redissonClient(DistributedLockProperties properties) {
35.             //build RedissonClient client
36.             return null;
37.         }
39.         @Bean
40.         RedisDistributedLockImpl redisDistributedLock(RedissonClient client) {
41.             return new RedisDistributedLockImpl(client);
42.         }
43.     }
44. }

复制代码

• @EnableConfigurationProperties(DistributedLockProperties.class)开启配置类 Properties 信息，会将配置文件里的信息注入 Properties 类里。
  
• @Configuration配置注解
  
• @ConditionalOnClass(CuratorFramework.class)条件注解，要求存在CuratorFramework类当前配置类才生效，Redis 的子配置类同理。
  
• @ConditionalOnMissingBean(DistributedLock.class)条件注解，Spring 不存在DistributedLockBean 当前配置类才生效，Redis 的子配置类同理。
  
• @ConditionalOnProperty(name = "distributed.lock.type", havingValue = "zookeeper", matchIfMissing = true)条件注解，这里判断配置文件distributed.lock.type等于zookeeper才生效，当如果没配置则默认当做zookeeper，Redis 的子配置类同理。
  
• @Bean将方法返回的 Bean 注入到 Spring IOC 容器里，方法入参中含依赖的 Bean
  

spring.factories

1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
2.   com.demo.distributed.lock.autoconfigure.DistributedLockAutoConfiguration

复制代码

我们只需要将该文件放到resource/META-INF/spring.factories下，就会被 Spring Boot 加载，这也是 Spring Boot 的约定大于配置的思想。
使用

Maven 依赖关系

1.             com.demo        distributed-lock-spring-boot-starter        1.0.0-SNAPSHOT                dev<?xml version="1.0" encoding="utf-8" ?>
2. <beans xmlns="http://www.springframework.org/schema/beans"
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.        xmlns:context="http://www.springframework.org/schema/context"
5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
7.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
9.     <context:component-scan base-package="com.demo.controller"/>
11.    
12.     <mvc:annotation-driven/>
14.    
15.     <mvc:default-servlet-handler/>
16. </beans>true<?xml version="1.0" encoding="utf-8" ?>
17. <beans xmlns="http://www.springframework.org/schema/beans"
18.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
19.        xmlns:context="http://www.springframework.org/schema/context"
20.        xmlns:mvc="http://www.springframework.org/schema/mvc"
21.        xsi:schemaLocation="http://www.springframework.org/schema/beans
22.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
24.     <context:component-scan base-package="com.demo.controller"/>
26.    
27.     <mvc:annotation-driven/>
29.    
30.     <mvc:default-servlet-handler/>
31. </beans><?xml version="1.0" encoding="utf-8" ?>
32. <beans xmlns="http://www.springframework.org/schema/beans"
33.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
34.        xmlns:context="http://www.springframework.org/schema/context"
35.        xmlns:mvc="http://www.springframework.org/schema/mvc"
36.        xsi:schemaLocation="http://www.springframework.org/schema/beans
37.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
39.     <context:component-scan base-package="com.demo.controller"/>
41.    
42.     <mvc:annotation-driven/>
44.    
45.     <mvc:default-servlet-handler/>
46. </beans>                org.redisson                redisson                3.23.1<?xml version="1.0" encoding="utf-8" ?>
47. <beans xmlns="http://www.springframework.org/schema/beans"
48.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
49.        xmlns:context="http://www.springframework.org/schema/context"
50.        xmlns:mvc="http://www.springframework.org/schema/mvc"
51.        xsi:schemaLocation="http://www.springframework.org/schema/beans
52.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
54.     <context:component-scan base-package="com.demo.controller"/>
56.    
57.     <mvc:annotation-driven/>
59.    
60.     <mvc:default-servlet-handler/>
61. </beans>                test<?xml version="1.0" encoding="utf-8" ?>
62. <beans xmlns="http://www.springframework.org/schema/beans"
63.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
64.        xmlns:context="http://www.springframework.org/schema/context"
65.        xmlns:mvc="http://www.springframework.org/schema/mvc"
66.        xsi:schemaLocation="http://www.springframework.org/schema/beans
67.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
69.     <context:component-scan base-package="com.demo.controller"/>
71.    
72.     <mvc:annotation-driven/>
74.    
75.     <mvc:default-servlet-handler/>
76. </beans>                org.apache.curator                curator-framework                5.1.0<?xml version="1.0" encoding="utf-8" ?>
77. <beans xmlns="http://www.springframework.org/schema/beans"
78.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
79.        xmlns:context="http://www.springframework.org/schema/context"
80.        xmlns:mvc="http://www.springframework.org/schema/mvc"
81.        xsi:schemaLocation="http://www.springframework.org/schema/beans
82.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
84.     <context:component-scan base-package="com.demo.controller"/>
86.    
87.     <mvc:annotation-driven/>
89.    
90.     <mvc:default-servlet-handler/>
91. </beans><?xml version="1.0" encoding="utf-8" ?>
92. <beans xmlns="http://www.springframework.org/schema/beans"
93.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
94.        xmlns:context="http://www.springframework.org/schema/context"
95.        xmlns:mvc="http://www.springframework.org/schema/mvc"
96.        xsi:schemaLocation="http://www.springframework.org/schema/beans
97.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
99.     <context:component-scan base-package="com.demo.controller"/>
101.    
102.     <mvc:annotation-driven/>
104.    
105.     <mvc:default-servlet-handler/>
106. </beans>org.apache.curator                curator-recipes                5.1.0<?xml version="1.0" encoding="utf-8" ?>
107. <beans xmlns="http://www.springframework.org/schema/beans"
108.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
109.        xmlns:context="http://www.springframework.org/schema/context"
110.        xmlns:mvc="http://www.springframework.org/schema/mvc"
111.        xsi:schemaLocation="http://www.springframework.org/schema/beans
112.         http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
114.     <context:component-scan base-package="com.demo.controller"/>
116.    
117.     <mvc:annotation-driven/>
119.    
120.     <mvc:default-servlet-handler/>
121. </beans>   

复制代码

此处结合 Maven profile 功能按照不同环境依赖不同分布式锁底层实现，同时 Spring Boot 也提供了 Spring Boot Profile 加载不同配置，可以从开发、测试、生产环境使用不同底层了，同时 Maven profile 可以根据-P指定加载不同的依赖进行打包，解决了不同环境使用不同分布式锁实现。
代码使用

1. private final DistributedLock distributedLock;
3. public DemoServiceImpl(DistributedLock distributedLock) {
4.     this.distributedLock = distributedLock;
5. }
7. public void test() {
8.     LockInfo lock = null;
9.     try {
10.         lock = distributedLock.tryLock("demo", 1000, 1000);
11.         //do something
12.     } finally {
13.         if (lock != null) {
14.             distributedLock.release(lock);
15.         }
16.     }
17. }

复制代码

业务代码中由于依赖的是接口，结合 Spring Boot Starter 条件注解 + Maven Profile 不管依赖哪个分布式锁实现，都无需去修改代码。
四、总结

本文介绍了在没有 Spring Boot 和 Starter 之前，开发人员在使用传统的 Spring XML 开发 Web 应用时需要引用许多依赖，并且需要大量编写 XML 代码来描述 Bean 以及它们之间的依赖关系。也了解了如何利用 SPI 加载自定义标签来加载 Bean 并进行注入。而 Spring Boot Starter 则提供了一种更加现代化的配置方式，它通过 SPI 机制加载自动装配的 @Configuration 配置类来代替传统的 Spring XML 完成 Bean 的注入，从而消除了大量的 XML 配置。最后，我们通过自定义开发了一个分布式锁 Spring Boot Starter 组件，利用一系列的 @ConditionalXXX 注解和 Maven Profile 来完成开发。这样，我们可以兼容多种分布式锁实现，并且在不同环境下使用不同的分布式锁实现，而无需修改业务代码。

作者：京东零售 陈炎清
来源：京东云开发者社区

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！