Flutter GraphQL模式生成插件graphql_schema2的使用

Flutter GraphQL模式生成插件graphql_schema2的使用

标题

GraphQL Schema 2

内容

• 版本信息:

  • Pub版本
  • Null Safety支持
  • Gitter讨论
  • 许可证
  • 维护状态

• 描述:

  • Dart实现的GraphQL类型系统。支持任何Dart运行的平台。
  • 设计决策旨在尽可能地与JavaScript参考实现保持一致，并正确实现官方规范。

• 功能:

  • 支持所有GraphQL类型：
    • String
    • Int
    • Float
    • Boolean
    • GraphQLObjectType
    • GraphQLUnionType
    • GraphQLEnumType
    • GraphQLInputObjectType
    • Date - ISO-8601日期字符串，反序列化为Dart DateTime对象

• 使用示例:

  • 使用辅助函数定义一个schema：

  final GraphQLSchema todoSchema = GraphQLSchema(
      query: objectType('Todo', [
        field('text', graphQLString.nonNullable()),
        field('created_at', graphQLDate),
      ]));
  

  • 所有GraphQL类型都是泛型的，以利用Dart的强类型支持。

• 序列化和反序列化:

  • GraphQL类型可以序列化和反序列化输入数据。具体实现取决于类型。

  var iso8601String = graphQLDate.serialize(DateTime.now());
  var date = graphQLDate.deserialize(iso8601String);
  print(date.millisecondsSinceEpoch);
  

• 验证:

  • GraphQL类型可以验证输入数据。

  var validation = myType.validate('[@root](/user/root)', {...});
  
  if (validation.successful) {
    doSomething(validation.value);
  } else {
    print(validation.errors);
  }
  

• 辅助函数:

  • graphQLSchema - 创建GraphQLSchema
  • objectType - 创建GraphQLObjectType带字段
  • field - 创建带有类型/参数/解析器的GraphQLField
  • listOf - 创建带有提供的innerType的GraphQLListType
  • inputObjectType - 创建GraphQLInputObjectType
  • inputField - 创建GraphQLInputObjectType的字段

• 类型:

  • 所有的GraphQL标量类型都内置，还包括一个Date类型：

  // 所有的GraphQL标量类型
  graphQLString
  graphQLId
  graphQLBoolean
  graphQLInt
  graphQLFloat
  graphQLDate
  

• 非空类型:

  • 可以通过调用类型的方法nonNullable轻松使类型非空。

• 列表类型:

  • 列表类型的支持也包括在内。使用listType助手方便。

  /// A non-nullable list of non-nullable integers
  listOf(graphQLInt.nonNullable()).nonNullable();
  

• 输入值和参数:

  • 假设以下GraphQL查询：

  {
     anime {
       characters(title: "Hunter x Hunter") {
         name
         age
       }
     }
  }
  

  • 其对应的schema：

  type AnimeQuery {
    characters($title: String!): [Character!]
  }
  
  type Character {
    name: String
    age: Int
  }
  

  • 字段characters接受参数title。在package:graphql_schema2中，使用GraphQLFieldInput来重现这一点：

  final GraphQLObjectType queryType = objectType('AnimeQuery', fields: [
    field('characters',
      listOf(characterType.nonNullable()),
      inputs: [
        new GraphQLFieldInput('title', graphQLString.nonNullable())
      ]
    ),
  ]);
  
  final GraphQLObjectType characterType = objectType('Character', fields: [
    field('name', graphQLString),
    field('age', graphQLInt),
  ]);
  

  • 在大多数情况下，你将委托实际的数据检索给数据库对象或异步解析函数。

  • package:graphql_schema2 包含了这个功能在resolve属性中，该属性传递了一个上下文对象和一个Map<String, dynamic>的参数。

  • 假设的例子：

  var field = field(
    'characters',
    graphQLString,
    resolve: (_, args) async {
      return await myDatabase.findCharacters(args['title']);
    },
  );
  

示例代码

import 'package:graphql_schema2/graphql_schema2.dart';

final GraphQLSchema todoSchema = GraphQLSchema(
  queryType: objectType('Todo', fields: [
    field(
      'text',
      graphQLString.nonNullable(),
      resolve: resolveToNull,
    ),
    field(
      'created_at',
      graphQLDate,
      resolve: resolveToNull,
    ),
  ]),
);

void main() {
  // 验证
  var validation = todoSchema.queryType!.validate(
    '[@root](/user/root)',
    {
      'foo': 'bar',
      'text': null,
      'created_at': 24,
    },
  );

  if (validation.successful) {
    print('This is valid data!!!');
  } else {
    print('Invalid data.');
    for (var s in validation.errors) {
      print('  * $s');
    }
  }

  // 序列化
  print(todoSchema.queryType!.serialize({
    'text': 'Clean your room!',
    'created_at': DateTime.now().subtract(Duration(days: 10))
  }));
}