Dart : freezedパッケージの仕組みについて

Question

https://pub.dev/packages/freezed#the-syntax
change_notifier,riverpodなどで出てくるfreezedパッケージについて見ているのですが、
説明を読んでもよくわかりません。
コードジェネレータというものが初めてなので(説明によるとよくあるものみたいですが)、
具体的に何をしているのかイメージできません。

providerなどで出てくるので状態管理の話だと思うのですが、その前段階の、
データベースからjsonデータ(文字列)を受け取って
map→クライアント側固有のモデルクラス
に変換する作業のように感じます。
そのモデルクラスをstate(状態)にセットして、
どう状態管理するか、という話に繋がっていく。
その変換をシンプルに、簡単に行うパッケージがfreezed、ということですかね?

結局中まで見て何をしているのか把握すべきでしょうか?
それともとにかく公式ページの説明に書いてある通りにすれば、
こういう結果になりますよ、
という使い方を覚えて使えば良い、ということなんでしょうか?

Answer 1

map→クライアント側固有のモデルクラス

に変換する作業のように感じます。

その変換をシンプルに、簡単に行うパッケージがfreezed、ということですかね?

その通りです。

例えば、以下のような機能を持つコードを、

class Person {
  final String name;
  final int age;

  Person({
    this.name,
    this.age,
  });

  Person copyWith({
    String name,
    int age,
  }) {
    return Person(
      name: name ?? this.name,
      age: age ?? this.age,
    );
  }

  @override
  int get hashCode => this.name.hashCode ^ this.age.hashCode;

  @override
  bool operator ==(dynamic other) {
    return identical(this, other) ||
        (other is Person && other.name == this.name && other.age == this.age);
  }
}

たったこれだけ書くだけで、自動生成してくれます。

@freezed
abstract class Person with _$Person {
  const factory Person({String name, int age}) = _Person;
}

---

結局中まで見て何をしているのか把握すべきでしょうか?

そこまでする必要はないと思います。

Comments

[moriman]

回答を頂きましてありがとうございます。

理解力が低くて申し訳ないのですが、確認させてもらって良いでしょうか。

お示しいただいた一つ目のコードを「(1)のコード」、
二つ目のコードを「(2)のコード」と呼びます。

freezedを使わなければ(1)のコードを自分で書かないといけないところを、
freezedを使えば、自分で(2)のコードを書くだけで、あとはコードを自動生成すると、(1)のコードを書いたのと同じ状態になるので、その後は(1)のコードがある前提で(1)のコードを利用したコードを書くことができる、
という理解で良いでしょうか?

[nskhei]

そういうことです。

[nskhei]

誤解を招くような文章だったのを修正しました。

あと一応補足ですが、map -> モデルクラスへの変換コード自体を生成するのは、
JsonSerializableというパッケージです。
freezedが担うのは、モデルクラスのcopyWithメソッドや==オペレータの生成です。

[moriman]

もう少し調べてみます。
ありがとうございました。