ข้อมูลเบื้องต้นเกี่ยวกับ API ฐานข้อมูลผู้ดูแลระบบ

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

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

หากต้องการเริ่มต้นใช้งาน Firebase Realtime Database บนเซิร์ฟเวอร์ของคุณ คุณจะต้อง ตั้งค่า Firebase Admin SDK ในภาษาที่คุณเลือกก่อน

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

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

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

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

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

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

ชวา
// 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) {
  }
});
โหนด 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());
});
หลาม
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 เป็นตัวระบุที่คุณใช้เพื่อแสดงบริการของคุณในกฎความปลอดภัย

ชวา
// 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);
    }
});
โหนด 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());
});
หลาม
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 สำหรับการแทนที่ตัวแปรการรับรองความถูกต้องของฐานข้อมูล

ชวา
// 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);
    }
});
โหนด 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());
});
หลาม
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)

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