Spring boot 自定义 Starter及自动配置的方法

更新时间：2022年12月07日 14:41:37 作者：、楽.

Starter 组件是 Spring boot 的一个核心特性，Starter组件的出现极大的简化了项目开发，这篇文章主要介绍了Spring boot 自定义 Starter 及自动配置,需要的朋友可以参考下

Starter 组件简介

Starter 组件是 Spring boot 的一个核心特性，Starter组件的出现极大的简化了项目开发，例如在项目中使用的pom.xml文件中添加以下配置：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.5.3</version>
</dependency>

Spring boot 就会自动关联web 开发相关的依赖，如 tomcat 及 spring-mvc等，进而能支持web开发，同时相关技术也将实现自动配置，避免了繁琐的配置文件。

Starter 组件使开发者不需要关注各种依赖库的处理、不需要具体的配置信息，由Spring boot 自动完成class的发现并加载。

利用Starter实现自动化配置需要两个条件：Maven依赖以及配置文件。

Maven依赖实际上就是导入一个JAR，然后Springboot启动时候就会找到这个jar包中 resource/META-INF/spring.factories文件，根据文件的配置找到相关的实现类。以上就是spring boot 的自动装配机制，如果理解该机制的话，很容易就能手写一个 starter 组件。

对starter组件我们可以简单理解为：

每个不同的starter组件实际上完成自身的功能逻辑，然后对外提供一个bean对象让别人调用
对外提供的bean通过自动装配机制注入到IOC容器中

自定义 Starter 组件

要实现一个自己的 starter 组件其实也很简单，首先我们需要明确我们需要做那些事：

通过配置类提供对外服务的 bean 对象
按照自动装配原理完成 spring.factories 的编写
starter 自动属性配置

Starter 组件

接下来我们就手写一个 starter 组件，模仿 RedisTemplate，流程如下：

创建一个spring boot 项目 redis-starter-demo
创建MyStarterTemplate

简单模拟 redis 的 get,set操作：

public class MyStarterTemplate {

    Map<String, String> map = new HashMap<>();

    public String put(String key, String value) {
        map.put(key, value);
        return "保存成功";
    }

    public String get(String key) {
        return map.get(key);
    }

}

创建配置类

@Configuration
public class MyAutoConfiguration {

    @Bean
    public MyStarterTemplate myStarterTemplate(){
        return new MyStarterTemplate();
    }

}

实现自动装配流程

在 classpath 下 META-INF目录下创建 spring.factories 文件：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.example.redisstarterdemo.MyAutoConfiguration

打包发布 maven install

使用 Starter

创建一个新项目用来引入 starter test-demo
pom 文件引入依赖

<dependency>
    <groupId>com.example</groupId>
    <artifactId>redis-starter-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

编写接口，直接 Autowired 注入MyStarterTemplate

@RestController
@RequestMapping(value = "/myRedis")
public class RedisStarterController {

    @Autowired
    private MyStarterTemplate myStarterTemplate;

    @RequestMapping("/save")
    public String save(@RequestParam String key, @RequestParam String value) {
        myStarterTemplate.put(key,value);
        return "ok";
    }

    @RequestMapping("/get")
    public String get(@RequestParam String key) {
        return  myStarterTemplate.get(key);
    }

}

以上便是一个完成的自定义 Starter，如果搞懂SPI机制的话，现在应该觉得很简单单了吧？

Starter 传参

以上是一个最简单的 starter 组件，但是有这么一种情况，我们还以 redis 为例，在 redis 中我们是可以通过在配置文件中来设置地址、账号密码等信息的，那这种情况我们应该如何操作呢？

我们还是在上面的项目中继续添加代码
创建需要注入的 bean 类

这里我们通过对外暴露一个创建方法用来给对象传递地址和端口号；

public class MyRedis {

    public String say() {
        return "my host:" + host + ",port:" + port;
    }

    public static MyRedis create(String host, Integer port) {
        return new MyRedis(host, port);
    }

    public MyRedis(String host, Integer port) {
        this.host = host;
        this.port = port;
    }

    private String host;

    private Integer port;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public Integer getPort() {
        return port;
    }

    public void setPort(Integer port) {
        this.port = port;
    }
}

创建属性类

@ConfigurationProperties(prefix = "redis")的作用是读取 application中以 redis 开头的数据，还有其他几种读取配置文件的注解可以自行研究。

由于我们这里设置了默认值，所以如果不配置的话也不影响，会使用默认值传递给 bean 。

@ConfigurationProperties(prefix = "redis")
public class MyProperties {

    private String host = "127.0.0.1";

    private Integer port = 6379;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public Integer getPort() {
        return port;
    }

    public void setPort(Integer port) {
        this.port = port;
    }

}

@ConfigurationProperties(prefix = "redis")
public class MyProperties {

    private String host = "127.0.0.1";

    private Integer port = 6379;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public Integer getPort() {
        return port;
    }

    public void setPort(Integer port) {
        this.port = port;
    }

}

创建配置类

使用配置文件，将相关信息传递给 bean 类。

@Configuration
@EnableConfigurationProperties(MyProperties.class)
public class MyRedisConfiguration {

    @Bean
    public MyRedis myRedis(MyProperties properties) {
        return MyRedis.create(properties.getHost(), properties.getPort());
    }

}

实现自动装配流程

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.example.redisstarterdemo.demo1.MyAutoConfiguration,\
  com.example.redisstarterdemo.demo2.MyRedisConfiguration

在项目中引用还是同样的操作，如果想要设置属性的话，只需要在配置文件中编写相关信息即可：

redis.host=196.128.255.255
redis.port=9999

自身与第三方维护

针对 spring boot 的starter 组件分为两类：

1.springboot 自身维护的starter组件

所有的 starter　组件自身不带　spring.factories 文件，都集中在spring-boot-autoconfigure 包下的 EnableAutoConfiguration
springboot 装配这些配置类是由条件的，不会将所有的都一股脑都加载进来，假设我没用到 redis 的话就不会引入相关依赖包，这样根据@ConditionalOnClass(RedisOperations.class)在classpath下找不到RedisOperations类，就不会加载该配置类。
自身维护的starter组件的命名为：spring-boot-starter-xxx

2.第三方维护的starter 组件

在自己的 jar 中维护 spring.factories 文件
命名方式：xxx-spring-boot-starter

到此这篇关于Spring boot 自定义 Starter 及自动配置的文章就介绍到这了,更多相关Spring boot 自定义 Starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Eclipse不自动编译java文件的终极解决方法
这篇文章主要介绍了Eclipse不自动编译java文件的终极解决方法,需要的朋友可以参考下
2015-12-12
Java实现TCP和UDP协议详解
这篇文章主要介绍了Java实现TCP和UDP协议详解,TCP(传输控制协议)和UDP(用户数据报协议)是两种最常用的传输层协议,它们都用于在网络上传输数据，但是它们之间有很多不同之处,需要的朋友可以参考下
2023-07-07
spring-gateway网关聚合swagger实现多个服务接口切换的示例代码
这篇文章主要介绍了spring-gateway网关聚合swagger实现多个服务接口切换的示例代码，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2022-03-03
SpringBoot整合Jackson超详细用法(附Jackson工具类)
这篇文章主要介绍了SpringBoot整合Jackson超详细教程,本篇讲的是Jackson的详细用法，Jackson工具类在文章最后，直接复制粘贴即可使用，需要的朋友可以参考下
2023-03-03
JNDI简介_动力节点Java学院整理
这篇文章主要介绍了JNDI简介，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-08-08
Java网络通信中URL与HTTP编程技术详解
要想实现网络编程,除了可以使用Socket之外,我们还可以利用URL编程或HTTP编程技术,所以今天这篇文章,就给大家介绍一下URL编程和HTTP编程技术,看看这两种技术有什么特点,文中有详细的代码讲解,需要的朋友可以参考下
2023-11-11
Java中NoClassDefFoundError 和 ClassNotFoundException的区别
Java中NoClassDefFoundError和ClassNotFoundException的区别,从类继承层次上来看，ClassNotFoundException是从Exception继承的,所以ClassNotFoundException是一个检查异常。具体详情需要的朋友可以参考下面文章内容
2022-06-06
SpringBoot 回滚操作的几种实现方式
回滚操作是一种常见的操作,用于撤销之前执行的操作,本文主要介绍了SpringBoot回滚操作的几种实现方式,包含基于异常类型的回滚、基于自定义逻辑的回滚和基于数据库状态的回滚,感兴趣的可以了解一下
2024-03-03
Java类的初始化实践分析
这篇文章主要介绍了Java类的初始化,结合具体实例形式较为详细的分析了java类初始化的常见情况、操作技巧与相关注意事项,需要的朋友可以参考下
2019-07-07
Java中的HashMap和Hashtable区别解析
这篇文章主要介绍了Java中的HashMap和Hashtable区别解析,HashMap和Hashtable都实现了Map接口,但决定用哪一个之前先要弄清楚它们之间的区别,主要的区别有线程安全性、同步和速度,需要的朋友可以参考下
2023-11-11