Popular MVC框架接口防重复提交功能@RequiredNoRepeatSubmit使用示例

最新推荐文章于 2022-09-21 20:30:16 发布

淡远

最新推荐文章于 2022-09-21 20:30:16 发布

阅读量796

点赞数

分类专栏： popularmvc系列使用教程 springboot 文章标签： spring boot java api 防重复提交

本文为博主原创文章，若需转载请明文展示原文地址和博主站点主页：www.danyuanblog.com

本文链接：https://blog.csdn.net/u011585609/article/details/112259232

版权

springboot 同时被 2 个专栏收录

13 篇文章 0 订阅

订阅专栏

popularmvc系列使用教程

10 篇文章 0 订阅

订阅专栏

Popular MVC框架接口防重复提交功能使用示例

简介

1、简介

此项目用于演示如何使用popularmvc提供的接口防重复提交功能。使用防重提交功能，只需要在需要防重的接口上添加@RequiredNoRepeatSubmit注解即可。主要有以下内容：

防重复提交码模式

自定义防重复提交码

自定义防重复提交码需要调用者保证防重复提交码的全局唯一性，推荐结构：userId+timestamp

timestamp在数据更新后才允许更新

使用sign作为防重码

如果接口开启了数字签名，则可以直接使用数字签名值sign作为防重复提交码，sign的算法自然就保证了防重码的唯一性

开启接口防重提交功能，避免因用户误操作重复提交而导致的多次相同的脏数据

对于一些新增数据的接口通常需要进行接口的防重复提交保护，如：用户账号注册、用户下单、用户发帖等等类似的应用场景。

防重复提交主要应用场景是避免用户短时间内由于误操作导致同一份数据被保存多次所带来的问题，如果被保存的数据内容存在唯一标识限制则可以选择不使用防重复提交，在业务侧保证数据的唯一性即可。

注意：防重复提交只能防止短时间内用户的误操作导致插入重复数据的问题，如果需要数据的唯一性还是需要在业务中自行处理。

demo源码传送门

项目示例

1 项目结构

项目结构

│  pom.xml
│  README.md
│      
└─src
    ├─main
    │  ├─java
    │  │  └─com
    │  │      └─danyuanblog
    │  │          └─framework
    │  │              └─demo
    │  │                  └─popularmvc
    │  │                      │  StartDemoApplication.java
    │  │                      │  
    │  │                      └─controller
    │  │                          │  TestDenyRepeatSubmitController.java
    │  │                          │  
    │  │                          └─dto
    │  │                                  UserInfoDto.java
    │  │                                  
    │  └─resources
    │          application.yml
    │          
    └─test
        └─java
            └─com
                └─danyuanblog
                    └─framework
                        └─popular
                            └─mvc

引入模块依赖，在pom.xml添加

	<dependency>
		<groupId>com.danyuanblog.framework</groupId>
		<artifactId>popular-web-mvc</artifactId>
		<version>${popular-web-mvc.version}</version>
	</dependency>

2 启用PopularMvc框架

/**  
* Title StartDemoApplication.java  
* Description  
* @author danyuan
* @date Oct 31, 2020
* @version 1.0.0
* site: www.danyuanblog.com
*/ 
package com.danyuanblog.framework.demo.popularmvc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import com.danyuanblog.framework.popularmvc.annotation.EnablePopularMvc;

@SpringBootApplication
@EnablePopularMvc
public class StartDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(StartDemoApplication.class, args);
	}
}

3 配置信息

错误码配置信息如下application.yml

popularmvc:
  #防重复提交码过期时间，开启防重的接口默认为2分钟内不允许提交相同的数据，这里我们可以修改为3分钟
  noSubmitRepeatTimeoutSeconds: 180
  api: 
    channels:
      default: #用于不区分渠道信息的应用
        default: #默认的秘钥信息
          enable: true
          #用于对称加解密、生成数字签名、验证数字签名的秘钥
          secret: "123456"
          keyPair: #用于非对称加解密的秘钥对
            privateSecret: ""
            publicSecret: ""
        appId1: #某个应用下的秘钥信息
          enable: true
          #用于对称加解密、生成数字签名、验证数字签名的秘钥
          secret: "123456"
          keyPair: #用于非对称加解密的秘钥对
            privateSecret: ""
            publicSecret: ""
      android:
        default:
          enable: true
          #用于对称加解密、生成数字签名、验证数字签名的秘钥
          secret: "123456"
          keyPair: #用于非对称加解密的秘钥对
            privateSecret: ""
            publicSecret: ""
      ios: 
        default: 
          enable: true
          secret: "12345678"  
          keyPair:
            privateSecret: ""
            publicSecret: ""

4 演示代码解析

4.1 接口防重提交使用示例

业务异常的使用主要分两种应用场景：

开启验证请求数据数字签名的接口，再开启防重复提交可以选择使用数字签名sign作为防重码
未开启数字签名的接口，需要调用者自己生成一个全局唯一的防重码

示例代码如下所示。

接口源码TestDenyRepeatSubmitController.java

/**  
* Title TestDenyRepeatSubmitController.java  
* Description  
* @author danyuan
* @date Jan 5, 2021
* @version 1.0.0
* site: www.danyuanblog.com
*/ 
package com.danyuanblog.framework.demo.popularmvc.controller;

import lombok.extern.slf4j.Slf4j;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import com.danyuanblog.framework.demo.popularmvc.controller.dto.UserInfoDto;
import com.danyuanblog.framework.popularmvc.annotation.RequiredNoRepeatSubmit;
import com.danyuanblog.framework.popularmvc.annotation.RequiredSign;
import com.danyuanblog.framework.popularmvc.consts.DenyRepeatSubmitType;
import com.danyuanblog.framework.popularmvc.utils.IOUtils;

@Api(tags = "测试接口防重复提交相关接口列表")
@RestController
@Slf4j
public class TestDenyRepeatSubmitController {
	
	@PostMapping(value="testUserAccountRegistNoRepeatSubmit",
			name="测试注册用户账号接口防重复提交功能")
	@ApiOperation(value="测试注册用户账号接口防重复提交功能", notes="防重复提交码由客户端生成，防止同一用户重复注册!")
	@RequiredNoRepeatSubmit(mode = DenyRepeatSubmitType.GENERATE_TOKEN)
	public void testUserAccountRegistNoRepeatSubmit(@RequestBody UserInfoDto userInfo){
		try {
			//模拟业务执行需要的耗时
			Thread.sleep(3000);
		} catch (InterruptedException e) {
			log.error(IOUtils.getThrowableInfo(e));
		}
		log.info("保存用户信息成功[{}]!",userInfo.toString());		
	}
	
	@PostMapping(value="testUserAccountRegistNoRepeatSubmitBySign",
			name="测试注册用户账号接口防重复提交功能数字签名模式")
	@ApiOperation(value="测试注册用户账号接口防重复提交功能数字签名模式", notes="使用数字签名，防止同一用户重复注册!")
	@RequiredNoRepeatSubmit(mode = DenyRepeatSubmitType.USE_SIGN)
	@RequiredSign
	public void testUserAccountRegistNoRepeatSubmitBySign(@RequestBody UserInfoDto userInfo){
		try {
			//模拟业务执行需要的耗时
			Thread.sleep(3000);
		} catch (InterruptedException e) {
			log.error(IOUtils.getThrowableInfo(e));
		}
		log.info("保存用户信息成功[{}]!",userInfo.toString());
	}
}

DTO UserInfoDto.java

/**  
* Title UserInfoDto.java  
* Description  
* @author danyuan
* @date Nov 29, 2020
* @version 1.0.0
* site: www.danyuanblog.com
*/ 
package com.danyuanblog.framework.demo.popularmvc.controller.dto;

import java.io.Serializable;
import java.util.List;

import com.danyuanblog.framework.popularmvc.annotation.Encrypt;
import com.danyuanblog.framework.popularmvc.annotation.IgnoreSign;

import lombok.Data;

@Data
public class UserInfoDto implements Serializable{/** 
	 *serialVersionUID
	 */
	private static final long serialVersionUID = 1L;

	private String username;
	@IgnoreSign
	private Integer age;
	@Encrypt
	private String desc;
	
	private List<UserInfoDto> friends;
}

4.2 结果演示

使用数字签名的方式

请求

curl -X POST -H  "Accept:*/*" -H  "Request-Origion:Knife4j" -H  "Content-Type:application/json" -d "{\"age\":22,\"desc\":\"sdfsdfsd\",\"friends\":[{\"age\":13,\"desc\":\"sfsdfds\",\"friends\":[],\"username\":\"sdfsd\"}],\"username\":\"fghhfghgf\"}" "http://localhost:8080/testUserAccountRegistNoRepeatSubmitBySign?sign=BAEADE359BE6DB2BDC3E04DBEAEFA363ACE63541&timestamp=235353453"

同时发起两个相同接口调用A和B (A稍微先于B一点)，调用结束后再发起一个C接口调用

结果

A请求的结果:
{
  "code": 0
}

B请求的结果：

{
  "msg": "您提交的请求正在处理，请耐心等待!",
  "code": 130006
}

C请求的结果：

{
  "msg": "你的请求数据已提交成功，请勿重复提交!",
  "code": 130007
}

自定义防重码方式

与数字签名模式不同的地方就是需要客户端定义防重复提交码的值，请求内容如下：

curl -X POST -H  "Accept:*/*" -H  "Request-Origion:Knife4j" -H  "Content-Type:application/json" -d "{\"age\":22,\"desc\":\"sdfsdfsd\",\"friends\":[{\"age\":13,\"desc\":\"sfsdfds\",\"friends\":[],\"username\":\"sdfsd\"}],\"username\":\"fghhfghgf\"}" "http://localhost:8080/testUserAccountRegistNoRepeatSubmit?repeatCode=555123234234&timestamp=123234234"

测试方式和结果和数字签名模式相同

淡远

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Popular MVC框架接口防重复提交功能@RequiredNoRepeatSubmit使用示例

Popular MVC框架接口防重复提交功能使用示例简介1、简介此项目用于演示如何使用popularmvc提供的接口防重复提交功能。使用防重提交功能，只需要在需要防重的接口上添加@RequiredNoRepeatSubmit注解即可。主要有以下内容：防重复提交码模式自定义防重复提交码自定义防重复提交码需要调用者保证防重复提交码的全局唯一性，推荐结构：userId+timestamptimestamp在数据更新后才允许更新使用sign作为防重码如果接口开启了数字签
复制链接

扫一扫