Flutter GraphQL规范与检查插件gql_pedantic的使用

概述

gql-pedantic 是一个用于 gql-dart 的静态分析工具，它可以帮助你遵循 GraphQL 规范并检查你的 Dart 代码。通过使用这个插件，你可以确保你的 GraphQL 查询和类型定义符合最佳实践。

安装

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

dev_dependencies:
  gql_pedantic: ^1.0.0

然后运行 flutter pub get 来安装这个包。

使用

1. 配置 gql_pedantic

在项目根目录下创建一个名为 .gql_pedantic.yaml 的配置文件，并添加以下内容：

rules:
  - name: query_name_convention
    enabled: true
    config:
      pattern: '^Query[A-Z].*'
  
  - name: type_name_convention
    enabled: true
    config:
      pattern: '^Type[A-Z].*'

上述配置中，我们定义了两个规则：

• query_name_convention 规则确保所有的查询名称以 Query 开头。
• type_name_convention 规则确保所有的类型名称以 Type 开头。

2. 运行 gql_pedantic

在终端中运行以下命令来执行 gql_pedantic 分析：

dart run gql_pedantic

如果存在不符合规范的代码，gql_pedantic 将会输出相应的错误信息。

示例代码

以下是一个完整的示例代码，展示了如何使用 gql_pedantic 插件。

1. 创建 GraphQL 查询

在 lib/graphql/query.dart 文件中创建一个 GraphQL 查询：

import 'package:gql/gql.dart';

final String _query = r'''
query QueryUser {
  user(id: "1") {
    id
    name
  }
}
''';

final QueryOptions queryOptions = QueryOptions(
  document: gql(_query),
);

2. 创建 GraphQL 类型

在 lib/graphql/type.dart 文件中创建一个 GraphQL 类型：

import 'package:gql/gql.dart';

class TypeUser {
  final String id;
  final String name;

  TypeUser({required this.id, required this.name});

  factory TypeUser.fromJson(Map<String, dynamic> json) {
    return TypeUser(
      id: json['id'],
      name: json['name'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'name': name,
    };
  }
}

3. 执行查询

在 lib/main.dart 文件中执行查询：

import 'package:flutter/material.dart';
import 'package:gql_exec/gql_exec.dart';
import 'package:http/http.dart' as http;
import 'graphql/query.dart';
import 'graphql/type.dart';

void main() async {
  final client = GraphQLClient(
    cache: InMemoryCache(),
    link: HttpLink(
      uri: 'http://localhost:4000/graphql',
      httpClient: http.Client(),
    ),
  );

  final result = await client.query(queryOptions);

  if (result.hasException) {
    print('Error: ${result.exception}');
  } else {
    final data = result.data!['user'];
    final user = TypeUser.fromJson(data);
    print('User ID: ${user.id}, Name: ${user.name}');
  }
}