自定义方法重试注解

概述

当你的系统依赖外部服务时,总是会有那么一些方法在执行时有可能会失败。方法执行失败了,那自然是再调用一次试试,说不定就调通了呢。为每个方法编写重试代码显然是对程序员的折磨,故下面我们介绍一个清爽的方法重试方案,其最终效果是被标注为@RetryExecution的方法,如果在运行过程中抛了异常,其会被再次尝试运行若干次。

(相同的思路,还可以实现自定义事物、锁、时间统计、异步重试等很多功能)

Spring AOP Proxies

关于Spring AOP的详细介绍参见官方文档,这里我们只介绍AOP Proxies的核心思想。考虑如下场景:

public class SimplePojo implements Pojo {

   public void foo() {
      // this next method invocation is a direct
      call on the 'this' reference
      this.bar();
   }

   public void bar() {
      // some logic...
   }
}
public class Main {

   public static void main(String[] args) {

      Pojo pojo = new SimplePojo();

      // this is a direct method call on the 'pojo' reference
      pojo.foo();
   }
}
aop_proxy_plain_pojo_call

当我们创建一个对象的实例,通过其实例的引用调用其方法时,我们直接调用了对象的方法。倘若我们想在方法执行前后做一些额外的工作,但是不侵入方法的代码,一个自然的想法就是为对象创建代理。

public class Main {

   public static void main(String[] args) {

      ProxyFactory factory = new ProxyFactory(new SimplePojo());
      factory.addInterface(Pojo.class);
      factory.addAdvice(new RetryAdvice());

      Pojo pojo = (Pojo) factory.getProxy();

      // this is a method call on the proxy!
      pojo.foo();
   }
}
aop_proxy_call

我们为对象创建了动态代理,对象的方法实际上由代理负责执行,由此我们得以通过定义代理的行为,在不侵入原方法的代码的情况下扩展方法的执行行为(e.g. 事物、计时、重试、etc.)。

实现方案

基于如上原理,我们接下来通过扩展AOP API来实现清爽的方法重试方案。

定义重试注解

/**
 * Created by benxue on 3/24/16.
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
@Documented
public @interface RetryExecution {
    int retryTimes() default 1;
}

定义拦截器

这里是被标注的方法实际执行的地方。

/**
 * Created by benxue on 3/24/16.
 */
@Component
public class RetryMethodInterceptor implements MethodInterceptor {

    private static final Logger logger = LogManager.getLogger(RetryMethodInterceptor.class.getName());

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {

       //cglib代理和jvm代理在获取annotation时是不是有区别?
        int retryTimes = invocation.getMethod().getAnnotation(RetryExecution.class).retryTimes();

        while (--retryTimes >= 0) {
            try {
                return invocation.proceed();
            } catch (Throwable t) {
                logger.error(t);
            }
        }
        return invocation.proceed();
    }
}

定义Advisor

Spring容器初始化Bean时,通过Advisor的Pointcut对象判断Bean中的方法是否需要被特殊处理(我们的例子中通过注解类型判断,同时判断结果会缓存下来)。如果需要,当方法通过代理被调用时,其会被转给Advisor的getAdvice方法返回的拦截器执行。

/**
 * Created by benxue on 3/24/16.
 */
@Component
public class RetryMethodAdvisor extends AbstractPointcutAdvisor {

    private final StaticMethodMatcherPointcut pointcut = new
            StaticMethodMatcherPointcut() {
                @Override
                public boolean matches(Method method, Class<?> targetClass) {
                    return method.isAnnotationPresent(RetryExecution.class);
                }
            };

    @Autowired
    private RetryMethodInterceptor interceptor;

    @Override
    public Pointcut getPointcut() {
        return this.pointcut;
    }

    @Override
    public Advice getAdvice() {
        return this.interceptor;
    }
}

全局配置

下面的配置会使得Spring在初始化时,寻找全部存在的的Advisor,并尝试通过识别出的Advisor为所有存在的Bean的方法配置拦截器。(其实我们强制使用了cglib)

<bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator">
    <property name="proxyTargetClass" value="true"/>
</bean>

<aop:aspectj-autoproxy proxy-target-class="true"/>

使用示例 && Self Injection

/**
 * Created by benxue on 3/16/16.
 */
@Service
public class ServiceImpl implements Service {

    ServiceImpl self;

    @Autowired
    private ApplicationContext applicationContext;

    // 在Service初始化完成之后,注入其Reference
    @PostConstruct
    private void init() {
        self = applicationContext.getBean("ServiceImpl", ServiceImpl.class);
    }
    
    @Override
    public void hello(){
        self.hahaha();
    }
    
    @Override
    public void hi(){
        hahaha();
    }
    
    @RetryExecution
    @Override
    public void hahaha() throw RuntimeException(){...}
}
public class Test {

    @Autowired
    private Service service;

    private void test() {
        service.hello();// 如果抛出异常,hahaha会被重新执行一次
        service.hi(); // hahaha被本地调用,无论是否抛出异常,hahaha都不会被重试
        service.hahaha(); // 如果抛出异常,hahaha会被重新执行一次
    }
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,383评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,522评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,852评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,621评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,741评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,929评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,076评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,803评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,265评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,582评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,716评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,395评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,039评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,027评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,488评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,612评论 2 350

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 什么是Spring Spring是一个开源的Java EE开发框架。Spring框架的核心功能可以应用在任何Jav...
    jemmm阅读 16,445评论 1 133
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,218评论 11 349
  • 来,让我们一起谈论我们的灵魂 甚至避开自己的耳目 就像一座玫瑰园 永远保持着微笑 就像想象力无声的诉说 像精神统治...
    咏鹅阅读 208评论 0 0