首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Play-Utils:一个专门为 Play Framework 开发的实用工具包模块

Play-Utils:一个专门为 Play Framework 开发的实用工具包模块

作者头像
joymufeng
发布2019-03-12 16:04:45
5570
发布2019-03-12 16:04:45
举报

Play-Utils 介绍

Play-Utils 是一个专门为 Play Framework 开发的实用工具包模块,目前已实现如下功能:

  • Retry 自动请求重试

1 Retry

Retry 工具包可以帮助你设置不同的重试策略,自动重试失败的请求,最终返回成功的结果或者是最后一次重试结果。

1.1 基本用法

将以下依赖添加至build.sbt文件:

libraryDependencies += "cn.playscala" %% "play-utils" % "0.1.0"

最简单的重试策略是固定时间重试,即每次重试的时间间隔相同。 在开始编码之前,你需要将Retry实例依赖注入到需要的地方:

class ExternalService @Inject()(retry: Retry)

下面的代码使用固定时间重试策略,每秒重试一次,最多重试3次:

import scala.concurrent.duration._

retry.withFixedDelay[Int](3, 1 seconds) { () =>
  Future.successful(0)
}.stopWhen(_ == 10)

stopWhen 用于设置重试终止条件,即当 Future 结果为 10 时直接返回该Future。你也可以使用 retryWhen 设置重试条件:

import scala.concurrent.duration._

retry.withFixedDelay[Int](3, 1 seconds) { () =>
  Future.successful(0)
}.retryWhen(_ != 10)

需要特别注意的是,如果在重试过程中发生异常,则会自动继续进行下一次重试。

除了采用依赖注入方式,你也可以直接使用单例对象Retry, 但是需要注意的是,选择单例对象方式需要在当前作用域内提供如下两个隐式对象:

implicit val ec: ExecutionContext = ...
implicit val scheduler: Scheduler = ...

Retry.withFixedDelay[Int](3, 1 seconds).apply { () =>
  Future.successful(0)
}.retryWhen(s => s != 10)

下文中如无特殊说明,默认为采用依赖注入方式,注入实例变量名为retry

你可以通过 withExecutionContext 和 withScheduler 两个方法设置自定义的线程池和定时器:

import scala.concurrent.duration._

retry.withFixedDelay[Int](3, 1 seconds) { () =>
  Future.successful(0)
}.withExecutionContext(ec)
 .withScheduler(s)
 .retryWhen(_ != 10)

1.2 重试策略

某些场景下,固定时间重试可能会对远程服务造成冲击,因此Retry提供了多种策略供你选择。

1.2.1 BackoffRetry

BackoffRetry包含两个参数,参数delay用于设置第一次延迟时间,参数factor是一个乘积因子,用于延长下一次的重试时间:

import scala.concurrent.duration._

retry.withBackoffDelay[Int](3, 1 seconds, 2.0) { () =>
  Future.successful(0)
}.retryWhen(_ != 10)

重试的延迟时间依次为:1 seconds2 seconds 和 4 seconds

1.2.2 JitterRetry

JitterRetry包含两个参数minDelaymaxDelay,用于控制延迟时间的上限和下限,真实的延迟时间会在这两个值之间波动:

import scala.concurrent.duration._

retry.withJitterDelay[Int](3, 1 seconds, 1 hours) { () =>
  Future.successful(0)
}.retryWhen(_ != 10)

1.2.3 FibonacciRetry

FibonacciRetry使用斐波纳契算法计算下一次的延迟时间:

import scala.concurrent.duration._

retry.withFibonacciDelay[Int](4, 1 seconds) { () =>
  Future.successful(0)
}.retryWhen(_ != 10)

重试的延迟时间依次为:0 seconds1 seconds1 seconds 和 2 seconds

需要注意的是,你可以设置baseDelay参数控制延迟的时间间隔:

import scala.concurrent.duration._

retry.withFibonacciDelay[Int](4, 2 seconds) { () =>
  Future.successful(0)
}.retryWhen(_ != 10)

重试的延迟时间依次为:0 seconds2 seconds2 seconds 和 4 seconds

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2018/09/20 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Play-Utils 介绍
  • 1 Retry
    • 1.1 基本用法
      • 1.2 重试策略
        • 1.2.1 BackoffRetry
        • 1.2.2 JitterRetry
        • 1.2.3 FibonacciRetry
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档