Как объединить данные из двух коллекций Firestore во Flutter?

9

У меня есть приложение чата во Flutter, использующее Firestore, и у меня есть две основные коллекции:

  • chats, Который вводится на авто идентификаторов, и имеет message, timestampи uidполе.
  • users, который включен uid, и имеет nameполе

В моем приложении я показываю список сообщений (из messagesколлекции), с этим виджетом:

class ChatList extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    var messagesSnapshot = Firestore.instance.collection("chat").orderBy("timestamp", descending: true).snapshots();
    var streamBuilder = StreamBuilder<QuerySnapshot>(
          stream: messagesSnapshot,
          builder: (BuildContext context, AsyncSnapshot<QuerySnapshot> querySnapshot) {
            if (querySnapshot.hasError)
              return new Text('Error: ${querySnapshot.error}');
            switch (querySnapshot.connectionState) {
              case ConnectionState.waiting: return new Text("Loading...");
              default:
                return new ListView(
                  children: querySnapshot.data.documents.map((DocumentSnapshot doc) {
                    return new ListTile(
                      title: new Text(doc['message']),
                      subtitle: new Text(DateTime.fromMillisecondsSinceEpoch(doc['timestamp']).toString()),
                    );
                  }).toList()
                );
            }
          }
        );
        return streamBuilder;
  }
}

Но теперь я хочу показать имя пользователя (из usersколлекции) для каждого сообщения.

Я обычно называю это соединением на стороне клиента, хотя я не уверен, есть ли у Flutter определенное имя для него.

Я нашел один способ сделать это (который я разместил ниже), но задаюсь вопросом, есть ли другой / лучший / более идиоматический способ сделать этот тип операции во Флаттере.

Итак: каков идиоматический способ во Флаттере искать имя пользователя для каждого сообщения в приведенной выше структуре?

Фрэнк ван Пуффелен
источник
Я думаю, что единственное решение, которое я исследовал много rxdart
Cenk YAGMUR

Ответы:

3

Я получил другую версию, которая кажется немного лучше, чем мой ответ с двумя вложенными компоновщиками .

Здесь я выделил загрузку данных в пользовательском методе, используя выделенный Messageкласс для хранения информации из сообщения Documentи необязательного связанного пользователя Document.

class Message {
  final message;
  final timestamp;
  final uid;
  final user;
  const Message(this.message, this.timestamp, this.uid, this.user);
}
class ChatList extends StatelessWidget {
  Stream<List<Message>> getData() async* {
    var messagesStream = Firestore.instance.collection("chat").orderBy("timestamp", descending: true).snapshots();
    var messages = List<Message>();
    await for (var messagesSnapshot in messagesStream) {
      for (var messageDoc in messagesSnapshot.documents) {
        var message;
        if (messageDoc["uid"] != null) {
          var userSnapshot = await Firestore.instance.collection("users").document(messageDoc["uid"]).get();
          message = Message(messageDoc["message"], messageDoc["timestamp"], messageDoc["uid"], userSnapshot["name"]);
        }
        else {
          message = Message(messageDoc["message"], messageDoc["timestamp"], "", "");
        }
        messages.add(message);
      }
      yield messages;
    }
  }
  @override
  Widget build(BuildContext context) {
    var streamBuilder = StreamBuilder<List<Message>>(
          stream: getData(),
          builder: (BuildContext context, AsyncSnapshot<List<Message>> messagesSnapshot) {
            if (messagesSnapshot.hasError)
              return new Text('Error: ${messagesSnapshot.error}');
            switch (messagesSnapshot.connectionState) {
              case ConnectionState.waiting: return new Text("Loading...");
              default:
                return new ListView(
                  children: messagesSnapshot.data.map((Message msg) {
                    return new ListTile(
                      title: new Text(msg.message),
                      subtitle: new Text(DateTime.fromMillisecondsSinceEpoch(msg.timestamp).toString()
                                         +"\n"+(msg.user ?? msg.uid)),
                    );
                  }).toList()
                );
            }
          }
        );
        return streamBuilder;
  }
}

По сравнению с решением с вложенными компоновщиками этот код более читабелен, в основном потому, что обработка данных и построитель пользовательского интерфейса лучше разделены. Он также загружает пользовательские документы только для пользователей, которые разместили сообщения. К сожалению, если пользователь разместил несколько сообщений, он загрузит документ для каждого сообщения. Я мог бы добавить кеш, но думаю, что этот код уже немного длинен для достижения цели.

Фрэнк ван Пуффелен
источник
1
Если вы не воспринимаете «хранение информации пользователя внутри сообщения» как ответ, я думаю, что это лучшее, что вы можете сделать. Если вы храните информацию о пользователе в сообщении, существует очевидный недостаток, заключающийся в том, что информация о пользователе может изменяться в коллекции пользователей, но не внутри сообщения. Используя запланированную функцию firebase, вы также можете решить эту проблему. Время от времени вы можете проходить сбор сообщений и обновлять информацию о пользователях в соответствии с последними данными в коллекции пользователей.
Угуркан Йилдирим
Лично я предпочитаю более простое решение, как это, по сравнению с объединением потоков, если в этом нет особой необходимости. Более того, мы могли бы преобразовать этот метод загрузки данных в нечто вроде класса обслуживания или следовать шаблону BLoC. Как вы уже упоминали, мы можем сохранить информацию о пользователе в Map<String, UserModel>и загрузить пользовательский документ только один раз.
Джошуа Чан
Согласился Джошуа. Я хотел бы видеть описание того, как это будет выглядеть в шаблоне BLoC.
Фрэнк ван Пуффелен
3

Если я правильно читаю, проблема сводится к следующему: как преобразовать поток данных, который требует асинхронного вызова для изменения данных в потоке?

В контексте проблемы поток данных представляет собой список сообщений, и асинхронный вызов предназначен для извлечения пользовательских данных и обновления сообщений с этими данными в потоке.

Это можно сделать непосредственно в объекте потока Дарт, используя asyncMap()функцию. Вот некоторый чистый код Dart, который демонстрирует, как это сделать:

import 'dart:async';
import 'dart:math' show Random;

final random = Random();

const messageList = [
  {
    'message': 'Message 1',
    'timestamp': 1,
    'uid': 1,
  },
  {
    'message': 'Message 2',
    'timestamp': 2,
    'uid': 2,
  },
  {
    'message': 'Message 3',
    'timestamp': 3,
    'uid': 2,
  },
];

const userList = {
  1: 'User 1',
  2: 'User 2',
  3: 'User 3',
};

class Message {
  final String message;
  final int timestamp;
  final int uid;
  final String user;
  const Message(this.message, this.timestamp, this.uid, this.user);

  @override
  String toString() => '$user => $message';
}

// Mimic a stream of a list of messages
Stream<List<Map<String, dynamic>>> getServerMessagesMock() async* {
  yield messageList;
  while (true) {
    await Future.delayed(Duration(seconds: random.nextInt(3) + 1));
    yield messageList;
  }
}

// Mimic asynchronously fetching a user
Future<String> userMock(int uid) => userList.containsKey(uid)
    ? Future.delayed(
        Duration(milliseconds: 100 + random.nextInt(100)),
        () => userList[uid],
      )
    : Future.value(null);

// Transform the contents of a stream asynchronously
Stream<List<Message>> getMessagesStream() => getServerMessagesMock()
    .asyncMap<List<Message>>((messageList) => Future.wait(
          messageList.map<Future<Message>>(
            (m) async => Message(
              m['message'],
              m['timestamp'],
              m['uid'],
              await userMock(m['uid']),
            ),
          ),
        ));

void main() async {
  print('Streams with async transforms test');
  await for (var messages in getMessagesStream()) {
    messages.forEach(print);
  }
}

Большая часть кода имитирует данные, поступающие из Firebase, в виде потока карты сообщений и асинхронной функции для извлечения пользовательских данных. Важная функция здесь getMessagesStream().

Код немного усложняется тем, что это список сообщений, поступающих в потоке. Чтобы предотвратить синхронные вызовы для извлечения пользовательских данных, код использует a Future.wait()для сбора List<Future<Message>>и создания a, List<Message>когда все фьючерсы завершены.

В контексте Flutter вы можете использовать поток из getMessagesStream()a FutureBuilderдля отображения объектов Message.

Мэтт С.
источник
3

Вы можете сделать это с помощью RxDart следующим образом. Https://pub.dev/packages/rxdart

import 'package:rxdart/rxdart.dart';

class Messages {
  final String messages;
  final DateTime timestamp;
  final String uid;
  final DocumentReference reference;

  Messages.fromMap(Map<String, dynamic> map, {this.reference})
      : messages = map['messages'],
        timestamp = (map['timestamp'] as Timestamp)?.toDate(),
        uid = map['uid'];

  Messages.fromSnapshot(DocumentSnapshot snapshot)
      : this.fromMap(snapshot.data, reference: snapshot.reference);

  @override
  String toString() {
    return 'Messages{messages: $messages, timestamp: $timestamp, uid: $uid, reference: $reference}';
  }
}

class Users {
  final String name;
  final DocumentReference reference;

  Users.fromMap(Map<String, dynamic> map, {this.reference})
      : name = map['name'];

  Users.fromSnapshot(DocumentSnapshot snapshot)
      : this.fromMap(snapshot.data, reference: snapshot.reference);

  @override
  String toString() {
    return 'Users{name: $name, reference: $reference}';
  }
}

class CombineStream {
  final Messages messages;
  final Users users;

  CombineStream(this.messages, this.users);
}

Stream<List<CombineStream>> _combineStream;

@override
  void initState() {
    super.initState();
    _combineStream = Observable(Firestore.instance
        .collection('chat')
        .orderBy("timestamp", descending: true)
        .snapshots())
        .map((convert) {
      return convert.documents.map((f) {

        Stream<Messages> messages = Observable.just(f)
            .map<Messages>((document) => Messages.fromSnapshot(document));

        Stream<Users> user = Firestore.instance
            .collection("users")
            .document(f.data['uid'])
            .snapshots()
            .map<Users>((document) => Users.fromSnapshot(document));

        return Observable.combineLatest2(
            messages, user, (messages, user) => CombineStream(messages, user));
      });
    }).switchMap((observables) {
      return observables.length > 0
          ? Observable.combineLatestList(observables)
          : Observable.just([]);
    })
}

для rxdart 0.23.x

@override
      void initState() {
        super.initState();
        _combineStream = Firestore.instance
            .collection('chat')
            .orderBy("timestamp", descending: true)
            .snapshots()
            .map((convert) {
          return convert.documents.map((f) {

            Stream<Messages> messages = Stream.value(f)
                .map<Messages>((document) => Messages.fromSnapshot(document));

            Stream<Users> user = Firestore.instance
                .collection("users")
                .document(f.data['uid'])
                .snapshots()
                .map<Users>((document) => Users.fromSnapshot(document));

            return Rx.combineLatest2(
                messages, user, (messages, user) => CombineStream(messages, user));
          });
        }).switchMap((observables) {
          return observables.length > 0
              ? Rx.combineLatestList(observables)
              : Stream.value([]);
        })
    }
Дженк ЯГМУР
источник
Очень круто! Есть ли способ, который не нужен f.reference.snapshots(), так как это по сути перезагрузка снимка, и я предпочел бы не полагаться на то, что клиент Firestore достаточно умен, чтобы дедуплицировать их (даже если я почти уверен, что он действительно дедуплицирует).
Фрэнк ван Пуффелен
Нашел это. Вместо Stream<Messages> messages = f.reference.snapshots()..., вы можете сделать Stream<Messages> messages = Observable.just(f).... Что мне нравится в этом ответе, так это то, что он просматривает пользовательские документы, поэтому, если имя пользователя обновляется в базе данных, результат сразу же отражается.
Фрэнк ван Пуффелен
Да, работа так хороша, что я обновляю свой код
Cenk YAGMUR
1

В идеале вы хотите исключить любую бизнес-логику, такую ​​как загрузка данных в отдельный сервис или следование шаблону BloC, например:

class ChatBloc {
  final Firestore firestore = Firestore.instance;
  final Map<String, String> userMap = HashMap<String, String>();

  Stream<List<Message>> get messages async* {
    final messagesStream = Firestore.instance.collection('chat').orderBy('timestamp', descending: true).snapshots();
    var messages = List<Message>();
    await for (var messagesSnapshot in messagesStream) {
      for (var messageDoc in messagesSnapshot.documents) {
        final userUid = messageDoc['uid'];
        var message;

        if (userUid != null) {
          // get user data if not in map
          if (userMap.containsKey(userUid)) {
            message = Message(messageDoc['message'], messageDoc['timestamp'], userUid, userMap[userUid]);
          } else {
            final userSnapshot = await Firestore.instance.collection('users').document(userUid).get();
            message = Message(messageDoc['message'], messageDoc['timestamp'], userUid, userSnapshot['name']);
            // add entry to map
            userMap[userUid] = userSnapshot['name'];
          }
        } else {
          message =
              Message(messageDoc['message'], messageDoc['timestamp'], '', '');
        }
        messages.add(message);
      }
      yield messages;
    }
  }
}

Тогда вы можете просто использовать Bloc в своем компоненте и слушать chatBloc.messagesпоток.

class ChatList extends StatelessWidget {
  final ChatBloc chatBloc = ChatBloc();

  @override
  Widget build(BuildContext context) {
    return StreamBuilder<List<Message>>(
        stream: chatBloc.messages,
        builder: (BuildContext context, AsyncSnapshot<List<Message>> messagesSnapshot) {
          if (messagesSnapshot.hasError)
            return new Text('Error: ${messagesSnapshot.error}');
          switch (messagesSnapshot.connectionState) {
            case ConnectionState.waiting:
              return new Text('Loading...');
            default:
              return new ListView(children: messagesSnapshot.data.map((Message msg) {
                return new ListTile(
                  title: new Text(msg.message),
                  subtitle: new Text('${msg.timestamp}\n${(msg.user ?? msg.uid)}'),
                );
              }).toList());
          }
        });
  }
}
Джошуа Чан
источник
1

Позвольте мне представить свою версию решения RxDart. Я использую combineLatest2с ListView.builderпостроить каждое сообщение Widget. Во время построения каждого виджета сообщения я ищу имя пользователя с соответствующимuid .

В этом фрагменте я использую линейный поиск имени пользователя, но это можно улучшить, создав uid -> user nameкарту

import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:flutter/widgets.dart';
import 'package:rxdart/rxdart.dart';

class MessageWidget extends StatelessWidget {
  // final chatStream = Firestore.instance.collection('chat').snapshots();
  // final userStream = Firestore.instance.collection('users').snapshots();
  Stream<QuerySnapshot> chatStream;
  Stream<QuerySnapshot> userStream;

  MessageWidget(this.chatStream, this.userStream);

  @override
  Widget build(BuildContext context) {
    Observable<List<QuerySnapshot>> combinedStream = Observable.combineLatest2(
        chatStream, userStream, (messages, users) => [messages, users]);

    return StreamBuilder(
        stream: combinedStream,
        builder: (_, AsyncSnapshot<List<QuerySnapshot>> snapshots) {
          if (snapshots.hasData) {
            List<DocumentSnapshot> chats = snapshots.data[0].documents;

            // It would be more efficient to convert this list of user documents
            // to a map keyed on the uid which will allow quicker user lookup.
            List<DocumentSnapshot> users = snapshots.data[1].documents;

            return ListView.builder(itemBuilder: (_, index) {
              return Center(
                child: Column(
                  children: <Widget>[
                    Text(chats[index]['message']),
                    Text(getUserName(users, chats[index]['uid'])),
                  ],
                ),
              );
            });
          } else {
            return Text('loading...');
          }
        });
  }

  // This does a linear search through the list of users. However a map
  // could be used to make the finding of the user's name more efficient.
  String getUserName(List<DocumentSnapshot> users, String uid) {
    for (final user in users) {
      if (user['uid'] == uid) {
        return user['name'];
      }
    }
    return 'unknown';
  }
}
Артур Томпсон
источник
Очень здорово видеть Артура. Это похоже на более чистую версию моего первоначального ответа с вложенными строителями . Определенно одно из более простых решений для чтения.
Фрэнк ван Пуффелен
0

Первое решение, которое я получил, - это вложение двух StreamBuilderэкземпляров, по одному для каждой коллекции / запроса.

class ChatList extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    var messagesSnapshot = Firestore.instance.collection("chat").orderBy("timestamp", descending: true).snapshots();
    var usersSnapshot = Firestore.instance.collection("users").snapshots();
    var streamBuilder = StreamBuilder<QuerySnapshot>(
      stream: messagesSnapshot,
      builder: (BuildContext context, AsyncSnapshot<QuerySnapshot> messagesSnapshot) {
        return StreamBuilder(
          stream: usersSnapshot,
          builder: (context, usersSnapshot) {
            if (messagesSnapshot.hasError || usersSnapshot.hasError || !usersSnapshot.hasData)
              return new Text('Error: ${messagesSnapshot.error}, ${usersSnapshot.error}');
            switch (messagesSnapshot.connectionState) {
              case ConnectionState.waiting: return new Text("Loading...");
              default:
                return new ListView(
                  children: messagesSnapshot.data.documents.map((DocumentSnapshot doc) {
                    var user = "";
                    if (doc['uid'] != null && usersSnapshot.data != null) {
                      user = doc['uid'];
                      print('Looking for user $user');
                      user = usersSnapshot.data.documents.firstWhere((userDoc) => userDoc.documentID == user).data["name"];
                    }
                    return new ListTile(
                      title: new Text(doc['message']),
                      subtitle: new Text(DateTime.fromMillisecondsSinceEpoch(doc['timestamp']).toString()
                                          +"\n"+user),
                    );
                  }).toList()
                );
            }
        });
      }
    );
    return streamBuilder;
  }
}

Как указано в моем вопросе, я знаю, что это решение не является хорошим, но, по крайней мере, оно работает.

Некоторые проблемы, которые я вижу с этим:

  • Он загружает всех пользователей, а не только тех, кто разместил сообщения. В небольших наборах данных это не будет проблемой, но по мере того, как я получу больше сообщений / пользователей (и использую запрос, чтобы показать их подмножество), я буду загружать все больше и больше пользователей, которые не публиковали никаких сообщений.
  • Код не очень хорошо читается при вложении двух сборщиков. Я сомневаюсь, что это идиоматический флаттер.

Если вы знаете лучшее решение, пожалуйста, напишите в качестве ответа.

Фрэнк ван Пуффелен
источник