订阅

订阅是持久存在的GraphQL读取操作，可以在一段时间内更新其响应，使客户端能够在数据可用时接收新数据。

Apollo iOS支持以下协议上的订阅

• WebSocket，包括多个子协议
• HTTP，使用分块的多部分响应（版本1.1.0及以后）

您必须使用 GraphQL 终端的支持的协议。

启用支持

为了支持GraphQL订阅，您需要使用支持订阅的ApolloClient实例初始化一个NetworkTransport. 下面是每个订阅协议的相关类。

WebSocket

为了使用基于 WebSocket 的Apollo iOS订阅，您需要安装可选的ApolloWebSocket库。此库包括两个符合NetworkTransport协议的类：

• WebSocketTransport 通过WebSocket发送所有操作（包括查询以及变体）。
• SplitNetworkTransport 维持一个 WebSocketTransport 实例，以及 一个 UploadingNetworkTransport 实例（通常是 RequestChainNetworkTransport）。这提供了一个使用HTTP进行查询和变体以及WebSocket进行订阅的单一网络传输。

SplitNetworkTransport 推荐用于大多数用例，因为它允许您保持一个单一 NetworkTransport 设置，从而避免了使用多个客户端对象引起的问题。

以下是一个使用 SplitNetworkTransport 支持所有 操作类型 的 ApolloClient 设置示例：

1
/// A common store to use for `httpTransport` and `webSocketTransport`.
2
let store = ApolloStore()
3

4
/// A web socket transport to use for subscriptions
5
let webSocketTransport: WebSocketTransport = {
6
  let url = URL(string: "ws://127.0.0.1:8080/websocket")!
7
  let webSocketClient = WebSocket(url: url, protocol: .graphql_transport_ws)
8
  return WebSocketTransport(websocket: webSocketClient)
9
}()
10

11
/// An HTTP transport to use for queries and mutations
12
let httpTransport: RequestChainNetworkTransport = {
13
  let url = URL(string: "https://127.0.0.1:8080/graphql")!
14
  return RequestChainNetworkTransport(interceptorProvider: DefaultInterceptorProvider(store: store), endpointURL: url)
15
}()
16

17
/// A split network transport to allow the use of both of the above
18
/// transports through a single `NetworkTransport` instance.
19
let splitNetworkTransport = SplitNetworkTransport(
20
  uploadingNetworkTransport: httpTransport,
21
  webSocketNetworkTransport: webSocketTransport
22
)
23

24
/// Create a client using the `SplitNetworkTransport`.
25
let client = ApolloClient(networkTransport: splitNetworkTransport, store: store)

WebSocket子协议

Apollo iOS 支持以下WebSocket子协议用于订阅：

• graphql-ws，该协议已在subscriptions-transport-ws和AWS AppSync库中实现。（⚠️此协议正在维护中！）
• graphql-transport-ws，该协议已在graphql-ws库中实现。

提供授权令牌

在标准HTTP操作中，如果需要身份验证，通常会在请求中发送Authorization头。然而，在WebSocket中，由于需要持久连接，这不能随每个有效载荷发送。

对于WebSocket，connectingPayload提供了您通常在请求头中指定的参数。

请注意，这必须在创建WebSocketTransport时设置。如果您需要更新connectingPayload，您需要使用新的webSocketTransport重新创建客户端。

1
let webSocketTransport: WebSocketTransport = {
2
  let url = URL(string: "ws://127.0.0.1:8080/websocket")!
3
  let webSocketClient = WebSocket(url: url, protocol: .graphql_transport_ws)
4
  let authPayload: JSONEncodableDictionary = ["authToken": myAuthToken]
5
  let config = WebSocketTransport.Configuration(connectingPayload: authPayload)
6
  return WebSocketTransport(websocket: webSocketClient, config: config)
7
}()

HTTP

Apollo iOS的默认NetworkTransport为RequestChainNetworkTransport。在Apollo iOS1.1.0及以后版本中，该传输支持HTTP上的订阅，无需额外配置。

生成和执行

Apollo iOS支持通过代码生成进行订阅。与查询类似，订阅通过生成的类的实例表示，符合GraphQLSubscription协议。

1
subscription ReviewAdded {
2
  reviewAdded {
3
    id
4
    stars
5
  }
6
}

在生成这些类后，您可以使用订阅支持的NetworkTransport执行通过ApolloClient.subscribe(subscription:)。如果这样做，您的客户端将继续接收更新数据，直到订阅被取消。

1
let subscription = client.subscribe(subscription: ReviewAddedSubscription()) { result in
2
  guard let data = try? result.get().data else { return }
3
  print(data.reviews.map { $0.stars })
4
}

取消订阅

在完成订阅连接时取消订阅是非常重要的。只要订阅处于活动状态，它就保持与服务器之间的连接，并保留其resultHandler完成块。这可能会导致内存泄漏并降低应用程序的性能。

调用ApolloClient.subscribe(subscription:)时，将返回一个不透明的Cancellable。您可以通过在返回的Cancellable上调用cancel()来取消订阅。这终止了与服务器的连接并释放了resultHandler完成块。

取消订阅的取消对象在其被释放时不会取消自己！请确保自行调用cancel()。一个类可以通过使用其析构函数来确保在释放时取消它管理的任何订阅：

1
class ReviewViewController {
2

3
  let client: ApolloClient!
4
  private var subscription: Cancellable?
5

6
  func subscribeToReviews() {
7
    // Keep a reference to the subscription's cancellation object.
8
    self.subscription = client.subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in
9
      // Handle each update from the subscription.
10
    }
11
  }
12

13
  deinit {
14
    // Make sure the subscription is cancelled, if it exists, when this object is deallocated.
15
    self.subscription?.cancel()
16
  }
17
}