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