Game - библиотека классов для реализации мультиплеерной игры Камень Ножницы Бумага.
ConsoleApp - консольное приложение для игры с компьютером.
В этой задаче нужно доработать приложение ConsoleApp так, чтобы оно хранило все данные в MongoDB.
К счастью, вся работа с БД уже изолирована за интерфейсами репозиториев IUserRepository и IGameRepository.
Сейчас у этих интерфейсов есть реализации для хранения всех данных в памяти.
Требуется создать новые реализации, для хранения данных в MongoDB. Ниже вся задача разбита на этапы:
Для изучения нужно развернуть MongoDB локально. Есть два способа:
- Установить MongoDB Community Edition. Скачать её можно отсюда.
- Развернуть локально Docker-образ MongoDB по инструкции.
Сначала нужно подготовить сами классы сущностей к тому, чтобы их мог сохранять и загружать из базы драйвер MongoDB. Драйвер делает это с помощью Bson сериализатора. Можно проверить работу сериализации отдельно от работы с сервером Mongo.
- Изучи, а потом запусти тест
BsonSerializationTest.UserEntityдолжен сериализоваться без ошибок, аGameEntityнет. Нужно настроить сериализациюGameEntity. - Добавь атрибут [BsonConstructor] над конструктором с полным набором аргументов.
- Добавь атрибут [BsonElement] над всеми readonly-свойствами и readonly-полями, потому что по умолчанию Mongo их игнорирует. То же самое нужно сделать со всеми вложенными в сериализуемую сущность классами.
- Запусти тест и проверь, что теперь класс
GameEntityуспешно сериализуется
Более подробно про настройку сериализации в Bson читай в документации: http://mongodb.github.io/mongo-csharp-driver/2.10/reference/bson/mapping/
- Реализуй в классе
MongoUserRepositoryвсе методы. Тебе поможет документация. Операции чтения: http://mongodb.github.io/mongo-csharp-driver/2.10/reference/driver/crud/reading/ Операции записи: http://mongodb.github.io/mongo-csharp-driver/2.10/reference/driver/crud/writing/ Проверь работоспособность тестами на этот репозиторий. - С помощью MongoDB Compass убедись, что после выполнения тестов, в базе
game-testsсоздаются коллекции и документы.
- Запусти тест
SearchByLoginFast. Запомни, как долго он работал. - Ускорить операцию поиска по логину можно создав индекс. Так как логины у пользователей должны быть уникальными, стоит сразу сделать индекс со свойством "уникальный". При наличии такого индекса MongoDB будет самостоятельно проверять, что логины в сохраненных сущностях не повторяются. Для простоты добавь создание индекса в конструкторе репозитория. Не волнуйся, MongoDB игнорирует повторное создание индекса. Тебе поможет документация http://mongodb.github.io/mongo-csharp-driver/2.10/reference/driver/admin/#indexes
- Повторно запусти тест
SearchByLoginFastи сравни время работы с первоначальным. - С помощью MongoDB Compass убедись, что после выполнения тестов, у коллекции users появился индекс и он используется.
- Раз ты создал уникальный индекс, то тест
LoginDuplicateNotAllowedтакже должен проходить. Проверь это.
- Поменяй
InMemoryUserRepositoryнаMongoUserRepositoryвConsoleApp. Пример создания Mongo репозитория смотри в тестах на репозитории. - С помощью MongoDB Compass проверь, что после окончания игры у пользователя обновляется количество сыгранных игр в БД.
- Реализуй в классе
MongoGameRepositoryвсе методы. Тебе поможет документация. Операции чтения: http://mongodb.github.io/mongo-csharp-driver/2.10/reference/driver/crud/reading/ Операции записи: http://mongodb.github.io/mongo-csharp-driver/2.10/reference/driver/crud/writing/ - Проверь работоспособность тестами на этот репозиторий.
- С помощью MongoDB Compass убедись, что после выполнения тестов, в базе game-tests создаются коллекции и документы.
- Поменяй
InMemoryGameRepositoryнаMongoGameRepositoryвConsoleApp. - Проверь, что прерванная на середине игра сохраняет состояние в БД и при перезапуске продолжается.
Самостоятельно спроектируй ещё одну сущность: GameTurnEntity — это информация об одном завершённом туре игры.
В рамках тура каждый игрок называет Камень Ножницы или Бумага, и определяется исход тура — победитель тура или ничья.
Объект этого типа возвращает метод GameEntity.FinishTurn().
Спроектируй репозиторий этих сущностей. Добавь его использование в ConsoleApp в двух местах, помеченных TODO-комментариями:
- Сохраняй эту сущность в БД в конце каждого тура.
- В методе
ShowScoreполучай из репозитория последние 5 туров и показывай информацию о том, кто что назвал и кто в итоге выиграл тур.
Убедись, что у тебя есть правильный индекс, для того, чтобы запрос последних 5 туров работал быстро. Можешь создать соответствующий тест, чтобы это проверить.
Вводные о моделировании данных:
https://docs.mongodb.com/manual/core/data-modeling-introduction/ https://docs.mongodb.com/manual/core/data-model-design/
Ограничение на размер документа 16 Мб и другие ограничения. https://docs.mongodb.com/manual/reference/limits/#BSON-Document-Size
О том, как принимать решения о проектировании БД: