1. Обзор
Добро пожаловать в лабораторию кода Friendly Chat. В этой лаборатории кода вы узнаете, как использовать платформу Firebase для создания приложений iOS. Вы будете внедрять чат-клиент и отслеживать его производительность с помощью Firebase.
Эта кодовая лаборатория также доступна в Objective-C.
Что вы узнаете
- Разрешить пользователям входить в систему.
- Синхронизируйте данные с помощью базы данных Firebase Realtime.
- Храните двоичные файлы в хранилище Firebase.
Что вам понадобится
- Xкод
- CocoaPods
- Тестовое устройство с iOS 8.0+ или симулятор
Как вы будете использовать этот учебник?
Как бы вы оценили свой опыт создания приложений для iOS?
2. Получите пример кода
Клонируйте репозиторий GitHub из командной строки.
$ git clone https://github.com/firebase/codelab-friendlychat-ios
3. Создайте стартовое приложение
Чтобы создать начальное приложение:
- В окне терминала перейдите к
Каталог ios-starter/swift-starterиз загрузки примера кода - Запустите
pod install --repo-update - Откройте файл рабочей области FriendlyChatSwift.xc, чтобы открыть проект в Xcode.
- Нажмите на
Кнопка запуска .
Через несколько секунд вы должны увидеть домашний экран Дружественного чата. Пользовательский интерфейс должен появиться. Однако на данный момент вы не можете войти в систему, отправлять или получать сообщения. Приложение прервется с исключением, пока вы не выполните следующий шаг.
4. Создайте проект консоли Firebase
Создать проект
В консоли Firebase выберите «Добавить проект» .
Назовите проект FriendlyChat , затем нажмите «Создать проект» .
Подключите свое iOS-приложение
- На экране «Обзор проекта» вашего нового проекта нажмите «Добавить Firebase в ваше приложение iOS ».
- Введите идентификатор пакета в виде "
com.google.firebase.codelab.FriendlyChatSwift". - Введите идентификатор App Store как «
123456». - Нажмите «Зарегистрировать приложение» .
Добавьте файл GoogleService-Info.plist в свое приложение.
На втором экране нажмите Загрузить GoogleService-Info.plist , чтобы загрузить файл конфигурации, содержащий все необходимые метаданные Firebase для вашего приложения. Скопируйте этот файл в свое приложение и добавьте его в цель FriendlyChatSwift .
Теперь вы можете щелкнуть «x» в правом верхнем углу всплывающего окна, чтобы закрыть его, пропустив шаги 3 и 4, поскольку вы будете выполнять эти шаги здесь.
Импорт модуля Firebase
Начните с того, что убедитесь, что модуль Firebase импортирован.
AppDelegate.swift , FCViewController.swift
import Firebase
Настройте Firebase в AppDelegate
Используйте метод «configure» в FirebaseApp внутри функции application:didFinishLaunchingWithOptions для настройки базовых служб Firebase из вашего файла .plist.
AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions
launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
FirebaseApp.configure()
GIDSignIn.sharedInstance().delegate = self
return true
}
5. Определите пользователей
Используйте правила для ограничения пользователей, прошедших проверку подлинности
Теперь мы добавим правило, требующее аутентификации перед чтением или записью любых сообщений. Для этого мы добавляем следующие правила в наш объект данных messages. В разделе «База данных» консоли Firebase выберите «База данных реального времени», затем перейдите на вкладку «Правила». Затем обновите правила, чтобы они выглядели так:
{
"rules": {
"messages": {
".read": "auth != null",
".write": "auth != null"
}
}
}
Для получения дополнительной информации о том, как это работает (включая документацию по переменной «auth»), см. документацию по безопасности Firebase.
Настройка API аутентификации
Прежде чем ваше приложение сможет получить доступ к API аутентификации Firebase от имени ваших пользователей, вам необходимо включить его.
- Перейдите в консоль Firebase и выберите свой проект.
- Выберите аутентификацию
- Выберите вкладку «Метод входа».
- Включите переключатель Google (синий)
- Нажмите Сохранить в появившемся диалоговом окне.
Если позже вы получите ошибки в этой кодовой лаборатории с сообщением «CONFIGURATION_NOT_FOUND», вернитесь к этому шагу и еще раз проверьте свою работу.
Подтвердите зависимость аутентификации Firebase
Убедитесь, что в файле Podfile существуют зависимости Firebase Auth.
Подфайл
pod 'Firebase/Auth'
Настройте свой Info.plist для входа в Google.
Вам нужно будет добавить пользовательскую схему URL-адресов в свой проект XCode.
- Откройте конфигурацию вашего проекта: дважды щелкните имя проекта в левом древовидном представлении. Выберите свое приложение в разделе ЦЕЛИ, затем перейдите на вкладку Информация и разверните раздел Типы URL.
- Нажмите кнопку + и добавьте схему URL-адресов для обратного идентификатора клиента. Чтобы найти это значение, откройте файл конфигурации GoogleService-Info.plist и найдите ключ REVERSED_CLIENT_ID. Скопируйте значение этого ключа и вставьте его в поле «Схемы URL» на странице конфигурации. Остальные поля оставьте пустыми.
- По завершении ваша конфигурация должна выглядеть примерно так (но со значениями, специфичными для вашего приложения):
Установить clientID для входа в Google
После настройки Firebase мы можем использовать clientID для настройки входа в Google внутри метода «didFinishLaunchingWithOptions:».
AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions
launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
FirebaseApp.configure()
GIDSignIn.sharedInstance().clientID = FirebaseApp.app()?.options.clientID
GIDSignIn.sharedInstance().delegate = self
return true
}
Добавьте обработчик входа
После успешного входа в Google используйте учетную запись для аутентификации в Firebase.
AppDelegate.swift
func sign(_ signIn: GIDSignIn!, didSignInFor user: GIDGoogleUser!, withError error: Error?) {
if let error = error {
print("Error \(error)")
return
}
guard let authentication = user.authentication else { return }
let credential = GoogleAuthProvider.credential(withIDToken: authentication.idToken,
accessToken: authentication.accessToken)
Auth.auth().signIn(with: credential) { (user, error) in
if let error = error {
print("Error \(error)")
return
}
}
}
Автоматический вход пользователя. Затем добавьте прослушиватель в Firebase Auth, чтобы позволить пользователю войти в приложение после успешного входа в систему. И удалите прослушиватель при deinit.
SignInViewController.swift
override func viewDidLoad() {
super.viewDidLoad()
GIDSignIn.sharedInstance().uiDelegate = self
GIDSignIn.sharedInstance().signInSilently()
handle = Auth.auth().addStateDidChangeListener() { (auth, user) in
if user != nil {
MeasurementHelper.sendLoginEvent()
self.performSegue(withIdentifier: Constants.Segues.SignInToFp, sender: nil)
}
}
}
deinit {
if let handle = handle {
Auth.auth().removeStateDidChangeListener(handle)
}
}
Выход
Добавьте метод выхода
FCViewController.swift
@IBAction func signOut(_ sender: UIButton) {
let firebaseAuth = Auth.auth()
do {
try firebaseAuth.signOut()
dismiss(animated: true, completion: nil)
} catch let signOutError as NSError {
print ("Error signing out: \(signOutError.localizedDescription)")
}
}
Проверка чтения сообщений от имени вошедшего пользователя
- Нажмите на Кнопка запуска .
- Вы должны быть немедленно отправлены на экран входа. Коснитесь кнопки входа в Google.
- Затем вы должны быть отправлены на экран обмена сообщениями, если все работает хорошо.
6. Активируйте базу данных в реальном времени
Импорт сообщений
В вашем проекте в консоли Firebase выберите элемент базы данных на левой панели навигации. В дополнительном меню базы данных выберите Import JSON . Перейдите к файлу initial_messages.json в каталоге friendlychat, выберите его и нажмите кнопку «Импорт» . Это заменит любые данные, находящиеся в настоящее время в вашей базе данных. Вы также можете редактировать базу данных напрямую, используя зеленый + и красный крестик для добавления и удаления элементов.
После импорта ваша база данных должна выглядеть так:
Подтвердите зависимость базы данных Firebase
В блоке зависимостей файла Podfile убедитесь, что Firebase/Database включена.
Подфайл
pod 'Firebase/Database'
Синхронизировать существующие сообщения
Добавьте код, который синхронизирует новые добавленные сообщения с пользовательским интерфейсом приложения.
Код, который вы добавите в этот раздел, будет:
- Инициализируйте базу данных Firebase и добавьте прослушиватель для обработки изменений, внесенных в базу данных.
- Обновите
DataSnapshot, чтобы отображались новые сообщения.
Измените методы "deinit", "configureDatabase" и "tableView:cellForRow indexPath:" вашего FCViewController; замените кодом, определенным ниже:
FCViewController.swift
deinit {
if let refHandle = _refHandle {
self.ref.child("messages").removeObserver(withHandle: _refHandle)
}
}
func configureDatabase() {
ref = Database.database().reference()
// Listen for new messages in the Firebase database
_refHandle = self.ref.child("messages").observe(.childAdded, with: { [weak self] (snapshot) -> Void in
guard let strongSelf = self else { return }
strongSelf.messages.append(snapshot)
strongSelf.clientTable.insertRows(at: [IndexPath(row: strongSelf.messages.count-1, section: 0)], with: .automatic)
})
}
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
// Dequeue cell
let cell = self.clientTable.dequeueReusableCell(withIdentifier: "tableViewCell", for: indexPath)
// Unpack message from Firebase DataSnapshot
let messageSnapshot = self.messages[indexPath.row]
guard let message = messageSnapshot.value as? [String: String] else { return cell }
let name = message[Constants.MessageFields.name] ?? ""
let text = message[Constants.MessageFields.text] ?? ""
cell.textLabel?.text = name + ": " + text
cell.imageView?.image = UIImage(named: "ic_account_circle")
if let photoURL = message[Constants.MessageFields.photoURL], let URL = URL(string: photoURL),
let data = try? Data(contentsOf: URL) {
cell.imageView?.image = UIImage(data: data)
}
return cell
}
Проверка синхронизации сообщений
- Нажмите на Кнопка запуска .
- Нажмите кнопку Войти, чтобы начать работу , чтобы перейти к окну сообщений.
- Добавьте новые сообщения непосредственно в консоль Firebase, щелкнув зеленый символ + рядом с записью «сообщения» и добавив объект, подобный следующему:
- Убедитесь, что они отображаются в пользовательском интерфейсе Friendly-Chat.
7. Отправляйте сообщения
Реализовать отправку сообщения
Отправка значений в базу данных. Когда вы используете метод push для добавления данных в базу данных Firebase Realtime, будет добавлен автоматический идентификатор. Эти автоматически сгенерированные идентификаторы являются последовательными, что гарантирует, что новые сообщения будут добавляться в правильном порядке.
Измените метод «sendMessage:» вашего FCViewController; замените кодом, определенным ниже:
FCViewController.swift
func sendMessage(withData data: [String: String]) {
var mdata = data
mdata[Constants.MessageFields.name] = Auth.auth().currentUser?.displayName
if let photoURL = Auth.auth().currentUser?.photoURL {
mdata[Constants.MessageFields.photoURL] = photoURL.absoluteString
}
// Push data to Firebase Database
self.ref.child("messages").childByAutoId().setValue(mdata)
}
Тестовая отправка сообщений
- Нажмите на Кнопка запуска .
- Нажмите Войти , чтобы перейти к окну сообщений.
- Введите сообщение и нажмите «Отправить». Новое сообщение должно отображаться в пользовательском интерфейсе приложения и в консоли Firebase.
8. Храните и получайте изображения
Подтвердите зависимость хранилища Firebase
В блоке зависимостей Podfile убедитесь, что Firebase/Storage включен.
Подфайл
pod 'Firebase/Storage'
Активируйте хранилище Firebase на панели инструментов
Перейдите в консоль Firebase и убедитесь, что хранилище активировано с доменом «gs://PROJECTID.appspot.com».
Если вместо этого вы видите окно активации, нажмите «НАЧАТЬ», чтобы активировать его с правилами по умолчанию.
Настроить FirebaseStorage
FCViewController.swift
func configureStorage() {
storageRef = Storage.storage().reference()
}
Получать изображения в существующих сообщениях
Добавьте код, загружающий изображения из Firebase Storage.
Измените метод tableView: cellForRowAt indexPath: вашего FCViewController; замените кодом, определенным ниже:
FCViewController.swift
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
// Dequeue cell
let cell = self.clientTable .dequeueReusableCell(withIdentifier: "tableViewCell", for: indexPath)
// Unpack message from Firebase DataSnapshot
let messageSnapshot: DataSnapshot! = self.messages[indexPath.row]
guard let message = messageSnapshot.value as? [String:String] else { return cell }
let name = message[Constants.MessageFields.name] ?? ""
if let imageURL = message[Constants.MessageFields.imageURL] {
if imageURL.hasPrefix("gs://") {
Storage.storage().reference(forURL: imageURL).getData(maxSize: INT64_MAX) {(data, error) in
if let error = error {
print("Error downloading: \(error)")
return
}
DispatchQueue.main.async {
cell.imageView?.image = UIImage.init(data: data!)
cell.setNeedsLayout()
}
}
} else if let URL = URL(string: imageURL), let data = try? Data(contentsOf: URL) {
cell.imageView?.image = UIImage.init(data: data)
}
cell.textLabel?.text = "sent by: \(name)"
} else {
let text = message[Constants.MessageFields.text] ?? ""
cell.textLabel?.text = name + ": " + text
cell.imageView?.image = UIImage(named: "ic_account_circle")
if let photoURL = message[Constants.MessageFields.photoURL], let URL = URL(string: photoURL),
let data = try? Data(contentsOf: URL) {
cell.imageView?.image = UIImage(data: data)
}
}
return cell
}
9. Отправляйте графические сообщения
Реализовать сохранение и отправку изображений
Загрузите изображение от пользователя, затем синхронизируйте URL-адрес хранилища этого изображения с базой данных, чтобы это изображение было отправлено внутри сообщения.
Измените метод "imagePickerController: didFinishPickingMediaWithInfo:" вашего FCViewController; замените кодом, определенным ниже:
FCViewController.swift
func imagePickerController(_ picker: UIImagePickerController,
didFinishPickingMediaWithInfo info: [String : Any]) {
picker.dismiss(animated: true, completion:nil)
guard let uid = Auth.auth().currentUser?.uid else { return }
// if it's a photo from the library, not an image from the camera
if #available(iOS 8.0, *), let referenceURL = info[UIImagePickerControllerReferenceURL] as? URL {
let assets = PHAsset.fetchAssets(withALAssetURLs: [referenceURL], options: nil)
let asset = assets.firstObject
asset?.requestContentEditingInput(with: nil, completionHandler: { [weak self] (contentEditingInput, info) in
let imageFile = contentEditingInput?.fullSizeImageURL
let filePath = "\(uid)/\(Int(Date.timeIntervalSinceReferenceDate * 1000))/\((referenceURL as AnyObject).lastPathComponent!)"
guard let strongSelf = self else { return }
strongSelf.storageRef.child(filePath)
.putFile(from: imageFile!, metadata: nil) { (metadata, error) in
if let error = error {
let nsError = error as NSError
print("Error uploading: \(nsError.localizedDescription)")
return
}
strongSelf.sendMessage(withData: [Constants.MessageFields.imageURL: strongSelf.storageRef.child((metadata?.path)!).description])
}
})
} else {
guard let image = info[UIImagePickerControllerOriginalImage] as? UIImage else { return }
let imageData = UIImageJPEGRepresentation(image, 0.8)
let imagePath = "\(uid)/\(Int(Date.timeIntervalSinceReferenceDate * 1000)).jpg"
let metadata = StorageMetadata()
metadata.contentType = "image/jpeg"
self.storageRef.child(imagePath)
.putData(imageData!, metadata: metadata) { [weak self] (metadata, error) in
if let error = error {
print("Error uploading: \(error)")
return
}
guard let strongSelf = self else { return }
strongSelf.sendMessage(withData: [Constants.MessageFields.imageURL: strongSelf.storageRef.child((metadata?.path)!).description])
}
}
}
Проверка отправки и получения графических сообщений
- Нажмите на Кнопка запуска .
- Нажмите Войти , чтобы перейти к окну сообщений.
- Нажмите значок «Добавить фото», чтобы выбрать фото. Новое сообщение с фотографией должно быть видно в пользовательском интерфейсе приложения и в консоли Firebase.
10. Поздравляем!
Вы использовали Firebase для простого создания приложения для чата в реальном времени.
Что мы рассмотрели
- База данных реального времени
- Федеративный вход
- Хранилище