Flutter自动生成代码插件leto_generator的使用

Flutter自动生成代码插件leto_generator的使用

介绍

leto_generator 是一个用于从带有注解的Dart类和函数生成GraphQL模式的插件。它是一个代码优先生成器，根据Dart代码中的注解生成不同的GraphQL元素。

使用方法

添加依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  leto_schema:

dev_dependencies:
  leto_generator:
  build_runner:

注解你的类、字段和函数

你可以使用以下注解来生成所需的GraphQL对象和查询：

import 'package:leto_schema/leto_schema.dart';

part 'file_name.g.dart';

@GraphQLObject()
class ObjectName {
  final String fieldName;

  const ObjectName({required this.fieldName});
}

@Query()
ObjectName getObject(ReqCtx ctx, String name) {
  return ObjectName(fieldName: name);
}

运行代码生成器

运行以下命令以生成代码：

dart run build_runner watch --delete-conflicting-outputs

生成的代码将包含 ObjectName 的 GraphQLObjectType 和 getObject 查询的字段，同时还会生成一个 lib/graphql_api.schema.dart 文件，其中包含了项目的GraphQL模式。该模式将在根 Query 类型中包含 getObject 解析器。

完整示例

以下是完整的示例代码，包括注解和生成的GraphQL类型定义：

import 'package:leto_schema/leto_schema.dart';

part 'file_name.g.dart';

// 定义一个GraphQL对象
@GraphQLObject()
class ObjectName {
  final String fieldName;

  const ObjectName({required this.fieldName});
}

// 定义一个GraphQL查询
@Query()
ObjectName getObject(ReqCtx ctx, String name) {
  return ObjectName(fieldName: name);
}

// 运行代码生成器
Future<void> main() async {
  // 打印生成的GraphQL模式字符串
  print(graphqlApiSchema.schemaStr);

  // 测试序列化和反序列化
  InputGen<int> d = graphqlApiSchema.serdeCtx.fromJson({
    'name': 'nn',
    'generic': 1,
  });
  print(d.toJson());
}

生成的GraphQL模式可能如下所示：

type Query {
  getObject(name: String!): ObjectName
}

type ObjectName {
  fieldName: String!
}