SpringBoot自定义starter及自动配置

本文涉及的产品
短信服务,100条 3个月
数字短信套餐包(仅限零售电商行业),100条 12个月
国际/港澳台短信套餐包,全球plus 100条 6个月
简介: SpringBoot自定义starter及自动配置

SpringBoot的核心就是自动配置,而支持自动配置的是一个个starter项目。除了官方已有的starter,用户自己也可以根据规则自定义自己的starter项目。


自定义starter条件

自动化配置需满足以下条件:


根据条件检查classpath下对应的类,也就是说需要提供对应可检查的类;

当满足条件时能够生成定义的Bean,并注册到容器中去;

能够自动配置项目所需要的配置;

自定义spring boot starter

这里通过maven项目管理工具进行starter的创建。首先我们需要创建一个简单的maven项目。这里我们以集成某短信服务为例,来创建一个项目。


创建maven项目

创建一个简单的maven项目,具体步骤省略。可通过intellj idea等IDE进行创建,也可通过maven命令进行创建。


目录结构如下:


.
├── pom.xml
├── spring-boot-starter-msg.iml
└── src
    ├── main
    └── test

在pom.xml中引入SpringBoot自动化配置依赖spring-boot-autoconfigure:


<dependency>

   <groupId>org.springframework.boot</groupId>

   <artifactId>spring-boot-autoconfigure</artifactId>

   <version>2.1.5.RELEASE</version>

</dependency>


定义Service服务类

定义Service服务类,有两个作用,一个为引入的项目本省的功能性服务,另外一个用来springboot自动配置时的判断依据。


这里定义一个MsgService的类。


package com.secbro2.msg;
import com.secbro2.utils.HttpClientUtils;
public class MsgService {
  /**
   * 访问发送短信的url地址
   */
  private String url;
  /**
   * 短信服务商提供的请求keyId
   */
  private String accessKeyId;
  /**
   * 短信服务商提供的KeySecret
   */
  private String accessKeySecret;
  public MsgService(String url, String accessKeyId, String accessKeySecret) {
    this.url = url;
    this.accessKeyId = accessKeyId;
    this.accessKeySecret = accessKeySecret;
  }
  public int sendMsg(String msg) {
    // 调用http服务并发送消息,返回结果
    return HttpClientUtils.sendMsg(url, accessKeyId, accessKeySecret, msg);
  }
  // 省略getter/setter方法
}

其中MsgService用到了一个工具类HttpClientUtils。在HttpClientUtils中只简单打印了请求的参数信息。

package com.secbro2.utils;
public class HttpClientUtils {
  public static int sendMsg(String url, String accessKeyId, String accessKeySecret, String msg) {
    //TODO 调用指定url进行请求的业务逻辑
    System.out.println("Http请求,url="   url   ";accessKeyId="   accessKeyId   ";accessKeySecret="   accessKeySecret   ";msg="   msg);
    return 0;
  }
}

定义配置类

定义MsgProperties配置类,用于封装application.properties或application.yml中的基础配置。这里关于短信发送的配置前缀统一采用msg。

@ConfigurationProperties(prefix = "msg")
public class MsgProperties {
  /**
   * 访问发送短信的url地址
   */
  private String url;
  /**
   * 短信服务商提供的请求keyId
   */
  private String accessKeyId;
  /**
   * 短信服务商提供的KeySecret
   */
  private String accessKeySecret;
  // 其他参数定义
  // 省略getter/setter方法
}

通过@ConfigurationProperties注解来进行对应的属性的装配。

创建自动化配置类

自动配置类就是一个普通的java类,通过不同的注解来对其赋予不同的功能。其中最核心的当然是@Configuration注解。

@Configuration
@ConditionalOnClass(MsgService.class)
@EnableConfigurationProperties(MsgProperties.class)
public class MsgAutoConfiguration {
  /**
   * 注入属性配置类
   */
  @Resource
  private MsgProperties msgProperties;
  @Bean
  @ConditionalOnMissingBean(MsgService.class)
  @ConditionalOnProperty(prefix = "msg", value = "enabled", havingValue = "true")
  public MsgService msgService() {
    MsgService msgService = new MsgService(msgProperties.getUrl(), msgProperties.getAccessKeyId(),
        msgProperties.getAccessKeySecret());
    // 如果提供了其他set方法,在此也可以调用对应方法对其进行相应的设置或初始化。
    return msgService;
  }
}

MsgAutoConfiguration类上的注解,@Configuration用来声明该类为一个配置类;@ConditionalOnClass注解说明只有当MsgService类存在于classpath中时才会进行相应的实例化;@EnableConfigurationProperties将application.properties中对应的属性配置设置于MsgProperties对象中;


msgService方法上的注解,@Bean表明该方法实例化的对象会被加载到容器当中;@ConditionalOnMissingBean指明当容器中不存在MsgService的对象时再进行实例化;@ConditionalOnProperty指定了配置文件中msg.enabled=true时才进行相应的实例化。


添加spring.factories

当所有的基础代码和自动配置类都准备完成,就需要对其进行注册。也就是我们熟悉的META-INF/spring.factories配置文件了。当然,这个需要在自己的项目中进行创建。


org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

com.secbro2.msg.MsgAutoConfiguration

1

2

在spring.factories配置文件中注册MsgAutoConfiguration类。如果有多个自动配置类,用逗号分隔换行即可。


至此,一个基于Spring Boot的自动配置starter便完成了。使用“maven:install”将其打包到本地maven仓库或上传至私服。其他项目便可以通过maven依赖使用。


starter项目使用

在其他项目中,通过以下依赖引入该依赖。


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

然后在当前项目的application.properties中配置对应的参数:

msg.enabled=true
msg.url=127.0.0.1
msg.accessKeyId=10001
msg.accessKeySecret=afelwjfwfwef

比如其他项目同样是Spring Boot项目,则可定义一个简单的Controller来进行测试。

@RestController
public class HelloWorldController {
  @Resource
  private MsgService msgService;
  @RequestMapping("/sendMsg")
  public String sendMsg(){
    msgService.sendMsg("测试消息");
    return "";
  }
}

当通过浏览器访问:http://localhost:8080/sendMsg时,便会打印出如下日志:


Http请求,url=127.0.0.1;accessKeyId=10001;accessKeySecret=afelwjfwfwef;msg=测试消息

1

说明MsgService对象被自动配置,并且测试通过。


而针对短信发送这样的starter,可以进行进一步拓展,实现短信发送的各种基础功能,而当其他项目需要时只用引入对应的依赖,并配置具体的参数即可马上使用,是不是非常方便?


总结下Starter的工作流程:


Spring Boot在启动时扫描项目所依赖的JAR包,寻找包含spring.factories文件的JAR包;

根据spring.factories配置加载AutoConfiguration类;

根据@Conditional注解的条件,进行自动配置并将Bean注入Spring容器。



目录
相关文章
|
8天前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起,Spring Boot作为一种快速开发框架,因其简化了Spring应用的初始搭建和开发过程,受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一,大大减少了手动配置的工作量,提高了开发效率。
28 0
|
1月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
46 4
|
1月前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
38 0
|
13天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
26 2
 SpringBoot入门(7)- 配置热部署devtools工具
|
3天前
|
存储 前端开发 JavaScript
springboot中路径默认配置与重定向/转发所存在的域对象
Spring Boot 提供了简便的路径默认配置和强大的重定向/转发机制,通过合理使用这些功能,可以实现灵活的请求处理和数据传递。理解并掌握不同域对象的生命周期和使用场景,是构建高效、健壮 Web 应用的关键。通过上述详细介绍和示例,相信读者能够更好地应用这些知识,优化自己的 Spring Boot 应用。
12 3
|
11天前
|
Java 数据库连接
SpringBoot配置多数据源实战
第四届光学与机器视觉国际学术会议(ICOMV 2025) 2025 4th International Conference on Optics and Machine Vision
40 8
|
9天前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项,在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件,可以确保应用程序在启动阶段加载正确的配置,并顺利启动运行。
17 2
|
20天前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
43 3
|
1月前
|
druid Java Maven
|
1月前
|
监控 Java Maven
springboot学习二:springboot 初创建 web 项目、修改banner、热部署插件、切换运行环境、springboot参数配置,打包项目并测试成功
这篇文章介绍了如何快速创建Spring Boot项目,包括项目的初始化、结构、打包部署、修改启动Banner、热部署、环境切换和参数配置等基础操作。
136 0
下一篇
无影云桌面