【Flutter/Dart】状態管理に必要なfreezedパッケージを徹底解説 クラスの作成・生成方法からチップスまで【2022年8月版】

@freezed
class Authore with _$Authore{
  @Assert('(0 < famousBook.length) || (0 < books.length)',
      'famousBookかbooksのどちらかは設定する必要がある')
  const factory Authore({
    // requiedか?をつける
    required String name,
    int? age,
    @Default('') String famousBook,
    // ListもMapも読み込める。素晴らしい！
    List books,
    // オブジェクトもJson読込が定義されていれば、入れられる
    required Map<String, ResultInfoData> resultInfo,
  }) = _WorkbookData;
}

var file = File('assets/data.json');
WorkboodData workboodData =
	WorkbookData.fromJson(json.decode(file.readAsStringSync()));

リストのJsonの読込

var file = File('assets/list.json');
List jsonData = json.decode(file.readAsStringSync());
List overviewData =
	jsonData.map((data) => OverviewData.fromJson(data)).toList();

以下のようにまとめて書いたら、エラーになった。

json.decode(file.readAsStringSync()).map((data) => OverviewData.fromJson(data)).toList();

Jsonの書込

var output = File('test/result/test.json');
output.writeAsStringSync(json.encode(copy));

メソッドを追加する

メソッド、といっても、freezedはImmutableなので、内部の値を変更するメソッドは書けません。読み取り専用や新しいインスタンスを返すメソッドになります。その場合、内部コンストラクタを作れば良いです。

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:flutter/foundation.dart';

part 'fraction.freezed.dart';
part 'fraction.g.dart';

@freezed

///分数
class Fraction with _$Fraction {
  const Fraction._(); // これ。
  const factory Fraction({
    ///分母
    required int numerator,

    ///分子
    required int denominator,
  }) = _TestData;

  factory Fraction.fromJson(Map<String, dynamic> json) =>
      _$FractionFromJson(json);

  void printValue() {
    print('$denominator/$numerator');
  }

  Fraction setDenominator(int denominator) {
    return copyWith(denominator: denominator);
  }
}

Live Template

使い始めると、何度もテンプレートをコピペすることになった。手を抜くために、Android Studioの機能のLive Templateを使用して、一発で書けるようにします。ついでにクラスに対応したJsonConverter(後で詳しく書きます)も作成するようにします。
まず、Android Studioで以下を入力する「File->Settings (Mac では、Preferences) -> Editor -> Live Templates -> Flutter」を選択して「+ -> LiveTemplate」を選択する。
Abbreviant: frz
Description: New freezed class
Applicable in dart: Dart -> top-level

Template text:

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:flutter/foundation.dart';
import 'dart:convert';

part '$FILE_NAME$.freezed.dart';
part '$FILE_NAME$.g.dart';

@freezed
class $CLASS_NAME$ with _$$$CLASS_NAME$ {
  const $CLASS_NAME$._(); //メソッド不要の場合、削除
  const factory $CLASS_NAME$({
    required String title,
  }) = _$CLASS_NAME$;

 factory $CLASS_NAME$.fromJson(Map<String, dynamic> json) => 
        _$$$CLASS_NAME$FromJson(json);
}
class $CLASS_NAME$Converter implements JsonConverter<$CLASS_NAME$, String> {
  const $CLASS_NAME$Converter();

  @override
  $CLASS_NAME$ fromJson(String jsonData) {
    return $CLASS_NAME$.fromJson(json.decode(jsonData));
  }

  @override
  String toJson($CLASS_NAME$ object) {
    return json.encode(object.toJson());
  }
}

Edit Variables:

JsonConverterとは。freezedで自作クラスをメンバー変数に持ちたいとき

freezedで自動作成するクラスのメンバー変数に自作クラスがある場合、そのままではJsonへの変換が作成されない。自作クラス用のJsonConverterが必要になる。メンバー変数にアノテーションでJsonConverterを指定する。
以下はその例。
Test: Freezedで生成するクラス
TestObject: 自作クラス
TestObjectConverter: 自作クラスのJson変換を実施するクラス

@freezed
class Test with _$Test {
  const factory Test({
    @TestObjectConverter() required TestObject testObject,
  }) = _Test;

  factory Test.fromJson(Map json) => _$TestFromJson(json);
}

class TestObject {
  final String value;
  TestObject(this.value);
}

class TestObjectConverter implements JsonConverter {
  const TestObjectConverter();

  @override
  TestObject fromJson(String value) {
    return TestObject(value);
  }

  @override
  String toJson(TestObject value) {
    return value.value;
  }
}

ファイル数が多くなったときの対策

プロジェクト全体のファイル数が多くなると、freezedのファイルを探すのに時間が掛かるようになります。そこでfreezedのファイルを特定のディレクトリに置いて、以下のファイルを作成して、build対象のファイルを狭くします。
<プロジェクトのルート>/build.yaml

targets:
  $default:
    builders:
      freezed:
        generate_for:
          include:
            - lib/data/*.dart
      json_serializable:
        generate_for:
          include:
            - lib/data/*.dart
        options:
          any_map: true
          explicit_to_json: true

この場合、data直下のみなので、*.dartと書いてます。その下にもディレクトリがある場合「lib/data/**/*.dart」のようなワイルドカードを使います。

Json変換の設定

jsonの項目名を変更する

Jsonに出力するときに、デフォルトでは変数名が項目名になる。以下のように設定すると、特定の文字列を項目名にできる。

 @JsonKey(name: 'phone_number') required String phoneNumber,

特定の項目を出力しない

クラスの外にnullに変換するtoJson用の関数を定義し、値がnullの場合はJsonに出力しないように設定する。そうすると、指定の項目がJsonに出力されなくなった。

Function? toNull(_) => null;

@freezed
class LoginUser with _$LoginUser {
  const factory LoginUser({
    @JsonKey(toJson: toNull, includeIfNull: false) required List cart,
  }) = _LoginUser;

}

(蛇足) @JsonKey(ignore: true) でいけるかと思ったが、ソース生成で失敗するようになったので、使えなかった。

発生したエラー

新しいメンバー変数を追加したときのエラー

error: The redirected constructor '_SettingData Function({String deviceId, String userId})' has incompatible parameters with 'SettingData Function({String deviceId, bool rememberPassword, String userId})'. (redirect_to_invalid_function_type at [bell] lib\data\setting_data.dart:17)

rememberPasswordというメンバー変数を追加したときに発生した。Android Studioを再起動したら消えた。

type ‘UnspecifiedInvalidResult’ is not a subtype of type ‘LibraryElementResult’ in type cast

ソース生成時に以下のエラーが発生した。

type 'UnspecifiedInvalidResult' is not a subtype of type 'LibraryElementResult' in type cast
[SEVERE] json_serializable:json_serializable on lib/provider.dart:

pubspec.lockを削除→flutter clean→flutter pub getという、いつもの動作？で直った。

まとめ

ということで、改めて、freezedについてまとめました。まとめるのに際して、改めて検索しましたが、ついでに自分でもLiveTemplateやbuild.yamlも導入しました。 あなたの参考になれば、嬉しいです。
また、FreezedとRiverpodをつかって、FlutterでMVVMパターンを実現するWEB講座を公開しております。こちらも開発の参考になれば光栄です！