R3 Corda: 升级 CorDapp(非平台版本升级)- Flow 版本

原文地址:https://docs.corda.net/upgrading-cordapps.html#flow-versioning

任何初始化其他 flows 的 flow 必须要使用 @InitiatingFlow 注解,像下边这样定义:

annotation class InitiatingFlow(val version: Int = 1)

version 属性默认值为1,定义了 flow 的版本。当flow 有任何一个新的 release 的时候并且这个 release 包含的变动是非向下兼容的,这个数值应该增加。一个非向下兼容的改动是一个改变了 flow 的接口的变动。

Flow 的接口是如何定义的?

Flow 的接口是通过在 InitiatingFlowInitiatedBy flow 之间有序的 sendreceive 调用来定义的,包括发送和接受的数据的类型。我们可以将 flow 的接口如下图这样表示:

Flow 接口

在上边的图中,InitiatingFlow

  • 发送了一个 Int
  • 接收了一个 String
  • 发送了一个 String
  • 接收了一个 CustomType
    InitiatedBy flow 恰恰相反:
  • 接收了一个 Int
  • 发送了一个 String
  • 接收了一个 String
  • 发送了一个 CustomType
    只要 IntiatingFlowInitiatedBy flows 遵循这个有序的一系列的动作,那么 flows 就可以按照任何你觉得合适的方式来实现(包括添加不共享给其他节点的业务逻辑)。

哪些是非向下兼容的改动?

Flow 可以有两种主要的方式会变为非向下兼容的:

  • sendreceive 调用的顺序变化:
    1. 一个 send 或者 receiveInitiatingFlow 或者 InitiatedBy flow 中被添加或者删除了
    2. sendreceive 调用的顺序变了
  • sendreceive 调用的类型变了

当运行不兼容版本的 flows 会发生什么?

带有非兼容接口的 InitiatingFlowInitiatedBy flows 可能会出现下边的行为:

  • flows 会没有明确原因地停住了并且永远也不会终止,通常是因为一个 flow 在等待这着一个回复,但是这个回复永远不会从另一方返回来
  • 其中的一个 flow 会带有异常地结束:“Expected Type X but Received Type Y”,因为 send 或者 receive 类型不正确
  • 其中的一个 flow 会带有异常地结束:“Counterparty flow terminated early on the other side”,因为一个 flow 向另外一个 flow 发送了一些数据,但是后边这个 flow 已经结束了

我应该如何升级我的 flows?

  1. 更新 flow 并且测试。在 InitiatingFlow 注解中增加 flow 版本号。
  2. 确保已经存在的所有版本的 flow 已经运行完了并且没有未结束的 SchedulableFlows 在网络中的任何节点中。这个可以通过清理节点的方式来实现,接下来会讲到。
  3. 关闭节点
  4. 用包含新的 flow 的 CorDapp JAR 文件替换掉原来的 CorDapp JAR
  5. 启动节点

如果你关掉了所有的节点并且同时更新了他们的 flow 的话,可能产生任何的不兼容的改动。

对于一些节点可能仍旧继续运行某个 flow 的以前版本的情况,这样你的新版本 flow 可能会跟一个旧版本进行沟通,更新的 flows 需要具备向下兼容性。这可能是任何真正的部署中都会发生的问题,你可能不会很容易地去在整个网络中去协调推出一个新的 code。

我该如何确保 flow 的向下兼容性?

InitiatingFlow 版本号会被包含在 flow session handshake 中并且通过 FlowLogic.getFlowContext 方法暴露给双方。这个方法需要一个 Party 作为输入,然后会返回一个 FlowContext 对象,这个对象描述了在对方节点上正在运行的 flow。它含有一个 flowVersion 的属性,可以使用这个属性来在不同的 flow 版本间来定制你自己的 flows,例如:

@Suspendable
override fun call() {
    val otherFlowVersion = otherSession.getCounterpartyFlowInfo().flowVersion
    val receivedString = if (otherFlowVersion == 1) {
        otherSession.receive<Int>().unwrap { it.toString() }
    } else {
        otherSession.receive<String>().unwrap { it }
    }
}

上边的代码演示了当 flow 的第一个版本期望收到一个 Int,但是后续的版本变成了期望收到一个 String。这个 flow 在跟其他仍然运行着包含旧的 flow 的旧的 CorDapp 之间还是能够进行沟通的。

我该如何处理关于 in-lined subflows 的接口变化?

下边是一个 in-lined subflow:

@StartableByRPC
@InitiatingFlow
class FlowA(val recipient: Party) : FlowLogic<Unit>() {
    @Suspendable
    override fun call() {
        subFlow(FlowB(recipient))
    }
}

@InitiatedBy(FlowA::class)
class FlowC(val otherSession: FlowSession) : FlowLogic() {
    // Omitted.
}

// Note: No annotations. This is used as an inlined subflow.
class FlowB(val recipient: Party) : FlowLogic<Unit>() {
    @Suspendable
    override fun call() {
        val message = "I'm an inlined subflow, so I inherit the @InitiatingFlow's session ID and type."
        initiateFlow(recipient).send(message)
    }
}

In-lined subflows 是当跟对方初始一个新的 flow session 的时候被调用的 flows。假设 flow A 调用 in-lined subFlow BB 初始了一个跟对方的会话(session)。对方使用的 FlowLogic 类型决定应该调用哪个对应的 flow 应该是由 A 决定的,而不是 B。这意味着 in-lined flow 的 response logic 必须要在 InitiateBy flow 里被显式地实现。这个可以通过调用一个匹配的 in-lined counter-flow,或者在对方的被初始的父的 flow 中显式地实现。In-lined subflows 也会从他们的父 flow 中继承 session IDs。

因此,一个 in-lined subflow 的一个借口的改动必须要考虑对父 flow 接口也要有一个改动。

一个 in-lined subflow 的例子是 CollectSignaturesFlow。他有一个没有 InitiateBy 注解的 response 的 flow 叫 SignTransactionFlow。这是因为这两个 flows 都是 in-lined。这两个 flows 是如何彼此交流的是通过调用他们的父 flows 来定义的。

在代码中,in-lined subflows 看起来就是一个常规的 FlowLogic 的实例,但是没有 InitiatingFlow 或者 InitiatedBy 注解。

In-lined subflows 是没有版本的,因为他们的版本是继承于他们的父 flow 的(InitiatingFlowInitiatedBy)。

不是 InitiatingFlow 或者 InitiatedBy flow,也不是由一个 InitiatingFlow 或者 InitiatedBy flow 调用的 in-lined subflows ,更新的时候可以不考虑向下兼容的问题。这种类型的 flows 包括用来查询 vault 的 utility flows,或者对外部系统进行查询的 flows。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • feisky云计算、虚拟化与Linux技术笔记posts - 1014, comments - 298, trac...
    不排版阅读 3,813评论 0 5
  • 我真正意义上完整看完的第一部韩剧,去年这个时候就看完了,直到今天偶然间又听到了剧中的插曲,勾起了我全部的回忆...
    鱼嚎阅读 300评论 0 1
  • 如果有一天,可以选择,我定会选择远走高飞,远走他乡,我们不必活在别人的眼里,却时时活在别人的眼中。 ...
    hello橙阅读 553评论 0 1
  • 姜广平老师不光光是一位优秀的作家,还是一位优秀的文学评论家。 说到文学评论,我还是在上大学的时候第一次听说。当时,...
    上官飞鸿阅读 1,731评论 29 38