บทนำสู่ฐานข้อมูลผู้ดูแลระบบ API

ด้วย Admin SDK คุณสามารถอ่านและเขียนข้อมูล Realtime Database ด้วยสิทธิ์ของผู้ดูแลระบบเต็มรูปแบบ หรือด้วยสิทธิ์แบบจำกัดที่ละเอียดยิ่งขึ้น ในเอกสารนี้ เราจะแนะนำคุณเกี่ยวกับการเพิ่ม Firebase Admin SDK ในโครงการของคุณเพื่อเข้าถึงฐานข้อมูลเรียลไทม์ของ Firebase

การติดตั้ง SDK ผู้ดูแลระบบ

การเริ่มต้นกับฐานข้อมูล Firebase เรียลไทม์บนเซิร์ฟเวอร์ของคุณคุณจะต้อง ตั้งค่า Firebase SDK ผู้ดูแลระบบ ในภาษาของคุณเลือก

การตรวจสอบสิทธิ์ SDK ผู้ดูแลระบบ

ก่อนที่คุณจะสามารถเข้าถึงฐานข้อมูลเรียลไทม์ของ Firebase จากเซิร์ฟเวอร์โดยใช้ Firebase Admin SDK คุณต้องตรวจสอบสิทธิ์เซิร์ฟเวอร์ของคุณด้วย Firebase เมื่อคุณรับรองความถูกต้องเซิร์ฟเวอร์มากกว่าเข้าสู่ระบบด้วยบัญชีผู้ใช้ข้อมูลประจำตัวของตามที่คุณต้องการใน app ลูกค้าคุณรับรองความถูกต้องมี บัญชีผู้ใช้บริการ ซึ่งระบุเซิร์ฟเวอร์ของคุณเพื่อ Firebase

คุณสามารถรับการเข้าถึงได้ 2 ระดับเมื่อคุณตรวจสอบสิทธิ์โดยใช้ Firebase Admin SDK:

ระดับการเข้าถึงการตรวจสอบสิทธิ์ของ Firebase Admin SDK
สิทธิพิเศษทางปกครอง สิทธิ์การเข้าถึงแบบอ่านและเขียนในฐานข้อมูลเรียลไทม์ของโปรเจ็กต์เสร็จสมบูรณ์ ใช้ด้วยความระมัดระวังเพื่อทำงานด้านการดูแลระบบ เช่น การย้ายข้อมูลหรือการปรับโครงสร้างใหม่ที่ต้องการการเข้าถึงทรัพยากรของโครงการของคุณอย่างไม่จำกัด
สิทธิพิเศษจำกัด เข้าถึงฐานข้อมูลเรียลไทม์ของโปรเจ็กต์ โดยจำกัดเฉพาะทรัพยากรที่เซิร์ฟเวอร์ของคุณต้องการ ใช้ระดับนี้เพื่อทำงานการดูแลระบบที่มีข้อกำหนดการเข้าถึงที่กำหนดไว้อย่างดี ตัวอย่างเช่น เมื่อเรียกใช้งานสรุปที่อ่านข้อมูลทั่วทั้งฐานข้อมูล คุณสามารถป้องกันการเขียนโดยไม่ได้ตั้งใจโดยการตั้งค่ากฎความปลอดภัยแบบอ่านอย่างเดียว แล้วเริ่มต้น Admin SDK ด้วยสิทธิ์ที่จำกัดโดยกฎนั้น

ตรวจสอบสิทธิ์ด้วยสิทธิ์ของผู้ดูแลระบบ

เมื่อคุณเริ่มต้น Firebase SDK ผู้ดูแลระบบที่มีข้อมูลประจำตัวสำหรับบัญชีผู้ใช้บริการที่มีบทบาทแก้ไขในโครงการ Firebase ของอินสแตนซ์ที่มีการอ่านที่สมบูรณ์และการเขียนการเข้าถึงโครงการของคุณ Realtime ฐานข้อมูล

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())
ไป
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)

ตรวจสอบสิทธิ์ด้วยสิทธิพิเศษที่จำกัด

ตามแนวทางปฏิบัติที่ดีที่สุด บริการควรมีสิทธิ์เข้าถึงเฉพาะทรัพยากรที่ต้องการเท่านั้น ที่จะได้รับการควบคุมที่ละเอียดมากกว่าทรัพยากรที่เข้าถึง Firebase เช่นแอปสามารถใช้รหัสเฉพาะของคุณใน กฎการรักษาความปลอดภัย ที่จะเป็นตัวแทนบริการของคุณ จากนั้นตั้งกฎที่เหมาะสมซึ่งให้สิทธิ์การเข้าถึงบริการของคุณกับทรัพยากรที่ต้องการ ตัวอย่างเช่น:

{
  "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'"
    }
  }
}

จากนั้นบนเซิร์ฟเวอร์ของคุณเมื่อคุณเริ่มต้นแอป Firebase ใช้ databaseAuthVariableOverride ตัวเลือกที่จะแทนที่การ auth ของวัตถุที่ใช้ตามกฎฐานข้อมูลของคุณ ในการกำหนดนี้ auth วัตถุตั้ง uid ฟิลด์ตัวระบุที่คุณใช้ในการแสดงบริการของคุณในกฎการรักษาความปลอดภัยของคุณ

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())
ไป
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)
ในบางกรณี คุณอาจต้องการลดขอบเขต Admin SDK เพื่อทำหน้าที่เป็นไคลเอ็นต์ที่ไม่ผ่านการตรวจสอบสิทธิ์ คุณสามารถทำเช่นนี้โดยการให้ค่า null สำหรับตัวแปรแทนที่ฐานข้อมูลการตรวจสอบสิทธิ์
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())
ไป
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)

ขั้นตอนถัดไป