Client RPC

从一个客户端程序来访问节点有多种方式,但是如果你的客户端一个用一个 JVM 兼容语言所编写的话,那么最方便的方式就是使用客户端类库来跟节点互动。这个类库会通过使用一个消息队列协议来跟运行着的节点进行连接,然后会提供一个简单的 RPC 接口来跟节点互动。你可以像通常那样去调用一个 Java 对象,然后来回的消息交互它会帮你控制。

这个客户端类库的起点是 CordaRPCClient 类。它提供了 一个 start 方法,返回了一个 CordaRPCConnection,包含了一个 CordaRPCops 的实现,可以通过 Kotlin 中的 proxy 和 Java 中的 getProxy() 来进行访问。 RPCs 返回的 observables 可以被订阅来接收节点的任何更新的 ongoing stream。

注意:这个返回的 CordaRPCConnection 即使创建和消费很小一部分服务器端资源都是非常昂贵的(消耗大)。当你使用完了它之后,调用它的 close 方法。或者你也可以在 CordaRPCClient 上使用 use 方法,这个会在传入的 lambda 结束之后自动清理。不要为你的每次调用创建一个新的 proxy – 重用一个已经存在的。

RPC 权限

如果一个节点的 owner 想跟它的节点通过 RPC 来互动的话(比如读取节点 storage 中的内容),他必须要定义一个或多个 RPC 用户。每个用户会通过一个用户名和密码来进行验证,还会被赋予一系列的RPC 能够使用的权限。

这些用户信息会被添加到节点的 node.conf 文件中。

添加一个 RPC 用户的语法如下:

rpcUsers=[
    {
        username=exampleUser
        password=examplePass
        permissions=[]
    }
    ...
]

目前,用户设置指定的权限才能够通过 RPC 启动 flows。这些权限设置如下:

rpcUsers=[
    {
        username=exampleUser
        password=examplePass
        permissions=[
            "StartFlow.net.corda.flows.ExampleFlow1",
            "StartFlow.net.corda.flows.ExampleFlow2"
        ]
    }
    ...
]

注意:当前,节点的 web server 具有超级用户的权限,这就意味着该用户可以不登陆就运行任何的 RPC 操作。这个会在未来的 release 中被改正。

Observables

RPC 系统使用一种特殊的方式来处理 observables。当一个方法返回 observable 的时候,或者直接返回,或者作为一个 response object graph 的子对象返回,客户端会创建一个跟服务器端匹配的 observable。服务器端 observable 发出的对象会被放进一个队列中,这个队列会被客户端来消费。返回的 observable 设置可能会发出含有更多的 observables 的 object graphs,它会像你期望的那样来工作的。

这个特性是要有一定的消耗的:server 必须要不断地接收由服务器端发出的对象直到你把他们下载下来。注意,服务器端的 observation buffer 是固定的,一旦被用光,客户端会变得很慢。你应该 subscribe 所有返回的 observables,否则的话随着 observations 的进入,客户端的内存就会不断的被使用。如果你不想要一个 observable,那么你先 subscribe 然后立即 unsubscribe,这样会清理掉客户端的 buffer,也会让 server 停止 streaming。如果你的 app 退出了的话,那么服务器端的资源会被自动释放。

注意:如果你在客户端泄露了一个 observable,然后它得到了搜集到的垃圾,你会在 log 中看到一个警示提示,并且 observable 会被自动的 unsubscribe。但是不要完全依赖于这个,因为垃圾回收是无法预测( non-deterministic)的。

未来

一个方法也能够在它的 object graph 中返回一个 ListenableFuture 并且会像对待 observables 的方式来对待它。在未来调用 cancel 方法会解除对任何未来的值的订阅并释放所有的资源。

版本(Versioning)

客户端 RPC 协议是使用节点的 Platform Version 来定义版本的。当一个代理(proxy)被创建后,server 会查询它的版本,你可以指定你的最小版本要求。在后期的版本中被添加的方法都会带有 @RPCSinceVersion 的注解。如果你使用了一个 server 不支持的方法,一个 UnsupportedOperationException 的异常会被抛出。如果你想知道 server 的版本,只需要使用 protocolVersion 属性(比如 Java 中的 getProtocolVersion)。

线程安全(Thread safety)

一个代理(proxy)是线程安全的、阻塞的(blocking)并且允许多个 RPCs 同时存在。任何返回的和你订阅的 observables 将会有对象会在后台运行的线程池中被有序地 emitted。每个 observable stream 会被绑定到一个单独的线程,但是要注意到的是,两个独立的 observables 可能在不同的线程上调用他们对应的 callbacks。

异常处理

如果 RPC 基础架构本身出了问题,一个 RPCException 会被抛出。如果你调用了一个要求比当前 server 支持的版本更高的一个方法, UnsupportedOperationException 异常会被抛出。否则的话,如果 server 的实现抛出了一个异常,这个异常会被序列化(serialised)并且被重新抛到客户端,因为它实际是从被调用的 RPC 方法中被抛出来的。

Wire 协议

客户端 RPC wire 协议是在 net/corda/client/rpc/RPCApi.kt 中被定义和文档化的。

Corda 节点的白名单类

CorDapps 对于通过 RPC 所使用的任何类,都要使用 Corda 的序列化(serialization) framework 将他们添加至白名单,除非这些类已经在 DefaultWhitelist 中默认地被添加到白名单中了。添加白名单的操作既可以通过 plugin architecture 或者使用 @CordaSerializable 注解来实现。

发表评论

电子邮件地址不会被公开。 必填项已用*标注