SpringBoot starter的理解与使用

目录

一、什么是SpringBoot starter机制？

二、为什么要自定义starter？

三、什么时候需要创建自定义starter

四、自动加载核心注解说明

五、自定义starter的开发流程

5.1 创建Starter项目（）

5.1.1 命名规范

5.1.2 必须引入的依赖

5.2.编写相关属性类(SmsProperties.java)：

5.3 编写Starter项目的业务功能 

5.4 编写自动配置类AutoConfig(SmsAutoConfig)

5.4.1 @Configuration：

5.4.2 @EnableConfigurationProperties：

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

 5.5.1 在resources下新建META-INF文件夹，然后创建spring.factories文件

 5.5.2 在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置

5.6 打包安装

5.7 其它项目引用

5.7.1 首先在其他项目的pom.xnml中引入依赖

5.7.2 在application.yml文件中添加配置

---

一、什么是SpringBoot starter机制？

  SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。
   starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。
   所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

二、为什么要自定义starter？

 在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，麻烦至极。 如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter，复用的时候只需要将其在pom中引用依赖即可，SpringBoot为我们完成自动装配，简直不要太爽。
 

三、什么时候需要创建自定义starter

在我们的日常开发工作中，可能会需要开发一个通用模块，以供其它工程复用。SpringBoot就为我们提供这样的功能机制，我们可以把我们的通用模块封装成一个个starter，这样其它工程复用的时候只需要在pom中引用依赖即可，由SpringBoot为我们完成自动装配。

举一些常见场景：

1. 通用模块-短信发送模块
2. 基于AOP技术实现日志切面
3. 分布式雪花ID，Long-->string，解决精度问题 jackson2/fastjson     
4. 微服务项目的数据库连接池配置
5. 微服务项目的每个模块都要访问redis数据库，每个模块都要配置redisTemplate

四、自动加载核心注解说明

五、自定义starter的开发流程

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

5.1 创建Starter项目（）

starter项目和SpringBoot工程结构没有什么区别，下面就把一些特殊的要求罗列一下

5.1.1 命名规范

SpringBoot官方命名方式
格式：spring-boot-starter-{模块名}
举例：spring-boot-starter-web
自定义命名方式
格式：{模块名}-spring-boot-starter
举例：mystarter-spring-boot-starter

界面不同就是IDEA版本原因

5.1.2 必须引入的依赖

由于的这里只做个案例给大家看，就只需要添加这几项就好了....

勾上图上的开发工具会自动导入spring-boot-configuration-processor依赖

       
       
           org.springframework.boot
           spring-boot-configuration-processor
           true
              

 5.2.编写相关属性类(SmsProperties.java)：

package com.zking.zzcloudspringbootstarter.sms;

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

@ConfigurationProperties("zzcloud.sms")
public class SmsProperties {

    private String accessKeyId;//访问ID、即帐号
    private String accessKeySecret;//访问凭证，即密码

    public String getAccessKeyId() {
        return accessKeyId;
    }

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public String getAccessKeySecret() {
        return accessKeySecret;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }
}

@ConfigurationProperties注解基本用法

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

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

5.3 编写Starter项目的业务功能 

 ISmsService和SmsServiceImp

ISmsService代码如下：

package com.zking.zzcloudspringbootstarter.sms;

public interface ISmsService {

    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

SmsServiceImp代码如下：

package com.zking.zzcloudspringbootstarter.sms;


import com.zking.zzcloudspringbootstarter.sms.ISmsService;

public class SmsServiceImpl implements ISmsService {

    private String accessKeyId;//访问ID、即帐号
    private String accessKeySecret;//访问凭证，即密码

    public SmsServiceImpl(String accessKeyId, String accessKeySecret) {
        this.accessKeyId = accessKeyId;
        this.accessKeySecret = accessKeySecret;
    }

    @Override
    public void send(String phone, String signName, String templateCode, String data) {
        System.out.println("接入短信系统，accessKeyId=" + accessKeyId + ",accessKeySecret=" + accessKeySecret);
        System.out.println("短信发送，phone=" + phone + ",signName=" + signName + ",templateCode=" + templateCode + ",data=" + data);
    }
}

  5.4 编写自动配置类AutoConfig(SmsAutoConfig)

SmsAutoConfig代码如下：

package com.zking.zzcloudspringbootstarter.config;

import com.zking.zzcloudspringbootstarter.sms.SmsProperties;
import com.zking.zzcloudspringbootstarter.sms.SmsServiceImpl;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.annotation.Resource;

@Configuration //表示该类为配置类
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {

    @Resource
    private SmsProperties smsProperties;


    @Bean
    public SmsServiceImpl smsServiceImpl(){
        return new SmsServiceImpl(smsProperties.getAccessKeyId(),smsProperties.getAccessKeySecret());
    }


}

5.4.1 @Configuration：

定义一个配置类

5.4.2 @EnableConfigurationProperties：

@EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。
如果只配置@ConfigurationProperties注解，在IOC容器中是获取不到properties配置文件转化的bean的

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

 5.5.1 在resources下新建META-INF文件夹，然后创建spring.factories文件

 5.5.2 在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置

代码如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.zking.zzcloudspringbootstarter.config.SmsAutoConfig,\
  

注意：其中AutoConfig是starter配置文件的类限定名，多个之间逗号分割，还可以\进行转义即相当于去掉后面换行和空格符号  

5.6 打包安装

 打包时需要注意一下，SpringBoot项目打包的JAR是可执行JAR，它的类放在BOOT-INF目录下，如果直接作为其他项目的依赖，会找不到类。可以通过修改pom文件来解决，代码如下：

     org.springframework.boot
     spring-boot-maven-plugin
     
         exec
     

如何打包：

打包成功可以在本地仓库看见

5.7 其它项目引用

5.7.1 首先在其他项目的pom.xnml中引入依赖

  5.7.2 在application.yml文件中添加配置

 然后我们可以写一个测试类来测试一下

 END

以上就是SpringBoot中使用starter的完整流程，可以看到我们是可以在其他项目中可以看到我们想要是功能的。

声明：学习记录，若有问题，欢迎评论

作者：借我丹青妙笔