如何去开发一个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;
    @Override
    public 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;
    @Bean
    public 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 {

    @Resource
    private XWHKINGClient xwhkingClient;

    @Test
    void testClient(){
        xwhkingClient.getName("xwhking") ;
    }

}

调用结果：

出来了 xwhking 结果成功。

在这里插入图片描述

这样开发一个starter 就结束了

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

wpf devexpress 开始点

wpf devexpress 开始点

此教程示范如何创建registration form和DevExpress WPF Data Editors 开始点 此项目源码 这个解决方案包含几个项目-每一个项目对应一个教程 RegistrationForm.BaseProject项目是基于工作的解决方案。项目包含三个视图&#xff1a;MainView&#xff0c;RegistraionView&…
阅读更多...
Os-ByteSec

Os-ByteSec

Os-ByteSec 一、主机发现和端口扫描 主机发现&#xff0c;靶机地址192.168.80.144 端口扫描&#xff0c;开放了80、139、445、2525端口 二、信息收集 访问80端口 路径扫描 dirsearch -u "http://192.168.80.144/" -e *访问扫描出来的路径&#xff0c;没有发现…
阅读更多...
IO流-序列化流

IO流-序列化流

一&#xff0c;序列化&#xff08;把java对象写到对象中去&#xff09; 二&#xff0c; Object OutputStream(对象字节输出流) 三&#xff0c;案例 package BigDecimal;import java.io.FileOutputStream; import java.io.ObjectOutputStream;public class Main {public static…
阅读更多...
​软考-高级-系统架构设计师教程（清华第2版）【第14章 云原生架构设计理论与实践（P496~526）-思维导图】​

​软考-高级-系统架构设计师教程（清华第2版）【第14章 云原生架构设计理论与实践（P496~526）-思维导图】​

软考-高级-系统架构设计师教程&#xff08;清华第2版&#xff09;【第14章 云原生架构设计理论与实践&#xff08;P496~526&#xff09;-思维导图】 课本里章节里所有蓝色字体的思维导图
阅读更多...
​软考-高级-系统架构设计师教程（清华第2版）【第13章 层次式架构设计理论与实践（P466~495）-思维导图】​

​软考-高级-系统架构设计师教程（清华第2版）【第13章 层次式架构设计理论与实践（P466~495）-思维导图】​

软考-高级-系统架构设计师教程&#xff08;清华第2版&#xff09;【第13章 层次式架构设计理论与实践&#xff08;P466~495&#xff09;-思维导图】 课本里章节里所有蓝色字体的思维导图
阅读更多...
数据库的分库分表 详解

数据库的分库分表 详解

前言 一个系统随着用户量上升&#xff0c;产生的数据也越来越多&#xff0c;到达一定程度&#xff0c;数据库就会产生瓶颈。 首先单机数据库所能承载的连接数&#xff0c;io和吞吐量都是有限的&#xff0c;并发量上来数据库就渐渐顶不住了。 如果单表的数据量过大&#xff0…
阅读更多...
阿里巴巴java开发手册-编程规约

阿里巴巴java开发手册-编程规约

编程规约 命名风格常量定义代码格式OOP 规约日期时间集合处理并发处理控制语句注释规约前后端规约其他 命名风格 【强制】代码中的命名均不能以下划线或美元符号开始&#xff0c;也不能以下划线或美元符号结束。 反例&#xff1a;_name / name / n a m e / n a m e / n a m e…
阅读更多...
腾讯云服务器租用价格，腾讯云服务器价格流量怎么算？

腾讯云服务器租用价格，腾讯云服务器价格流量怎么算？

首先&#xff0c;让我们来看看腾讯云服务器租用价格。根据您的需求不同&#xff0c;腾讯云提供了多种不同的配置选项&#xff0c;从轻量级应用服务器到高性能的GPU服务器&#xff0c;都可以满足您的需求。以下是一些常见的腾讯云服务器租用价格&#xff1a; 一、腾讯云服务器租…
阅读更多...
vs2017 编译Qt 5.11.2 源码

vs2017 编译Qt 5.11.2 源码

SDK 10.0.22000.194 有 2种编译方式 &#xff0c;第二种 看下面 方式一: 1、问题描述&#xff1a; 使用VS编译程序时&#xff0c;运行库选择多线程&#xff08;/MT&#xff09;&#xff0c;表示采用多线程静态release的方式进行编译。 但是&#xff0c;发现编译是不能通过的…
阅读更多...
使用 Filebeat+Easysearch+Console 打造日志管理平台

使用 Filebeat+Easysearch+Console 打造日志管理平台

近年来&#xff0c;日志管理平台越来越流行。使用日志管理平台可以实时地、统一地、方便地管理和查看日志&#xff0c;挖掘日志数据价值&#xff0c;驱动运维、运营&#xff0c;提升服务管理效率。 方案架构 Beats 是轻量级采集器&#xff0c;包括 Filebeat、Metricbeat 等。E…
阅读更多...
记一次服务器配置文件获取OSS

记一次服务器配置文件获取OSS

一、漏洞原因 由于网站登录口未做双因子校验，导致可以通过暴力破解获取管理员账号，成功进入系统；未对上传的格式和内容进行校验，可以任意文件上传获取服务器权限；由于服务器上配置信息，可以进一步获取数据库权限和OSS管理权限。二、漏洞成果 弱口令获取网站的管理员权限通…
阅读更多...
资产设备管理系统

资产设备管理系统

dtAsset 是一个固定资产设备管理系统&#xff0c;它专为中小企业的需求而设计。该软件提供了对常用资产设备进行信息化管理的功能&#xff0c;并支持自定义设备类型、导入导出数据、维护工作统计、采购管理、文档管理、运维监控 (使用 Zabbix)、知识库等功能。 主要模块 1.系统…
阅读更多...
ogrinfo不是内部或者外部命令

ogrinfo不是内部或者外部命令

这个是GDAL的问题&#xff0c;我是通过OSGeo4w安装的&#xff0c;出来就是这个问题&#xff0c;教程没有仔细看干。 第一次安装&#xff0c;选择express install&#xff01;&#xff01;&#xff01;&#xff01; 第一次安装&#xff0c;选择express install&#xff01;&…
阅读更多...
动手学深度学习——循环神经网络的简洁实现（代码详解）

动手学深度学习——循环神经网络的简洁实现（代码详解）

文章目录 循环神经网络的简洁实现1. 定义模型2. 训练与预测 循环神经网络的简洁实现 # 使用深度学习框架的高级API提供的函数更有效地实现相同的语言模型 import torch from torch import nn from torch.nn import functional as F from d2l import torch as d2lbatch_size, …
阅读更多...
微信如何实现自动转发朋友圈（跟圈）？

微信如何实现自动转发朋友圈（跟圈）？

阅读更多...
黑马程序员 学成在线项目 第1章 项目介绍环境搭建v3.1

黑马程序员 学成在线项目 第1章 项目介绍环境搭建v3.1

第1章 项目介绍&环境搭建v3.1 1.项目背景 1.1 在线教育市场环境 以下内容摘自艾瑞&#xff1a;2020年在线教育行业洞察&#xff1a;To B赛道篇_网络服务_艾瑞网 在线教育行业是一个有着极强的广度和深度的行业&#xff0c;从校内到校外&#xff1b;从早幼教到职业培训&…
阅读更多...
【Python】逆向与爬虫的故事

【Python】逆向与爬虫的故事

目录 一、前言 二、爬虫 1、什么是爬虫&#xff1f; 2、Python 爬虫的主要工具 3、爬虫的基本流程 4、实例代码 三、逆向 1、什么是逆向&#xff1f; 2、Python 逆向的主要工具 3、逆向的基本流程 4、实例代码 四、总结 一、前言 随着互联网技术的发展&#xff0c…
阅读更多...
RIP路由信息协议

RIP路由信息协议

RIP路由信息协议(Routing Information Protocol) 最先得到广泛应用的协议&#xff0c;最大优点是简单要求网络中的每个路由器都要维护一张表&#xff0c;表中记录了从它自己到其他每一个目的网络的距离RIP是应用层协议&#xff0c;它在传输层使用UDP&#xff0c;RIP报文作为UD…
阅读更多...
2023.11.18 - hadoop之zookeeper分布式协调服务

2023.11.18 - hadoop之zookeeper分布式协调服务

1.zookeeper简介 ZooKeeper概念: Zookeeper是一个分布式协调服务的开源框架。本质上是一个分布式的小文件存储系统 ZooKeeper作用: 主要用来解决分布式集群中应用系统的一致性问题。 ZooKeeper结构: 采用树形层次结构&#xff0c;没有目录与文件之分,ZooKeeper树中的每个节点被…
阅读更多...
HDMI之EDID析义篇

HDMI之EDID析义篇

DisplayID Type X Video Timing Data Block 实例 F0 2A 10 93 FF 0E 6F 08 8F 10 93 7F 07 37 04 8F 10该数据来源于SHARP AQUOS-TVE23A 4K144Hz电视机的第3个EDID块(基于HF-EEODB)。 定义 解释 VTDB 1: 3840x2160 144.000009 Hz 16:9 333.216 kHz 1343.527000 MHz (RBv3,h…
阅读更多...
最新文章

Copyright @ 2022~2023