関数を返すプロバイダかCallable Classを返すプロバイダか…🤔

[riscait]

前提

複数のドメインの機能を利用する場合を想定しています

---

サンプルのため処理を簡素化しています。
実際の運用では、 ref.watch で複数のProviderに依存したり、処理自体が長くなる可能性が高いです。

中の処理が長くなった時には、Providerを分割するか、プライベートメソッドで切り出す必要があるのは共通だと思います。

関数を返すProvider

メリット

• Class定義が必要ない

デメリット

• void を返す関数の場合は型明示が必要→ごちゃごちゃして見える？

/// Stringを引数で受け取りintを返却する関数を提供するProvider
final parseNumTextProvider = Provider(
  (ref) => ({required String numText}) async {
    final banana = ref.watch(bananaDomainProvider);
    final orange = ref.watch(orangeDomainProvider);

    debugPrint('$banana, $orange');

    await Future<void>.delayed(const Duration(seconds: 1));
    return int.parse(numText);
  },
);

/// Stringを引数で受け取り何も返却しない関数を提供するProvider
/// 戻り値がない場合は `Null` だと推論されてしまうので `void` と明示する必要がある
final printNumTextProvider =
    Provider<Future<void> Function({required String numText})>(
  (ref) => ({required String numText}) async {
    final banana = ref.watch(bananaDomainProvider);
    final orange = ref.watch(orangeDomainProvider);

    debugPrint('$banana, $orange');

    final r = int.parse(numText);
    await Future<void>.delayed(const Duration(seconds: 1));
    debugPrint(r.toString());
  },
);

void f(Ref ref) {
  final r1 = ref.read(parseNumTextProvider)(numText: '1');
  final r2 = ref.read(printNumTextProvider)(numText: '2');
}

Callable Classを使ったProvider

メリット

• Classに処理があるのでProvider自体の定義はスッキリする。

デメリット

• Class定義が必要（ボイラープレートが多い）

/// Stringを引数で受け取りintを返却する関数を提供するProvider
final parseNumTextProvider = Provider((ref) => ParseNumText(ref.read));

class ParseNumText {
  ParseNumText(this._read);

  final Reader _read;
  BananaDomain get _banana => _read(bananaDomainProvider);
  OrangeDomain get _orange => _read(orangeDomainProvider);

  Future<int> call({required String numText}) async {
    debugPrint('$_banana, $_orange');
    await Future<void>.delayed(const Duration(seconds: 1));
    return int.parse(numText);
  }
}

/// Stringを引数で受け取り何も返却しない関数を提供するProvider
final printNumTextProvider = Provider((ref) => PrintNumText(ref.read));

class PrintNumText {
  PrintNumText(this._read);

  final Reader _read;
  BananaDomain get _banana => _read(bananaDomainProvider);
  OrangeDomain get _orange => _read(orangeDomainProvider);

  Future<void> call({required String numText}) async {
    debugPrint('$_banana, $_orange');
    final r = int.parse(numText);
    await Future<void>.delayed(const Duration(seconds: 1));
  }
}

void f(Ref ref) {
  final r1 = ref.read(parseNumTextProvider)(numText: '1');
  final r2 = ref.read(printNumTextProvider)(numText: '2');
}

[7f13]

関数はCallable Class利用がやっぱり読みやすいと思いました。

[naipaka]

Class定義の必要ない関数を返すProviderだとすっきりするものの、初見で見た時にぱっと見どう使えばいいいかがわからなそうな気がしました🤔
（自分が見慣れていないのもありますが。。）

[RyosukeOK]

自分もCallable Classs利用がベターだと感じました。
riverpodのドキュメントに揃えたメジャーな書き方の方が、今後のパッケージの変更にも対応できそうです。
一方で、プライベートメンバのアンダースコアが読み難さを助長していると思います。

また、無名関数を返すことを強調した以下の書き方もありかなと思いました。
（追記）いや、読みにくかったです。

/// Stringを引数で受け取りintを返却する関数を提供するProvider
final parseNumTextProvider = Provider((ref) {
  return ({required String numText}) => parseNumText(ref, numText);
});

Future<int> parseNumText(
  ProviderRef ref,
  String numText,
) async {
  final banana = ref.read(bananaDomainProvider);
  final orange = ref.read(orangeDomainProvider);

  print('$banana, $orange');

  await Future<void>.delayed(const Duration(seconds: 1));
  return int.parse(numText);
}

[riscait]

お三方、コメントありがとうございました！
閉じるのが遅くなってしまいましたが、今後もClassを利用した方法でやっていきましょう🚀