Giới thiệu về API Cơ sở dữ liệu quản trị

Với Admin SDK, bạn có thể đọc và ghi dữ liệu Realtime Database với toàn bộ đặc quyền quản trị hoặc với các đặc quyền hạn chế chi tiết hơn. Trong tài liệu này, chúng tôi sẽ hướng dẫn bạn cách thêm Firebase Admin SDK vào dự án để truy cập vào Firebase Realtime Database.

Thiết lập Admin SDK

Để bắt đầu sử dụng Cơ sở dữ liệu theo thời gian thực của Firebase trên máy chủ, trước tiên, bạn cần thiết lập Firebase Admin SDK bằng ngôn ngữ mà bạn chọn.

Xác thực SDK dành cho quản trị viên

Trước khi có thể truy cập vào Firebase Realtime Database từ một máy chủ bằng Firebase Admin SDK, bạn phải xác thực máy chủ của mình bằng Firebase. Khi xác thực một máy chủ, thay vì đăng nhập bằng thông tin đăng nhập của tài khoản người dùng như trong ứng dụng khách, bạn sẽ xác thực bằng một tài khoản dịch vụ. Tài khoản này sẽ xác định máy chủ của bạn với Firebase.

Bạn có thể nhận được 2 cấp truy cập khi xác thực bằng Firebase Admin SDK:

Các cấp truy cập xác thực của Firebase Admin SDK
Đặc quyền của quản trị viên Có toàn quyền đọc và ghi vào Realtime Database của một dự án. Sử dụng một cách thận trọng để hoàn thành các tác vụ quản trị, chẳng hạn như di chuyển dữ liệu hoặc tái cấu trúc dữ liệu. Các tác vụ này yêu cầu quyền truy cập không hạn chế vào tài nguyên của dự án.
Quyền hạn bị hạn chế Quyền truy cập vào Realtime Database của một dự án, chỉ giới hạn ở những tài nguyên mà máy chủ của bạn cần. Sử dụng cấp này để hoàn tất các tác vụ quản trị có yêu cầu truy cập được xác định rõ. Ví dụ: khi chạy một tác vụ tóm tắt đọc dữ liệu trên toàn bộ cơ sở dữ liệu, bạn có thể ngăn chặn các thao tác ghi nhầm bằng cách thiết lập một quy tắc bảo mật chỉ đọc, sau đó khởi động Admin SDK với các đặc quyền bị giới hạn theo quy tắc đó.

Xác thực bằng đặc quyền quản trị

Khi bạn khởi chạy Firebase Admin SDK bằng thông tin đăng nhập cho một tài khoản dịch vụ có vai trò Người chỉnh sửa trong dự án Firebase, phiên bản đó sẽ có quyền đọc và ghi đầy đủ vào Realtime Database của dự án.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json");

// Initialize the app with a service account, granting admin privileges
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .build();
FirebaseApp.initializeApp(options);

// As an admin, the app has access to read and write all data, regardless of Security Rules
DatabaseReference ref = FirebaseDatabase.getInstance()
    .getReference("restricted_access/secret_document");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    Object document = dataSnapshot.getValue();
    System.out.println(document);
  }

  @Override
  public void onCancelled(DatabaseError error) {
  }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a service account, granting admin privileges
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com"
});

// As an admin, the app has access to read and write all data, regardless of Security Rules
var db = admin.database();
var ref = db.ref("restricted_access/secret_document");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a service account, granting admin privileges
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com'
})

# As an admin, the app has access to read and write all data, regradless of Security Rules
ref = db.reference('restricted_access/secret_document')
print(ref.get())
Tìm
ctx := context.Background()
conf := &firebase.Config{
	DatabaseURL: "https://databaseName.firebaseio.com",
}
// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

// Initialize the app with a service account, granting admin privileges
app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// As an admin, the app has access to read and write all data, regradless of Security Rules
ref := client.NewRef("restricted_access/secret_document")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

Xác thực với đặc quyền hạn chế

Theo phương pháp hay nhất, một dịch vụ chỉ nên có quyền truy cập vào những tài nguyên mà dịch vụ đó cần. Để kiểm soát chi tiết hơn các tài nguyên mà một bản sao ứng dụng Firebase có thể truy cập, hãy sử dụng một mã nhận dạng duy nhất trong Quy tắc bảo mật để biểu thị dịch vụ của bạn. Sau đó, hãy thiết lập các quy tắc phù hợp để cấp cho dịch vụ của bạn quyền truy cập vào những tài nguyên mà dịch vụ đó cần. Ví dụ: 

{
  "rules": {
    "public_resource": {
      ".read": true,
      ".write": true
    },
    "some_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": false
    },
    "another_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": "auth.uid === 'my-service-worker'"
    }
  }
}

Sau đó, trên máy chủ, khi bạn khởi tạo ứng dụng Firebase, hãy sử dụng tuỳ chọn databaseAuthVariableOverride để ghi đè đối tượng auth mà các quy tắc cơ sở dữ liệu của bạn sử dụng. Trong đối tượng auth tuỳ chỉnh này, hãy đặt trường uid thành giá trị nhận dạng mà bạn đã dùng để biểu thị dịch vụ của mình trong Quy tắc bảo mật.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

// Initialize the app with a custom auth variable, limiting the server's access
Map<String, Object> auth = new HashMap<String, Object>();
auth.put("uid", "my-service-worker");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(auth)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/some_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a custom auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: {
    uid: "my-service-worker"
  }
});

// The app only has access as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/some_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a custom auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': {
        'uid': 'my-service-worker'
    }
})

# The app only has access as defined in the Security Rules
ref = db.reference('/some_resource')
print(ref.get())
Tìm
ctx := context.Background()
// Initialize the app with a custom auth variable, limiting the server's access
ao := map[string]interface{}{"uid": "my-service-worker"}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &ao,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

Trong một số trường hợp, bạn có thể muốn giảm phạm vi của Admin SDK để hoạt động như một ứng dụng khách chưa được xác thực. Bạn có thể thực hiện việc này bằng cách cung cấp giá trị null cho chế độ ghi đè biến xác thực cơ sở dữ liệu.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(null)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access to public data as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/public_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a null auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: null
});

// The app only has access to public data as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/public_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a None auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': None
})

# The app only has access to public data as defined in the Security Rules
ref = db.reference('/public_resource')
print(ref.get())
Tìm
ctx := context.Background()
// Initialize the app with a nil auth variable, limiting the server's access
var nilMap map[string]interface{}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &nilMap,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access to public data as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

Các bước tiếp theo