如何去开发一个springboot starter

如何去开发一个springboot starter

我们在平时用 Java 开发的时候，在 pom.xml 文件中引入一个依赖就可以很方便的使用了，但是你们知道这是如何实现的吗。

现在我们就来解决这一个问题！

创建 SpringBoot 项目

首先我们要做的就是把你想要给别人方便使用的内容自己的写好

我这里直接另外创建了一个 springboot 的 web 项目，在这个 web 项目中我用 controller 写了几个简单的接口，用于后面的调用，然后再创建一个 springboot 项目，这个新的 springboot 项目就是用来开发 starter 的方便使用者更好、更方便使用。

现在是具体流程：

springboot 的 web 项目创建

用 IDEA 快速创建一个 springboot 项目，创建方法如下：

  1. 选择 spring Initializer
  2. 自己写一个项目的名称
  3. 语言选择 Java
  4. 包管理工具选择 Maven
  5. 组这个可以自己写 例如我的昵称 xwhking 就可以写 com.xwkhing
  6. jdk 选择1.8
  7. Java 选择8
  8. 然后就是下一步

在这里插入图片描述

进入下一步后

  1. 选择 springboot 的版本，我一般选择2.7左右的

  2. 然后选择开发工具

    1. Spring Boot Devtools
    2. Spring COnfiguration Processor 主要用于后面我们在工程中使用的使用在 yml 中写配置时能够自动提示配置
    3. Lombok 通过使用 annotation 快速的生成主要的 getter 和 setter
    4. Spring Web 加上也没事
      在这里插入图片描述

  3. 然后就是创建了。

创建好了以后就进入写代码环节，写一个简单的 web 请求的 Demo

我这里的目录结构如下：

在这里插入图片描述

UserController的代码如下：
package com.xwhking.interface_test.controller;import com.xwhking.interface_test.entity.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;
import java.util.Date;import static com.xwhking.interface_test.utils.GenSign.genSign;@RestController
@RequestMapping("/user")
public class UserController {@GetMapping("/name")public String getName(@RequestParam String name , HttpServletRequest request){System.out.println("请求参数名字为 ： " + name);return "GET 请求参数名字为 ： " + name;}@GetMapping("/getOne")public User getUser(HttpServletRequest request){User user = new User();user.setId(123l);user.setUsername("xwhking");user.setPassword("admin123");System.out.println(user);return user ;}
}
User代码
package com.xwhking.interface_test.entity;import lombok.Data;@Data
public class User {private Long id;private String username;private String password;@Overridepublic String toString(){return "User { " +"id: " + id + "," +"name:" + username + ","+"password: " + password + "}";}
}

这些完成以后就可以启动这一个项目了。

可以用浏览器试试

在这里插入图片描述

starter开发

以同样的方式创建一个springboot项目，需要特别注意的就是，我们需要把 pom.xml 文件中的 build 部分代码全部去掉。

pom.xml 文件

注意这里引入了 Hutool 工具库，用于后面开发，并且文件里面是没有 build 模块的，这里还需要注意把版本的snapshot去掉

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.10</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.xwhking</groupId><artifactId>InterfaceStarter</artifactId><version>0.0.1</version><name>InterfaceStarter</name><description>InterfaceStarter</description><properties><java.version>8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>5.8.16</version></dependency></dependencies>
</project>
目录结构
  1. client 目录 这里就是真正使用的类，对对应的功能进行了封装。
  2. config 目录 这里对 client 进行配置，并且把 client 包装成一个 Bean 返回
  3. utils 工具类，这里用来生成签名的工具
  4. META-INF.spring.factories 这个非常重要，用于别人调用的时候，在写配置的之后能够进行提示与自动装配

在这里插入图片描述

client 代码
package com.xwhking.interfacestarter.client;import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpUtil;
import lombok.Data;import java.time.LocalDateTime;
import java.util.Date;
import java.util.HashMap;import static com.xwhking.interfacestarter.utils.GenSign.genSign;/*** 发起请求时候一定要注意，不要把secretKey直接传送，只需要进行一个签名传送就好了，然后后端通过同样的方式进行签名* 的生成，进行对比，验证身份。*/
@Data
public class XWHKINGClient {private String accessKey;private String secretKey;private Long userId;public XWHKINGClient(String accessKey,String secretKey,Long userId){this.userId = userId;this.accessKey = accessKey;this.secretKey = secretKey;}public String getName(String name){//可以单独传入http参数，这样参数会自动做URL编码，拼接在URL中HashMap<String, Object> paramMap = new HashMap<>();paramMap.put("name", name);HashMap<String,String> headerMap = new HashMap<>();headerMap.put("accessKey",accessKey);headerMap.put("userId",userId.toString());headerMap.put("sign", genSign(accessKey,secretKey,userId));headerMap.put("timestamp",Long.toString(new Date().getTime()));String result1= HttpRequest.get("http://localhost:8080/user/name").addHeaders(headerMap).form(paramMap).execute().body();System.out.println(result1);return result1;}public String GetUser(){HashMap<String,String> headerMap = new HashMap<>();headerMap.put("accessKey",accessKey);headerMap.put("userId",userId.toString());headerMap.put("sign", genSign(accessKey,secretKey,userId));headerMap.put("timestamp",Long.toString(new Date().getTime()));String result1= HttpRequest.get("http://localhost:8080/user/getOne").addHeaders(headerMap).execute().body();System.out.println(result1);return result1;}public static void main(String[] args) {new XWHKINGClient("xwhking","admin123",123123l).getName("XWHKING");}
}

这里都加了请求头，加请求头的目的是为了，进行签名认证。

为什么要进行签名认证
  1. 保证安全性，一个人不能随便调用，如果随便调用的话，自己的服务器资源会收到压迫，以及资源的损失。
  2. 适用于无需保存登录态。只认签名，不关注用户登录态。
如何进行签名认证

通过 http request header 头传递参数

这里主要传递的参数

  • accessKey： 调用的标识， 需要复杂、 无序、无规律，这里我没有实现，只是简单的模拟，如果需要实现的话可以使用现成的签名实现工具包，例如 hutool
  • secretKey： 调用的密钥，需要复杂、 无序、无规律，该参数一定一定不能放到请求头中，不然可能会被别人抓包，以及可能造成泄露。
  • 用户请求的参数
  • sign： 签名，由 accessKey 和 secretKey 以及 userId 等信息生成，用于传递信息。然后后端通过同样的方式进行生成对比验证权限。
  • 上述问题满足了，可能还抵挡不了别人的攻击，例如别人用重放就可以再次调用 API 了，限制重放的方法：
    • 加随机数，只能使用一次，服务端要保存使用过的随机数
    • 加 timestamp 时间戳，检验时间戳是否过期，我这里就是通过时间戳，超过10s就失效。
对web中的UserController进行更新

更新就是为了校验，然后如果更新了，项目记得重启

package com.xwhking.interface_test.controller;import com.xwhking.interface_test.entity.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;
import java.util.Date;import static com.xwhking.interface_test.utils.GenSign.genSign;@RestController
@RequestMapping("/user")
public class UserController {/*** 校验签名，以及其他信息，注意这里的 secretKey 是模拟的一般用户的 secretKey 是需要去从数据库取出来，* 然后进行验证。* @param request*/private void verifyRequest(HttpServletRequest request){String sign = request.getHeader("sign");String accessKey = request.getHeader("accessKey");String secretKey = "admin123";String userId = request.getHeader("userId");String requestTime = request.getHeader("timestamp");long oldTime = Long.parseLong(requestTime);long newTime = new Date().getTime();if(newTime - oldTime > 10000){throw new RuntimeException("检测到请求异常");}String newSign = genSign(accessKey,secretKey,Long.parseLong(userId));if(!newSign.equals(sign)){throw new RuntimeException("签名错误");}}@GetMapping("/name")public String getName(@RequestParam String name , HttpServletRequest request){verifyRequest(request);System.out.println("请求参数名字为 ： " + name);return "GET 请求参数名字为 ： " + name;}@GetMapping("/getOne")public User getUser(HttpServletRequest request){verifyRequest(request);User user = new User();user.setId(123l);user.setUsername("xwhking");user.setPassword("admin123");System.out.println(user);return user ;}
}
config 代码

要注意其中的注解

package com.xwhking.interfacestarter.config;import com.xwhking.interfacestarter.client.XWHKINGClient;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationProperties(prefix = "xwhking.client")
@Data
@ComponentScan
public class XWHKINGClientConfig {private String accessKey;private String secretKey;private String userId;@Beanpublic XWHKINGClient xwhkingClient(){return new XWHKINGClient(accessKey,secretKey,Long.parseLong(userId));}
}
生成签名代码

这里直接使用了 Hutool 工具库中的 sh256 的生成方法

package com.xwhking.interfacestarter.utils;import cn.hutool.crypto.SecureUtil;
import lombok.Data;@Data
public class GenSign {public static String genSign(String accessKey,String secretKey,Long userId){String key = "xwhking" + "." + accessKey + "." + secretKey + "."  + userId;return SecureUtil.sha256(key);}
}
META-INF 中文件的内容

通过看内容就可以看出，你需要把后面的内容进行替换，写入你的地址。

org.springframework.boot.autoconfigure.EnableAutoConfiguration = com.xwhking.interfacestarter.XWHKINGClientConfig

到这里 Starter 就完了，然后使用 maven 进行打包（调用install）。这里的打包会把包直接放入你的 maven 仓库，打包成功就会出现 BUILD SUCCESS

在这里插入图片描述

在其他项目中使用

首先复制这段代码

<groupId>com.xwhking</groupId>
<artifactId>InterfaceStarter</artifactId>
<version>0.0.1</version>

然后在你的其他项目中添加进依赖

<dependency><groupId>com.xwhking</groupId><artifactId>InterfaceStarter</artifactId><version>0.0.1</version>
</dependency>

刷新 maven 仓库

然后再 yml 配置中加入配置

在 config中的prefix 可以设置前缀，也就是可以更改xwhking.client

在这里插入图片描述

然后在你的代码中使用 Test 进行测试

@SpringBootTest
class MainApplicationTests {@Resourceprivate XWHKINGClient xwhkingClient;@Testvoid testClient(){xwhkingClient.getName("xwhking") ;}}

调用结果：

出来了 xwhking 结果成功。

在这里插入图片描述

这样开发一个starter 就结束了

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/160208.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

css3

css3

基础 <!DOCTYPE html> <html><head><meta charset"utf-8"><title>style</title><!-- link&#xff08;外部样式&#xff09;和style&#xff08;内部样式&#xff09;优先级相同&#xff0c;重复写会覆盖 --><link re…
阅读更多...
呜呜呜呜呜呜呜呜呜

呜呜呜呜呜呜呜呜呜

问问吾问无为谓
阅读更多...
面试题-9

面试题-9

1.如何封装一个组件 1.使用Vue.extend()创建一个组件 2.使用Vue.components()方法注册组件 3.如果子组件需要数据,可以在props中接收定义 4.子组件修改好数据,要把数据传递给父组件&#xff0c;可以用emit()方法 原则: 把功能拆开 尽量让组件原子化,一个组件做一件事情 …
阅读更多...
centos7安装MySQL—以MySQL5.7.30为例

centos7安装MySQL—以MySQL5.7.30为例

centos7安装MySQL—以MySQL5.7.30为例 本文以MySQL5.7.30为例。 官网下载 进入MySQL官网&#xff1a;https://www.mysql.com/ 点击DOWNLOADS 点击链接&#xff1b; 点击如上链接&#xff1a; 选择对应版本&#xff1a; 点击下载。 安装 将下载后的安装包上传到/usr/local下…
阅读更多...
CTF靶场搭建及Web赛题制作与终端docker环境部署

CTF靶场搭建及Web赛题制作与终端docker环境部署

♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ ♡ ♥ 写在前面 ╔═══════════════════════════════════════════════════…
阅读更多...
使用ChatGPT创建Makefile构建系统：使用Make运行Docker

使用ChatGPT创建Makefile构建系统：使用Make运行Docker

使用ChatGPT创建Makefile构建系统&#xff1a;使用Make运行Docker 芯语芯愿&#xff08;知乎/纷传/CSDN/&#xff09;&#xff1b;小石头的芯语芯愿&#xff08;微信公众号&#xff09; 开发高效现代的构建系统对于满足开发周期需求至关重要。原先&#xff0c;嵌入式开发者一…
阅读更多...
Unity 场景烘培 ——LensFlare镜头光晕（三）

Unity 场景烘培 ——LensFlare镜头光晕（三）

提示&#xff1a;文章有错误的地方&#xff0c;还望诸位大神指出&#xff01; 文章目录 前言一、镜头光晕 (Lens Flares)是什么&#xff1f;二、使用Lens Flares组件总结 前言 一般情况下都会忽略的东西&#xff0c;镜头光晕。理论上不加镜头光晕&#xff0c;也不会有什么影响…
阅读更多...
vue3的两个提示[Vue warn]: 关于组件渲染和函数外部使用

vue3的两个提示[Vue warn]: 关于组件渲染和函数外部使用

1. [Vue warn]: inject() can only be used inside setup() or functional components. 这个消息是提示我们&#xff0c;需要将引入的方法作为一个变量使用。以vue-store为例&#xff0c;如果我们按照如下的方式使用&#xff1a; import UseUserStore from ../../store/module…
阅读更多...
数据治理之考评环节

数据治理之考评环节

考评的流程&#xff08;批处理&#xff09; 周期调度&#xff0c;每天一次&#xff1a;采集hive, hdfs元数据存放到mysql中的dga库的metainfo表手动通过管理页面补充辅助信息指标考评 读取要考评的表的元数据及辅助信息读取要考评的指标对每张表的每个指标逐个进行考评保存考评…
阅读更多...
RabbitMQ快速入门（简单收发消息）

RabbitMQ快速入门（简单收发消息）

文章目录 前言一、数据隔离1.用户管理2.virtual host 二、控制台收发1.交换机2.队列3.绑定 三、编程式收发1.依赖和配置2.收发信息 总结 前言 1.了解数据隔离 2.RabbitMQ控制台收发信息 3.SpringBoot整合RabbitMQ收发信息 一、数据隔离 1.用户管理 点击Admin选项卡&#xff0…
阅读更多...
mmdet全教程

mmdet全教程

官方给的文档一言难尽&#xff0c;网上的教程又没有从大纲到源码的完整解读&#xff0c;计划年后开个系列记录一下
阅读更多...
依赖库：Ceres-solver-2.0.0安装

依赖库：Ceres-solver-2.0.0安装

依赖库&#xff1a;Ceres-solver-2.0.0安装 前言安装ceres-solver-2.0.0验证 前言 Ceres Solver是谷歌开源的C非线性优化库&#xff0c;能够解决有约束或无约束条件下的非线性最小二乘问题。2010年之后大量的运用在谷歌的产品开发中&#xff0c;尤其在谷歌开源的cartographer中…
阅读更多...
图像分类单张图片预测准确率达到百分之百

图像分类单张图片预测准确率达到百分之百

在图像分类任务中&#xff0c;针对单个图片得到100%的准确率是有可能但极其罕见的&#xff0c;并且不代表模型在整个测试集上也能达到100%的准确率。   针对单个图片获得100%准确率的情况可能包括以下几种情形&#xff1a; 图片本身特殊性: 如果测试集中的某张图片在训练集中…
阅读更多...
【python基础（1）】变量和简单数据类型

【python基础（1）】变量和简单数据类型

文章目录 一. 变量的命名和使用二. 字符串1. 修改字符串的大小写2. 在字符串中使用变量3. 使用制表符或换行符来添加空白4. 删除空白 三. 数1. 整数2. 浮点数3. 整数和浮点数4. 数中的下划线5. 同时给多个变量赋值6. 常量 三. 注释四. Python之禅 一. 变量的命名和使用 变量规…
阅读更多...
各种LLM数据集包括SFT数据集

各种LLM数据集包括SFT数据集

各种LLM数据集包括SFT数据集 数集介绍和 hf上的名字对话数据生成方法交通领域数据集SFT 的解释数集介绍和 hf上的名字 通用预训练数据集 SFT datasets SFT 数据集 50万条中文ChatGPT指令Belle数据集：BelleGroup/train_0.5M_CN 100万条中文ChatGPT指令Belle数据集：BelleGrou…
阅读更多...
C++学习 --stack

C++学习 --stack

目录 1&#xff0c; 什么是stack 2&#xff0c; 创建stack 2-1&#xff0c; 标准数据类型 2-2&#xff0c; 自定义数据类型 2-3&#xff0c; 其他创建方式 3&#xff0c; 操作stack 3-1&#xff0c; 赋值 3-2&#xff0c; 插入元素(push) 3-3&#xff0c; 查询元素 3…
阅读更多...
Linux的简单使用

Linux的简单使用

Linux命令使用技巧 Tab键自动补全连续两次Tab键&#xff0c;给出操作提示使用上下箭头快速调出曾经使用过的命令使用clear命令或者Ctrll快捷键实现清屏Linux的常用命令 命令作用详细说明ls [-al] [dir]显示指定目录下的内容 -a 显示所有文件及目录 (. 开头的隐藏文件也会列出) …
阅读更多...
sonar对webgoat进行静态扫描

sonar对webgoat进行静态扫描

安装sonar并配置 docker安装sonarqube&#xff0c;sonarQube静态代码扫描 - Joson6350 - 博客园 (cnblogs.com) 对webgoat进行sonar扫描 扫描结果 bugs Change this condition so that it does not always evaluate to "false" 意思是这里的else if语句不会执行…
阅读更多...
“我，24岁，年薪20万”：选对了行业究竟多重要？

“我，24岁，年薪20万”：选对了行业究竟多重要？

那些在职场上顺风顺水&#xff0c;按部就班拿到高薪的人都有什么特点&#xff1f; 今天的主人公Flee告诉我&#xff0c;是稳。 在她的故事里&#xff0c;我看到一个“别人家的姑娘”&#xff0c;是怎样在职场上稳步晋升&#xff0c;大学毕业仅2年&#xff0c;就拿到18.6K月薪&a…
阅读更多...
「go查漏补缺」命名规则以及 GROM 结构体的应用

「go查漏补缺」命名规则以及 GROM 结构体的应用

概述&#xff1a; 在学习GORM过程中&#xff0c;总是在调用结构体和文件导入这里出错&#xff0c;所以整理了以下文档用于梳理变量/结构体命名规则和import导入的知识点 一、变量/结构体命名规则 变量/结构体都遵守同样的命名规则&#xff1a;可见性由首字母大小写决定 大写…
阅读更多...
最新文章

Copyright @ 2022~2023