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

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 căn cứ hỏa lực Realtime trên máy chủ của bạn, trước tiên bạn sẽ cần phải thiết lập các căn cứ hỏa lực SDK quản trị trong ngôn ngữ của bạn lựa 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 nhận một máy chủ, chứ không phải là đăng nhập với thông tin tài khoản người dùng của như bạn sẽ ở một ứng dụng client, bạn xác thực với một tài khoản dịch vụ trong đó xác định máy chủ của bạn để căn cứ hỏa lực.

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. Sử dụng thận trọng để 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 của 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ó cá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 tạo căn cứ hỏa lực SDK quản trị với các chứng chỉ cho một tài khoản dịch vụ với vai trò biên tập viên cho dự án căn cứ hỏa lực của bạn, ví dụ có hoàn đọc và truy cập 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))
    .setDatabaseUrl("https://databaseName.firebaseio.com")
    // Or other region, e.g. <databaseName>.europe-west1.firebasedatabase.app
    .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),
  databaseURL: "https://databaseName.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ó được kiểm soát hạt mịn hơn so với các nguồn tài nguyên một căn cứ hỏa lực dụ ứng dụng có thể truy cập, sử dụng một định danh duy nhất ở bạn Security Rules để đạ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 tạo ứng dụng căn cứ hỏa lực, sử dụng databaseAuthVariableOverride tùy chọn ghi đè auth đối tượng được sử dụng bởi các quy định cơ sở dữ liệu của bạn. Trong phong tục này auth đối tượng, thiết lập các uid trường để nhận dạng bạn sử dụng để đại diện cho dịch vụ của bạn trong Quy định bảo mật của bạn.

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))
    .setDatabaseUrl("https://databaseName.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),
  databaseURL: "https://databaseName.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 giảm bớt 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ể làm điều này bằng cách cung cấp một giá trị null cho biến override cơ sở dữ liệu auth.
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))
    .setDatabaseUrl("https://databaseName.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),
  databaseURL: "https://databaseName.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