Flutter插件zrepository的使用_zrepository是一个为Flutter项目设计的反应式键值存储库

Flutter插件zrepository的使用_zrepository是一个为Flutter项目设计的反应式键值存储库

zrepository 是一个为Flutter项目设计的反应式键值存储库。它简化了类存储，并在 shared_preferences 的基础上增加了反应式功能。这意味着它可以像普通的 SharedPreferences 一样做所有事情，但还允许监听值的变化。这使得保持小部件与持久化值同步变得非常简单。

获取开始

首先，在你的 pubspec.yaml 文件中添加 zrepository：

dependencies:
  zrepository: ^0.0.2

接下来，创建一个扩展自 ZClass 的类：

import 'package:zrepository/zrepository.dart';

class Person extends ZClass {
  final String name;

  Person({super.uuid, required this.name});

  [@override](/user/override)
  List<Object?> get props => [name];

  [@override](/user/override)
  Map<String, dynamic> toMap() {
    return {
      'uuid': uuid,
      'name': name,
    };
  }
}

注意，必须在构造函数中引用 UUID，以确保每个类都有唯一的标识符。

为了让一切正常工作，我们还需要添加一个工厂方法 fromMap()：

class Person extends ZClass {
  ...
  factory Person.fromMap(Map<String, dynamic> map) {
    return Person(
      uuid: map['uuid'] as String?,
      name: map['name'] as String,
    );
  }
  ...
}

最后，我们需要在主程序中设置这些新类的实例：

void main() async {
  ZRepository.setInstances({
    Person: Person.fromMap,
  });

  runApp(const App());
}

配置已经完成。下面是使用示例：

// ignore_for_file: must_be_immutable

import 'package:flutter/material.dart';
import 'package:zrepository/zrepository.dart';

void main() async {
  ZRepository.setInstances({
    Person: Person.fromMap,
  });

  runApp(const App());
}

class App extends StatefulWidget {
  const App({super.key});

  [@override](/user/override)
  State<App> createState() => _AppState();
}

class _AppState extends State<App> {
  final String repositoryKey = 'person';
  late Stream<List<Person>> _stream;

  TextEditingController nameController = TextEditingController();

  [@override](/user/override)
  void initState() {
    WidgetsBinding.instance.addPostFrameCallback((_) async {
      _stream = await ZRepository.stream<Person>(repositoryKey);
      _stream.listen((event) => setState(() {}));
    });
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: StreamBuilder(
          stream: _stream,
          builder: (context, snapshot) {
            if (snapshot.hasData) {
              return Center(
                child: Column(
                  children: [
                    ...(snapshot.data as List<Person>).map((e) => Container(
                      padding: const EdgeInsets.all(10),
                      decoration: BoxDecoration(
                        border: Border.all(color: Colors.black),
                        borderRadius: BorderRadius.circular(10)
                      ),
                      margin: const EdgeInsets.only(bottom: 10),
                      child: TextButton(
                        onPressed: () {
                          ZRepository.removeEspecific<Person>(repositoryKey, item: e);
                        },
                        child: Text(e.name),
                      ),
                    )).toList(),
                    SizedBox(
                      width: 300,
                      child: TextField(
                        controller: nameController,
                      ),
                    ),
                    FilledButton(
                      onPressed: () => ZRepository.addInList(key: repositoryKey, object: Person(name: nameController.text)),
                      child: const Text('Add')
                    ),
                  ],
                ),
              );
            }
            return const Center(child: Text('Loading...'));
          },
        ),
      ),
    );
  }
}

class Person extends ZClass {
  final String name;
  Person({super.uuid, required this.name});

  [@override](/user/override)
  List<Object?> get props => [name];

  factory Person.fromMap(Map<String, dynamic> map) {
    return Person(
      uuid: map['uuid'] as String?,
      name: map['name'] as String,
    );
  }

  [@override](/user/override)
  Map<String, dynamic> toMap() {
    return {
      'uuid': uuid,
      'name': name,
    };
  }
}