Flutter数据缓存拦截插件hive_cache_interceptor的使用

Hive Cache Interceptor

Hasura Connect Cache Interceptor 使用一个 hive 包。

如何使用

pubspec.yaml

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

dependencies:
  hasura_connect: <最新版本>
  hive_cache_interceptor: <最新版本>

yourfile.dart

在你的 Dart 文件中进行如下配置：

import 'package:hasura_connect/hasura_connect.dart';
import 'package:hasura_hive_cache_interceptor/hasura_hive_cache_interceptor.dart';

// 创建 HiveCacheInterceptor 实例
// 可选参数 `<your box name>` 是你的 Hive 盒子名称，可以省略
final cacheInterceptor = HiveCacheInterceptor("<your box name> (optional)");

// 初始化 HasuraConnect 实例，并传入缓存拦截器
final hasura = HasuraConnect(
  "<your hasura url>", // 替换为你的 Hasura URL
  interceptors: [cacheInterceptor], // 添加缓存拦截器
  httpClient: httpClient, // 你的 HTTP 客户端实例
);

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 hive_cache_interceptor 插件：

pubspec.yaml

dependencies:
  flutter:
    sdk: flutter
  hasura_connect: ^0.13.0
  hive_cache_interceptor: ^0.1.0
  hive: ^2.0.4
  http: ^0.13.3

main.dart

import 'package:flutter/material.dart';
import 'package:hasura_connect/hasura_connect.dart';
import 'package:hasura_hive_cache_interceptor/hasura_hive_cache_interceptor.dart';
import 'package:hive/hive.dart';
import 'package:path_provider/path_provider.dart'; // 用于获取文件路径

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化 Hive
  var dir = await getApplicationDocumentsDirectory();
  Hive.init(dir.path);

  // 打开一个盒子
  final myBox = await Hive.openBox('my_box');

  // 创建 HiveCacheInterceptor 实例
  final cacheInterceptor = HiveCacheInterceptor("my_box");

  // 初始化 HasuraConnect 实例，并传入缓存拦截器
  final hasura = HasuraConnect(
    "https://your-hasura-instance.hasura-app.io/v1/graphql", // 替换为你的 Hasura URL
    interceptors: [cacheInterceptor],
    httpClient: HttpClientWithInterceptor.build(interceptors: [
      // 如果你有自定义的 HTTP 客户端拦截器，可以在这里添加
    ]),
  );

  runApp(MyApp(hasura));
}

class MyApp extends StatelessWidget {
  final HasuraConnect hasura;

  MyApp(this.hasura);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page', hasura: hasura),
    );
  }
}

class MyHomePage extends StatefulWidget {
  final String title;
  final HasuraConnect hasura;

  MyHomePage({Key key, this.title, this.hasura}) : super(key: key);

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String result = '';

  Future<void> fetchData() async {
    try {
      final snapshot = await widget.hasura.query(
        r'''
          query GetUsers {
            users {
              id
              name
            }
          }
        ''',
      );
      setState(() {
        result = snapshot.toString();
      });
    } catch (e) {
      print(e);
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: fetchData,
              child: Text('Fetch Data'),
            ),
            SizedBox(height: 20),
            Text(result),
          ],
        ),
      ),
    );
  }
}