程序员必看内容连续集之 SpringBoot06 自定义Starter

发布于:2022-11-09 ⋅ 阅读:(9) ⋅ 点赞:(0) ⋅ 评论:(0)

目录

一、SpringBoot starter简介

二、sms短信启动器starter制作

三、sms短信调用启动器starter测试


一、SpringBoot starter简介

1、什么是SpringBoot starter机制

SpringBoot中的starter是一种非常重要的机制(自动化配置),能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。

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

SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。

2、为什么要自定义starter

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

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

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

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

二、sms短信启动器starter制作

1、自定义starter的开发流程

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

接下来我们自定义一个sms短信的starter

 第①步:创建Starter项目(spring-initl 2.1.14)

        注意要点:

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>

 第②步:定义Starter需要的配置类

smsspringbootstarter:

package com.zq.smsspringbootstarter.properties;

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

/**
 * @author zq
 * @site www.zq.com
 *
 * 短信发送时,一般要提供短信账户凭证
 * spring:
 *     application:
 *         name: sms-spring-boot-starter
 *
 *  当需要使用自定义sms的模块时,在yml文件中进行配置
 *  spboot:
 *  *     sms:
 *  *         xxx: sms-spring-boot-starter
 *
 *  ConfigurationProperties默认是会报错的,然后需要在starter项目配置类中进行解决
 */
@ConfigurationProperties(prefix = "spboot.sms")
public class SmsProperties {
    private String accessKeyId;//短信发送接口的账号
    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;
    }
}

第③步:编写Starter项目的业务功能 

 

 Smsservice:

package com.zq.smsspringbootstarter.service;

/**
 * @author zq
 * @site www.zq.com
 */
public interface SmsService {
    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

  SmsserviceImpl:

package com.zq.smsspringbootstarter.service;

/**
 * 接入阿里短信接口的业务类
 */
public class SmsServiceImpl implements SmsService {

    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);
    }
}

第④步:编写自动配置类

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

SmsAutoConfig:

package com.zq.smsspringbootstarter.config;

import com.zq.smsspringbootstarter.properties.SmsProperties;
import com.zq.smsspringbootstarter.service.SmsService;
import com.zq.smsspringbootstarter.service.SmsServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author zq
 * @site www.zq.com
 */
@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {
    @Autowired
    private SmsProperties smsProperties;
//    将短信发送的业务类交给Spring容器进行管理
    @Bean
    public SmsService smsService(){
        return new SmsServiceImpl(smsProperties.getAccessKeyId()
                ,smsProperties.getAccessKeySecret());
    }
}

第⑤步:编写spring.factories文件加载自动配置类

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

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

spring.factories:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zq.smsspringbootstarter.config.SmsAutoConfig

第⑥步:打包安装

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

<packaging>jar</packaging>

<classifier>exec</classifier>

 做完这六步那么我们自定义Starter就创建完成了,我们现在使用另外一个项目进行测试,我们自定义的这个自定义starter是否能够使用。 

三、sms短信调用启动器starter测试

我们在这里创建一个springboot项目加入我们自定义的stater进行测试:

测试:

第①步:构建项目测试用的spboot项目,勾选组件lombok以及spring-boot-starter-web


第②步:添加自定义starter依赖如下

<!--     导入短信发自定义starter的启动器(根据自动信息来修改)   -->
        <dependency>
            <groupId>com.zq</groupId>
            <artifactId>sms-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

第③步:配置yml文件

server:
    port: 8080
spring:
    application:
        name: startertext
spboot:
    ssm:
        acces-key-id: zq
        acces-key-secret: 123456

第④步:编写测试类

SmsController:

package com.zq.startertext.controller;

import com.zq.smsspringbootstarter.service.SmsService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author zq
 * @company www.zq.com
 */
@RestController
public class SmsController {

    @Autowired
    public SmsService smsService;

    @RequestMapping("/sms/send")
    public String send(){
        smsService.send("17275320054","签名","336609","你好,短信启动器创建成功");

        return "text succes";
    }

}

第五步:启动项目测试

 OK出现结果说明我们的自定义Starter是能够使用滴