摘要：特性支持過(guò)程式編程基于字節(jié)碼的代理重試基于注解的重試，允許自定義注解無(wú)縫接入接口與注解的統(tǒng)一解決與中的不足之處設(shè)計(jì)目的綜合了和的優(yōu)勢(shì)?；谧止?jié)碼實(shí)現(xiàn)的代理重試，可以不依賴。提供基于代碼模式字節(jié)碼增強(qiáng)實(shí)現(xiàn)的方式。

支持過(guò)程式編程和注解編程的 java 重試框架。

支持 fluent 過(guò)程式編程

基于字節(jié)碼的代理重試

基于注解的重試，允許自定義注解

無(wú)縫接入 spring

接口與注解的統(tǒng)一

解決 spring-retry 與 guava-retrying 中的不足之處

綜合了 spring-retry 和 gauva-retrying 的優(yōu)勢(shì)。

調(diào)整一些特性，使其更利于實(shí)際使用。

采用 Netty 類(lèi)似的接口思想，保證接口的一致性，和替換的靈活性。

借鑒 Hibernate-Validator 的設(shè)計(jì)，允許用戶自定義注解。

spring-retry 與 guava-retrying 中的不足之處

更新記錄

sisyphus

    com.github.houbb
    sisyphus-core
    0.0.6

詳情參見(jiàn) [RetryerTest]()

public void helloTest() {
    Retryer.newInstance()
            .retry(new Callable() {
                @Override
                public String call() throws Exception {
                    System.out.println("called...");
                    throw new RuntimeException();
                }
            });
}

retry

指定一個(gè) callable 的實(shí)現(xiàn)。

我們打印一條日志，并且模擬一個(gè)程序異常。

日志信息

called...
called...
called...

和一些其他異常信息。

重試觸發(fā)的條件，默認(rèn)是程序發(fā)生了異常

這里的重試間隔默認(rèn)為沒(méi)有時(shí)間間隔，一共嘗試3次。（包括第一次程序本身執(zhí)行）

作為開(kāi)發(fā)者，我們一般都會(huì)選擇比較著名的框架。

比如 guava-retrying spring-retry。

或者干脆自己寫(xiě)一個(gè)。

java retry 這篇文章中我列舉了常見(jiàn)的實(shí)現(xiàn)方式
以及上述的兩種框架，也講述了其中的不足。

使用靈活

fluent 優(yōu)雅寫(xiě)法

提供足夠多的實(shí)現(xiàn)

沒(méi)有默認(rèn)基于注解的實(shí)現(xiàn)

重試策略設(shè)計(jì)并不友好

使用簡(jiǎn)單

重試條件單一

重試等待策略單一

無(wú)法自定義注解

我作為一名開(kāi)發(fā)，平時(shí)說(shuō)實(shí)在的，看到重試。

我肯定會(huì)偷懶寫(xiě)一個(gè) for 循環(huán)，重試幾次就結(jié)束了。

因?yàn)闀r(shí)間不允許。

如果你更勤快一點(diǎn)，就可以選擇 spring-retry/guava-retrying。如果你熟悉他們的優(yōu)缺點(diǎn)的話。

sisyphus 所有的實(shí)現(xiàn)都是基于接口的。

你完全可以實(shí)現(xiàn)自己的實(shí)現(xiàn)，所有的東西基本完全可以被替換。

當(dāng)然一些常見(jiàn)的策略實(shí)現(xiàn)，項(xiàng)目的基本框架都有詳盡的注釋?zhuān)?dāng)做參考也可以有一點(diǎn)幫助。

參考了 netty 的設(shè)計(jì)，保證接口實(shí)現(xiàn)的一致性。

而且 sisyphus 還做了更多，還保證了接口和注解之間的一致性。

使用引導(dǎo)類(lèi)，保證使用時(shí)的便利性，后期拓展的靈活性。

hibernate-validator 的作者是我知道為數(shù)不多的對(duì)于 java 注解應(yīng)用很棒的開(kāi)發(fā)者。（雖然所知甚少）

自定義注解就是從這個(gè)框架中學(xué)來(lái)的。

spring 基本與我們的代碼形影不離，所以你可以很簡(jiǎn)單的結(jié)合 spring.

就像你使用 spring-retry 一樣。

sisyphus 在模塊劃分的時(shí)候考慮到使用者的方便，主要有幾個(gè)模塊：

接口定義模塊，是最基礎(chǔ)的部分。

會(huì)被 sisyphus-core 默認(rèn)依賴。

一般不需要引入，如果你想根據(jù)它實(shí)現(xiàn)自己的重試框架，不妨一試。

對(duì)于 sisyphus-api 模塊的默認(rèn)實(shí)現(xiàn)。

并且添加易于使用的 Fluent 引導(dǎo)類(lèi)，可以很方便的寫(xiě)出聲明式的重試代碼。

sisyphus 的注解實(shí)現(xiàn)模塊。

（1）基于字節(jié)碼實(shí)現(xiàn)的代理重試，可以不依賴 spring。平時(shí)使用也更加靈活

（2）允許自定義注解及其實(shí)現(xiàn)。使用者可以編寫(xiě)屬于自己的重試注解。

spring 做為 java 開(kāi)發(fā)的引導(dǎo)者。自然是要支持的。

你可以和使用 spring-retry 一樣方便的使用 sisyphus-spring。

sisyphus-api
sisyphus-core
sisyphus-annotation
sisyphus-spring
sisyphus-test

sisyphus-api 是基礎(chǔ)的，靈活性最高。

sisyphus-spring 是最簡(jiǎn)單易用的，靈活性相對(duì)較差。

sisyphus-test 僅僅用作測(cè)試，不用外部引入。

為了滿足更加方便的配置，Retryer 類(lèi)提供了許多可以配置的信息。

/**
 * 默認(rèn)配置測(cè)試
 */
public void defaultConfigTest() {
    Retryer.newInstance()
            .condition(RetryConditions.hasExceptionCause())
            .retryWaitContext(RetryWaiter.retryWait(NoRetryWait.class).context())
            .maxAttempt(3)
            .listen(RetryListens.noListen())
            .recover(Recovers.noRecover())
            .callable(new Callable() {
                @Override
                public String call() throws Exception {
                    System.out.println("called...");
                    throw new RuntimeException();
                }
            }).retryCall();
}

和下面的代碼是等價(jià)的：

public void helloTest() {
    Retryer.newInstance()
            .callable(new Callable() {
                @Override
                public String call() throws Exception {
                    System.out.println("called...");
                    throw new RuntimeException();
                }
            }).retryCall();
}

重試觸發(fā)的條件，可以指定多個(gè)條件。

默認(rèn)為拋出異常。

重試等待的策略，可以指定多個(gè)。

默認(rèn)為不做任何等待。

指定最大重試次數(shù)，包括第一次執(zhí)行。

默認(rèn)值：3 次。

指定重試的監(jiān)聽(tīng)實(shí)現(xiàn)，默認(rèn)為不做監(jiān)聽(tīng)。

當(dāng)重試完成之后，依然滿足重試條件，則可以指定恢復(fù)的策略。

默認(rèn)不做恢復(fù)。

待重試執(zhí)行的方法。

觸發(fā)重試執(zhí)行。

所有的接口，都可以直接查看對(duì)應(yīng)的子類(lèi)實(shí)例。

基于替換的靈活性，用戶可以實(shí)現(xiàn)接口，定義更符合自己業(yè)務(wù)的實(shí)現(xiàn)。

配置具有很高的靈活性，但是對(duì)于開(kāi)發(fā)人員的使用，就沒(méi)有注解那樣簡(jiǎn)單靈活。

所以本框架也實(shí)現(xiàn)了基于注解的重試。

保證接口和注解二者的統(tǒng)一性。

    ${project.groupId}
    sisyphus-annotation
    ${project.version}

核心注解主要有兩個(gè)。

用于指定重試的相關(guān)配置。

/**
 * 重試注解
 * 1. 實(shí)際需要，只允許放在方法上。
 * 2. 如果放在接口上，是否所有的子類(lèi)都生效？為了簡(jiǎn)單明確，不提供這種實(shí)現(xiàn)。
 * 3. 保持注解和接口的一致性。{@link com.github.houbb.sisyphus.api.core.Retry} 接口
 * @author binbin.hou
 * @since 0.0.3
 */
@Documented
@Inherited
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@RetryAble(DefaultRetryAbleHandler.class)
public @interface Retry {

    /**
     * 重試類(lèi)實(shí)現(xiàn)
     * @return 重試
     * @since 0.0.5
     */
    Class retry() default DefaultRetry.class;

    /**
     * 最大嘗試次數(shù)
     * 1. 包含方法第一次正常執(zhí)行的次數(shù)
     * @return 次數(shù)
     */
    int maxAttempt() default 3;

    /**
     * 重試觸發(fā)的場(chǎng)景
     * @return 重試觸發(fā)的場(chǎng)景
     */
    Class condition() default ExceptionCauseRetryCondition.class;

    /**
     * 監(jiān)聽(tīng)器
     * 1. 默認(rèn)不進(jìn)行監(jiān)聽(tīng)
     * @return 監(jiān)聽(tīng)器
     */
    Class listen() default NoRetryListen.class;

    /**
     * 恢復(fù)操作
     * 1. 默認(rèn)不進(jìn)行任何恢復(fù)操作
     * @return 恢復(fù)操作對(duì)應(yīng)的類(lèi)
     */
    Class recover() default NoRecover.class;

    /**
     * 等待策略
     * 1. 支持指定多個(gè)，如果不指定，則不進(jìn)行任何等待，
     * @return 等待策略
     */
    RetryWait[] waits() default {};

}

用于指定重試的等待策略。

package com.github.houbb.sisyphus.annotation.annotation;

import com.github.houbb.sisyphus.annotation.annotation.metadata.RetryWaitAble;
import com.github.houbb.sisyphus.annotation.handler.impl.DefaultRetryWaitAbleHandler;
import com.github.houbb.sisyphus.core.constant.RetryWaitConst;
import com.github.houbb.sisyphus.core.support.wait.NoRetryWait;

import java.lang.annotation.*;

/**
 * 重試等待策略
 * 1. 為了對(duì)應(yīng)重試策略，所有的內(nèi)置注解應(yīng)該實(shí)現(xiàn)當(dāng)前的注解。
 * 2. 是否允許自定義注解？
 *
 * 當(dāng)注解+對(duì)象同時(shí)出現(xiàn)的時(shí)候，視為組合。
 *
 * @author binbin.hou
 * @since 0.0.3
 */
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Target(ElementType.ANNOTATION_TYPE)
@RetryWaitAble(DefaultRetryWaitAbleHandler.class)
public @interface RetryWait {

    /**
     * 默認(rèn)值
     * 1. fixed 模式，則對(duì)應(yīng)固定等待時(shí)間
     * 2. 遞增
     * @return 默認(rèn)值
     */
    long value() default RetryWaitConst.VALUE_MILLS;

    /**
     * 最小值
     * @return 最小值
     */
    long min() default RetryWaitConst.MIN_MILLS;

    /**
     * 最大值
     * @return 最大值
     */
    long max() default RetryWaitConst.MAX_MILLS;

    /**
     * 影響因數(shù)
     * 1. 遞增重試，默認(rèn)為 {@link RetryWaitConst#INCREASE_MILLS_FACTOR}
     * 2. 指數(shù)模式。默認(rèn)為 {@link RetryWaitConst#MULTIPLY_FACTOR}
     * @return 影響因數(shù)
     */
    double factor() default Double.MIN_VALUE;

    /**
     * 指定重試的等待時(shí)間 class 信息
     * @return 重試等待時(shí)間 class
     */
    Class retryWait() default NoRetryWait.class;

}

定義好了注解，肯定要有注解的相關(guān)使用。

關(guān)于注解的使用，主要有兩種方式。

基于代理模式和字節(jié)碼增強(qiáng)。

如果是項(xiàng)目中沒(méi)有使用 spring，直接使用這種方式比較方便。

可以和 spring 直接整合。

使用方式和 spring-retry 是一樣的。

為了便于用戶更加方便地使用注解，同時(shí)又不依賴 spring。

提供基于代碼模式+字節(jié)碼增強(qiáng)實(shí)現(xiàn)的方式。

引入注解相關(guān)模塊。

    ${project.groupId}
    sisyphus-annotation
    ${project.version}

以下測(cè)試代碼可以參考 [spring-test]() 模塊。

MenuServiceImpl.java

public class MenuServiceImpl {

    public void queryMenu(long id) {
        System.out.println("查詢菜單...");
        throw new RuntimeException();
    }

    @Retry
    public void queryMenuRetry(long id) {
        System.out.println("查詢菜單...");
        throw new RuntimeException();
    }

}

使用 RetryTemplate 進(jìn)行測(cè)試

@Test(expected = RuntimeException.class)
public void templateTest() {
    MenuServiceImpl menuService = RetryTemplate.getProxyObject(new MenuServiceImpl());
    menuService.queryMenu(1);
}

日志信息

查詢菜單...

只請(qǐng)求了一次。

@Test(expected = RuntimeException.class)
public void templateRetryTest() {
    MenuServiceImpl menuService = RetryTemplate.getProxyObject(new MenuServiceImpl());
    menuService.queryMenuRetry(1);
}

日志信息

查詢菜單...
查詢菜單...
查詢菜單...

當(dāng)然還有更多的配置，可以自行嘗試。

如果你想結(jié)合 spring 使用注解，請(qǐng)繼續(xù)往下看。

類(lèi)似于 spring-retry 框架，如果你使用 spring 框架，那么整合本項(xiàng)目將會(huì)非常簡(jiǎn)單。

注解的方式和過(guò)程式編程，二者盡可能的保持一致性，你想從一種方式變?yōu)榱硪环N也比較簡(jiǎn)單。

想從 spring-retry 切換到本框架也很方便。

    ${project.groupId}
    sisyphus-spring
    ${project.version}

會(huì)默認(rèn)引入 spring 以及 AOP 相關(guān) jar。

你可以參考 sisyphus-test 模塊。

下面模擬非常常見(jiàn)的一些業(yè)務(wù)方法。

使用 @Retry 標(biāo)識(shí)方法需要進(jìn)行重試。

SpringService.java

public interface SpringService {

    /**
     * 查詢示例代碼
     * @return 結(jié)果
     */
    String query();

}

SpringServiceImpl.java

import com.github.houbb.sisyphus.annotation.annotation.Retry;
import com.github.houbb.sisyphus.test.service.SpringService;
import org.springframework.stereotype.Service;

/**
 * @author binbin.hou
 * @since 0.0.4
 */
@Service
public class SpringServiceImpl implements SpringService {

    @Override
    @Retry
    public String query() {
        System.out.println("spring service query...");
        throw new RuntimeException();
    }

}

基于注解直接如下配置即可。

使用 @EnableRetry 標(biāo)識(shí)需要開(kāi)啟重試。

@Configurable
@ComponentScan(basePackages = "com.github.houbb.sisyphus.test.service")
@EnableRetry
public class SpringConfig {
}

import com.github.houbb.sisyphus.test.config.SpringConfig;
import com.github.houbb.sisyphus.test.service.SpringService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

/**
 * @author binbin.hou
 * @since 0.0.4
 */
@ContextConfiguration(classes = SpringConfig.class)
@RunWith(SpringJUnit4ClassRunner.class)
public class SpringServiceTest {

    @Autowired
    private SpringService springService;

    @Test(expected = RuntimeException.class)
    public void queryTest() {
        springService.query();
    }

}

日志信息

spring service query...
spring service query...
spring service query...