ข้อมูลเบื้องต้นเกี่ยวกับ Admin Database API

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

การตั้งค่า Admin SDK

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

การตรวจสอบสิทธิ์ Admin SDK

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

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

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

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

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

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())
Go
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))
    // 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())
Go
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))
    // 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())
Go
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)

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