1. Khái quát chung
Bàn thắng
Trong phòng thí nghiệm lập trình này, bạn sẽ xây dựng một ứng dụng đề xuất nhà hàng trên Android được hỗ trợ bởi Cloud Firestore. Bạn sẽ học cách:
- Đọc và ghi dữ liệu vào Firestore từ ứng dụng Android
- Lắng nghe những thay đổi trong dữ liệu Firestore trong thời gian thực
- Sử dụng các quy tắc bảo mật và Xác thực Firebase để bảo mật dữ liệu Firestore
- Viết các truy vấn Firestore phức tạp
điều kiện tiên quyết
Trước khi bắt đầu codelab này, hãy chắc chắn rằng bạn có:
- Android Studio Flamingo hoặc mới hơn
- Trình giả lập Android có API 19 trở lên
- Node.js phiên bản 16 trở lên
- Phiên bản Java 17 trở lên
2. Tạo dự án Firebase
- Đăng nhập vào bảng điều khiển Firebase bằng tài khoản Google của bạn.
- Trong bảng điều khiển Firebase , nhấp vào Thêm dự án .
- Như minh họa trong ảnh chụp màn hình bên dưới, hãy nhập tên cho dự án Firebase của bạn (ví dụ: "Món ăn thân thiện") và nhấp vào Tiếp tục .
- Bạn có thể được yêu cầu bật Google Analytics, vì mục đích của phòng thí nghiệm lập trình này, lựa chọn của bạn không thành vấn đề.
- Sau khoảng một phút, dự án Firebase của bạn sẽ sẵn sàng. Nhấp vào Tiếp tục .
3. Thiết lập dự án mẫu
Tải xuống mã
Chạy lệnh sau để sao chép mã mẫu cho phòng thí nghiệm mã này. Thao tác này sẽ tạo một thư mục có tên friendlyeats-android trên máy của bạn:
$ git clone https://github.com/firebase/friendlyeats-android
Nếu bạn không có git trên máy của mình, bạn cũng có thể tải xuống mã trực tiếp từ GitHub.
Thêm cấu hình Firebase
- Trong bảng điều khiển Firebase , chọn Tổng quan về dự án ở điều hướng bên trái. Nhấp vào nút Android để chọn nền tảng. Khi được nhắc nhập tên gói, hãy sử dụng
com.google.firebase.example.fireeats
- Nhấp vào Đăng ký ứng dụng và làm theo hướng dẫn để tải xuống tệp
google-services.jsonvà di chuyển tệp đó vào thư mụcapp/của mã bạn vừa tải xuống. Sau đó nhấp vào Tiếp theo .
Nhập dự án
Mở AndroidStudio. Nhấp vào Tệp > Mới > Nhập dự án và chọn thư mục friendlyeats-android .
4. Thiết lập Trình giả lập Firebase
Trong lớp học lập trình này, bạn sẽ sử dụng Bộ trình giả lập Firebase để mô phỏng cục bộ Cloud Firestore và các dịch vụ Firebase khác. Điều này cung cấp một môi trường phát triển cục bộ an toàn, nhanh chóng và miễn phí để xây dựng ứng dụng của bạn.
Cài đặt Firebase CLI
Trước tiên, bạn sẽ cần cài đặt Firebase CLI . Nếu đang sử dụng macOS hoặc Linux, bạn có thể chạy lệnh cURL sau:
curl -sL https://firebase.tools | bash
Nếu bạn đang sử dụng Windows, hãy đọc hướng dẫn cài đặt để nhận tệp nhị phân độc lập hoặc cài đặt qua npm .
Khi bạn đã cài đặt CLI, việc chạy firebase --version sẽ báo cáo phiên bản 9.0.0 trở lên:
$ firebase --version 9.0.0
Đăng nhập
Chạy firebase login để kết nối CLI với tài khoản Google của bạn. Điều này sẽ mở ra một cửa sổ trình duyệt mới để hoàn tất quá trình đăng nhập. Đảm bảo chọn cùng một tài khoản mà bạn đã sử dụng khi tạo dự án Firebase trước đó.
Liên kết dự án của bạn
Từ bên trong thư mục friendlyeats-android , hãy chạy firebase use --add để kết nối dự án cục bộ của bạn với dự án Firebase của bạn. Làm theo lời nhắc để chọn dự án bạn đã tạo trước đó và nếu được yêu cầu chọn bí danh, hãy nhập default .
5. Chạy ứng dụng
Bây giờ là lúc chạy Bộ giả lập Firebase và ứng dụng Android FriendlyEats lần đầu tiên.
Chạy trình giả lập
Trong thiết bị đầu cuối của bạn, từ trong thư mục friendlyeats-android hãy chạy firebase emulators:start để khởi động Trình giả lập Firebase. Bạn sẽ thấy các bản ghi như thế này:
$ firebase emulators:start i emulators: Starting emulators: auth, firestore i firestore: Firestore Emulator logging to firestore-debug.log i ui: Emulator UI logging to ui-debug.log ┌─────────────────────────────────────────────────────────────┐ │ ✔ All emulators ready! It is now safe to connect your app. │ │ i View Emulator UI at http://localhost:4000 │ └─────────────────────────────────────────────────────────────┘ ┌────────────────┬────────────────┬─────────────────────────────────┐ │ Emulator │ Host:Port │ View in Emulator UI │ ├────────────────┼────────────────┼─────────────────────────────────┤ │ Authentication │ localhost:9099 │ http://localhost:4000/auth │ ├────────────────┼────────────────┼─────────────────────────────────┤ │ Firestore │ localhost:8080 │ http://localhost:4000/firestore │ └────────────────┴────────────────┴─────────────────────────────────┘ Emulator Hub running at localhost:4400 Other reserved ports: 4500 Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.
Bây giờ bạn đã có một môi trường phát triển cục bộ hoàn chỉnh đang chạy trên máy của mình! Đảm bảo để lệnh này chạy trong phần còn lại của phòng thí nghiệm mã, ứng dụng Android của bạn sẽ cần kết nối với trình giả lập.
Kết nối ứng dụng với Trình giả lập
Mở các tệp util/FirestoreInitializer.kt và util/AuthInitializer.kt trong Android Studio. Các tệp này chứa logic để kết nối SDK Firebase với trình giả lập cục bộ đang chạy trên máy của bạn khi khởi động ứng dụng.
Trên phương thức create() của lớp FirestoreInitializer , hãy kiểm tra đoạn mã này:
// Use emulators only in debug builds
if (BuildConfig.DEBUG) {
firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
}
Chúng tôi đang sử dụng BuildConfig để đảm bảo rằng chúng tôi chỉ kết nối với trình giả lập khi ứng dụng của chúng tôi đang chạy ở chế độ debug . Khi chúng tôi biên dịch ứng dụng ở chế độ release , điều kiện này sẽ sai.
Chúng ta có thể thấy rằng nó đang sử dụng phương thức useEmulator(host, port) để kết nối SDK Firebase với trình giả lập Firestore cục bộ. Trong suốt ứng dụng, chúng tôi sẽ sử dụng FirebaseUtil.getFirestore() để truy cập phiên bản FirebaseFirestore này, vì vậy chúng tôi đảm bảo rằng chúng tôi luôn kết nối với trình giả lập Firestore khi chạy ở chế độ debug .
Chạy ứng dụng
Nếu bạn đã thêm tệp google-services.json đúng cách, dự án sẽ được biên dịch ngay bây giờ. Trong Android Studio, nhấp vào Build > Rebuild Project và đảm bảo rằng không còn lỗi nào.
Trong Android Studio Chạy ứng dụng trên trình giả lập Android của bạn. Lúc đầu, bạn sẽ thấy màn hình "Đăng nhập". Bạn có thể sử dụng bất kỳ email và mật khẩu nào để đăng nhập vào ứng dụng. Quá trình đăng nhập này đang kết nối với trình giả lập Xác thực Firebase nên không có thông tin đăng nhập thực nào được truyền đi.
Bây giờ hãy mở Giao diện người dùng Trình giả lập bằng cách điều hướng đến http://localhost:4000 trong trình duyệt web của bạn. Sau đó nhấp vào tab Xác thực và bạn sẽ thấy tài khoản bạn vừa tạo:
Khi bạn đã hoàn tất quá trình đăng nhập, bạn sẽ thấy màn hình chính của ứng dụng:
Chúng tôi sẽ sớm thêm một số dữ liệu để điền vào màn hình chính.
6. Ghi dữ liệu vào Firestore
Trong phần này, chúng tôi sẽ ghi một số dữ liệu vào Firestore để chúng tôi có thể điền vào màn hình chính hiện đang trống.
Đối tượng mô hình chính trong ứng dụng của chúng ta là một nhà hàng (xem model/Restaurant.kt ). Dữ liệu Firestore được chia thành các tài liệu, bộ sưu tập và bộ sưu tập con. Chúng tôi sẽ lưu trữ từng nhà hàng dưới dạng tài liệu trong bộ sưu tập cấp cao nhất có tên là "restaurants" . Để tìm hiểu thêm về mô hình dữ liệu Firestore, hãy đọc về tài liệu và bộ sưu tập trong tài liệu .
Đối với mục đích trình diễn, chúng tôi sẽ thêm chức năng trong ứng dụng để tạo mười nhà hàng ngẫu nhiên khi chúng tôi nhấp vào nút "Thêm mục ngẫu nhiên" trong menu mục bổ sung. Mở tệp MainFragment.kt và thay thế nội dung trong phương thức onAddItemsClicked() bằng:
private fun onAddItemsClicked() {
val restaurantsRef = firestore.collection("restaurants")
for (i in 0..9) {
// Create random restaurant / ratings
val randomRestaurant = RestaurantUtil.getRandom(requireContext())
// Add restaurant
restaurantsRef.add(randomRestaurant)
}
}
Có một vài điều quan trọng cần lưu ý về đoạn mã trên:
- Chúng tôi bắt đầu bằng cách tham khảo bộ sưu tập
"restaurants". Bộ sưu tập được tạo hoàn toàn khi tài liệu được thêm vào, vì vậy không cần phải tạo bộ sưu tập trước khi ghi dữ liệu. - Tài liệu có thể được tạo bằng các lớp dữ liệu Kotlin mà chúng tôi sử dụng để tạo từng tài liệu Nhà hàng.
- Phương thức
add()thêm tài liệu vào bộ sưu tập có ID được tạo tự động, vì vậy chúng tôi không cần chỉ định ID duy nhất cho mỗi Nhà hàng.
Bây giờ, hãy chạy lại ứng dụng và nhấp vào nút "Thêm mục ngẫu nhiên" trong menu mục bổ sung (ở góc trên cùng bên phải) để gọi mã bạn vừa viết:
Bây giờ hãy mở Giao diện người dùng Trình giả lập bằng cách điều hướng đến http://localhost:4000 trong trình duyệt web của bạn. Sau đó nhấp vào tab Firestore và bạn sẽ thấy dữ liệu bạn vừa thêm:
Dữ liệu này là 100% cục bộ cho máy của bạn. Trên thực tế, dự án thực của bạn thậm chí còn chưa chứa cơ sở dữ liệu Firestore! Điều này có nghĩa là an toàn khi thử nghiệm sửa đổi và xóa dữ liệu này mà không gây hậu quả.
Xin chúc mừng, bạn vừa ghi dữ liệu vào Firestore! Trong bước tiếp theo, chúng ta sẽ tìm hiểu cách hiển thị dữ liệu này trong ứng dụng.
7. Hiển thị dữ liệu từ Firestore
Trong bước này, chúng ta sẽ tìm hiểu cách truy xuất dữ liệu từ Firestore và hiển thị dữ liệu đó trong ứng dụng của mình. Bước đầu tiên để đọc dữ liệu từ Firestore là tạo Query . Mở tệp MainFragment.kt và thêm đoạn mã sau vào đầu phương thức onViewCreated() :
// Firestore
firestore = Firebase.firestore
// Get the 50 highest rated restaurants
query = firestore.collection("restaurants")
.orderBy("avgRating", Query.Direction.DESCENDING)
.limit(LIMIT.toLong())
Bây giờ chúng tôi muốn lắng nghe truy vấn để chúng tôi nhận được tất cả các tài liệu phù hợp và được thông báo về các bản cập nhật trong tương lai theo thời gian thực. Vì mục tiêu cuối cùng của chúng ta là liên kết dữ liệu này với một RecyclerView nên chúng ta cần tạo một lớp RecyclerView.Adapter để lắng nghe dữ liệu.
Mở lớp FirestoreAdapter , lớp này đã được triển khai một phần. Trước tiên, hãy làm cho bộ điều hợp triển khai EventListener và xác định hàm onEvent để nó có thể nhận các bản cập nhật cho truy vấn Firestore:
abstract class FirestoreAdapter<VH : RecyclerView.ViewHolder>(private var query: Query?) :
RecyclerView.Adapter<VH>(),
EventListener<QuerySnapshot> { // Add this implements
// ...
// Add this method
override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {
// Handle errors
if (e != null) {
Log.w(TAG, "onEvent:error", e)
return
}
// Dispatch the event
if (documentSnapshots != null) {
for (change in documentSnapshots.documentChanges) {
// snapshot of the changed document
when (change.type) {
DocumentChange.Type.ADDED -> {
// TODO: handle document added
}
DocumentChange.Type.MODIFIED -> {
// TODO: handle document changed
}
DocumentChange.Type.REMOVED -> {
// TODO: handle document removed
}
}
}
}
onDataChanged()
}
// ...
}
Khi tải lần đầu, người nghe sẽ nhận được một sự kiện ADDED cho mỗi tài liệu mới. Khi tập hợp kết quả của truy vấn thay đổi theo thời gian, người nghe sẽ nhận được nhiều sự kiện hơn có chứa các thay đổi. Bây giờ hãy hoàn thành việc triển khai trình nghe. Trước tiên, hãy thêm ba phương thức mới: onDocumentAdded , onDocumentModified và onDocumentRemoved :
private fun onDocumentAdded(change: DocumentChange) {
snapshots.add(change.newIndex, change.document)
notifyItemInserted(change.newIndex)
}
private fun onDocumentModified(change: DocumentChange) {
if (change.oldIndex == change.newIndex) {
// Item changed but remained in same position
snapshots[change.oldIndex] = change.document
notifyItemChanged(change.oldIndex)
} else {
// Item changed and changed position
snapshots.removeAt(change.oldIndex)
snapshots.add(change.newIndex, change.document)
notifyItemMoved(change.oldIndex, change.newIndex)
}
}
private fun onDocumentRemoved(change: DocumentChange) {
snapshots.removeAt(change.oldIndex)
notifyItemRemoved(change.oldIndex)
}
Sau đó gọi các phương thức mới này từ onEvent :
override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {
// Handle errors
if (e != null) {
Log.w(TAG, "onEvent:error", e)
return
}
// Dispatch the event
if (documentSnapshots != null) {
for (change in documentSnapshots.documentChanges) {
// snapshot of the changed document
when (change.type) {
DocumentChange.Type.ADDED -> {
onDocumentAdded(change) // Add this line
}
DocumentChange.Type.MODIFIED -> {
onDocumentModified(change) // Add this line
}
DocumentChange.Type.REMOVED -> {
onDocumentRemoved(change) // Add this line
}
}
}
}
onDataChanged()
}
Cuối cùng triển khai phương thức startListening() để đính kèm trình nghe:
fun startListening() {
if (registration == null) {
registration = query.addSnapshotListener(this)
}
}
Giờ đây, ứng dụng đã được định cấu hình đầy đủ để đọc dữ liệu từ Firestore. Chạy lại ứng dụng và bạn sẽ thấy các nhà hàng bạn đã thêm ở bước trước:
Bây giờ, hãy quay lại Giao diện người dùng giả lập trong trình duyệt của bạn và chỉnh sửa một trong các tên nhà hàng. Bạn sẽ thấy nó thay đổi trong ứng dụng gần như ngay lập tức!
8. Sắp xếp và lọc dữ liệu
Ứng dụng hiện đang hiển thị các nhà hàng được xếp hạng hàng đầu trong toàn bộ bộ sưu tập, nhưng trong một ứng dụng nhà hàng thực, người dùng sẽ muốn sắp xếp và lọc dữ liệu. Ví dụ: ứng dụng sẽ có thể hiển thị "Các nhà hàng hải sản hàng đầu ở Philadelphia" hoặc "Pizza rẻ nhất".
Nhấp vào thanh màu trắng ở đầu ứng dụng sẽ hiển thị hộp thoại bộ lọc. Trong phần này, chúng tôi sẽ sử dụng truy vấn Firestore để làm cho hộp thoại này hoạt động:
Hãy chỉnh sửa phương thức onFilter() của MainFragment.kt . Phương thức này chấp nhận một đối tượng Filters là đối tượng trợ giúp mà chúng tôi đã tạo để nắm bắt đầu ra của hộp thoại bộ lọc. Chúng tôi sẽ thay đổi phương thức này để tạo truy vấn từ các bộ lọc:
override fun onFilter(filters: Filters) {
// Construct query basic query
var query: Query = firestore.collection("restaurants")
// Category (equality filter)
if (filters.hasCategory()) {
query = query.whereEqualTo(Restaurant.FIELD_CATEGORY, filters.category)
}
// City (equality filter)
if (filters.hasCity()) {
query = query.whereEqualTo(Restaurant.FIELD_CITY, filters.city)
}
// Price (equality filter)
if (filters.hasPrice()) {
query = query.whereEqualTo(Restaurant.FIELD_PRICE, filters.price)
}
// Sort by (orderBy with direction)
if (filters.hasSortBy()) {
query = query.orderBy(filters.sortBy.toString(), filters.sortDirection)
}
// Limit items
query = query.limit(LIMIT.toLong())
// Update the query
adapter.setQuery(query)
// Set header
binding.textCurrentSearch.text = HtmlCompat.fromHtml(
filters.getSearchDescription(requireContext()),
HtmlCompat.FROM_HTML_MODE_LEGACY
)
binding.textCurrentSortBy.text = filters.getOrderDescription(requireContext())
// Save filters
viewModel.filters = filters
}
Trong đoạn mã trên, chúng tôi xây dựng một đối tượng Query bằng cách đính kèm các mệnh đề where và orderBy để khớp với các bộ lọc đã cho.
Chạy lại ứng dụng và chọn bộ lọc sau để hiển thị các nhà hàng giá rẻ phổ biến nhất:
Bây giờ bạn sẽ thấy một danh sách các nhà hàng được lọc chỉ chứa các tùy chọn giá thấp:
Nếu bạn đã làm được đến đây, thì giờ đây bạn đã xây dựng một ứng dụng xem đề xuất nhà hàng hoạt động đầy đủ trên Firestore! Bây giờ bạn có thể sắp xếp và lọc các nhà hàng trong thời gian thực. Trong một số phần tiếp theo, chúng tôi sẽ thêm đánh giá cho các nhà hàng và thêm các quy tắc bảo mật cho ứng dụng.
9. Tổ chức dữ liệu trong các bộ sưu tập con
Trong phần này, chúng tôi sẽ thêm xếp hạng vào ứng dụng để người dùng có thể đánh giá các nhà hàng yêu thích (hoặc ít được yêu thích nhất) của họ.
Bộ sưu tập và bộ sưu tập con
Cho đến nay, chúng tôi đã lưu trữ tất cả dữ liệu nhà hàng trong bộ sưu tập cấp cao nhất có tên là "nhà hàng". Khi người dùng xếp hạng một nhà hàng, chúng tôi muốn thêm một đối tượng Rating mới cho các nhà hàng. Đối với nhiệm vụ này, chúng tôi sẽ sử dụng một bộ sưu tập con. Bạn có thể nghĩ về một bộ sưu tập con như một bộ sưu tập được đính kèm vào một tài liệu. Vì vậy, mỗi tài liệu nhà hàng sẽ có một bộ sưu tập con xếp hạng đầy đủ các tài liệu xếp hạng. Các bộ sưu tập con giúp tổ chức dữ liệu mà không làm tài liệu của chúng tôi bị đầy hoặc yêu cầu các truy vấn phức tạp.
Để truy cập một bộ sưu tập con, hãy gọi .collection() trên tài liệu gốc:
val subRef = firestore.collection("restaurants")
.document("abc123")
.collection("ratings")
Bạn có thể truy cập và truy vấn một bộ sưu tập con giống như với bộ sưu tập cấp cao nhất, không có giới hạn kích thước hoặc thay đổi hiệu suất. Bạn có thể đọc thêm về mô hình dữ liệu Firestore tại đây .
Viết dữ liệu trong một giao dịch
Việc thêm Rating vào bộ sưu tập con thích hợp chỉ yêu cầu gọi .add() , nhưng chúng tôi cũng cần cập nhật xếp hạng trung bình của đối tượng Restaurant và số lượng xếp hạng để phản ánh dữ liệu mới. Nếu chúng tôi sử dụng các thao tác riêng biệt để thực hiện hai thay đổi này thì có một số điều kiện tương tranh có thể dẫn đến dữ liệu cũ hoặc không chính xác.
Để đảm bảo rằng xếp hạng được thêm đúng cách, chúng tôi sẽ sử dụng giao dịch để thêm xếp hạng cho nhà hàng. Giao dịch này sẽ thực hiện một số hành động:
- Đọc xếp hạng hiện tại của nhà hàng và tính toán xếp hạng mới
- Thêm xếp hạng vào bộ sưu tập con
- Cập nhật xếp hạng trung bình của nhà hàng và số lượng xếp hạng
Mở RestaurantDetailFragment.kt và triển khai chức năng addRating :
private fun addRating(restaurantRef: DocumentReference, rating: Rating): Task<Void> {
// Create reference for new rating, for use inside the transaction
val ratingRef = restaurantRef.collection("ratings").document()
// In a transaction, add the new rating and update the aggregate totals
return firestore.runTransaction { transaction ->
val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()
?: throw Exception("Restaurant not found at ${restaurantRef.path}")
// Compute new number of ratings
val newNumRatings = restaurant.numRatings + 1
// Compute new average rating
val oldRatingTotal = restaurant.avgRating * restaurant.numRatings
val newAvgRating = (oldRatingTotal + rating.rating) / newNumRatings
// Set new restaurant info
restaurant.numRatings = newNumRatings
restaurant.avgRating = newAvgRating
// Commit to Firestore
transaction.set(restaurantRef, restaurant)
transaction.set(ratingRef, rating)
null
}
}
Hàm addRating() trả về một Task đại diện cho toàn bộ giao dịch. Trong hàm onRating() các trình lắng nghe được thêm vào tác vụ để phản hồi kết quả của giao dịch.
Bây giờ Chạy lại ứng dụng và nhấp vào một trong các nhà hàng, thao tác này sẽ hiển thị màn hình chi tiết nhà hàng. Nhấp vào nút + để bắt đầu thêm đánh giá. Thêm đánh giá bằng cách chọn một số ngôi sao và nhập một số văn bản.
Nhấn Gửi sẽ bắt đầu giao dịch. Khi giao dịch hoàn tất, bạn sẽ thấy đánh giá của mình hiển thị bên dưới và cập nhật về số lượng đánh giá của nhà hàng:
Chúc mừng! Giờ đây, bạn đã có một ứng dụng đánh giá nhà hàng di động, địa phương, xã hội được xây dựng trên Cloud Firestore. Tôi nghe nói những ngày này rất phổ biến.
10. Bảo mật dữ liệu của bạn
Cho đến nay chúng tôi chưa xem xét tính bảo mật của ứng dụng này. Làm thế nào để chúng tôi biết rằng người dùng chỉ có thể đọc và ghi dữ liệu chính xác? Cơ sở dữ liệu Firestore được bảo mật bằng một tệp cấu hình có tên là Quy tắc bảo mật .
Mở tệp firestore.rules , bạn sẽ thấy như sau:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
//
// WARNING: These rules are insecure! We will replace them with
// more secure rules later in the codelab
//
allow read, write: if request.auth != null;
}
}
}
Hãy thay đổi các quy tắc này để ngăn chặn các thay đổi hoặc truy cập dữ liệu không mong muốn, hãy mở tệp firestore.rules và thay thế nội dung bằng nội dung sau:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Determine if the value of the field "key" is the same
// before and after the request.
function isUnchanged(key) {
return (key in resource.data)
&& (key in request.resource.data)
&& (resource.data[key] == request.resource.data[key]);
}
// Restaurants
match /restaurants/{restaurantId} {
// Any signed-in user can read
allow read: if request.auth != null;
// Any signed-in user can create
// WARNING: this rule is for demo purposes only!
allow create: if request.auth != null;
// Updates are allowed if no fields are added and name is unchanged
allow update: if request.auth != null
&& (request.resource.data.keys() == resource.data.keys())
&& isUnchanged("name");
// Deletes are not allowed.
// Note: this is the default, there is no need to explicitly state this.
allow delete: if false;
// Ratings
match /ratings/{ratingId} {
// Any signed-in user can read
allow read: if request.auth != null;
// Any signed-in user can create if their uid matches the document
allow create: if request.auth != null
&& request.resource.data.userId == request.auth.uid;
// Deletes and updates are not allowed (default)
allow update, delete: if false;
}
}
}
}
Các quy tắc này hạn chế quyền truy cập để đảm bảo rằng khách hàng chỉ thực hiện các thay đổi an toàn. Ví dụ: cập nhật tài liệu nhà hàng chỉ có thể thay đổi xếp hạng, không phải tên hoặc bất kỳ dữ liệu bất biến nào khác. Xếp hạng chỉ có thể được tạo nếu ID người dùng khớp với người dùng đã đăng nhập, điều này ngăn chặn giả mạo.
Để đọc thêm về Quy tắc bảo mật, hãy truy cập tài liệu .
11. Kết luận
Bây giờ bạn đã tạo một ứng dụng có đầy đủ tính năng trên Firestore. Bạn đã tìm hiểu về các tính năng quan trọng nhất của Firestore, bao gồm:
- Tài liệu và bộ sưu tập
- Đọc và ghi dữ liệu
- Sắp xếp và lọc với các truy vấn
- Bộ sưu tập con
- giao dịch
Tìm hiểu thêm
Để tiếp tục tìm hiểu về Firestore, đây là một số nơi tốt để bắt đầu:
Ứng dụng nhà hàng trong phòng thí nghiệm lập trình này dựa trên ứng dụng ví dụ "Món ăn thân thiện". Bạn có thể duyệt qua mã nguồn của ứng dụng đó tại đây .
Tùy chọn: Triển khai vào sản xuất
Cho đến nay, ứng dụng này chỉ sử dụng Bộ giả lập Firebase. Nếu bạn muốn tìm hiểu cách triển khai ứng dụng này cho dự án Firebase thực, hãy tiếp tục sang bước tiếp theo.
12. (Tùy chọn) Triển khai ứng dụng của bạn
Cho đến nay, ứng dụng này hoàn toàn là cục bộ, tất cả dữ liệu được chứa trong Bộ giả lập Firebase. Trong phần này, bạn sẽ tìm hiểu cách định cấu hình dự án Firebase của mình để ứng dụng này hoạt động trong sản xuất.
Xác thực căn cứ hỏa lực
Trong bảng điều khiển Firebase, hãy chuyển đến phần Xác thực và nhấp vào Bắt đầu . Điều hướng đến tab Phương thức đăng nhập và chọn tùy chọn Email/Mật khẩu từ Nhà cung cấp gốc .
Kích hoạt phương thức đăng nhập Email/Mật khẩu và nhấp vào Lưu .
lò sưởi
Tạo nên cơ sở dữ liệu
Điều hướng đến phần Cơ sở dữ liệu Firestore của bảng điều khiển và nhấp vào Tạo cơ sở dữ liệu :
- Khi được nhắc về Quy tắc bảo mật, hãy chọn bắt đầu trong Chế độ sản xuất , chúng tôi sẽ sớm cập nhật các quy tắc đó.
- Chọn vị trí cơ sở dữ liệu mà bạn muốn sử dụng cho ứng dụng của mình. Lưu ý rằng việc chọn một vị trí cơ sở dữ liệu là một quyết định vĩnh viễn và để thay đổi nó, bạn sẽ phải tạo một dự án mới. Để biết thêm thông tin về cách chọn vị trí dự án, hãy xem tài liệu .
Triển khai quy tắc
Để triển khai các Quy tắc bảo mật mà bạn đã viết trước đó, hãy chạy lệnh sau trong thư mục codelab:
$ firebase deploy --only firestore:rules
Thao tác này sẽ triển khai nội dung của firestore.rules cho dự án của bạn, bạn có thể xác nhận điều này bằng cách điều hướng đến tab Quy tắc trong bảng điều khiển.
Triển khai chỉ mục
Ứng dụng FriendlyEats có tính năng sắp xếp và lọc phức tạp, yêu cầu một số chỉ mục hỗn hợp tùy chỉnh. Chúng có thể được tạo thủ công trong bảng điều khiển Firebase nhưng sẽ đơn giản hơn nếu viết định nghĩa của chúng trong tệp firestore.indexes.json và triển khai chúng bằng Firebase CLI.
Nếu bạn mở tệp firestore.indexes.json , bạn sẽ thấy rằng các chỉ mục bắt buộc đã được cung cấp:
{
"indexes": [
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "city", "mode": "ASCENDING" },
{ "fieldPath": "avgRating", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "category", "mode": "ASCENDING" },
{ "fieldPath": "avgRating", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "price", "mode": "ASCENDING" },
{ "fieldPath": "avgRating", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "city", "mode": "ASCENDING" },
{ "fieldPath": "numRatings", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "category", "mode": "ASCENDING" },
{ "fieldPath": "numRatings", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "price", "mode": "ASCENDING" },
{ "fieldPath": "numRatings", "mode": "DESCENDING" }
]
},
{
"collectionId": "restaurants",
"queryScope": "COLLECTION",
"fields": [
{ "fieldPath": "city", "mode": "ASCENDING" },
{ "fieldPath": "price", "mode": "ASCENDING" }
]
},
{
"collectionId": "restaurants",
"fields": [
{ "fieldPath": "category", "mode": "ASCENDING" },
{ "fieldPath": "price", "mode": "ASCENDING" }
]
}
],
"fieldOverrides": []
}
Để triển khai các chỉ mục này, hãy chạy lệnh sau:
$ firebase deploy --only firestore:indexes
Lưu ý rằng việc tạo chỉ mục không diễn ra ngay lập tức, bạn có thể theo dõi tiến trình trong bảng điều khiển Firebase.
Định cấu hình ứng dụng
Trong các tệp util/FirestoreInitializer.kt và util/AuthInitializer.kt , chúng tôi đã định cấu hình SDK Firebase để kết nối với trình giả lập khi ở chế độ gỡ lỗi:
override fun create(context: Context): FirebaseFirestore {
val firestore = Firebase.firestore
// Use emulators only in debug builds
if (BuildConfig.DEBUG) {
firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
}
return firestore
}
Nếu muốn thử nghiệm ứng dụng của mình với dự án Firebase thực, bạn có thể:
- Xây dựng ứng dụng ở chế độ phát hành và chạy trên thiết bị.
- Tạm thời thay
BuildConfig.DEBUGbằngfalsevà chạy lại ứng dụng.
Lưu ý rằng bạn có thể cần phải Đăng xuất khỏi ứng dụng và đăng nhập lại để kết nối đúng cách với sản xuất.