[Flutter]FirestoreとReduxを連携して状態を管理する

概要

ユーザのデータを扱うスマホアプリにおいて、アプリ使用中の状態管理とデータ保存用の外部ストレージとをどう連携するかについて書いてみようと思います。

具体的には、アプリ内での状態管理はredux、データの保存はcloud firestoreを用います（あくまで1例であり、他にも選択肢はあります）。

方法

全体像

1. firestoreには各ユーザごとにデータが保存されている。

2. ユーザAがスマホアプリを起動したらgoogleアカウントを用いてサインイン

3. googleアカウントの認証に成功したらfirestoreからユーザAのデータを取得し、reduxのstroeに格納

4. データを変更したらreduxのmiddlewareでfirestore上のデータも変更

firestoreの構成

firestoreには「users」コレクションを作成し、各ユーザのデータをドキュメントとして格納します。ドキュメントidはgoogleアカウントとします。

ログインと認証

アプリ起動時にログインページでユーザにgoogleアカウントの入力を求めます。firebase authを使って認証処理を行い、認証に成功した場合はfirestoreからそのgmailアドレスのユーザのデータを取得します。

firebase authのUserインスタンスからそのユーザのデータをfirestoreから取得する処理は例えば次のようになります。

Future<AppState> get_data(User user)async{
    FirebaseFirestore db;
    DocumentReference docRef;
    CollectionReference colRef;
    
    //firestoreインスタンスを初期化
    db=FirebaseFirestore.instance;
    
    //gmailアドレスでユーザのデータへの参照を取得
    colRef=await db.collection('users');    
    docRef=await colRef.doc(user.email);

    var snapshot=await docRef.get();
    if (!snapshot.exists){
        //ユーザのデータが存在しない場合は新規に追加
      await colRef.doc(user.email).set({'name': user.displayName});
      docRef=await colRef.doc(user.email);
    }
    
    //参照からデータを取得し、mapに格納
    var col_items
        =await docRef.collection('items').get();

    Map<int, String>items={};
    for(var snapshot in col_items.docs){
      int id=int.parse(snapshot.id);
      items[id]=snapshot.data()['item'];
    }
    
    return AppState(items: items);
}

例としてint型のidとString型のデータ（item）のmapの場合を想定してみました。

class AppState{
  Map<int, String> items;
  
  AppState({this.items});
  
  AppState.initState(){
    items={};
  }
}

storeに格納

上記で取得したデータを用いてstoreを初期化します。

空データで初期化してからmiddlewareでデータを取得してくるというやり方もあります（というかその方がいいのかも）。

AppState state;
try {
  state = await fireStore.initDataSets(user);
}
catch(Exception){
  state=AppState.initState();
}

Store<AppState> store=Store<AppState>(
  appStateReducer,
  initialState: state,
  middleware: [AppStateMiddleWare]
);

データの変更をfirestoreに反映

firestoreのユーザのドキュメントへの参照をactionへ渡し、midllewareでその参照を用いてfirestoreに書き込みます。上記のget_dataではローカル変数に参照を格納していますが、クラスメンバにしておくと便利かもしれないですね。

middleware

void AppStateMiddleWare(Store<AppState> store, dynamic action, 
                        NextDispatcher next) async {                             
    next(action);
     
    if (action is AddItemAction){

        var docRef=action.docRef;
        int id=action.id;
        await docRef.collection('items')
              .doc(id.toString()).set({'item': action.item});
    }
}

action

class AddItemAction{
  final String item;
  final int id;
  final DocumentReference docRef;

  AddItemAction({this.item, this.id, this.docRef});
}

最後に

こういう使い方はかなり多いと思うんですが、方法論みたいなのは全然見かけないので書いてみました。あくまで個人開発でしか使っていないので参考程度にお願いします。