JSONRPC

一个简单的 Swift 库，用于 JSON-RPC

特性

• 类型安全
• 灵活的数据传输支持
• 并发支持

dependencies: [
    .package(url: "https://github.com/ChimeHQ/JSONRPC", from: "0.9.0")
]

您将使用的核心类型是 JSONRPCSession。它需要您设置一个 DataChannel 对象，该对象处理原始数据的读取和写入。

let channel = DataChannel(...)
let session = JSONRPCSession(channel: channel)

let params = "hello" // any Encodable
let response: Decodable = try await session.sendRequest(params, method: "my_method")

Task {
    for await (request, handler, data) in session.requestSequence {
        // inspect request, possibly re-decode with more specific type,
        // and reply using the handler
    }
}

Task {
    for await (notification, data) in session.notificationSequence {
        // inspect notification
    }
}

DataChannel 上的闭包允许使用不同的传输机制。 JSONRPC 包提供了一些基本变体

• 预定义消息通道
  • 一个传递静态消息集的通道
  • 用法：let channel = await DataChannel.predefinedMessagesChannel(with: messages)
• Stdio 通道
  • 使用 stdout + stdin 作为消息传输。
  • 注意：当使用此传输时，请确保没有非协议消息发送到 stdout，例如使用 print
  • 用法：let channel = DataChannel.stdioPipe()
• Actor 通道
  • 使用 Swift actors 传递消息。
  • 例如，当客户端和服务器都在 Swift 中实现并在同一进程中运行时，这可能对测试很有用。
  • 用法：let (clientChannel, serverChannel) = DataChannel.withDataActor()
• WebSocket 通道
  • 使用 URLSessionWebSocketTask 作为消息传输。
  • 用法：let channel = DataChannel.webSocket(url: socketURL, terminationHandler: { print("socket closed" })

我很乐意听到您的声音！问题或拉取请求都很棒。 Matrix space 和 Discord 都可用于实时帮助，但我强烈倾向于以文档的形式回答。您也可以在 mastodon 上找到我。

我更喜欢协作，如果您有类似的项目，我很乐意找到合作方式。

我更喜欢使用制表符进行缩进以提高可访问性。但是，我宁愿您使用您想要的系统并创建一个 PR，而不是因为空格而犹豫。

参与此项目即表示您同意遵守贡献者行为准则。