gql-dart/ferry 项目使用教程

1. 项目目录结构及介绍

gql-dart/ferry 项目是一个用于 Dart 的流式强类型 GraphQL 客户端。项目的目录结构如下：

ferry/
├── examples/              # 示例项目目录
├── packages/              # 相关包目录
│   ├── ferry/             # ferry 核心包
│   ├── ferry_cache/       # 缓存相关包
│   ├── ferry_exec/        # 执行接口相关包
│   ├── ferry_flutter/     # Flutter 相关组件包
│   ├── ferry_generator/   # 代码生成器相关包
│   ├── ferry_store/       # 数据存储相关包
│   ├── ferry_hive_store/  # 使用 Hive 的数据存储实现
│   └── normalize/         # 数据归一化/反归一化相关包
├── github/                # GitHub 工作流目录
├── website/               # 官方网站相关文件
├── CHANGELOG.md           # 更新日志
├── CONTRIBUTING.md        # 贡献指南
├── README.md              # 项目说明文件
├── logo.jpg               # 项目 logo
├── melos.yaml             # Melos 配置文件
└── pubspec.lock           # 包依赖锁定文件

• examples/: 包含了一些使用 ferry 的示例项目。
• packages/: 存放着项目的各个子包，每个子包都有其特定的功能。
• github/: 包含了项目在 GitHub 上的工作流，如自动化测试、构建等。
• website/: 包含了项目的官方网站静态文件。
• CHANGELOG.md: 记录了项目的版本更新历史和更改内容。
• CONTRIBUTING.md: 提供了贡献代码的指南。
• README.md: 是项目的说明文件，包含了项目的概述、安装和使用方法。
• logo.jpg: 是项目的标志图片。
• melos.yaml: 是 Melos 工具的配置文件，用于自动化项目任务。
• pubspec.lock: 锁定了项目的依赖版本，确保构建的一致性。

2. 项目的启动文件介绍

项目的启动文件主要是 examples/ 目录下的示例项目中的 main.dart 文件，以下是 main.dart 的基本结构：

import 'package:flutter/material.dart';
import 'package:ferry/ferry.dart'; // 引入 ferry 包

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // 初始化 GraphQL 客户端
    final client = GraphQLClient(
      link: HttpLink('https://your-graphql-endpoint.com'),
      cache: GraphQLCache(store: HiveStore()),
    );

    return MaterialApp(
      title: 'Ferry Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(client: client), // 传入客户端到主页
    );
  }
}

class MyHomePage extends StatelessWidget {
  final GraphQLClient client;

  MyHomePage({required this.client});

  @override
  Widget build(BuildContext context) {
    // 使用 client 进行 GraphQL 操作
    return Scaffold(
      appBar: AppBar(
        title: Text('Ferry Example'),
      ),
      body: Center(
        // ... 这里可以放置你的查询或变更组件
      ),
    );
  }
}

在这个启动文件中，首先引入了必要的包，然后在 main 函数中创建了 GraphQLClient，并在 MyApp 组件中将其作为参数传递给 MyHomePage。在 MyHomePage 中，可以使用这个客户端来进行 GraphQL 查询或变更。

3. 项目的配置文件介绍

项目的配置文件主要包括 pubspec.yaml 和 melos.yaml。

• pubspec.yaml: 定义了项目的依赖项和其他构建配置。以下是 pubspec.yaml 的基本结构：

name: ferry_example
description: A simple ferry example
version: 0.1.0

environment:
  sdk: flutter

dependencies:
  flutter:
    sdk: flutter
  ferry: ^X.X.X
  ferry_cache: ^X.X.X
  ferry_exec: ^X.X.X
  ferry_flutter: ^X.X.X
  # 其他依赖

dev_dependencies:
  flutter_test:
    sdk: flutter
  # 开发依赖

在这个文件中，列出了项目依赖的包和版本，以及开发环境依赖的包。

• melos.yaml: 用于配置 Melos 工具的自动化任务，如自动化测试、构建等。以下是 melos.yaml 的一个简单示例：

tasks:
  build:
    run: