Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/houbb/resubmit

The repeat submit tool for java.(java 防止重复提交框架，支持注解。支持 spring, springboot 整合。)
https://github.com/houbb/resubmit

resubmission spring-boot springboot springboot2 submit

Last synced: 21 days ago
JSON representation

The repeat submit tool for java.(java 防止重复提交框架，支持注解。支持 spring, springboot 整合。)

Host: GitHub
URL: https://github.com/houbb/resubmit
Owner: houbb
License: apache-2.0
Created: 2020-07-31T09:26:20.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-12-10T10:57:48.000Z (almost 2 years ago)
Last Synced: 2024-10-01T06:23:07.135Z (about 1 month ago)
Topics: resubmission, spring-boot, springboot, springboot2, submit
Language: Java
Homepage:
Size: 116 KB
Stars: 79
Watchers: 2
Forks: 26
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # resubmit

[resubmit](https://github.com/houbb/resubmit) 是一款为 java 设计的渐进式防止重复提交框架。

[![Build Status](https://travis-ci.com/houbb/resubmit.svg?branch=master)](https://travis-ci.com/houbb/resubmit)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.houbb/resubmit/badge.svg)](http://mvnrepository.com/artifact/com.github.houbb/resubmit)

[![](https://img.shields.io/badge/license-Apache2-FF0080.svg)](https://github.com/houbb/resubmit/blob/master/LICENSE.txt)

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/houbb/resubmit)

推荐阅读：

[面试官：你们的项目中是怎么做防止重复提交的？](https://mp.weixin.qq.com/s/ZQx7cDUJXMDm4QXAPsfnFQ)

[resubmit 渐进式防重复提交框架简介](https://mp.weixin.qq.com/s/tVkeyrDNc_scRusbClrY1w)

## 创作目的

有时候手动加防止重复提交很麻烦，每次手动编写不利于复用。

所以希望从从简到繁实现一个工具，便于平时使用。

## 特性

- 渐进式实现，可独立 spring 使用

- 基于注解+字节码，配置灵活

- 支持编程式的调用

- 支持注解式，完美整合 spring

- 支持整合 spring-boot

> [变更日志](https://github.com/houbb/resubmit/blob/master/CHANGELOG.md)

# 快速开始

## maven 引入

```xml

    com.github.houbb

    resubmit-core

    1.1.0

```

## 编码

- UserService.java

`@Resubmit` 对应的属性如下：

| 属性 | 说明 | 默认值 |

|:---|:---|:---|

| value() | 多久内禁止重复提交，单位为毫秒。| 60000 |

```java

@Resubmit(5000)

public void queryInfo(final String id) {

    System.out.println("query info: " + id);

}

```

- 测试代码

如果在指定时间差内，重复请求，则会抛出异常 ResubmitException

```java

@Test(expected = ResubmitException.class)

public void errorTest() {

    UserService service = ResubmitProxy.getProxy(new UserService());

    service.queryInfo("1");

    service.queryInfo("1");

}

```

相同的参数直接提交2次，就会报错。

- 测试场景2

如果等待超过指定的 5s，就不会报错。

```java

@Test

public void untilTtlTest() {

    UserService service = ResubmitProxy.getProxy(new UserService());

    service.queryInfo("1");

    DateUtil.sleep(TimeUnit.SECONDS, 6);

    service.queryInfo("1");

}

```

## 自定义

`ResubmitProxy.getProxy(new UserService());` 可以获取 UserService 对应的代理。

等价于：

```java

ResubmitBs resubmitBs = ResubmitBs.newInstance()

                .cache(new CommonCacheServiceMap())

                .keyGenerator(new KeyGenerator())

                .tokenGenerator(new HttpServletRequestTokenGenerator());

UserService service = ResubmitProxy.getProxy(new UserService(), resubmitBs);

```

其中 ResubmitBs 作为引导类，对应的策略都支持自定义。

| 属性 | 说明  | 默认值 |

|:---|:---|:---|

| cache() | 缓存实现策略 | 默认为基于 ConcurrentHashMap 实现的基于内存的缓存实现 |

| keyGenerator() | key 实现策略，用于唯一标识一个方法+参数，判断是否为相同的提交 | md5 策略 |

| tokenGenerator() | token 实现策略，用于唯一标识一个用户。 | 从 HttpServletRequest 中的 header 属性 `resubmit_token` 中获取 |

# spring 整合使用

## maven 引入

```xml

    com.github.houbb

    resubmit-spring

    1.1.0

```

## 代码编写

- UserService.java

```java

@Service

public class UserService {

    @Resubmit(5000)

    public void queryInfo(final String id) {

        System.out.println("query info: " + id);

    }

}

```

- SpringConfig.java

```java

@ComponentScan("com.github.houbb.resubmit.test.service")

@EnableResubmit

@Configuration

public class SpringConfig {

}

```

### @EnableResubmit 注解说明

`@EnableResubmit` 中用户可以指定对应的实现策略，便于更加灵活的适应业务场景。

和 `ResubmitBs` 中支持自定义的属性一一对应。

| 属性 | 说明  | 默认值 |

|:---|:---|:---|

| cache() | 缓存实现策略 | 默认为基于 ConcurrentHashMap 实现的基于内存的缓存实现 |

| keyGenerator() | key 实现策略，用于唯一标识一个方法+参数，判断是否为相同的提交 | md5 策略 |

| tokenGenerator() | token 实现策略，用于唯一标识一个用户。 | 从 HttpServletRequest 中的 header 属性 `resubmit_token` 中获取 |

## 测试代码

```java

@ContextConfiguration(classes = SpringConfig.class)

@RunWith(SpringJUnit4ClassRunner.class)

public class ResubmitSpringTest {

    @Autowired

    private UserService service;

    @Test(expected = ResubmitException.class)

    public void queryTest() {

        service.queryInfo("1");

        service.queryInfo("1");

    }

}

```

# 整合 spring-boot

## maven 引入

```xml

    com.github.houbb

    resubmit-springboot-starter

    1.1.0

```

## 代码实现

- UserService.java

这个方法实现和前面的一样。

```java

@Service

public class UserService {

    @Resubmit(5000)

    public void queryInfo(final String id) {

        System.out.println("query info: " + id);

    }

}

```

- Application.java

启动入口

```java

@SpringBootApplication

public class ResubmitApplication {

    public static void main(String[] args) {

        SpringApplication.run(ResubmitApplication.class, args);

    }

}

```

## 测试代码

```java

@ContextConfiguration(classes = ResubmitApplication.class)

@RunWith(SpringJUnit4ClassRunner.class)

public class ResubmitSpringBootStarterTest {

    @Autowired

    private UserService service;

    @Test(expected = ResubmitException.class)

    public void queryTest() {

        service.queryInfo("1");

        service.queryInfo("1");

    }

}

```

# 自定义策略

上面提到 `@EnableResubmit` 中的策略支持自定义。

此处仅以 cache 为例，为了简单，默认是基于本地内存的缓存实现。

**如果你不是单点应用，那么基于 redis 的缓存更加合适**

## 自定义缓存 cache

### 实现缓存

只需要实现 `ICommonCacheService` 接口即可。

```java

public class MyDefineCache extends CommonCacheServiceMap {

    // 这里只是作为演示，实际生产建议使用 redis 作为统一缓存

    @Override

    public synchronized void set(String key, String value, long expireMills) {

        System.out.println("------------- 自定义的设置实现");

        super.set(key, value, expireMills);

    }

}

```

### core 中指定使用

在非 spring 项目中，可以在引导类中指定我们定义的缓存。

```java

ResubmitBs resubmitBs = ResubmitBs.newInstance()

                .cache(new MyDefineCache());

UserService service = ResubmitProxy.getProxy(new UserService(), resubmitBs);

```

其他使用方式保持不变。

### spring 中指定使用

在 spring 项目中，我们需要调整一下配置，其他不变。

```java

@ComponentScan("com.github.houbb.resubmit.test.service")

@Configuration

@EnableResubmit(cache = "myDefineCache")

public class SpringDefineConfig {

    @Bean("myDefineCache")

    public ICommonCacheService myDefineCache() {

        return new MyDefineCache();

    }

}

```

`@EnableResubmit(cache = "myDefineCache")` 指定我们自定义的缓存策略名称。

# Redis 的内置缓存策略

为了便于复用，基于 redis 的缓存策略已实现，后续有时间进行讲解。

> [Redis-Config](https://github.com/houbb/redis-config)

# 开源地址

为了便于大家学习使用，目前防重复提交框架已开源。

欢迎大家 fork+star，鼓励一下老马~

> [https://github.com/houbb/resubmit](https://github.com/houbb/resubmit)

# Road-Map

- [ ] 优化 spring 对应的版本依赖

- [ ] 添加基于 redis 的 cache 实现

# 中间件等工具开源矩阵

[heaven: 收集开发中常用的工具类](https://github.com/houbb/heaven)

[rpc: 基于 netty4 实现的远程调用工具](https://github.com/houbb/rpc)

[mq: 简易版 mq 实现](https://github.com/houbb/mq)

[ioc: 模拟简易版 spring ioc](https://github.com/houbb/ioc)

[mybatis: 简易版 mybatis](https://github.com/houbb/mybatis)

[cache: 渐进式 redis 缓存](https://github.com/houbb/cache)

[jdbc-pool: 数据库连接池实现](https://github.com/houbb/jdbc-pool)

[sandglass: 任务调度时间工具框架](https://github.com/houbb/sandglass)

[sisyphus: 支持注解的重试框架](https://github.com/houbb/sisyphus)

[resubmit: 防止重复提交框架，支持注解](https://github.com/houbb/resubmit)

[auto-log: 日志自动输出](https://github.com/houbb/auto-log)

[async: 多线程异步并行框架](https://github.com/houbb/async)

# 缓存相关工具

[cache: 手写渐进式 redis](https://github.com/houbb/cache)

[common-cache: 通用缓存标准定义](https://github.com/houbb/common-cache)

[redis-config: 兼容各种常见的 redis 配置模式](https://github.com/houbb/redis-config)

[lock: 开箱即用的分布式锁](https://github.com/houbb/lock)

[resubmit: 防重复提交](https://github.com/houbb/resubmit)

[rate-limit: 限流](https://github.com/houbb/rate-limit/)