SpringBoot自定义starter

鑫品

已于 2024-08-06 16:31:08 修改

阅读量660

点赞数 1

于 2022-02-28 16:52:53 首次发布

本文链接：https://blog.csdn.net/andrew_dear/article/details/123186585

版权

0. 项目模块

zzcloud-spring-boot-starter(1.1.14)

1. 什么是SpringBoot starter机制

SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，

应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。

starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，

并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。

所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

2. 为什么要自定义starter

在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定的包下，

然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，麻烦至极。

如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter，复用的时候只需要将其在pom中引用依赖即可，

SpringBoot为我们完成自动装配，简直不要太爽

3. 什么时候需要创建自定义starter

在我们的日常开发工作中，可能会需要开发一个通用模块，以供其它工程复用。SpringBoot就为我们提供这样的功能机制，

我们可以把我们的通用模块封装成一个个starter，这样其它工程复用的时候只需要在pom中引用依赖即可，

由SpringBoot为我们完成自动装配。

常见场景：

1.通用模块-短信发送模块

2.基于AOP技术实现日志切面

3.分布式雪花ID，Long-->string，解决精度问题

4.微服务项目的数据库连接池配置

5.微服务项目的每个模块都要访问redis数据库，每个模块都要配置redisTemplate

也可以通过starter解决

4. 自动加载核心注解说明

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

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

5. 自定义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.必须引入的依赖



       

       <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.其它项目引用

6. 案例二：AOP方式统一服务日志

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

7. 案例三：统一处理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();

    }

}