Flutter状态管理插件riverpod_tachyon_plugin的使用

Flutter状态管理插件riverpod_tachyon_plugin的使用

Riverpod code generation powered by Tachyon。

信息

该代码生成器产生的代码几乎与官方的 riverpod_generator 相同，但它是使用 tachyon 而不是 build_runner。

安装

1. 在你的项目的 pubspec.yaml 中添加：

dependencies:
  riverpod_annotation: any

dev_dependencies:
  tachyon: any
  riverpod_tachyon_plugin: any

1. 创建一个名为 tachyon_config.yaml 的文件在项目根目录下：

file_generation_paths: # 哪些文件/路径需要包含在构建中
  - "file/path/to/watch"
  - "another/one"

generated_file_line_length: 80 # 默认行长度

plugins:
  - riverpod_tachyon_plugin # 注册 riverpod_tachyon_plugin

代码生成

现在你可以像使用 build_runner 一样创建提供者。主要的区别是你需要将部分文件更改为以下格式 <file name>.gen.dart。

示例

import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'user.gen.dart';

class User {
  User({
    required this.id,
    required this.username,
  });

  final int id;
  final String username;
}

@riverpod
User user(UserRef ref) {
  return User(id: 11, username: 'pantelis');
}

执行 tachyon:

dart run tachyon build

这将生成以下代码：

part of 'user.dart';

String _$userHash() => r'0c59864fbc5f80cdab48302d3bd7c942c878cb87';

@ProviderFor(user)
final userProvider = AutoDisposeProvider<User>.internal(
  user,
  name: r'userProvider',
  debugGetCreateSourceHash:
      const bool.fromEnvironment('dart.vm.product') ? null : _$userHash,
  dependencies: null,
  allTransitiveDependencies: null,
);

typedef UserRef = AutoDisposeProviderRef<User>;

完整示例

文件结构

- example/
  - lib/
    - example.dart
    - user.gen.dart
    - user.dart

example/lib/example.dart

import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'example.gen.dart';

class User {
  User({
    required this.id,
    required this.username,
  });

  final int id;
  final String username;
}

@riverpod
User user(UserRef ref) {
  return User(id: 11, username: 'Pantelis');
}

// Keep alive provider
@Riverpod(keepAlive: true)
Future<List<User>> users(UsersRef ref) async {
  await Future.delayed(const Duration(seconds: 1));
  return [
    User(id: 11, username: 'Pantelis'),
  ];
}

class Post {
  Post({
    required this.id,
  });

  final int id;
}

@riverpod
class PostNotifier extends _$PostNotifier {
  @override
  Post build(int postId) {
    // Family provider
    return Post(id: postId);
  }
}

// Provider with dependencies
@Riverpod(dependencies: [user])
class PostsNotifier extends _$PostsNotifier {
  @override
  List<Post> build() {
    // get posts for user id
    ref.watch(userProvider).id;
    return [Post(id: 1)];
  }
}

example/lib/user.gen.dart

part of 'user.dart';

String _$userHash() => r'0c59864fbc5f80cdab48302d3bd7c942c878cb87';

@ProviderFor(user)
final userProvider = AutoDisposeProvider<User>.internal(
  user,
  name: r'userProvider',
  debugGetCreateSourceHash:
      const bool.fromEnvironment('dart.vm.product') ? null : _$userHash,
  dependencies: null,
  allTransitiveDependencies: null,
);

typedef UserRef = AutoDisposeProviderRef<User>;

example/lib/user.dart

import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'user.gen.dart';

class User {
  User({
    required this.id,
    required this.username,
  });

  final int id;
  final String username;
}