文章目录
一、什么是SpringBoot Starter
SpringBoot中的starter是一种非常重要的机制(自动化配置),能简化繁杂的配置,将其统一集成进starter,使用者只需要在maven中引入starter依赖,
SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理以及需要配置各种信息的困扰。
SpringBoot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。
SpringBoot提供了针对日常应用研发各种场景的spring-boot-starter依赖模块。(mybatis、redis等)所有这些依赖模块遵循“约定大于配置”的理念。
二、SpringBoot Starter的应用场景
2.1 复用方式
在日常开发过程中,我们如果需要开发一个通用模块,以供其他模块使用。可以采用以下两种方式:
1.将通用模块的代码拷贝到本项目中------非常麻烦,需要适配非常多的东西:比如添加通用模块的依赖,修改包路径等。
2.把我们的通用模块封装成一个个starter,这样其它工程复用的时候只需要在pom中引用依赖即可,由SpringBoot为我们完成自动装配。
2.2 应用场景
1.通用模块-短信发送模块
2.基于AOP技术实现日志切面
3.微服务项目的数据库连接池配置
三、 自定义Starter的实现步骤
1.创建Starter项目(spring-initl 2.1.14)
2.编写配置类,用于创建一个客户端Bean对象
3.编写Starter项目的业务功能
4.编写spring.factories文件加载自动配置类
5.打包到本地仓库或者发布到远程仓库
6.其它项目引用
案例一、自定义Starter:通过API签名认证获取随机文本功能
1.创建Starter项目
<!--true:表示两个项目之间依赖不传递;不设置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>
注意:引入相关依赖spring-boot-configuration-processor、spring-boot-autoconfigure等,用于开启自动导入以及配置文件的编辑提示.
2.编写配置类,用于创建一个客户端Bean对象
2.1 @Configuraiton:告诉Spring这是一个关于配置的类
2.2 @ConfigurationProperties("xx.xx"):能够读取application.yml中的配置,并将读取到的配置设置到当前配置类中的属性.
2.3 @ComponentScan:自动扫描组件,使得Spring能够自动注册相应的bean
/**
* SDK配置类
*
* @author: trainee
* @since: 2024/4/9 0009 22:16
*/
@Configuration
@ConfigurationProperties("trainee.sdk")
@Data
@ComponentScan
public class ApiSdkConfig {
private String accessKey;
private String secretKey;
@Bean
public SdkClient getSdkClient() {
return new SdkClient(accessKey,secretKey);
}
}
3.编写Starter项目的业务功能
package com.wzh.api.traineeapisdk.client;
import cn.hutool.core.util.RandomUtil;
import cn.hutool.http.HttpRequest;
import com.wzh.api.traineeapisdk.utils.SignUtil;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import java.util.HashMap;
import java.util.Map;
/**
* 第三方客户端接口,提供给开发者调用.
*
* @author: trainee
* @since: 2024/4/9 0009 22:22
*/
@Data
@Slf4j
public class SdkClient {
private String accessKey;
private String secretKey;
public SdkClient(String accessKey, String secretKey) {
this.accessKey = accessKey;
this.secretKey = secretKey;
}
/**
* 执行业务-获取随机文本
*
* @return String 随机文本
*/
public String getRandomWork() {
return HttpRequest.get("http://localhost:8090/api/interface/random/word")
.addHeaders(getHeadMap("", accessKey, secretKey))
.execute().body();
}
/**
* 负责将数字签名的相关参数填入请求头中
*
* @param body
* @param accessKey
* @param secretKey
* @return
*/
protected static Map<String, String> getHeadMap(String body, String accessKey, String secretKey) {
//六个参数
Map<String, String> headMap = new HashMap<>();
headMap.put("accessKey", accessKey);
headMap.put("body", body);
headMap.put("sign", SignUtil.getSign(body, secretKey));
headMap.put("nonce", RandomUtil.randomNumbers(5));
//当下时间/1000,时间戳大概10位
headMap.put("timestamp", String.valueOf(System.currentTimeMillis() / 1000));
return headMap;
}
}
// 获取签名
public class SignUtil {
/**
* 获取签名值
*
* @param body 请求体
* @param secretKey 秘钥
* @return 签名值
*/
public static String getSign(String body, String secretKey) {
return DigestUtil.sha256Hex(body + "." + secretKey);
}
}
4.编写spring.factories文件加载自动配置类
1.在resources下新建META-INF文件夹,然后创建spring.factories文件
2.在该文件中加入如下配置,该配置指定上步骤中定义的配置类为自动装配的配置
org.springframework.boot.autoconfigure.=com.wzh.api.traineeapisdk.ApiSdkConfig
5.打包到本地仓库或者发布到远程仓库
6.在其它项目中应用
1.引入pom依赖
<dependency>
<groupId>com.wzh.api</groupId>
<artifactId>trainee-api-sdk</artifactId>
<version>0.0.1</version>
</dependency>
2.在application.yml文件中添加配置
trainee:
sdk:
access-key: wzh
secret-key: 123456