SDK ứng dụng Firebase Data Connect cho phép bạn gọi các truy vấn và biến đổi phía máy chủ trực tiếp từ ứng dụng Firebase. Bạn tạo một SDK ứng dụng tuỳ chỉnh song song khi thiết kế giản đồ, truy vấn và biến đổi mà bạn triển khai cho dịch vụ Data Connect. Sau đó, bạn tích hợp các phương thức từ SDK này vào logic ứng dụng.
Như đã đề cập ở nơi khác, điều quan trọng cần lưu ý là các truy vấn và đột biến Data Connect không được mã ứng dụng gửi và thực thi trên máy chủ. Thay vào đó, khi được triển khai, các thao tác Data Connect sẽ được lưu trữ trên máy chủ như Cloud Functions. Điều này có nghĩa là bạn cần triển khai các thay đổi tương ứng ở phía máy khách để tránh làm gián đoạn người dùng hiện tại (ví dụ: trên các phiên bản ứng dụng cũ).
Đó là lý do Data Connect cung cấp cho bạn môi trường và công cụ dành cho nhà phát triển giúp bạn tạo nguyên mẫu cho giản đồ, truy vấn và các đột biến do máy chủ triển khai. Nền tảng này cũng tự động tạo SDK phía máy khách trong khi bạn tạo nguyên mẫu.
Khi bạn lặp lại các bản cập nhật cho dịch vụ và ứng dụng khách, cả bản cập nhật phía máy chủ và phía ứng dụng khách đều sẵn sàng để triển khai.
Tạo SDK Kotlin
Giống như hầu hết các dự án Firebase, thao tác trên mã ứng dụng Firebase Data Connect diễn ra trong một thư mục dự án cục bộ. Cả tiện ích Data Connect VS Code và CLI Firebase đều là các công cụ cục bộ quan trọng để tạo và quản lý mã ứng dụng.
Các tuỳ chọn tạo SDK được liên kết với một số mục trong tệp dataconnect.yaml được tạo khi bạn khởi chạy dự án.
Khởi tạo quá trình tạo SDK
Trongconnector.yaml, hãy thêm outputDir, package và (đối với SDK web) packageJsonDir.
connectorId: movies
generate:
kotlinSdk:
outputDir: ../../../src/main/java/com/myapplication
package: com.myapplication
Thay thế outputDir bằng đường dẫn của thư mục chứa mã được tạo; đường dẫn này tương ứng với thư mục chứa chính tệp connector.yaml. Thay thế package bằng câu lệnh gói Kotlin để sử dụng trong các tệp được tạo hoặc bỏ qua package để sử dụng gói mặc định.
Cập nhật SDK trong khi tạo nguyên mẫu
Nếu bạn đang tạo bản minh hoạ tương tác bằng tiện ích Data Connect VS Code và trình mô phỏng Data Connect, thì các tệp nguồn SDK sẽ tự động được tạo và cập nhật trong khi bạn sửa đổi các tệp .gql xác định giản đồ, truy vấn và đột biến. Đây có thể là một tính năng hữu ích trong quy trình tải lại (nóng).
.gql và cũng tự động cập nhật các nguồn SDK.
Ngoài ra, bạn có thể sử dụng CLI để tạo lại SDK bất cứ khi nào tệp .gql thay đổi:
firebase dataconnect:sdk:generate --watchTạo SDK để tích hợp và phát hành chính thức
Trong một số trường hợp, chẳng hạn như chuẩn bị nguồn dự án để gửi cho các bài kiểm thử CI, bạn có thể gọi CLI Firebase để cập nhật hàng loạt.
Trong những trường hợp này, hãy sử dụng firebase dataconnect:sdk:generate.
Thiết lập mã ứng dụng
Tích hợp Data Connect vào mã ứng dụng khách
Để thiết lập mã ứng dụng để sử dụng Data Connect và SDK đã tạo, trước tiên, hãy làm theo hướng dẫn thiết lập Firebase tiêu chuẩn.
Sau đó, hãy thêm nội dung sau vào phần plugins trong app/build.gradle.kts:
// The Firebase team tests with version 1.8.22; however, other 1.8 versions,
// and all newer versions are expected work too.
kotlin("plugin.serialization") version "1.8.22" // MUST match the version of the Kotlin compiler
Sau đó, hãy thêm nội dung sau vào phần dependencies trong app/build.gradle.kts:
implementation("com.google.firebase:firebase-dataconnect:16.0.0-beta01")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.5.1")
implementation("com.google.firebase:firebase-auth:23.1.0") // Optional
implementation("com.google.firebase:firebase-appcheck:18.0.0") // Optional
Khởi chạy SDK Android Data Connect
Khởi chạy thực thể Data Connect bằng thông tin bạn đã sử dụng để thiết lập Data Connect (tất cả đều có trong thẻ Data Connect của bảng điều khiển Firebase).
Đối tượng ConnectorConfig
SDK yêu cầu một đối tượng cấu hình trình kết nối.
Đối tượng này được tạo tự động từ serviceId và location trong dataconnect.yaml và connectorId trong connector.yaml.
Lấy một thực thể trình kết nối
Giờ đây, bạn đã thiết lập một đối tượng cấu hình, hãy lấy một thực thể trình kết nối Data Connect. Mã cho trình kết nối của bạn sẽ do trình mô phỏng Data Connect tạo. Nếu tên trình kết nối là movies và gói Kotlin là com.myapplication, như được chỉ định trong connector.yaml, thì hãy truy xuất đối tượng trình kết nối bằng cách gọi:
val connector = com.myapplication.MoviesConnector.instance
Chạy truy vấn và thay đổi
Với đối tượng trình kết nối, bạn có thể chạy các truy vấn và đột biến như được xác định trong mã nguồn GraphQL. Giả sử trình kết nối của bạn đã xác định các hoạt động sau:
mutation createMovie($title: String!, $releaseYear: Int!, $genre: String!, $rating: Int!) {
movie_insert(data: {
title: $title
releaseYear: $releaseYear
genre: $genre
rating: $rating
})
}
query getMovieByKey($key: Movie_Key!) {
movie(key: $key) { id title }
}
query listMoviesByGenre($genre: String!) {
movies(where: {genre: {eq: $genre}}) {
id
title
}
}
thì bạn có thể tạo và truy xuất một bộ phim như sau:
val connector = MoviesConnector.instance
val addMovieResult1 = connector.createMovie.execute(
title = "Empire Strikes Back",
releaseYear = 1980,
genre = "Sci-Fi",
rating = 5
)
val movie1 = connector.getMovieByKey.execute(addMovieResult1.data.key)
println("Empire Strikes Back: ${movie1.data.movie}")
Bạn cũng có thể truy xuất nhiều phim:
val connector = MoviesConnector.instance
val addMovieResult2 = connector.createMovie.execute(
title="Attack of the Clones",
releaseYear = 2002,
genre = "Sci-Fi",
rating = 5
)
val listMoviesResult = connector.listMoviesByGenre.execute(genre = "Sci-Fi")
println(listMoviesResult.data.movies)
Bạn cũng có thể thu thập Flow chỉ tạo ra kết quả khi truy xuất kết quả truy vấn mới bằng cách gọi phương thức execute() của truy vấn.
val connector = MoviesConnector.instance
connector.listMoviesByGenre.flow(genre = "Sci-Fi").collect { data ->
println(data.movies)
}
connector.createMovie.execute(
title="A New Hope",
releaseYear = 1977,
genre = "Sci-Fi",
rating = 5
)
connector.listMoviesByGenre.execute(genre = "Sci-Fi") // will cause the Flow to get notified
Tạo nguyên mẫu và kiểm thử ứng dụng Android
Đo lường ứng dụng để sử dụng trình mô phỏng cục bộ
Bạn có thể sử dụng trình mô phỏng Data Connect, cho dù từ tiện ích Data Connect VS Code hay từ CLI.
Việc đo lường ứng dụng để kết nối với trình mô phỏng cũng giống nhau đối với cả hai trường hợp.
val connector = MoviesConnector.instance
// Connect to the emulator on "10.0.2.2:9399"
connector.dataConnect.useEmulator()
// (alternatively) if you're running your emulator on non-default port:
connector.dataConnect.useEmulator(port = 9999)
// Make calls from your app
Để chuyển sang tài nguyên chính thức, hãy chú thích các dòng để kết nối với trình mô phỏng.
Loại dữ liệu trong SDK Data Connect
Máy chủ Data Connect đại diện cho các loại dữ liệu GraphQL phổ biến và tuỳ chỉnh. Các giá trị này được biểu thị trong SDK như sau.
| Loại kết nối dữ liệu | Kotlin |
|---|---|
| Chuỗi | Chuỗi |
| Int | Int (32 bit) |
| Nổi | Double (số thực 64 bit) |
| Boolean | Boolean |
| mã nhận dạng duy nhất (UUID) | java.util.UUID |
| Ngày | java.util.Date |
| Dấu thời gian | com.google.firebase.Timestamp |
| Int64 | Dài |
| Bất kỳ | com.google.firebase.dataconnect.AnyValue |