API Codable của Swift (ra mắt trong Swift 4) cho phép chúng ta tận dụng sức mạnh của trình biên dịch để dễ dàng liên kết dữ liệu từ các định dạng được tuần tự hoá với các loại Swift.
Có thể bạn đã sử dụng Codable để liên kết dữ liệu từ một API web với mô hình dữ liệu của ứng dụng (và ngược lại), nhưng API này linh hoạt hơn nhiều.
Trong hướng dẫn này, chúng ta sẽ xem cách sử dụng Codable để liên kết dữ liệu từ Cloud Firestore với các loại Swift và ngược lại.
Khi tìm nạp một tài liệu từ Cloud Firestore, ứng dụng của bạn sẽ nhận được một từ điển gồm các cặp khoá/giá trị (hoặc một mảng từ điển, nếu bạn sử dụng một trong các thao tác trả về nhiều tài liệu).
Giờ đây, bạn chắc chắn có thể tiếp tục sử dụng trực tiếp các từ điển trong Swift. Các từ điển này mang lại một số tính linh hoạt tuyệt vời có thể phù hợp với trường hợp sử dụng của bạn. Tuy nhiên, phương pháp này không an toàn về kiểu và bạn có thể dễ dàng gặp phải các lỗi khó theo dõi bằng cách viết sai tên thuộc tính hoặc quên liên kết thuộc tính mới mà nhóm của bạn đã thêm khi họ phát hành tính năng mới thú vị đó vào tuần trước.
Trước đây, nhiều nhà phát triển đã khắc phục những thiếu sót này bằng cách triển khai một lớp liên kết đơn giản cho phép họ liên kết các từ điển với các loại Swift. Nhưng một lần nữa, hầu hết các phương thức triển khai này đều dựa trên việc chỉ định mối liên kết giữa các tài liệu Cloud Firestore và các loại tương ứng của mô hình dữ liệu trong ứng dụng theo cách thủ công.
Với tính năng hỗ trợ API Codable của Swift trong Cloud Firestore, việc này trở nên dễ dàng hơn nhiều:
- Bạn sẽ không còn phải triển khai mã liên kết theo cách thủ công nữa.
- Bạn có thể dễ dàng xác định cách liên kết các thuộc tính có tên khác nhau.
- API này có tính năng hỗ trợ tích hợp cho nhiều loại Swift.
- Bạn có thể dễ dàng thêm tính năng hỗ trợ để liên kết các loại tuỳ chỉnh.
- Điều tuyệt vời nhất là: đối với các mô hình dữ liệu đơn giản, bạn sẽ không phải viết bất kỳ mã liên kết nào.
Liên kết dữ liệu
Cloud Firestore lưu trữ dữ liệu trong các tài liệu liên kết các khoá với giá trị. Để tìm nạp
dữ liệu từ một tài liệu riêng lẻ, chúng ta có thể gọi DocumentSnapshot.data(). Phương thức này
trả về một từ điển liên kết tên trường với Any:
func data() -> [String : Any]?.
Điều này có nghĩa là chúng ta có thể sử dụng cú pháp chỉ số dưới của Swift để truy cập vào từng trường riêng lẻ.
import FirebaseFirestore
#warning("DO NOT MAP YOUR DOCUMENTS MANUALLY. USE CODABLE INSTEAD.")
func fetchBook(documentId: String) {
let docRef = db.collection("books").document(documentId)
docRef.getDocument { document, error in
if let error = error as NSError? {
self.errorMessage = "Error getting document: \(error.localizedDescription)"
}
else {
if let document = document {
let id = document.documentID
let data = document.data()
let title = data?["title"] as? String ?? ""
let numberOfPages = data?["numberOfPages"] as? Int ?? 0
let author = data?["author"] as? String ?? ""
self.book = Book(id:id, title: title, numberOfPages: numberOfPages, author: author)
}
}
}
}
Mặc dù có vẻ đơn giản và dễ triển khai, nhưng mã này dễ bị lỗi, khó duy trì và dễ xảy ra lỗi.
Như bạn có thể thấy, chúng ta đang đưa ra các giả định về các loại dữ liệu của các trường trong tài liệu. Các giả định này có thể đúng hoặc không đúng.
Hãy nhớ rằng vì không có giản đồ nên bạn có thể dễ dàng thêm một tài liệu mới vào bộ sưu tập và chọn một loại khác cho một trường. Bạn có thể vô tình chọn chuỗi cho trường numberOfPages, dẫn đến vấn đề liên kết khó tìm. Ngoài ra, bạn sẽ phải cập nhật mã liên kết mỗi khi thêm một trường mới. Việc này khá phức tạp.
Và đừng quên rằng chúng ta không tận dụng hệ thống kiểu mạnh mẽ của Swift. Hệ thống này biết chính xác kiểu chính xác cho từng thuộc tính của Book.
Codable là gì?
Theo tài liệu của Apple, Codable là "một loại có thể tự chuyển đổi thành và từ một biểu diễn bên ngoài". Trên thực tế, Codable là một bí danh kiểu cho các giao thức Encodable và Decodable. Bằng cách tuân thủ một loại Swift theo giao thức này, trình biên dịch sẽ tổng hợp mã cần thiết để mã hoá/giải mã một thực thể của loại này từ một định dạng được tuần tự hoá, chẳng hạn như JSON.
Một loại đơn giản để lưu trữ dữ liệu về một cuốn sách có thể có dạng như sau:
struct Book: Codable {
var title: String
var numberOfPages: Int
var author: String
}
Như bạn có thể thấy, việc tuân thủ loại này theo Codable là ít xâm nhập nhất. Chúng ta chỉ phải thêm sự tuân thủ vào giao thức; không cần thay đổi gì khác.
Với điều này, giờ đây, chúng ta có thể dễ dàng mã hoá một cuốn sách thành một đối tượng JSON:
do {
let book = Book(title: "The Hitchhiker's Guide to the Galaxy",
numberOfPages: 816,
author: "Douglas Adams")
let encoder = JSONEncoder()
let data = try encoder.encode(book)
}
catch {
print("Error when trying to encode book: \(error)")
}
Việc giải mã một đối tượng JSON thành một thực thể Book hoạt động như sau:
let decoder = JSONDecoder()
let data = /* fetch data from the network */
let decodedBook = try decoder.decode(Book.self, from: data)
Liên kết đến và từ các loại đơn giản trong Cloud Firestore tài liệu bằng Codable
Cloud Firestore hỗ trợ một tập hợp rộng các loại dữ liệu, từ các chuỗi đơn giản đến các bản đồ lồng nhau. Hầu hết các loại này tương ứng trực tiếp với các loại tích hợp của Swift. Trước tiên, hãy xem xét việc liên kết một số loại dữ liệu đơn giản trước khi đi sâu vào các loại phức tạp hơn.
Để liên kết các tài liệu Cloud Firestore với các loại Swift, hãy làm theo các bước sau:
- Đảm bảo bạn đã thêm khung
FirebaseFirestorevào dự án của mình. Bạn có thể sử dụng Trình quản lý gói Swift hoặc CocoaPods để thực hiện việc này. - Nhập
FirebaseFirestorevào tệp Swift. - Tuân thủ loại của bạn theo
Codable. - (Không bắt buộc, nếu bạn muốn sử dụng loại này trong khung hiển thị
List) Thêm thuộc tínhidvào loại của bạn và sử dụng@DocumentIDđể yêu cầu Cloud Firestore liên kết thuộc tính này với mã tài liệu. Chúng ta sẽ thảo luận chi tiết hơn về vấn đề này bên dưới. - Sử dụng
documentReference.data(as: )để liên kết một tham chiếu tài liệu với một loại Swift. - Sử dụng
documentReference.setData(from: )để liên kết dữ liệu từ các loại Swift với một Cloud Firestore tài liệu. - (Không bắt buộc, nhưng bạn nên thực hiện) Triển khai quy trình xử lý lỗi thích hợp.
Hãy cập nhật loại Book cho phù hợp:
struct Book: Codable {
@DocumentID var id: String?
var title: String
var numberOfPages: Int
var author: String
}
Vì loại này đã có thể mã hoá, nên chúng ta chỉ phải thêm thuộc tính id và chú thích thuộc tính này bằng trình bao bọc thuộc tính @DocumentID.
Lấy đoạn mã trước để tìm nạp và liên kết một tài liệu, chúng ta có thể thay thế tất cả mã liên kết thủ công bằng một dòng duy nhất:
func fetchBook(documentId: String) {
let docRef = db.collection("books").document(documentId)
docRef.getDocument { document, error in
if let error = error as NSError? {
self.errorMessage = "Error getting document: \(error.localizedDescription)"
}
else {
if let document = document {
do {
self.book = try document.data(as: Book.self)
}
catch {
print(error)
}
}
}
}
}
Bạn có thể viết mã này một cách ngắn gọn hơn bằng cách chỉ định loại tài liệu khi gọi getDocument(as:). Thao tác này sẽ thực hiện việc liên kết cho bạn và trả về một loại Result chứa tài liệu được liên kết hoặc một lỗi trong trường hợp giải mã không thành công:
private func fetchBook(documentId: String) {
let docRef = db.collection("books").document(documentId)
docRef.getDocument(as: Book.self) { result in
switch result {
case .success(let book):
// A Book value was successfully initialized from the DocumentSnapshot.
self.book = book
self.errorMessage = nil
case .failure(let error):
// A Book value could not be initialized from the DocumentSnapshot.
self.errorMessage = "Error decoding document: \(error.localizedDescription)"
}
}
}
Việc cập nhật một tài liệu hiện có cũng đơn giản như gọi documentReference.setData(from: ). Bao gồm một số quy trình xử lý lỗi cơ bản, đây là mã để lưu một thực thể Book:
func updateBook(book: Book) {
if let id = book.id {
let docRef = db.collection("books").document(id)
do {
try docRef.setData(from: book)
}
catch {
print(error)
}
}
}
Khi bạn thêm một tài liệu mới, Cloud Firestore sẽ tự động xử lý việc gán một mã tài liệu mới cho tài liệu đó. Việc này vẫn hoạt động ngay cả khi ứng dụng hiện đang ở chế độ ngoại tuyến.
func addBook(book: Book) {
let collectionRef = db.collection("books")
do {
let newDocReference = try collectionRef.addDocument(from: self.book)
print("Book stored with new document reference: \(newDocReference)")
}
catch {
print(error)
}
}
Ngoài việc liên kết các loại dữ liệu đơn giản, Cloud Firestore hỗ trợ một số loại dữ liệu khác, một số loại trong đó là các loại có cấu trúc mà bạn có thể dùng để tạo các đối tượng lồng nhau bên trong một tài liệu.
Các loại tuỳ chỉnh lồng nhau
Hầu hết các thuộc tính mà chúng ta muốn liên kết trong tài liệu đều là các giá trị đơn giản, chẳng hạn như tiêu đề của cuốn sách hoặc tên của tác giả. Nhưng trong những trường hợp chúng ta cần lưu trữ một đối tượng phức tạp hơn thì sao? Ví dụ: chúng ta có thể muốn lưu trữ các URL đến bìa sách ở nhiều độ phân giải.
Cách dễ nhất để thực hiện việc này trong Cloud Firestore là sử dụng một bản đồ:
Khi viết cấu trúc Swift tương ứng, chúng ta có thể tận dụng việc Cloud Firestore hỗ trợ URL. Khi lưu trữ một trường chứa URL, trường đó sẽ được chuyển đổi thành một chuỗi và ngược lại:
struct CoverImages: Codable {
var small: URL
var medium: URL
var large: URL
}
struct BookWithCoverImages: Codable {
@DocumentID var id: String?
var title: String
var numberOfPages: Int
var author: String
var cover: CoverImages?
}
Hãy lưu ý cách chúng ta xác định một cấu trúc, CoverImages, cho bản đồ bìa trong tài liệu
Cloud Firestore. Bằng cách đánh dấu thuộc tính bìa trên BookWithCoverImages là không bắt buộc, chúng ta có thể xử lý trường hợp một số tài liệu có thể không chứa thuộc tính bìa.
Nếu bạn tò mò về lý do không có đoạn mã nào để tìm nạp hoặc cập nhật dữ liệu, thì bạn sẽ rất vui khi biết rằng không cần mã để đọc hoặc ghi từ/vào Cloud Firestore: tất cả những việc này đều hoạt động với mã mà chúng ta đã viết trong phần ban đầu.
Mảng
Đôi khi, chúng ta muốn lưu trữ một tập hợp các giá trị trong một tài liệu. Thể loại của một cuốn sách là một ví dụ điển hình: một cuốn sách như The Hitchhiker's Guide to the Galaxy có thể thuộc nhiều danh mục – trong trường hợp này là "Khoa học viễn tưởng" và "Hài":
Trong Cloud Firestore, chúng ta có thể mô hình hoá việc này bằng cách sử dụng một mảng giá trị. Tính năng này được hỗ trợ cho mọi loại có thể mã hoá (chẳng hạn như String, Int, v.v.). Sau đây cho thấy cách thêm một mảng thể loại vào mô hình Book:
public struct BookWithGenre: Codable {
@DocumentID var id: String?
var title: String
var numberOfPages: Int
var author: String
var genres: [String]
}
Vì tính năng này hoạt động cho mọi loại có thể mã hoá, nên chúng ta cũng có thể sử dụng các loại tuỳ chỉnh. Hãy tưởng tượng chúng ta muốn lưu trữ một danh sách các thẻ cho mỗi cuốn sách. Cùng với tên của thẻ, chúng ta cũng muốn lưu trữ màu của thẻ, như sau:
Để lưu trữ thẻ theo cách này, tất cả những gì chúng ta cần làm là triển khai một cấu trúc Tag để biểu thị một thẻ và làm cho thẻ đó có thể mã hoá:
struct Tag: Codable, Hashable {
var title: String
var color: String
}
Và chỉ như vậy, chúng ta có thể lưu trữ một mảng Tags trong tài liệu Book!
struct BookWithTags: Codable {
@DocumentID var id: String?
var title: String
var numberOfPages: Int
var author: String
var tags: [Tag]
}
Thông tin nhanh về việc liên kết mã tài liệu
Trước khi chuyển sang liên kết thêm các loại khác, hãy nói về việc liên kết mã tài liệu trong một lát.
Chúng ta đã sử dụng trình bao bọc thuộc tính @DocumentID trong một số ví dụ trước
để liên kết mã tài liệu của tài liệu Cloud Firestore với thuộc tính id của các loại Swift. Việc này rất quan trọng vì một số lý do:
- Việc này giúp chúng ta biết tài liệu nào cần cập nhật trong trường hợp người dùng thực hiện các thay đổi cục bộ.
Listcủa SwiftUI yêu cầu các phần tử của nó phải làIdentifiableđể ngăn các phần tử nhảy xung quanh khi chúng được chèn.
Bạn nên lưu ý rằng một thuộc tính được đánh dấu là @DocumentID sẽ không được
mã hoá bởi Cloud Firestore's bộ mã hoá khi ghi lại tài liệu. Điều này là do mã tài liệu không phải là một thuộc tính của chính tài liệu đó. Vì vậy, việc ghi mã tài liệu vào tài liệu sẽ là một sai lầm.
Khi làm việc với các loại lồng nhau (chẳng hạn như mảng thẻ trên Book trong ví dụ trước trong hướng dẫn này), bạn không bắt buộc phải thêm thuộc tính @DocumentID: các thuộc tính lồng nhau là một phần của tài liệu Cloud Firestore và không cấu thành một tài liệu riêng biệt. Do đó, chúng không cần mã tài liệu.
Ngày và giờ
Cloud Firestore có một loại dữ liệu tích hợp để xử lý ngày và giờ. Nhờ tính năng hỗ trợ Codable của Cloud Firestore, bạn có thể dễ dàng sử dụng các loại dữ liệu này.
Hãy xem tài liệu này đại diện cho mẹ của tất cả các ngôn ngữ lập trình, Ada, được phát minh vào năm 1843:
Một loại Swift để liên kết tài liệu này có thể có dạng như sau:
struct ProgrammingLanguage: Codable {
@DocumentID var id: String?
var name: String
var year: Date
}
Chúng ta không thể bỏ qua phần này về ngày và giờ mà không thảo luận về @ServerTimestamp. Trình bao bọc thuộc tính này là một công cụ mạnh mẽ khi xử lý dấu thời gian trong ứng dụng của bạn.
Trong bất kỳ hệ thống phân tán nào, rất có thể đồng hồ trên các hệ thống riêng lẻ không hoàn toàn đồng bộ mọi lúc. Bạn có thể nghĩ rằng điều này không phải là vấn đề lớn, nhưng hãy tưởng tượng những tác động của một đồng hồ chạy hơi lệch pha đối với hệ thống giao dịch chứng khoán: ngay cả độ lệch một phần nghìn giây cũng có thể dẫn đến sự khác biệt hàng triệu đô la khi thực hiện giao dịch.
Cloud Firestore xử lý các thuộc tính được đánh dấu bằng @ServerTimestamp như sau: nếu thuộc tính là nil khi bạn lưu trữ thuộc tính đó (ví dụ: bằng cách sử dụng addDocument()), Cloud Firestore sẽ điền trường này bằng dấu thời gian hiện tại của máy chủ tại thời điểm ghi vào cơ sở dữ liệu. Nếu trường không phải là nil
khi bạn gọi addDocument() hoặc updateData(), Cloud Firestore sẽ giữ nguyên
giá trị thuộc tính. Bằng cách này, bạn có thể dễ dàng triển khai các trường như createdAt và lastUpdatedAt.
Điểm địa lý
Vị trí địa lý có ở khắp mọi nơi trong ứng dụng của chúng ta. Nhiều tính năng thú vị có thể thực hiện được bằng cách lưu trữ vị trí địa lý. Ví dụ: bạn nên lưu trữ vị trí cho một việc cần làm để ứng dụng có thể nhắc bạn về một việc cần làm khi bạn đến một điểm đến.
Cloud Firestore có một loại dữ liệu tích hợp, GeoPoint, có thể lưu trữ
kinh độ và vĩ độ của bất kỳ vị trí nào. Để liên kết vị trí từ/đến một
Cloud Firestore tài liệu, chúng ta có thể sử dụng loại GeoPoint:
struct Office: Codable {
@DocumentID var id: String?
var name: String
var location: GeoPoint
}
Loại tương ứng trong Swift là CLLocationCoordinate2D và chúng ta có thể liên kết giữa hai loại đó bằng thao tác sau:
CLLocationCoordinate2D(latitude: office.location.latitude,
longitude: office.location.longitude)
Để tìm hiểu thêm về cách truy vấn tài liệu theo vị trí thực, hãy xem hướng dẫn giải pháp này.
Enum
Enum có lẽ là một trong những tính năng ngôn ngữ bị đánh giá thấp nhất trong Swift; chúng có nhiều tính năng hơn bạn nghĩ. Một trường hợp sử dụng phổ biến cho enum là mô hình hoá các trạng thái rời rạc của một thứ gì đó. Ví dụ: chúng ta có thể đang viết một ứng dụng để quản lý bài viết. Để theo dõi trạng thái của một bài viết, chúng ta có thể muốn sử dụng enum Status:
enum Status: String, Codable {
case draft
case inReview
case approved
case published
}
Cloud Firestore không hỗ trợ enum một cách tự nhiên (tức là không thể thực thi tập hợp giá trị), nhưng chúng ta vẫn có thể tận dụng việc enum có thể được nhập,
và chọn một loại có thể mã hoá. Trong ví dụ này, chúng ta đã chọn String. Điều này có nghĩa là
tất cả các giá trị enum sẽ được liên kết đến/từ chuỗi khi được lưu trữ trong một
Cloud Firestore tài liệu.
Và vì Swift hỗ trợ các giá trị thô tuỳ chỉnh, nên chúng ta thậm chí có thể tuỳ chỉnh giá trị nào tham chiếu đến trường hợp enum nào. Ví dụ: nếu chúng ta quyết định lưu trữ trường hợp Status.inReview dưới dạng "đang xem xét", thì chúng ta chỉ cần cập nhật enum ở trên như sau:
enum Status: String, Codable {
case draft
case inReview = "in review"
case approved
case published
}
Tuỳ chỉnh việc liên kết
Đôi khi, tên thuộc tính của các tài liệu Cloud Firestore mà chúng ta muốn liên kết không khớp với tên của các thuộc tính trong mô hình dữ liệu của chúng ta trong Swift. Ví dụ: một trong những đồng nghiệp của chúng ta có thể là nhà phát triển Python và quyết định chọn snake_case cho tất cả tên thuộc tính của họ.
Đừng lo lắng: Codable sẽ giúp bạn!
Đối với những trường hợp như thế này, chúng ta có thể sử dụng CodingKeys. Đây là một enum mà chúng ta có thể thêm vào một cấu trúc có thể mã hoá để chỉ định cách liên kết một số thuộc tính.
Hãy xem xét tài liệu này:
Để liên kết tài liệu này với một cấu trúc có thuộc tính tên thuộc loại String, chúng ta cần thêm một enum CodingKeys vào cấu trúc ProgrammingLanguage và chỉ định tên của thuộc tính trong tài liệu:
struct ProgrammingLanguage: Codable {
@DocumentID var id: String?
var name: String
var year: Date
enum CodingKeys: String, CodingKey {
case id
case name = "language_name"
case year
}
}
Theo mặc định, API Codable sẽ sử dụng tên thuộc tính của các loại Swift để
xác định tên thuộc tính trên các tài liệu Cloud Firestore mà chúng ta đang cố gắng
liên kết. Vì vậy, miễn là tên thuộc tính khớp nhau, bạn không cần thêm CodingKeys vào các loại có thể mã hoá. Tuy nhiên, sau khi sử dụng CodingKeys cho một loại cụ thể, chúng ta cần thêm tất cả tên thuộc tính mà chúng ta muốn liên kết.
Trong đoạn mã ở trên, chúng ta đã xác định một thuộc tính id mà chúng ta có thể muốn sử dụng làm mã nhận dạng trong khung hiển thị List của SwiftUI. Nếu chúng ta không chỉ định thuộc tính này trong CodingKeys, thì thuộc tính này sẽ không được liên kết khi tìm nạp dữ liệu và do đó trở thành nil.
Điều này sẽ dẫn đến việc khung hiển thị List được điền bằng tài liệu đầu tiên.
Mọi thuộc tính không được liệt kê là một trường hợp trên enum CodingKeys tương ứng sẽ bị bỏ qua trong quá trình liên kết. Điều này thực sự có thể thuận tiện nếu chúng ta muốn loại trừ một số thuộc tính khỏi việc liên kết.
Ví dụ: nếu chúng ta muốn loại trừ thuộc tính reasonWhyILoveThis khỏi việc liên kết, thì tất cả những gì chúng ta cần làm là xoá thuộc tính đó khỏi enum CodingKeys:
struct ProgrammingLanguage: Identifiable, Codable {
@DocumentID var id: String?
var name: String
var year: Date
var reasonWhyILoveThis: String = ""
enum CodingKeys: String, CodingKey {
case id
case name = "language_name"
case year
}
}
Đôi khi, chúng ta có thể muốn ghi một thuộc tính trống trở lại tài liệu
Cloud Firestore. Swift có khái niệm về các giá trị không bắt buộc để biểu thị việc không có giá trị
và Cloud Firestore cũng hỗ trợ các giá trị null.
Tuy nhiên, hành vi mặc định để mã hoá các giá trị không bắt buộc có giá trị nil là chỉ bỏ qua chúng. @ExplicitNull cho phép chúng ta kiểm soát cách xử lý các giá trị không bắt buộc của Swift
khi mã hoá chúng: bằng cách gắn cờ một thuộc tính không bắt buộc là
@ExplicitNull, chúng ta có thể yêu cầu Cloud Firestore ghi thuộc tính này vào
tài liệu có giá trị null nếu thuộc tính này chứa giá trị nil.
Sử dụng bộ mã hoá và bộ giải mã tuỳ chỉnh để liên kết màu
Là chủ đề cuối cùng trong phạm vi đề cập đến việc liên kết dữ liệu bằng Codable, hãy giới thiệu bộ mã hoá và bộ giải mã tuỳ chỉnh. Phần này không đề cập đến loại dữ liệu gốc Cloud Firestore, nhưng bộ mã hoá và bộ giải mã tuỳ chỉnh rất hữu ích trong các ứng dụng Cloud Firestore của bạn.
"Làm cách nào để liên kết màu" là một trong những câu hỏi thường gặp nhất của nhà phát triển, không chỉ đối với Cloud Firestore mà còn đối với việc liên kết giữa Swift và JSON cũng vậy. Có rất nhiều giải pháp, nhưng hầu hết đều tập trung vào JSON và hầu hết đều liên kết màu dưới dạng một từ điển lồng nhau bao gồm các thành phần RGB.
Có vẻ như nên có một giải pháp tốt hơn và đơn giản hơn. Tại sao chúng ta không sử dụng màu web (hoặc cụ thể hơn là ký hiệu màu hex CSS) – chúng dễ sử dụng (về cơ bản chỉ là một chuỗi) và thậm chí còn hỗ trợ độ trong suốt!
Để có thể liên kết một Color Swift với giá trị hex của nó, chúng ta cần tạo một tiện ích Swift thêm Codable vào Color.
extension Color {
init(hex: String) {
let rgba = hex.toRGBA()
self.init(.sRGB,
red: Double(rgba.r),
green: Double(rgba.g),
blue: Double(rgba.b),
opacity: Double(rgba.alpha))
}
//... (code for translating between hex and RGBA omitted for brevity)
}
extension Color: Codable {
public init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let hex = try container.decode(String.self)
self.init(hex: hex)
}
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode(toHex)
}
}
Bằng cách sử dụng decoder.singleValueContainer(), chúng ta có thể giải mã một String thành Color tương đương mà không cần lồng các thành phần RGBA. Ngoài ra, bạn có thể sử dụng các giá trị này trong giao diện người dùng web của ứng dụng mà không cần chuyển đổi trước!
Với điều này, chúng ta có thể cập nhật mã để liên kết thẻ, giúp bạn dễ dàng xử lý trực tiếp màu thẻ thay vì phải liên kết chúng theo cách thủ công trong mã giao diện người dùng của ứng dụng:
struct Tag: Codable, Hashable {
var title: String
var color: Color
}
struct BookWithTags: Codable {
@DocumentID var id: String?
var title: String
var numberOfPages: Int
var author: String
var tags: [Tag]
}
Xử lý lỗi
Trong các đoạn mã ở trên, chúng ta cố ý giữ quy trình xử lý lỗi ở mức tối thiểu, nhưng trong một ứng dụng chính thức, bạn nên đảm bảo xử lý mọi lỗi một cách thích hợp.
Dưới đây là đoạn mã cho thấy cách sử dụng để xử lý mọi tình huống lỗi mà bạn có thể gặp phải:
class MappingSimpleTypesViewModel: ObservableObject {
@Published var book: Book = .empty
@Published var errorMessage: String?
private var db = Firestore.firestore()
func fetchAndMap() {
fetchBook(documentId: "hitchhiker")
}
func fetchAndMapNonExisting() {
fetchBook(documentId: "does-not-exist")
}
func fetchAndTryMappingInvalidData() {
fetchBook(documentId: "invalid-data")
}
private func fetchBook(documentId: String) {
let docRef = db.collection("books").document(documentId)
docRef.getDocument(as: Book.self) { result in
switch result {
case .success(let book):
// A Book value was successfully initialized from the DocumentSnapshot.
self.book = book
self.errorMessage = nil
case .failure(let error):
// A Book value could not be initialized from the DocumentSnapshot.
switch error {
case DecodingError.typeMismatch(_, let context):
self.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.valueNotFound(_, let context):
self.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.keyNotFound(_, let context):
self.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.dataCorrupted(let key):
self.errorMessage = "\(error.localizedDescription): \(key)"
default:
self.errorMessage = "Error decoding document: \(error.localizedDescription)"
}
}
}
}
}
Xử lý lỗi trong các bản cập nhật trực tiếp
Đoạn mã trước minh hoạ cách xử lý lỗi khi tìm nạp một tài liệu. Ngoài việc tìm nạp dữ liệu một lần, Cloud Firestore cũng hỗ trợ cung cấp các bản cập nhật cho ứng dụng của bạn khi chúng xảy ra, bằng cách sử dụng cái gọi là trình nghe ảnh chụp nhanh: chúng ta có thể đăng ký một trình nghe ảnh chụp nhanh trên một bộ sưu tập (hoặc truy vấn) và Cloud Firestore sẽ gọi trình nghe của chúng ta bất cứ khi nào có bản cập nhật.
Dưới đây là đoạn mã cho thấy cách đăng ký trình nghe ảnh chụp nhanh, liên kết dữ liệu bằng Codable và xử lý mọi lỗi có thể xảy ra. Đoạn mã này cũng cho thấy cách thêm một tài liệu mới vào bộ sưu tập. Như bạn sẽ thấy, không cần tự cập nhật mảng cục bộ chứa các tài liệu được liên kết, vì mã trong trình nghe ảnh chụp nhanh sẽ xử lý việc này.
class MappingColorsViewModel: ObservableObject {
@Published var colorEntries = [ColorEntry]()
@Published var newColor = ColorEntry.empty
@Published var errorMessage: String?
private var db = Firestore.firestore()
private var listenerRegistration: ListenerRegistration?
public func unsubscribe() {
if listenerRegistration != nil {
listenerRegistration?.remove()
listenerRegistration = nil
}
}
func subscribe() {
if listenerRegistration == nil {
listenerRegistration = db.collection("colors")
.addSnapshotListener { [weak self] (querySnapshot, error) in
guard let documents = querySnapshot?.documents else {
self?.errorMessage = "No documents in 'colors' collection"
return
}
self?.colorEntries = documents.compactMap { queryDocumentSnapshot in
let result = Result { try queryDocumentSnapshot.data(as: ColorEntry.self) }
switch result {
case .success(let colorEntry):
if let colorEntry = colorEntry {
// A ColorEntry value was successfully initialized from the DocumentSnapshot.
self?.errorMessage = nil
return colorEntry
}
else {
// A nil value was successfully initialized from the DocumentSnapshot,
// or the DocumentSnapshot was nil.
self?.errorMessage = "Document doesn't exist."
return nil
}
case .failure(let error):
// A ColorEntry value could not be initialized from the DocumentSnapshot.
switch error {
case DecodingError.typeMismatch(_, let context):
self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.valueNotFound(_, let context):
self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.keyNotFound(_, let context):
self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
case DecodingError.dataCorrupted(let key):
self?.errorMessage = "\(error.localizedDescription): \(key)"
default:
self?.errorMessage = "Error decoding document: \(error.localizedDescription)"
}
return nil
}
}
}
}
}
func addColorEntry() {
let collectionRef = db.collection("colors")
do {
let newDocReference = try collectionRef.addDocument(from: newColor)
print("ColorEntry stored with new document reference: \(newDocReference)")
}
catch {
print(error)
}
}
}
Tất cả các đoạn mã được sử dụng trong bài đăng này đều là một phần của ứng dụng mẫu mà bạn có thể tải xuống từ kho lưu trữ GitHub này.
Hãy sử dụng Codable!
API Codable của Swift cung cấp một cách mạnh mẽ và linh hoạt để liên kết dữ liệu từ các định dạng được tuần tự hoá đến và từ mô hình dữ liệu của ứng dụng. Trong hướng dẫn này, bạn đã thấy cách dễ dàng sử dụng API này trong các ứng dụng sử dụng Cloud Firestore làm kho lưu trữ dữ liệu.
Bắt đầu từ một ví dụ cơ bản với các loại dữ liệu đơn giản, chúng ta dần tăng độ phức tạp của mô hình dữ liệu, đồng thời có thể dựa vào việc triển khai Codable và Firebase để thực hiện việc liên kết cho chúng ta.
Để biết thêm chi tiết về Codable, tôi khuyên bạn nên tham khảo các tài nguyên sau:
- John Sundell có một bài viết hay về Các kiến thức cơ bản về Codable.
- Nếu bạn thích sách hơn, hãy xem Hướng dẫn về Trường học bay của Mattt's về Codable của Swift.
- Và cuối cùng, Donny Wals có một loạt bài viết về Codable.
Mặc dù chúng tôi đã cố gắng hết sức để biên soạn một hướng dẫn toàn diện về việc liên kết Cloud Firestore tài liệu, nhưng hướng dẫn này chưa đầy đủ và bạn có thể đang sử dụng các chiến lược khác để liên kết các loại của mình. Hãy cho chúng tôi biết những chiến lược bạn sử dụng để liên kết các loại dữ liệu khác hoặc biểu thị dữ liệu trong Swift bằng cách sử dụng nút Gửi ý kiến phản hồi bên dưới. Cloud Firestore
Thực sự không có lý do gì để không sử dụng tính năng hỗ trợ Codable của Cloud Firestore.