Hasura Connect 项目教程

1. 项目的目录结构及介绍

hasura_connect/
├── lib/
│   ├── hasura_connect.dart
│   ├── hasura_connect_base.dart
│   ├── hasura_connect_exception.dart
│   ├── hasura_connect_snapshot.dart
│   ├── hasura_connect_subscription.dart
│   ├── hasura_connect_utils.dart
│   └── hasura_connect_widget.dart
├── test/
│   ├── hasura_connect_test.dart
│   └── hasura_connect_subscription_test.dart
├── pubspec.yaml
├── README.md
└── CHANGELOG.md

目录结构介绍

• lib/: 包含项目的核心代码文件。

  • hasura_connect.dart: 主文件，定义了 HasuraConnect 类，用于连接 Hasura 服务。
  • hasura_connect_base.dart: 基础类文件，包含一些基础功能和接口。
  • hasura_connect_exception.dart: 异常处理文件，定义了与 Hasura 连接相关的异常。
  • hasura_connect_snapshot.dart: 快照处理文件，用于处理离线缓存。
  • hasura_connect_subscription.dart: 订阅处理文件，用于处理 GraphQL 订阅。
  • hasura_connect_utils.dart: 工具类文件，包含一些辅助函数。
  • hasura_connect_widget.dart: 小部件文件，用于在 Flutter 应用中集成 Hasura Connect。

• test/: 包含项目的测试文件。

  • hasura_connect_test.dart: 主测试文件，包含对 HasuraConnect 类的测试。
  • hasura_connect_subscription_test.dart: 订阅测试文件，包含对订阅功能的测试。

• pubspec.yaml: 项目的配置文件，定义了项目的依赖和元数据。

• README.md: 项目的说明文件，包含项目的介绍、安装和使用说明。

• CHANGELOG.md: 项目的变更日志，记录了项目的版本更新和变更内容。

2. 项目的启动文件介绍

项目的启动文件是 lib/hasura_connect.dart。该文件定义了 HasuraConnect 类，是连接 Hasura 服务的核心类。

主要功能

• 连接 Hasura 服务: 通过 HasuraConnect 类的实例化，可以连接到指定的 Hasura 服务。
• 执行 GraphQL 查询、变更和订阅: 提供了 query, mutation, 和 subscription 方法，用于执行相应的 GraphQL 操作。
• 离线缓存: 支持离线缓存功能，可以在无网络情况下继续使用缓存的数据。

示例代码

import 'package:hasura_connect/hasura_connect.dart';

String url = 'http://localhost:8080/v1/graphql';
HasuraConnect hasuraConnect = HasuraConnect(url);

// 执行查询
var query = '''
  query {
    users {
      id
      name
    }
  }
''';

hasuraConnect.query(query).then((data) {
  print(data);
}).catchError((error) {
  print(error);
});

3. 项目的配置文件介绍

项目的配置文件是 pubspec.yaml，该文件定义了项目的依赖、元数据和其他配置信息。

主要配置项

• name: 项目的名称。
• description: 项目的描述。
• version: 项目的版本号。
• environment: 定义了项目的 Dart SDK 版本范围。
• dependencies: 项目的依赖库，包括 hasura_connect 和其他第三方库。
• dev_dependencies: 开发依赖库，用于项目的测试和开发工具。

示例配置

name: hasura_connect_example
description: A new Flutter project.
version: 1.0.0

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter
  hasura_connect: ^5.0.0+3

dev_dependencies:
  flutter_test:
    sdk: flutter

通过以上配置，可以确保项目在指定的 Dart SDK 版本范围内运行，并且正确引入了 hasura_connect 库。