Flutter状态管理插件riverpod_mutations的使用

riverpod_mutations 是一个简单的包，用于在Flutter应用中实现Riverpod的状态管理，特别是处理异步函数的状态。这个包旨在作为临时解决方案，直到官方Riverpod mutations实现为止，并且希望与未来的官方实现API兼容。

特性

• 简单直观地处理任何异步函数的状态。

开始使用

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

dependencies:
  riverpod_mutations: ^1.0.0
  riverpod: ^2.2.0
  riverpod_annotation: ^1.2.1

dev_dependencies:
  riverpod_generator: ^1.2.0
  build_runner: ^2.3.3

然后运行flutter pub get来安装这些依赖。

使用示例

下面是一个如何使用riverpod_mutations的基本示例。此示例展示了如何将字符串转换为双精度浮点数，并处理可能发生的错误。

示例代码

首先，确保你已经设置了生成器并创建了.g.dart文件。这通常涉及到运行flutter pub run build_runner build命令。

import 'package:riverpod/riverpod.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:riverpod_mutations/riverpod_mutations.dart';

part 'riverpod_mutations_example.g.dart';

@riverpod
MutationState<double, String> stringToDouble(StringToDoubleRef ref) {
  return MutationState.create(ref, (input) async {
    await Future.delayed(Duration(seconds: 1));
    print('Got $input');
    return double.parse(input);
  });
}

void example(ProviderContainer container) {
  final stringToDouble = container.read(stringToDoubleProvider.notifier);

  // 调用mutation函数
  stringToDouble.mutate('4.7').then((result) {
    result.when(
      data: (data) => print('Result: $data'),
      error: (error) => print('Error: $error'),
      loading: () => print('Loading...'),
    );
  });
}

更复杂的例子

这里有一个更复杂的例子，它演示了如何使用TodosNotifier和addTodoProvider来管理待办事项列表。

import 'dart:math';
import 'package:riverpod/riverpod.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:riverpod_mutations/riverpod_mutations.dart';

part 'riverpod_mutations_example.g.dart';

class Todo {
  Todo({required this.title});
  final String timeCreated = DateTime.now().toString();
  final String title;

  [@override](/user/override)
  String toString() {
    return 'Todo(title: $title, timeCreated: $timeCreated)';
  }
}

[@Riverpod](/user/Riverpod)(keepAlive: true)
class TodosNotifier extends _$TodosNotifier {
  [@override](/user/override)
  Future<List<Todo>> build() async {
    final list = <Todo>[];
    for (var i = 0; i < 3; i++) {
      await Future<void>.delayed(const Duration(milliseconds: 100));
      list.add(Todo(title: 'Todo $i'));
    }
    return list;
  }

  Future<void> addTodo(Todo todo) async {
    await Future<void>.delayed(const Duration(seconds: 1), () {
      if (Random().nextBool()) {
        throw Exception('Failed to add todo');
      }
    });
    var newState = [...await future, todo];
    state = AsyncData(newState);
  }
}

[@Riverpod](/user/Riverpod)(keepAlive: true)
MutationState<void, Todo> addTodo(AddTodoRef ref) {
  return MutationState.create((newState) => ref.state = newState, (todo) async {
    return await ref.read(todosNotifierProvider.notifier).addTodo(todo);
  });
}