SDK quản trị là một tập hợp các thư viện máy chủ cho phép bạn tương tác với Firebase từ các môi trường đặc quyền để thực hiện các thao tác như:
- Đọc và ghi dữ liệu Cơ sở dữ liệu theo thời gian thực với toàn bộ đặc quyền của quản trị viên.
- Gửi thông báo qua Giải pháp gửi thông báo qua đám mây của Firebase theo phương thức lập trình bằng một phương pháp đơn giản, thay thế cho các giao thức máy chủ Giải pháp gửi thông báo qua đám mây của Firebase.
- Tạo và xác minh mã thông báo xác thực Firebase.
- Truy cập vào các tài nguyên của Google Cloud như bộ chứa Cloud Storage và cơ sở dữ liệu Cloud Firestore được liên kết với các dự án Firebase của bạn.
- Tạo bảng điều khiển dành cho quản trị viên được đơn giản hoá của riêng bạn để làm những việc như tra cứu dữ liệu người dùng hoặc thay đổi địa chỉ email của người dùng để xác thực.
Nếu muốn dùng SDK Node.js làm ứng dụng để truy cập của người dùng cuối (ví dụ: trong ứng dụng IoT hoặc máy tính Node.js), thay vì quyền truy cập quản trị từ một môi trường đặc quyền (như máy chủ), bạn nên làm theo hướng dẫn thiết lập SDK JavaScript của ứng dụng khách.
Dưới đây là ma trận tính năng cho biết những tính năng nào của Firebase được hỗ trợ trong từng ngôn ngữ:
Để tìm hiểu thêm về việc tích hợp SDK dành cho quản trị viên cho những mục đích sử dụng này, hãy xem tài liệu tương ứng về Cơ sở dữ liệu theo thời gian thực, FCM, Xác thực, Cấu hình từ xa và Cloud Storage. Phần còn lại của trang này tập trung vào quy trình thiết lập cơ bản cho SDK dành cho quản trị viên.
Điều kiện tiên quyết
Đảm bảo rằng bạn có một ứng dụng máy chủ.
Đảm bảo rằng máy chủ của bạn chạy nội dung sau đây tuỳ thuộc vào SDK quản trị mà bạn sử dụng:
- SDK Node.js dành cho quản trị viên – Node.js 14 trở lên (nên dùng Node.js 18+)
Chúng tôi không còn hỗ trợ Node.js 14 và 16 nữa. - SDK Java dành cho quản trị viên — Java 8 trở lên
- SDK dành cho quản trị viên — Python 3.7 trở lên (nên dùng Python 3.8+)
Chúng tôi không còn hỗ trợ Python 3.7. - SDK dành cho quản trị viên Go — Phiên bản 1.20 trở lên
- SDK .NET dành cho quản trị viên — .NET Framework 4.6.2+ hoặc .NET Standard 2.0 cho .NET 6.0+
- SDK Node.js dành cho quản trị viên – Node.js 14 trở lên (nên dùng Node.js 18+)
Thiết lập dự án và tài khoản dịch vụ Firebase
Để sử dụng SDK quản trị của Firebase, bạn cần có:
- Một dự án Firebase.
- Tài khoản dịch vụ SDK quản trị của Firebase để giao tiếp với Firebase. Tài khoản dịch vụ này được tạo tự động khi bạn tạo dự án Firebase hoặc thêm Firebase vào dự án Google Cloud.
- Tệp cấu hình chứa thông tin xác thực của tài khoản dịch vụ của bạn.
Nếu chưa có dự án Firebase, bạn cần tạo một dự án trong bảng điều khiển của Firebase. Hãy xem bài viết Tìm hiểu về các dự án Firebase để tìm hiểu thêm về các dự án Firebase.
Thêm SDK
Nếu đang thiết lập một dự án mới, bạn cần cài đặt SDK cho ngôn ngữ mà bạn chọn.
Node.js
SDK Node.js dành cho quản trị viên của Firebase có sẵn trên npm. Nếu bạn chưa có tệp package.json
, hãy tạo một tệp qua npm init
. Tiếp theo, hãy cài đặt gói npm firebase-admin
và lưu gói đó vào package.json
:
npm install firebase-admin --save
Để sử dụng mô-đun trong ứng dụng, hãy require
mô-đun từ bất kỳ tệp JavaScript nào:
const { initializeApp } = require('firebase-admin/app');
Nếu đang sử dụng ES2015, bạn có thể import
mô-đun:
import { initializeApp } from 'firebase-admin/app';
Java
SDK Java quản trị của Firebase đã được phát hành lên kho lưu trữ trung tâm Maven.
Để cài đặt thư viện, hãy khai báo thư viện đó dưới dạng một phần phụ thuộc trong tệp build.gradle
:
dependencies {
implementation 'com.google.firebase:firebase-admin:9.3.0'
}
Nếu sử dụng Maven để xây dựng ứng dụng, bạn có thể thêm phần phụ thuộc sau đây vào pom.xml
:
<dependency>
<groupId>com.google.firebase</groupId>
<artifactId>firebase-admin</artifactId>
<version>9.3.0</version>
</dependency>
Python
Firebase Admin Python SDK có sẵn thông qua pip.
Bạn có thể cài đặt thư viện cho tất cả người dùng thông qua sudo
:
sudo pip install firebase-admin
Hoặc bạn có thể chỉ cài đặt thư viện cho người dùng hiện tại bằng cách truyền cờ --user
:
pip install --user firebase-admin
Tiến hành
Bạn có thể cài đặt SDK dành cho quản trị viên Go bằng tiện ích go get
:
# Install the latest version:
go get firebase.google.com/go/v4@latest
# Or install a specific version:
go get firebase.google.com/go/[email protected]
C#
Bạn có thể cài đặt SDK quản trị .NET bằng trình quản lý gói .NET:
Install-Package FirebaseAdmin -Version 3.0.0
Ngoài ra, hãy cài đặt tiện ích này bằng tiện ích dòng lệnh dotnet
:
dotnet add package FirebaseAdmin --version 3.0.0
Bạn cũng có thể cài đặt bằng cách thêm mục nhập tham chiếu gói sau đây vào tệp .csproj
:
<ItemGroup>
<PackageReference Include="FirebaseAdmin" Version="3.0.0" />
</ItemGroup>
Khởi chạy SDK
Sau khi tạo dự án Firebase, bạn có thể khởi chạy SDK bằng Thông tin xác thực mặc định của ứng dụng trên Google. Vì hoạt động tra cứu thông tin xác thực mặc định được thực hiện hoàn toàn tự động trong các môi trường của Google, không cần cung cấp biến môi trường hoặc cấu hình khác, nên bạn nên sử dụng cách khởi chạy SDK này cho các ứng dụng chạy trong môi trường của Google như Cloud Run, App Engine và Cloud Functions.
Để tuỳ ý chỉ định các tuỳ chọn khởi chạy cho các dịch vụ như Cơ sở dữ liệu theo thời gian thực, Cloud Storage hoặc Cloud Functions, hãy sử dụng biến môi trường FIREBASE_CONFIG
. Nếu nội dung của biến FIREBASE_CONFIG
bắt đầu bằng {
, thì nội dung đó sẽ được phân tích cú pháp dưới dạng đối tượng JSON. Nếu không, SDK sẽ giả định rằng chuỗi là đường dẫn của tệp JSON chứa các tuỳ chọn.
Node.js
const app = initializeApp();
Java
FirebaseApp.initializeApp();
Python
default_app = firebase_admin.initialize_app()
Tiến hành
app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
C#
FirebaseApp.Create();
Sau khi khởi chạy, bạn có thể sử dụng SDK dành cho quản trị viên để thực hiện các loại thao tác sau:
- Triển khai phương thức xác thực tuỳ chỉnh
- Quản lý người dùng Xác thực Firebase
- Đọc và ghi dữ liệu từ Cơ sở dữ liệu theo thời gian thực
- Gửi tin nhắn qua Giải pháp gửi thông báo qua đám mây của Firebase
Sử dụng mã làm mới OAuth 2.0
SDK dành cho quản trị viên cũng cung cấp thông tin đăng nhập cho phép bạn xác thực bằng mã làm mới Google OAuth2:
Node.js
const myRefreshToken = '...'; // Get refresh token from OAuth2 flow
initializeApp({
credential: refreshToken(myRefreshToken),
databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});
Java
FileInputStream refreshToken = new FileInputStream("path/to/refreshToken.json");
FirebaseOptions options = FirebaseOptions.builder()
.setCredentials(GoogleCredentials.fromStream(refreshToken))
.setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
.build();
FirebaseApp.initializeApp(options);
Python
cred = credentials.RefreshToken('path/to/refreshToken.json')
default_app = firebase_admin.initialize_app(cred)
Tiến hành
opt := option.WithCredentialsFile("path/to/refreshToken.json")
config := &firebase.Config{ProjectID: "my-project-id"}
app, err := firebase.NewApp(context.Background(), config, opt)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.FromFile("path/to/refreshToken.json"),
});
Khởi chạy SDK trong các môi trường không phải của Google
Nếu đang làm việc trong một môi trường máy chủ không phải của Google mà trong đó việc tra cứu thông tin xác thực mặc định không thể hoàn toàn tự động, thì bạn có thể khởi chạy SDK bằng tệp khoá tài khoản dịch vụ đã xuất.
Các dự án Firebase hỗ trợ tài khoản dịch vụ của Google. Bạn có thể sử dụng các tài khoản này để gọi API máy chủ Firebase từ máy chủ ứng dụng hoặc môi trường đáng tin cậy. Nếu đang phát triển mã cục bộ hoặc triển khai ứng dụng tại chỗ, bạn có thể sử dụng thông tin xác thực thu được qua tài khoản dịch vụ này để cho phép các yêu cầu máy chủ.
Để xác thực một tài khoản dịch vụ và cho phép tài khoản đó truy cập vào các dịch vụ của Firebase, bạn phải tạo một tệp khoá riêng tư ở định dạng JSON.
Cách tạo tệp khoá riêng tư cho tài khoản dịch vụ:
Trong bảng điều khiển của Firebase, hãy mở phần Cài đặt > Tài khoản dịch vụ.
Nhấp vào Generate New Private Key (Tạo khoá riêng tư mới), sau đó xác nhận bằng cách nhấp vào Generate key (Tạo khoá).
Lưu trữ an toàn tệp JSON chứa khoá.
Khi uỷ quyền qua một tài khoản dịch vụ, bạn có 2 lựa chọn để cung cấp thông tin đăng nhập cho ứng dụng của mình. Bạn có thể đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS hoặc có thể chuyển đường dẫn đến khoá tài khoản dịch vụ trong mã một cách rõ ràng. Lựa chọn đầu tiên an toàn hơn và được khuyên dùng.
Cách đặt biến môi trường:
Đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS thành đường dẫn tệp của tệp JSON chứa khoá tài khoản dịch vụ của bạn. Biến này chỉ áp dụng cho phiên shell hiện tại, vì vậy, nếu bạn mở một phiên mới, hãy đặt lại biến đó.
Linux hoặc macOS
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
Windows
Với PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
Sau khi bạn hoàn tất các bước trên, Thông tin xác thực mặc định của ứng dụng (ADC) có thể ngầm xác định thông tin xác thực của bạn, cho phép bạn sử dụng thông tin xác thực tài khoản dịch vụ khi kiểm thử hoặc chạy trong các môi trường không phải của Google.
Khởi động SDK như minh hoạ:
Node.js
initializeApp({
credential: applicationDefault(),
databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});
Java
FirebaseOptions options = FirebaseOptions.builder()
.setCredentials(GoogleCredentials.getApplicationDefault())
.setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
.build();
FirebaseApp.initializeApp(options);
Python
default_app = firebase_admin.initialize_app()
Tiến hành
app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
ProjectId = "my-project-id",
});
Khởi chạy nhiều ứng dụng
Trong hầu hết trường hợp, bạn chỉ phải khởi chạy một ứng dụng mặc định. Bạn có thể truy cập vào các dịch vụ trong ứng dụng đó theo hai cách tương đương:
Node.js
// Initialize the default app
const defaultApp = initializeApp(defaultAppConfig);
console.log(defaultApp.name); // '[DEFAULT]'
// Retrieve services via the defaultApp variable...
let defaultAuth = getAuth(defaultApp);
let defaultDatabase = getDatabase(defaultApp);
// ... or use the equivalent shorthand notation
defaultAuth = getAuth();
defaultDatabase = getDatabase();
Java
// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);
System.out.println(defaultApp.getName()); // "[DEFAULT]"
// Retrieve services by passing the defaultApp variable...
FirebaseAuth defaultAuth = FirebaseAuth.getInstance(defaultApp);
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance(defaultApp);
// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.getInstance();
defaultDatabase = FirebaseDatabase.getInstance();
Python
# Import the Firebase service
from firebase_admin import auth
# Initialize the default app
default_app = firebase_admin.initialize_app(cred)
print(default_app.name) # "[DEFAULT]"
# Retrieve services via the auth package...
# auth.create_custom_token(...)
Tiến hành
// Initialize default app
app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
// Access auth service from the default app
client, err := app.Auth(context.Background())
if err != nil {
log.Fatalf("error getting Auth client: %v\n", err)
}
C#
// Initialize the default app
var defaultApp = FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
});
Console.WriteLine(defaultApp.Name); // "[DEFAULT]"
// Retrieve services by passing the defaultApp variable...
var defaultAuth = FirebaseAuth.GetAuth(defaultApp);
// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.DefaultInstance;
Một số trường hợp sử dụng yêu cầu bạn tạo nhiều ứng dụng cùng lúc. Ví dụ: bạn có thể muốn đọc dữ liệu từ Cơ sở dữ liệu theo thời gian thực của một dự án Firebase và tạo mã thông báo tuỳ chỉnh cho một dự án khác. Hoặc bạn có thể muốn xác thực 2 ứng dụng bằng thông tin xác thực riêng biệt. Firebase SDK cho phép bạn tạo nhiều ứng dụng cùng một lúc, mỗi ứng dụng có thông tin cấu hình riêng.
Node.js
// Initialize the default app
initializeApp(defaultAppConfig);
// Initialize another app with a different config
var otherApp = initializeApp(otherAppConfig, 'other');
console.log(getApp().name); // '[DEFAULT]'
console.log(otherApp.name); // 'other'
// Use the shorthand notation to retrieve the default app's services
const defaultAuth = getAuth();
const defaultDatabase = getDatabase();
// Use the otherApp variable to retrieve the other app's services
const otherAuth = getAuth(otherApp);
const otherDatabase = getDatabase(otherApp);
Java
// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);
// Initialize another app with a different config
FirebaseApp otherApp = FirebaseApp.initializeApp(otherAppConfig, "other");
System.out.println(defaultApp.getName()); // "[DEFAULT]"
System.out.println(otherApp.getName()); // "other"
// Use the shorthand notation to retrieve the default app's services
FirebaseAuth defaultAuth = FirebaseAuth.getInstance();
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance();
// Use the otherApp variable to retrieve the other app's services
FirebaseAuth otherAuth = FirebaseAuth.getInstance(otherApp);
FirebaseDatabase otherDatabase = FirebaseDatabase.getInstance(otherApp);
Python
# Initialize the default app
default_app = firebase_admin.initialize_app(cred)
# Initialize another app with a different config
other_app = firebase_admin.initialize_app(cred, name='other')
print(default_app.name) # "[DEFAULT]"
print(other_app.name) # "other"
# Retrieve default services via the auth package...
# auth.create_custom_token(...)
# Use the `app` argument to retrieve the other app's services
# auth.create_custom_token(..., app=other_app)
Tiến hành
// Initialize the default app
defaultApp, err := firebase.NewApp(context.Background(), nil)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
// Initialize another app with a different config
opt := option.WithCredentialsFile("service-account-other.json")
otherApp, err := firebase.NewApp(context.Background(), nil, opt)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
// Access Auth service from default app
defaultClient, err := defaultApp.Auth(context.Background())
if err != nil {
log.Fatalf("error getting Auth client: %v\n", err)
}
// Access auth service from other app
otherClient, err := otherApp.Auth(context.Background())
if err != nil {
log.Fatalf("error getting Auth client: %v\n", err)
}
C#
// Initialize the default app
var defaultApp = FirebaseApp.Create(defaultOptions);
// Initialize another app with a different config
var otherApp = FirebaseApp.Create(otherAppConfig, "other");
Console.WriteLine(defaultApp.Name); // "[DEFAULT]"
Console.WriteLine(otherApp.Name); // "other"
// Use the shorthand notation to retrieve the default app's services
var defaultAuth = FirebaseAuth.DefaultInstance;
// Use the otherApp variable to retrieve the other app's services
var otherAuth = FirebaseAuth.GetAuth(otherApp);
Đặt phạm vi cho Cơ sở dữ liệu theo thời gian thực và Xác thực
Nếu bạn đang dùng máy ảo Google Compute Engine có Thông tin xác thực mặc định của ứng dụng trên Google cho Cơ sở dữ liệu theo thời gian thực hoặc quy trình xác thực, hãy nhớ thiết lập phạm vi truy cập phù hợp.
Đối với Cơ sở dữ liệu theo thời gian thực và tính năng Xác thực, bạn cần có phạm vi kết thúc bằng userinfo.email
và cloud-platform
hoặc firebase.database
. Để kiểm tra và thay đổi các phạm vi truy cập hiện có, hãy chạy các lệnh sau bằng gcloud.
Google Cloud
# Check the existing access scopes
gcloud compute instances describe [INSTANCE_NAME] --format json
# The above command returns the service account information. For example:
"serviceAccounts": [
{
"email": "your.gserviceaccount.com",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/userinfo.email"
]
}
],
# Stop the VM, then run the following command, using the service account
# that gcloud returned when you checked the scopes.
gcloud compute instances set-service-account [INSTANCE_NAME] --service-account "your.gserviceaccount.com" --scopes "https://www.googleapis.com/auth/firebase.database,https://www.googleapis.com/auth/userinfo.email"
Kiểm thử bằng thông tin đăng nhập của người dùng cuối trên gcloud
Khi kiểm thử cục bộ SDK dành cho quản trị viên bằng Thông tin xác thực mặc định của ứng dụng trên Google có được bằng cách chạy gcloud auth application-default login
, bạn cần thực hiện thêm một số thay đổi để sử dụng tính năng Xác thực Firebase do những điều sau:
- Tính năng xác thực Firebase không chấp nhận thông tin xác thực của người dùng cuối gcloud được tạo bằng mã ứng dụng khách gcloud OAuth.
- Tính năng Xác thực Firebase yêu cầu cung cấp mã dự án khi khởi chạy cho loại thông tin đăng nhập của người dùng cuối này.
Để khắc phục, bạn có thể tạo Thông tin xác thực mặc định của ứng dụng trên Google trong gcloud bằng ID ứng dụng khách OAuth 2.0 của riêng mình. Mã ứng dụng OAuth phải là một loại ứng dụng Ứng dụng dành cho máy tính.
Google Cloud
gcloud auth application-default login --client-id-file=[/path/to/client/id/file]
Bạn có thể chỉ định rõ mã dự án khi khởi chạy ứng dụng hoặc chỉ sử dụng biến môi trường GOOGLE_CLOUD_PROJECT
. Mục sau giúp tránh việc thực hiện bất kỳ thay đổi nào khác để kiểm thử mã.
Cách chỉ định rõ mã dự án:
Node.js
import { initializeApp, applicationDefault } from 'firebase-admin/app';
initializeApp({
credential: applicationDefault(),
projectId: '<FIREBASE_PROJECT_ID>',
});
Java
FirebaseOptions options = FirebaseOptions.builder()
.setCredentials(GoogleCredentials.getApplicationDefault())
.setProjectId("<FIREBASE_PROJECT_ID>")
.build();
FirebaseApp.initializeApp(options);
Python
app_options = {'projectId': '<FIREBASE_PROJECT_ID>'}
default_app = firebase_admin.initialize_app(options=app_options)
Tiến hành
config := &firebase.Config{ProjectID: "<FIREBASE_PROJECT_ID>"}
app, err := firebase.NewApp(context.Background(), config)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
ProjectId = "<FIREBASE_PROJECT_ID>",
});
Các bước tiếp theo
Tìm hiểu về Firebase:
Khám phá ứng dụng Firebase mẫu.
Khám phá mã nguồn mở trong GitHub cho Node.js, Java và Python.
Hãy đọc các bài đăng trên blog liên quan đến SDK dành cho quản trị viên của một trong những người tạo ra SDK dành cho quản trị viên. Ví dụ: Truy cập vào Firestore và Firebase thông qua máy chủ proxy.
Thêm các tính năng của Firebase vào ứng dụng:
- Viết một phần phụ trợ không máy chủ bằng Cloud Functions.
- Lưu trữ thông tin bằng Cơ sở dữ liệu theo thời gian thực hoặc dữ liệu của blob bằng Cloud Storage.
- Nhận thông báo bằng ứng dụng Nhắn tin qua đám mây.