resubmit

resubmit 是一款为 java 规划的渐进式避免重复提交结构。

推荐阅读:

面试官:你们的项目中是怎么做避免重复提交的?

resubmit 渐进式防重复提交结构简介

创造意图

有时候手动加避免重复提交很麻烦,每次手动编写不利于复用。

所以希望从从简到繁完成一个东西,便于平常运用。

特性

  • 渐进式完成,可独立 spring 运用

  • 根据注解+字节码,配置灵活

  • 支撑编程式的调用

  • 支撑注解式,完美整合 spring

  • 支撑整合 spring-boot

变更日志

resubmit 渐进式防重复提交框架简介

快速开始

maven 引进

<dependency>
    <group>com.github.houbb</group>
    <artifact>resubmit-core</artifact>
    <version>1.0.0</version>
</dependency>

编码

  • UserService.java

@Resubmit 对应的特点如下:

特点 阐明 默认值
value() 多久内制止重复提交,单位为毫秒。 60000
@Resubmit(5000)
public void queryInfo(final String id) {
    System.out.println("query info: " + id);
}
  • 测验代码

假如在指定时间差内,重复请求,则会抛出反常 ResubmitException

@Test(expected = ResubmitException.class)
public void errorTest() {
    UserService service = ResubmitProxy.getProxy(new UserService());
    service.queryInfo("1");
    service.queryInfo("1");
}

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

  • 测验场景2

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

@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 对应的代理。

等价于:

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 引进

<dependency>
    <group>com.github.houbb</group>
    <artifact>resubmit-spring</artifact>
    <version>1.0.0</version>
</dependency>

代码编写

  • UserService.java
@Service
public class UserService {
    @Resubmit(5000)
    public void queryInfo(final String id) {
        System.out.println("query info: " + id);
    }
}
  • SpringConfig.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 中获取

测验代码

@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 引进

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>resubmit-springboot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

代码完成

  • UserService.java

这个办法完成和前面的一样。

@Service
public class UserService {
    @Resubmit(5000)
    public void queryInfo(final String id) {
        System.out.println("query info: " + id);
    }
}
  • Application.java

启动进口

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

测验代码

@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 接口即可。

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 项目中,能够在引导类中指定我们界说的缓存。

ResubmitBs resubmitBs = ResubmitBs.newInstance()
                .cache(new MyDefineCache());
UserService service = ResubmitProxy.getProxy(new UserService(), resubmitBs);

其他运用方式坚持不变。

spring 中指定运用

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

@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

开源地址

为了便于我们学习运用,现在防重复提交结构已开源。

欢迎我们 fork+star,鼓舞一下老马~

github.com/houbb/resub…