SpringBoot starter机制与自定义starter的开发流程

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: SpringBoot中的starter是一种非常重要的机制(自动化配置),能够抛弃以前繁杂的配置,将其统一集成进starter, 应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。 starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean, 并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。 所有这些依赖模块都遵循着约定成俗的默认配置,并允许
  1. 项目模块
    zzcloud-spring-boot-starter(1.1.14)
  2. 什么是SpringBoot starter机制
    SpringBoot中的starter是一种非常重要的机制(自动化配置),能够抛弃以前繁杂的配置,将其统一集成进starter,
    应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。
    starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean,
    并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。
    所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。
  3. 为什么要自定义starter
    在我们的日常开发工作中,经常会有一些独立于业务之外的配置模块,我们经常将其放到一个特定的包下,
    然后如果另一个工程需要复用这块功能的时候,需要将代码硬拷贝到另一个工程,重新集成一遍,麻烦至极。
    如果我们将这些可独立于业务代码之外的功能配置模块封装成一个个starter,复用的时候只需要将其在pom中引用依赖即可,
    SpringBoot为我们完成自动装配,简直不要太爽
  4. 什么时候需要创建自定义starter
    在我们的日常开发工作中,可能会需要开发一个通用模块,以供其它工程复用。SpringBoot就为我们提供这样的功能机制,
    我们可以把我们的通用模块封装成一个个starter,这样其它工程复用的时候只需要在pom中引用依赖即可,
    由SpringBoot为我们完成自动装配。

    常见场景:
    1.通用模块-短信发送模块
    2.基于AOP技术实现日志切面

    3.分布式雪花ID,Long-->string,解决精度问题
    jackson2/fastjson

    4.微服务项目的数据库连接池配置
    5.微服务项目的每个模块都要访问redis数据库,每个模块都要配置redisTemplate
    也可以通过starter解决

  5. 自动加载核心注解说明
    详情见:images/01 自动加载核心注解说明.png

为短信发送功能创建一个starter

    • 自定义starter的开发流程

    1.创建Starter项目(spring-initl 2.1.14)
    2.定义Starter需要的配置类(Properties)
    3.编写Starter项目的业务功能
    4.编写自动配置类
    5.编写spring.factories文件加载自动配置类
    6.打包安装
    7.其它项目引用

1.创建Starter项目

 starter项目和SpringBoot工程结构没有什么区别,下面就把一些特殊的要求罗列一下
 1.命名规范
   SpringBoot官方命名方式
   格式:spring-boot-starter-{模块名}
   举例:spring-boot-starter-web
   自定义命名方式
   格式:{模块名}-spring-boot-starter
   举例:mystarter-spring-boot-starter
 2.必须引入的依赖
   <!--表示两个项目之间依赖不传递;不设置optional或者optional是false,表示传递依赖-->
   <!--例如:project1依赖a.jar(optional=true),project2依赖project1,则project2不依赖a.jar-->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-configuration-processor</artifactId>
       <optional>true</optional>
   </dependency>       

2.编写相关属性类(XxxProperties):SmsProperties.java

 1.@ConfigurationProperties注解基本用法
   前缀定义了哪些外部属性将绑定到类的字段上
   根据 Spring Boot 宽松的绑定规则,类的属性名称必须与外部属性的名称匹配
   我们可以简单地用一个值初始化一个字段来定义一个默认值
   类本身可以是包私有的
   类的字段必须有公共 setter 方法   

 注意:SmsProperties代码写完后会报如下错误,这是正常的,因为
       还有配置类AutoConfig和一个注解@EnableConfigurationProperties没有加
       Not registered via @EnableConfigurationProperties or marked as Spring component

3.编写Starter项目的业务功能

 ISmsService和SmsServiceImpl
  

4.编写自动配置类AutoConfig

1. @Configuration:
   定义一个配置类
2. @EnableConfigurationProperties:
   @EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。
   如果只配置@ConfigurationProperties注解,在IOC容器中是获取不到properties配置文件转化的bean的
               

5.编写spring.factories文件加载自动配置类

 1.在resources下新建META-INF文件夹,然后创建spring.factories文件
 2.在该文件中加入如下配置,该配置指定上步骤中定义的配置类为自动装配的配置
   org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zking.zzcloudspringbootstarter.config.AutoConfig

   注1:其中AutoConfig是starter配置文件的类限定名,多个之间逗号分割,还可以\进行转义即相当于去掉后面换行和空格符号  
        # Auto Configure
        org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
          com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration,\
          com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration 

6.打包安装

 打包时需要注意一下,SpringBoot项目打包的JAR是可执行JAR,它的类放在BOOT-INF目录下,
 如果直接作为其他项目的依赖,会找不到类。可以通过修改pom文件来解决,代码如下:
 <plugin>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-maven-plugin</artifactId>
     <configuration>
         <classifier>exec</classifier>
     </configuration>
 </plugin>

7.其它项目引用

  1. 案例二:AOP方式统一服务日志
    原先实现统一日志都是放到每个工程中以AOP方式实现,现在有了starter方式,就可以将公司的日志规范集中到这里来统一管理。

    @ConditionalOnProperty(prefix = "zzcloud.weblog",value = "enabled", matchIfMissing = true)
    //matchIfMissing属性:默认情况下matchIfMissing为false,也就是说如果未进行属性配置,则自动配置不生效。如果matchIfMissing为true,则表示如果没有对应的属性配置,则自动配置默认生效

    配置属性a:
    1:不配置a
    matchifmissing=false 不满足 matchifmissing=true 满足
    2:配置a=false
    matchifmissing=false 不满足 matchifmissing=true 不满足
    3:配置a=true
    matchifmissing=false 满足 matchifmissing=true 满足

    @ConditionalOnMissingBean
    详见《附录三》

  1. 案例三:统一处理Long类型id的

附录一:自定义springboot-starter的应用场景

  1. 我们公司采用微服务架构,每个服务都会使用swagger来生成在线接口文档。未封装swagger-starter之前,
    那么在每个服务里边,都需要增加swagger的配置类。而封装swagger-starter之后,可以省去这一步的操作,
    还可以通过增加自定义配置来实现一些自定义的功能。

附录二:ConditionalOnProperty配置Spring Boot通过@ConditionalOnProperty来控制Configuration是否生效
1、matchIfMissing属性:从application.properties中读取某个属性值,如果该值为空,默认值为true
@Configuration
@ConditionalOnClass({ Feign.class })
@ConditionalOnProperty(value = "feign.oauth2.enabled", matchIfMissing = true)
public class OAuth2FeignAutoConfiguration {

@Bean
@ConditionalOnBean(OAuth2ClientContext.class)
public RequestInterceptor oauth2FeignRequestInterceptor(OAuth2ClientContext oauth2ClientContext) {
    return new OAuth2FeignRequestInterceptor(oauth2ClientContext);
}

}

2、havingValue属性:通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值,如果该值为空,则返回false;如果值不为空,则将该值与havingValue指定的值进行比较,如果一样则返回true;否则返回false。如果返回值为false,则该configuration不生效;为true则生效。
@Configuration
//如果synchronize在配置文件中并且值为true
@ConditionalOnProperty(name = "synchronize", havingValue = "true")
public class SecondDatasourceConfig {

@Bean(name = "SecondDataSource")
@Qualifier("SecondDataSource")
@ConfigurationProperties(prefix = "spring.second.datasource")
public DataSource jwcDataSource() {
    return DataSourceBuilder.create().build();
}

}

附录三:@ConditionalOnMissingBean
如果存在它修饰的类的bean,则不需要再创建这个bean;该注解只能在@Bean 注释的方法上使用,不能再@Component 注释的类上使用。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
11月前
|
并行计算 Java 数据处理
SpringBoot高级并发实践:自定义线程池与@Async异步调用深度解析
SpringBoot高级并发实践:自定义线程池与@Async异步调用深度解析
748 0
|
12月前
|
SQL 监控 druid
springboot-druid数据源的配置方式及配置后台监控-自定义和导入stater(推荐-简单方便使用)两种方式配置druid数据源
这篇文章介绍了如何在Spring Boot项目中配置和监控Druid数据源,包括自定义配置和使用Spring Boot Starter两种方法。
|
11月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
776 2
|
7月前
|
Java Maven 开发者
编写SpringBoot的自定义starter包
通过本文的介绍,我们详细讲解了如何创建一个Spring Boot自定义Starter包,包括自动配置类、配置属性类、`spring.factories`文件的创建和配置。通过自定义Starter,可以有效地复用公共配置和组件,提高开发效率。希望本文能帮助您更好地理解和应用Spring Boot自定义Starter,在实际项目中灵活使用这一强大的功能。
534 17
|
6月前
|
JSON Java 数据格式
微服务——SpringBoot使用归纳——Spring Boot中的全局异常处理——拦截自定义异常
本文介绍了在实际项目中如何拦截自定义异常。首先,通过定义异常信息枚举类 `BusinessMsgEnum`,统一管理业务异常的代码和消息。接着,创建自定义业务异常类 `BusinessErrorException`,并在其构造方法中传入枚举类以实现异常信息的封装。最后,利用 `GlobalExceptionHandler` 拦截并处理自定义异常,返回标准的 JSON 响应格式。文章还提供了示例代码和测试方法,展示了全局异常处理在 Spring Boot 项目中的应用价值。
274 0
|
9月前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
1459 15
|
11月前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
10月前
|
安全 Java 应用服务中间件
如何将Spring Boot应用程序运行到自定义端口
如何将Spring Boot应用程序运行到自定义端口
679 0
|
11月前
|
缓存 NoSQL Java
Springboot自定义注解+aop实现redis自动清除缓存功能
通过上述步骤,我们不仅实现了一个高度灵活的缓存管理机制,还保证了代码的整洁与可维护性。自定义注解与AOP的结合,让缓存清除逻辑与业务逻辑分离,便于未来的扩展和修改。这种设计模式非常适合需要频繁更新缓存的应用场景,大大提高了开发效率和系统的响应速度。
334 2
|
11月前
|
前端开发 Java 数据库
springBoot:template engine&自定义一个mvc&后端给前端传数据&增删改查 (三)
本文介绍了如何自定义一个 MVC 框架,包括后端向前端传递数据、前后端代理配置、实现增删改查功能以及分页查询。详细展示了代码示例,从配置文件到控制器、服务层和数据访问层的实现,帮助开发者快速理解和应用。
127 0