top of page

[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});
}


最後に


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

最新記事

すべて表示

【Flutter/Dart】TextFieldで文字列をフォーマットする

やりたいこと TextFieldで入力フォームを作りたい。 例えば入力内容が金額の場合、3桁区切りで頭に¥を付けた表記にしたい。 ただしユーザにこれらを入力させるのではなく、ユーザはあくまで数字を入力するだけで、アプリ側で自動でフォーマットしたい。 方法 TextInputFormatterを継承し、所望のフォーマット処理を追加することで実現可能。 例えばこの記事などを参照。 以下は個人的に躓いた

【Flutter/Dart】iosシミュレータ起動後にデバイスに保存した画像が見つからない

現象 やってること iosシミュレータで画像をデバイスのローカルに保存 保存したパスをデータベースに保存 アプリ立ち上げ時にデータベースから画像パスを取得し、そのパスの画像を画面上に表示 起きている現象 iosシミュレータを再起動した場合、上記3で「ファイルパスが見つからない」というエラーが出る 原因 保存時のディレクトリを getApplicationDocumentsDirectory() に

【Flutter/dart】late変数が初期化されたかのチェック

やりたいこと 初期値さえ決まればあとは不変な変数がある ただし、コンストラクタ起動時にはまだ決定できない このような変数について late finalで変数を定義 (何らかのタイミングで)初期化されたかどうかをチェックし、されていなければ値を入れる(チェックしないとfinalに値を代入したエラーになるので) この場合、「初期化されたかどうか」はどのようにチェックしたらいいのか分からなかった nul

Comments


あなたの買い物をサポートする
アプリ Shop Plan

iphone6.5p2.png

​いつ何を買うかの計画を立てられるアプリです。

google-play-badge.png
Download_on_the_App_Store_Badge_JP_RGB_blk_100317.png

靴を大切にしよう!靴管理アプリ SHOES_KEEP

納品:iPhone6.5①.png

靴の履いた回数、お手入れ回数を管理するアプリです。

google-play-badge.png
Download_on_the_App_Store_Badge_JP_RGB_blk_100317.png

「後で読む」を忘れないアプリ ArticleReminder

気になった​Webサイトを登録し、指定時刻にリマインダを送れるアプリです

google-play-badge.png
Download_on_the_App_Store_Badge_JP_RGB_blk_100317.png
bottom of page