如何优雅地创建一个自定义的Spring Boot Starter

优雅永不过时,希望看完本文,你会觉得starter如此优雅!

Spring Boot Starter是一种简化Spring Boot应用开发的机制,它可以通过引入一些预定义的依赖和配置,让我们快速地集成某些功能模块,而无需繁琐地编写代码和配置文件。Spring Boot官方提供了很多常用的Starter,例如spring-boot-starter-webspring-boot-starter-data-jpa等,但有时候我们也需要根据自己的业务需求,创建一些自定义的Starter,以便在不同的项目中复用一些通用的功能或组件。本文将以一个简单的日期格式化功能为例,介绍如何创建一个自定义的Spring Boot Starter,并说明其原理和使用方法。


目录

一、Starter的命名规范

二、Starter项目的结构

三、Starter项目的依赖

四、Starter项目的属性类

五、Starter项目的业务功能类

六、Starter项目的自动配置类

七、Starter项目的自动装配文件

八、Starter项目的使用方法

九、Starter项目的原理

总结


一、Starter的命名规范

在创建一个自定义的Starter之前,我们需要先确定它的名称。Starter的命名有一种习惯,官方的Starter一般都是以spring-boot-starter-为前缀,后面跟上模块名,例如spring-boot-starter-web表示集成了Web开发相关的依赖和配置。而我们自定义的Starter一般都是以模块名为前缀,后面跟上-spring-boot-starter,例如woniu-spring-boot-starter表示集成了日期格式化相关的依赖和配置。这样做的目的是为了避免与官方或其他第三方提供的Starter产生冲突或混淆。

二、Starter项目的结构

创建一个自定义的Starter项目和创建一个普通的Spring Boot项目没有太大区别,我们可以使用IDE或者Spring Initializr来快速生成一个基本的项目结构。一个典型的Starter项目结构如下:

复制代码
woniu-spring-boot-starter
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com.woniu.util
│   │   │       ├── autoconfigure // 自动配置类所在的包
│   │   │       │   ├── WoniuAutoConfiguration.java // 自动配置类
│   │   │       │   └── WoniuProperties.java // 属性类
│   │   │       └── util // 业务功能类所在的包
│   │   │           └── WoniuUtil.java // 业务功能类
│   │   └── resources
│   │       └── META-INF
│   │           └── spring.factories // Spring Boot自动装配文件
│   └── test
│       └── java
├── pom.xml // Maven依赖管理文件
└── README.md // 项目说明文档

三、Starter项目的依赖

在创建一个自定义的Starter项目时,我们需要在pom.xml文件中添加一些必要的依赖。首先,我们需要添加spring-boot-starter作为基础依赖,它提供了Spring Boot核心功能和默认配置。其次,我们需要添加spring-boot-configuration-processor作为编译时依赖,它可以帮助我们生成属性类和配置元数据,并且设置为可选依赖,避免传递给其他项目。最后,我们需要添加我们要集成的功能模块相关的依赖,例如在本例中,我们要集成日期格式化功能,所以我们不需要添加其他额外的依赖。以下是一个示例:

复制代码
<dependencies>
    <!-- 基础依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <!-- 编译时依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

四、Starter项目的属性类

在创建一个自定义的Starter项目时,我们需要编写一个属性类,用来定义我们要集成的功能模块所需的配置项,并且使用@ConfigurationProperties注解来指定配置文件中的前缀。例如,在本例中,我们要集成日期格式化功能,所以我们需要定义一个日期格式的配置项,并且使用woniu作为配置文件中的前缀。以下是一个示例:

复制代码
package com.woniu.util.autoconfigure;

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

@ConfigurationProperties(prefix = "woniu")
public class WoniuProperties {

    private String pattern = "yyyy-MM-dd hh:mm:ss"; // 日期格式,默认为"yyyy-MM-dd hh:mm:ss"

    // 省略getter和setter方法
}

五、Starter项目的业务功能类

在创建一个自定义的Starter项目时,我们需要编写一个或多个业务功能类,用来实现我们要集成的功能模块的具体逻辑。例如,在本例中,我们要集成日期格式化功能,所以我们需要定义一个日期工具类,用来根据配置的日期格式将日期转换为字符串。以下是一个示例:

复制代码
package com.woniu.util.util;

import java.text.SimpleDateFormat;
import java.util.Date;

public class WoniuUtil {

    private String pattern; // 日期格式

    public WoniuUtil(String pattern) {
        this.pattern = pattern;
    }

    public String dateToStr(Date date){
        SimpleDateFormat sdf = new SimpleDateFormat(pattern);
        String format = sdf.format(date);
        return format;
    }
}

六、Starter项目的自动配置类

在创建一个自定义的Starter项目时,我们需要编写一个自动配置类,用来根据属性类和业务功能类,创建相应的Bean对象,并且使用@EnableConfigurationProperties注解来启用属性类,使用@ConditionalOnClass注解来判断业务功能类是否存在,使用@ConditionalOnProperty注解来判断配置文件中是否有相应的配置项。例如,在本例中,我们要集成日期格式化功能,所以我们需要根据WoniuPropertiesWoniuUtil,创建一个WoniuUtil类型的Bean对象,并且使用woniu.enabled作为配置文件中的开关项。以下是一个示例:

复制代码
package com.woniu.util.autoconfigure;

import com.woniu.util.util.WoniuUtil;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
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(WoniuProperties.class)
@ConditionalOnClass(WoniuUtil.class)
@ConditionalOnProperty(prefix = "woniu", name = "enabled", havingValue = "true")
public class WoniuAutoConfiguration {

    private final WoniuProperties woniuProperties;

    public WoniuAutoConfiguration(WoniuProperties woniuProperties) {
        this.woniuProperties = woniuProperties;
    }

    @Bean
    public WoniuUtil woniuUtil() {
        return new WoniuUtil(woniuProperties.getPattern());
    }
}

七、Starter项目的自动装配文件

在创建一个自定义的Starter项目时,我们需要在resources/META-INF目录下创建一个名为spring.factories的文件,用来指定我们的自动配置类,让Spring Boot能够在启动时自动扫描并加载它。以下是一个示例:

复制代码
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.woniu.util.autoconfigure.WoniuAutoConfiguration

八、Starter项目的使用方法

在完成了一个自定义的Starter项目后,我们可以将它打包成jar文件,并且发布到Maven仓库或者本地仓库,这样就可以在其他项目中引用它了。例如,在本例中,我们可以在其他项目的pom.xml文件中添加如下依赖:

复制代码
<dependency>
    <groupId>com.woniu</groupId>
    <artifactId>woniu-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

然后,在其他项目的配置文件中添加如下配置项:

复制代码
woniu:
  enabled: true # 开启日期格式化功能
  pattern: yyyy-MM-dd # 设置日期格式,可选,默认为yyyy-MM-dd hh:mm:ss

最后,在其他项目的代码中,我们可以通过注入WoniuUtil类来调用日期格式化功能。例如:

复制代码
package com.example.demo;

import com.woniu.util.util.WoniuUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
public class DemoController {

    @Autowired
    private WoniuUtil woniuUtil;

    @GetMapping("/date")
    public String date() {
        Date date = new Date();
        String str = woniuUtil.dateToStr(date);
        return str;
    }
}

这样,我们就可以通过访问/date来获取格式化后的日期字符串了。

九、Starter项目的原理

Starter项目的核心原理是基于Spring Boot的自动装配机制,即根据类路径和配置文件中的条件,动态地创建和注入Bean对象到应用上下文中。Starter项目通过在resources/META-INF目录下创建一个名为spring.factories的文件,来指定自动配置类的全限定名,让Spring Boot在启动时能够扫描并加载它。自动配置类则通过一系列的注解来定义和控制自动装配的逻辑,例如:

  • @Configuration注解标识这是一个配置类,用来创建和注册Bean对象。
  • @EnableConfigurationProperties注解启用属性类,并将其注入到配置类中。
  • @ConditionalOnClass注解判断类路径中是否存在指定的类,如果存在则满足条件。
  • @ConditionalOnProperty注解判断配置文件中是否存在指定的属性,如果存在并且值与期望相符,则满足条件。
  • @Bean注解根据属性类和业务功能类,创建相应类型的Bean对象,并注册到应用上下文中。

当所有的条件都满足时,Starter项目就能实现自动装配的功能,让我们无需手动编写和配置Bean对象,只需引入依赖和设置属性即可。

总结

本文介绍了如何创建一个自定义的Spring Boot Starter,以及它的命名规范、项目结构、依赖管理、属性类、业务功能类、自动配置类、自动装配文件和使用方法。通过创建一个自定义的Starter,我们可以将一些通用的功能或组件封装起来,方便在不同的项目中复用,提高开发效率和代码质量。同时,本文也介绍了Starter项目的原理和机制,帮助我们深入理解Spring Boot的自动装配特性。不禁感慨,优雅,实在是优雅!

相关推荐
蓝澈112124 分钟前
迪杰斯特拉算法之解决单源最短路径问题
java·数据结构
Kali_0732 分钟前
使用 Mathematical_Expression 从零开始实现数学题目的作答小游戏【可复制代码】
java·人工智能·免费
rzl0243 分钟前
java web5(黑马)
java·开发语言·前端
时序数据说1 小时前
为什么时序数据库IoTDB选择Java作为开发语言
java·大数据·开发语言·数据库·物联网·时序数据库·iotdb
君爱学习1 小时前
RocketMQ延迟消息是如何实现的?
后端
guojl1 小时前
深度解读jdk8 HashMap设计与源码
java
Falling421 小时前
使用 CNB 构建并部署maven项目
后端
guojl1 小时前
深度解读jdk8 ConcurrentHashMap设计与源码
java
程序员小假1 小时前
我们来讲一讲 ConcurrentHashMap
后端