Flutter数据缓存插件cache_data的使用

Flutter数据缓存插件cache_data的使用

cache_data 是一个用于在 Flutter 中获取数据并将其以一定时长为有效期保存到 Hive 数据库中的库。此库依赖于 hive 进行数据库操作，并且依赖于 dart_json_mapper 将 JSON 反序列化为 Dart 对象。

获取开始

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

dependencies:
  cache_data:
  dart_json_mapper:
  dart_json_mapper_flutter:
dev_dependencies:
  build_runner:

接下来，将 @jsonSerializable 添加到你的模型类上。

例如，定义一个名为 Data 的模型类：

// data.dart
@JsonSerializable()
class Data {
  int userId;
  int id;
  String title;

  Data({
    required this.userId,
    required this.id,
    required this.title,
  });

  // 使用工厂构造函数进行反序列化
  factory Data.fromJson(Map<String, dynamic> json) => _$DataFromJson(json);
}

然后在主文件中初始化 CacheData 和 dart_json_mapper：

// main.dart
import 'data.dart';
import 'main.mapper.g.dart' show initializeJsonMapper;

import 'package:dart_json_mapper_flutter/dart_json_mapper_flutter.dart' show flutterAdapter;
import 'package:flutter/material.dart';
import 'package:cache_data/cache_data.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await CacheData.init();
  initializeJsonMapper(adapters: [flutterAdapter]);
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Material App',
      home: HomeView(),
    );
  }
}

接着，创建 build.yaml 文件来配置构建生成器：

# build.yaml
targets:
  $default:
    builders:
      dart_json_mapper:
        generate_for:
          - lib/data.dart
      reflectable:
        generate_for:
          - no/files

最后，运行构建命令以生成必要的映射文件：

pub run build_runner build --delete-conflicting-outputs

或者使用以下命令进行实时监控：

pub run build_runner watch --delete-conflicting-outputs

使用

现在你可以使用 CacheData 来获取并缓存数据了。以下是一个示例，展示了如何从网络请求数据并缓存结果：

import 'package:cache_data/cache_data.dart';
import 'package:flutter/material.dart';
import 'dart:async';

class HomeView extends StatefulWidget {
  [@override](/user/override)
  _HomeViewState createState() => _HomeViewState();
}

class _HomeViewState extends State<HomeView> {
  final cache = CacheData<List<Data>>();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Cache Data Example'),
      ),
      body: FutureBuilder<List<Data>?>(
        future: cache.fetchData(
          'https://jsonplaceholder.typicode.com/albums',
          duration: Duration(hours: 1),
        ),
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.waiting) {
            return Center(child: CircularProgressIndicator());
          } else if (snapshot.hasError) {
            return Center(child: Text('Error: ${snapshot.error}'));
          } else if (!snapshot.hasData || snapshot.data!.isEmpty) {
            return Center(child: Text('No data available'));
          } else {
            return ListView.builder(
              itemCount: snapshot.data!.length,
              itemBuilder: (context, index) {
                final item = snapshot.data![index];
                return ListTile(
                  title: Text(item.title),
                  subtitle: Text('ID: ${item.id}'),
                );
              },
            );
          }
        },
      ),
    );
  }
}