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

Với SDK quản trị, bạn có thể đọc và ghi dữ liệu Cơ sở dữ liệu thời gian thực với đầy đủ các đặc quyền của quản trị viên hoặc với các đặc quyền giới hạn 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 của bạn để truy cập Cơ sở dữ liệu thời gian thực của Firebase.

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

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

Cấp độ truy cập xác thực SDK quản trị viên Firebase
Đặc quyền quản trị Hoàn thành quyền truy cập đọc và ghi vào Cơ sở dữ liệu thời gian thực của dự án. Thận trọng khi hoàn thành các tác vụ quản trị như di chuyển hoặc tái cấu trúc dữ liệu yêu cầu quyền truy cập không hạn chế vào tài nguyên dự án của bạn.
Đặc quyền hạn chế Quyền truy cập vào Cơ sở dữ liệu thời gian thực 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 tác vụ quản trị có yêu cầu truy cập được xác định rõ. Ví dụ: khi chạy 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 ngẫu nhiên bằng cách đặt quy tắc bảo mật chỉ đọc và sau đó khởi chạy SDK quản trị với các đặc quyền bị giới hạn bởi quy tắc đó.

Xác thực với các đặc quyền của quản trị viên

Khi bạn khởi chạy SDK quản trị Firebase bằng thông tin đăng nhập cho tài khoản dịch vụ có vai trò Người chỉnh sửa trên dự án Firebase của mình, phiên bản đó có toàn bộ quyền truy cập đọc và ghi vào Cơ sở dữ liệu thời gian thực của dự án của bạ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())
Đi
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ác đặc quyền hạn chế

Như một phương pháp hay nhất, một dịch vụ chỉ nên có quyền truy cập vào các tài nguyên mà nó cần. Để có thêm quyền kiểm soát chi tiết hơn đối với các tài nguyên mà phiên bản ứng dụng Firebase có thể truy cập, hãy sử dụng số 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 đó, thiết lập các quy tắc thích hợp cấp cho dịch vụ của bạn quyền truy cập vào các tài nguyên mà nó 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 bạn khởi chạy ứng dụng Firebase, hãy sử dụng tùy chọn databaseAuthVariableOverride để ghi đè đối tượng auth được các quy tắc cơ sở dữ liệu của bạn sử dụng. Trong đối tượng auth thực tùy chỉnh này, hãy đặt trường uid thành số nhận dạng mà bạn đã sử dụng để đại diện cho 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())
Đi
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 hạ cấp các SDK quản trị viên để 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 ghi đè biến auth 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())
Đi
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)

Bước tiếp theo