Admin SDK là một bộ 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ư:
- Thực hiện truy vấn và đột biến trên dịch vụ Firebase Data Connect để quản lý dữ liệu hàng loạt và các thao tác khác bằng đặc quyền quản trị viên đầy đủ.
- Đọc và ghi dữ liệu Realtime Database bằng toàn bộ đặc quyền quản trị.
- Gửi thông báo Firebase Cloud Messaging theo phương thức lập trình bằng cách sử dụng một phương pháp thay thế đơn giản cho giao thức máy chủ Firebase Cloud Messaging.
- 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 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 đơn giản của riêng bạn để thực hiện các thao tá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 sử dụng SDK Node.js làm ứng dụng khách để người dùng cuối truy cập (ví dụ: trong ứng dụng IoT hoặc máy tính để bàn Node.js), thay vì quyền truy cập quản trị từ một môi trường đặc quyền (chẳng hạ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 các tính năng Firebase được hỗ trợ trong từng ngôn ngữ:
Để tìm hiểu thêm về việc tích hợp Admin SDK cho các mục đích sử dụng này, hãy xem tài liệu tương ứng về Realtime Database, FCM, Authentication, Remote Config và Cloud Storage. Phần còn lại của trang này tập trung vào việc thiết lập cơ bản cho Admin SDK.
Điều kiện tiên quyết
Đảm bảo rằng bạn có ứng dụng máy chủ.
Đảm bảo rằng máy chủ của bạn chạy những nội dung sau tuỳ thuộc vào Admin SDK mà bạn sử dụng:
- SDK Node.js dành cho quản trị viên — Node.js phiên bản 18 trở lên
- SDK Java dành cho quản trị viên — Java 8 trở lên
- SDK Python dành cho quản trị viên — Python 3.7 trở lên (nên dùng Python 3.8 trở lên)
Không còn hỗ trợ Python 3.7. - SDK Go dành cho quản trị viên — Go 1.21 trở lên
- SDK .NET dành cho quản trị viên — .NET Framework 4.6.2 trở lên hoặc .NET Standard 2.0 cho .NET 6.0 trở lên
Thiết lập dự án Firebase và tài khoản dịch vụ
Để sử dụng Firebase Admin SDK, bạn cần có những thông tin sau:
- Một dự án Firebase.
- Tài khoản dịch vụ SDK Quản trị 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 có thông tin xác thực của tài khoản dịch vụ.
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 Firebase. Truy cập vào bài viết Tìm hiểu về dự án Firebase để tìm hiểu thêm về 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 Firebase Admin Node.js có trên npm. Nếu bạn chưa có tệp package.json, hãy tạo tệp đó thông 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 dành cho quản trị viên 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 đó làm phần phụ thuộc trong tệp build.gradle:
dependencies {
implementation 'com.google.firebase:firebase-admin:9.4.1'
}
Nếu sử dụng Maven để tạo ứng dụng, bạn có thể thêm phần phụ thuộc sau vào pom.xml:
<dependency>
<groupId>com.google.firebase</groupId>
<artifactId>firebase-admin</artifactId>
<version>9.4.1</version>
</dependency>
Python
Bạn có thể sử dụng SDK Firebase dành cho quản trị viên bằng Python 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 Admin SDK 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/v4@4.15.0
C#
Bạn có thể cài đặt Admin SDK .NET bằng trình quản lý gói .NET:
Install-Package FirebaseAdmin -Version 3.1.0
Ngoài ra, bạn có thể cài đặt bằng tiện ích dòng lệnh dotnet:
dotnet add package FirebaseAdmin --version 3.1.0
Ngoài ra, bạn có thể cài đặt gói này bằng cách thêm mục tham chiếu gói sau vào tệp .csproj:
<ItemGroup>
<PackageReference Include="FirebaseAdmin" Version="3.1.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 Google. Vì việc tra cứu thông tin xác thực mặc định được tự động hoá hoàn toàn trong các môi trường của Google, nên bạn không cần cung cấp biến môi trường hoặc cấu hình khác. Do đó, 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 các môi trường của Google như Cloud Run, App Engine và Cloud Functions.
Để chỉ định tuỳ ý các tuỳ chọn khởi chạy cho các dịch vụ như Realtime Database, 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 Admin SDK để thực hiện các loại tác vụ sau:
- Triển khai quy trình xác thực tuỳ chỉnh
- Quản lý người dùng Firebase Authentication
- Thực hiện các truy vấn và đột biến quản trị trên dịch vụ Firebase Data Connect.
- Đọc và ghi dữ liệu từ Realtime Database
- Gửi thông báo Firebase Cloud Messaging
Sử dụng mã thông báo làm mới OAuth 2.0
Admin SDK cũng cung cấp thông tin xác thực cho phép bạn xác thực bằng mã thông báo 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 môi trường không phải của Google
Nếu đang làm việc trong môi trường máy chủ không phải của Google, trong đó không thể tự động hoá hoàn toàn việc tra cứu thông tin xác thực mặc định, 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 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 thông qua tài khoản dịch vụ này để uỷ quyền cho các yêu cầu máy chủ.
Để xác thực tài khoản dịch vụ và uỷ quyền cho 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 Firebase, hãy mở Settings (Cài đặt) > Service Accounts (Tài khoản dịch vụ).
Nhấp vào Tạo khoá riêng tư mới, rồi xác nhận bằng cách nhấp vào Tạo khoá.
Lưu trữ an toàn tệp JSON chứa khoá.
Khi uỷ quyền thông qua tài khoản dịch vụ, bạn có hai lựa chọn để cung cấp thông tin xác thực cho ứng dụng của mình. Bạn có thể đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS hoặc truyền rõ ràng đường dẫn đến khoá tài khoản dịch vụ trong mã. Bạn nên chọn phương thức đầu tiên vì phương thức này an toàn hơn.
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ụ. 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ể xác định ngầm 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 môi trường không phải của Google.
Khởi chạy SDK như sau:
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 các trường hợp, bạn chỉ cần khởi chạy một ứng dụng mặc định. Bạn có thể truy cập các dịch vụ từ ứ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 một lúc. Ví dụ: bạn có thể muốn đọc dữ liệu từ Realtime Database 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 hai ứng dụng bằng thông tin xác thực riêng biệt. SDK Firebase 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 Realtime Database và Authentication
Nếu bạn đang sử dụng máy ảo Google Compute Engine có Thông tin xác thực mặc định của ứng dụng Google cho Realtime Database hoặc Authentication, hãy nhớ đặt đúng phạm vi truy cập.
Đối với Realtime Database và Authentication, bạn cần có cá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 phạm vi truy cập hiện có, hãy chạy các lệnh sau bằng gcloud.
gcloud
# 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 gcloud
Khi kiểm thử Admin SDK cục bộ bằng Thông tin xác thực mặc định của ứng dụng Google thu đượ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 Firebase Authentication do những lý do sau:
- Firebase Authentication không chấp nhận thông tin đăng nhập của người dùng cuối gcloud được tạo bằng mã ứng dụng khách OAuth gcloud.
- Firebase Authentication yêu cầu cung cấp mã dự án khi khởi chạy cho các loại thông tin xác thực 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 Google trong gcloud bằng mã ứng dụng OAuth 2.0 của riêng bạn. Mã ứng dụng khách OAuth phải là loại ứng dụng Ứng dụng dành cho máy tính.
gcloud
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. Cách sau giúp bạn không cần thực hiện thêm bất kỳ thay đổi nào để 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á các ứng dụng Firebase mẫu.
Khám phá mã nguồn mở trong GitHub cho Node.js, Java và Python.
Đọc các bài đăng trên blog liên quan đến Admin SDK của một trong những nhà sáng tạo Admin SDK. Ví dụ: Truy cập 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 phần phụ trợ không máy chủ bằng Cloud Functions.
- Lưu trữ thông tin bằng Realtime Database hoặc dữ liệu blob bằng Cloud Storage.
- Nhận thông báo bằng Cloud Messaging.