在使用 Apollo GraphQL Server 进行数据查询时，有时候我们需要在查询过程中主动中断。比如某些查询可能需要大量的计算资源，而我们希望能够在不影响服务器性能的前提下，尽可能地快速响应客户端请求。在这种情况下，中断查询是一种很有效的策略。
本文将介绍 Apollo GraphQL Server 中断查询的方法，详细探讨其原理和实现方式，并提供示例代码和学习指导。
什么是中断查询？
中断查询指的是在查询过程中，服务器在满足某些条件时，主动中断查询并返回已获取到的部分数据。这样可以避免不必要的计算，提高服务器性能，并减少客户端的等待时间。
中断查询通常是通过查询执行器来实现的。查询执行器会在执行查询过程中进行一系列的检查，比如查询的条件、查询的数据量等，并根据这些检查结果来决定是否中断查询。
Apollo GraphQL Server 中断查询的实现方式
在 Apollo GraphQL Server 中，中断查询的实现方式主要有以下几种：
1. 取消 promise
最简单的中断查询方法是使用 promise，可以直接调用 promise 的 cancel 方法取消查询，如下所示：
// www.javascriptcn.com code example
export function myResolver(_, { id }) {
const cancellation = createCancellation()
doQuery(id, cancellation.promise)
return cancellation.promise
}
function doQuery(id, promise) {
// 查询数据
// 如果此时 promise 被取消，则退出函数
if (promise.isCancelled) {
return
}
// 继续查询数据
}这里使用了一个 createCancellation 方法来创建一个取消 promise，并将其传递给 doQuery 方法。在 doQuery 方法中会经常使用 isCancelled 方法来检查 promise 是否已取消，如已取消则直接退出查询。
2. 自定义中断策略
也可以通过自定义中断策略，来实现更加灵活的中断查询。
首先需要定义一个 checkShouldAbort 方法，用于检查是否应该中断查询：
function checkShouldAbort(context) {
if (...some conditions...) {
throw new Error('Query was aborted.')
}
}然后在查询执行器中，加入中断查询的逻辑：
// www.javascriptcn.com code example
async function executeQuery(query, schema, contextValue, rootValue, context) {
try {
checkShouldAbort(context)
const result = await graphql(
schema,
query,
rootValue,
contextValue,
context
)
checkShouldAbort(context)
return result
} catch (error) {
// 屏蔽错误信息，防止信息泄露
throw new Error('Query was aborted.')
}
}这里通过 checkShouldAbort 方法来检查是否需要中断查询，如果需要中断，则直接抛出异常。
3. 使用 Observable
使用 Observable 也是一种中断查询的方式。Observable 可以将查询结果作为一系列的事件进行推送，可以使用 takeUntil 操作符来中断查询：
// www.javascriptcn.com code example
import { Observable } from 'rxjs'
export function myResolver(_, { id }) {
// 创建 Observable 对象
const observable = new Observable(observer => {
doQuery(id, {
onNext: result => observer.next(result),
onError: error => observer.error(error),
onCompleted: () => observer.complete(),
})
})
// 中断查询
const abortController = new AbortController()
const signal = abortController.signal
observable.pipe(takeUntil(from(signal)))
return observable
}
function doQuery(id, { onNext, onError, onCompleted }) {
// 查询数据
// 如果 abortController.signal 被触发，则中断查询
if (signal.aborted) {
return
}
// 推送查询结果
onNext(result1)
onNext(result2)
// ...
onCompleted()
}这里首先创建了一个 Observable 对象，然后使用 doQuery 方法来查询数据，并使用 takeUntil 操作符来捕获信号。使用 AbortController 的 signal 来控制查询的中断。
示例代码
下面是一个简单的示例，展示了如何使用 Apollo GraphQL Server 中断查询：
// www.javascriptcn.com code example
import { makeExecutableSchema } from 'graphql-tools'
import { graphql } from 'graphql'
import { from } from 'rxjs'
import { takeUntil } from 'rxjs/operators'
// 定义查询类型和部分 resolvers
const typeDefs = `
type Query {
users: [User!]!
}
type User {
id: ID!
name: String!
age: Int!
}
`
const users = [
{ id: 1, name: 'Alice', age: 21 },
{ id: 2, name: 'Bob', age: 22 },
{ id: 3, name: 'Charlie', age: 23 },
{ id: 4, name: 'David', age: 24 },
{ id: 5, name: 'Eva', age: 25 },
]
const resolvers = {
Query: {
users: () => {
// 创建一个 Observable 对象
const observable = new Observable(observer => {
// 查询数据
users.forEach(user => {
observer.next(user)
// 如果满足一定条件，则中断查询
if (user.age >= 23) {
observer.complete()
}
})
observer.complete()
})
// 中断查询
const abortController = new AbortController()
const signal = abortController.signal
observable.pipe(takeUntil(from(signal)))
return observable
},
},
}
// 创建 schema，并执行查询
const schema = makeExecutableSchema({
typeDefs,
resolvers,
})
graphql(schema, '{ users { id name age } }')
.then(console.log)
.catch(console.error)在上面的示例中，我们声明了一个简单的查询类型和 Query resolver，然后创建了一个 Observable 对象，使用 forEach 方法查询数据，并在满足一定条件时中断查询。
学习指导
中断查询是一个比较高级的查询优化技巧，需要熟悉 JavaScript 的 Promise 和 Observable 等异步编程方式，并掌握 GraphQL 的查询执行流程和中断查询的原理。
如果您想进一步学习 GraphQL 或其他前端技术，推荐以下文章：
以上参考文章和文档可以帮助您更加深入地理解中断查询及其相关的技术。
Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/67d85310a941bf7134ed0b0f