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

Với SDK dành cho quản trị viên, bạn có thể đọc và ghi dữ liệu Cơ sở dữ liệu theo thời gian thực bằng toàn bộ đặc quyền của quản trị viên hoặc với các đặc quyền giới hạn ở mức 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 SDK Quản trị Firebase vào dự án để truy cập vào Firebase Realtime Database.

Thiết lập SDK dành cho quản trị viên

Để bắt đầu sử dụng Cơ sở dữ liệu theo thời gian thực Firebase trên máy chủ, trước tiên, bạn cần thiết lập SDK quản trị Firebase 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 SDK Quản trị Firebase, bạn phải xác thực máy chủ của mình bằng Firebase. Khi xác thực 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 tài khoản dịch vụ giúp xác định máy chủ của bạn với Firebase.

Bạn có thể có hai cấp truy cập khác nhau khi xác thực bằng SDK Quản trị viên Firebase:

Cấp truy cập xác thực SDK của Firebase dành cho quản trị viên
Đặc quyền quản trị Hoàn tất quyền đọc và ghi vào Realtime Database của một dự án. Hãy sử dụng với sự thận trọng để hoàn thành các tác vụ quản trị như di chuyển dữ liệu hoặc tái cấu trúc, các tác vụ này yêu cầu quyền truy cập không bị hạn chế vào tài nguyên của dự án.
Hạn chế đặc quyền Quyền truy cập vào Realtime Database của dự án, chỉ giới hạn ở các tài nguyên mà máy chủ của bạn cần. Sử dụng cấp này để hoàn thành các nhiệm vụ quản trị có yêu cầu truy cập được xác định rõ ràng. Ví dụ: khi chạy một công việc tóm tắt đọc dữ liệu trên toàn bộ cơ sở dữ liệu, bạn có thể bảo vệ khỏi việc ghi do nhầm lẫn bằng cách đặt quy tắc bảo mật chỉ có thể đọc, sau đó khởi chạy SDK Quản trị 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 SDK Quản trị Firebase bằng thông tin xác thực cho một tài khoản dịch vụ có vai trò Người chỉnh sửa trên dự án Firebase, thực thể đó 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())
Tiến hành
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ế

Tốt nhất là một dịch vụ chỉ có quyền truy cập vào các tài nguyên mà dịch vụ đó cần. Để có được quyền kiểm soát chi tiết hơn đối với các tài nguyên mà một thực thể ứng dụng Firebase có thể truy cập, hãy sử dụng một giá trị nhận dạng duy nhất trong Quy tắc bảo mật để đại diện cho dịch vụ của bạn. Sau đó, hãy thiết lập các quy tắc thích hợp để cấp cho dịch vụ quyền truy cập vào các 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ủ của bạn, khi khởi chạy ứng dụng Firebase, hãy 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())
Tiến hành
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 thu hẹp phạm vi của SDK quản trị để đóng vai trò là ứng dụng 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 cơ 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())
Tiến hành
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