[dart]意図しないところで変数の値が変わる

状況

アプリの動作を規定するクラスがある。「設定変更」の画面は既存のインスタンスのコピーを引数にとり、画面上に設定値を表示。「保存」ボタンを押すとこのインスタンスのコピーを既存のインスタンスと入れ替える。「保存」ボタンを押さずに戻った場合は既存のインスタンスを保持する。

ところが、ある程度操作して「保存」ボタンを押さずに戻った場合でも、既存のインスタンスが変更されてしまっている。

原因

「設定変更」の画面を作る際に、インスタンスを=で代入していた。

dartでは（というかC#などほとんどの言語でそうだが）クラスを=で代入しても参照渡しになる。つまり、変数のアドレスが渡されるので、代入先の値を変更すると元の値も変更される。上記の例では、「設定変更」の画面上でインスタンスのコピーの値を変更しているつもりが、既定のインスタンスの値まで変更しており、「保存」ボタンを押してインスタンスを入れ替える処理をしなくても値が変わってしまっていた。

解決策

=で渡さずに、新しいインスタンスを作る必要がある。dartではクラスをまるごとコピーしてくれるメソッドはないっぽいので、元の値を引き継げるようなメソッドを用意しておくと便利。

class settingData{
  String name;
  int id;

  //メンバ変数をコピーして新しいインスタンスを作るコンストラクタ
  settingData.copyFrom(settingData source){
    this.name=source.name;
    this.id=source.id;
  }
}
class SettingPage extends StatefulWidget{
  final settingData data;
    
  SettingPage({this.data})
}

//~~~~何らかのクラス~~~~~~

Future<void> goToSettingPage(settingData data) async{
  await Navigator.of(context).push(new MaterialPageRoute(
    builder: (context) =>
    // SettingPage(data: data)   ダメな例
    SettingPage(data: settingData.copyFrom(data))  //こうする
  ));
}

ただし、このやり方だとsettingDataクラスに新しいメンバ変数を追加するたびにcopyFrom()コンストラクタまで変更しないといけないのであまりスマートではない気もする。

最後に

かなり初歩的なミスですが、上記のようなシチュエーションは少なくないとは思います（ユーザが承認するまで仮のデータを使う）。変数の受け渡しには注意しましょう。