关于github:resubmit-渐进式防重复提交框架简介

6次阅读

共计 4170 个字符,预计需要花费 11 分钟才能阅读完成。

resubmit

resubmit 是一款为 java 设计的渐进式避免反复提交框架。

举荐浏览:

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

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

创作目标

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

所以心愿从从简到繁实现一个工具,便于平时应用。

个性

  • 渐进式实现,可独立 spring 应用
  • 基于注解 + 字节码,配置灵便
  • 反对编程式的调用
  • 反对注解式,完满整合 spring
  • 反对整合 spring-boot

变更日志

疾速开始

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,激励一下老马~

https://github.com/houbb/resubmit

正文完
 0