Flutter GraphQL服务端通信插件graphql_server2的使用

Graphql Server 2

package:graphql_server2 是一个用于实现GraphQL服务器的基础包。你可能会更喜欢 package:angel3_graphql，这是在Dart中实现GraphQL后端最快的方法。

package:graphql_server2 不依赖于任何特定框架，因此可以在任何Dart项目中使用。

Ad-hoc Usage

实际的查询功能由 GraphQL 类处理，它接受来自 package:graphql_schema2 的模式（schema）。在大多数情况下，你将想要在一些GraphQL文本字符串上调用 parseAndExecute 方法。它返回一个 Stream 或 Map<String, dynamic>，并且可能抛出一个 GraphQLException（它是JSON可序列化的）：

try {
    var data = await graphQL.parseAndExecute(responseText);

    if (data is Stream) {
        // 处理订阅...
    } else {
        response.send({'data': data});
    }
} on GraphQLException catch(e) {
    response.send(e.toJson());
}

你可以查阅API文档以获取更多：API Document

如果你需要类似于 graphql-js 中的 graphQLHttp 功能，那么这个包不包含此功能，因为它通常特定于你使用的框架/平台。package:angel3_graphql 中的 graphQLHttp 实现是一个很好的例子：graphQLHttp source code

Subscriptions

涉及 subscription 操作的GraphQL查询可以返回一个 Stream。最终，向客户端传递订阅事件的传输方式不在GraphQL规范中指定，所以这取决于你自己。

注意，在这样的模式中：

type TodoSubscription {
    onTodo: TodoAdded!
}

type TodoAdded {
    id: ID!
    text: String!
    isComplete: Bool
}

你的Dart模式的 onTodo 解析器应该是一个包含 onTodo 键的 Map：

field(
  'onTodo',
  todoAddedType,
  resolve: (_, __) {
    return someStreamOfTodos()
            .map((todo) => {'onTodo': todo});
  },
);

为了重用现有的工具（即JS客户端等），package:graphql_server2 实现了Apollo的 subscriptions-transport-ws 规范。

注意：此时，Apollo的规范与其客户端实际期望的协议严重不同步。 参见以下问题以跟踪此情况： https://github.com/apollographql/subscriptions-transport-ws/issues/551

该实现基于 package:stream_channel 构建，因此可以在任何双向传输上使用，无论是WebSockets、TCP套接字、Isolates等。

使用此包的用户预计会扩展 Server 抽象类。Server 将处理传输和通信，但再次强调，发出订阅事件取决于你的实现。

这是一个来自 package:angel3_graphql 中 graphQLWS 的片段。它在一个单一请求的上下文中运行：

var channel = IOWebSocketChannel(socket);
var client = stw.RemoteClient(channel.cast<String>());
var server =
    _GraphQLWSServer(client, graphQL, req, res, keepAliveInterval);
await server.done;

请参阅 package:angel3_graphql 中的 graphQLWS 以获取一个很好的例子：graphQLWS source code

Introspection

GraphQL模式的内省允许客户端查询模式本身，并获取有关服务器预期响应的信息。GraphQL 类自动处理这一点，因此你不需要为此编写任何代码。

但是，你可以调用 reflectSchema 方法手动反射模式：API Document

Mirrors Usage

默认情况下，dart:mirrors 不是必需的，但它可以被选择性地使用。

mirrorsFieldResolver 可以从具体对象解析字段，而无需你首先将其序列化：API Document

你还可以使用 convertDartType 将具体Dart类型转换为 GraphQLType。然而，理想的选择是 package:graphql_generator2。

• API Document
• package:graphql_generator2

示例代码

以下是一个完整的示例demo，展示了如何使用 graphql_server2 包创建一个简单的GraphQL服务器：

import 'package:graphql_schema2/graphql_schema2.dart';
import 'package:graphql_server2/graphql_server2.dart';
import 'package:test/test.dart';

void main() {
  test('single element', () async {
    var todoType = objectType('todo', fields: [
      field(
        'text',
        graphQLString,
        resolve: (obj, args) => obj.text,
      ),
      field(
        'completed',
        graphQLBoolean,
        resolve: (obj, args) => obj.completed,
      ),
    ]);

    var schema = graphQLSchema(
      queryType: objectType('api', fields: [
        field(
          'todos',
          listOf(todoType),
          resolve: (_, __) => [
            Todo(
              text: 'Clean your room!',
              completed: false,
            )
          ],
        ),
      ]),
    );

    var graphql = GraphQL(schema);
    var result = await graphql.parseAndExecute('{ todos { text } }');

    print(result);
    expect(result, {
      'todos': [
        {'text': 'Clean your room!'}
      ]
    });
  });
}

class Todo {
  final String? text;
  final bool? completed;

  Todo({this.text, this.completed});
}

在这个示例中，我们定义了一个简单的 Todo 类型和一个包含 todos 查询的模式。然后我们创建了一个 GraphQL 实例并执行了一个查询。最后，我们打印并验证了结果。

希望这些信息能帮助你更好地理解和使用 graphql_server2 包！如果有任何问题或需要进一步的帮助，请随时提问。