了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

หน้านี้ได้รับการแปลโดย Cloud Translation API

เรียกใช้ฟังก์ชันจากแอปของคุณ

SDK ของไคลเอ็นต์ Cloud Functions for Firebase ช่วยให้คุณเรียกใช้ฟังก์ชันจากแอป Firebase ได้โดยตรง หากต้องการเรียกใช้ฟังก์ชันจากแอปในลักษณะนี้ ให้เขียนและทำให้ฟังก์ชันที่เรียกใช้ได้ของ HTTP ใช้งานได้ใน Cloud Functions แล้วเพิ่มตรรกะไคลเอ็นต์เพื่อเรียกใช้ฟังก์ชันจากแอป

โปรดทราบว่าฟังก์ชันที่เรียกใช้ได้ของ HTTP นั้นคล้ายคลึงกัน แต่ไม่เหมือนกับฟังก์ชัน HTTP หากต้องการใช้ฟังก์ชันที่เรียกได้ของ HTTP คุณต้องใช้ SDK ของไคลเอ็นต์สำหรับแพลตฟอร์มของคุณร่วมกับ API แบ็กเอนด์ (หรือใช้โปรโตคอล) ไฟล์ที่เรียกได้มีความแตกต่าง ของคีย์จากฟังก์ชัน HTTP

เมื่อมี Callable, โทเค็นการตรวจสอบสิทธิ์ Firebase, โทเค็น FCM และโทเค็น App Check (หากมี) จะรวมอยู่ในคำขอโดยอัตโนมัติ
ทริกเกอร์จะดีซีเรียลเนื้อหาของคำขอและตรวจสอบโทเค็นการตรวจสอบสิทธิ์โดยอัตโนมัติ

Firebase SDK สำหรับ Cloud Functions รุ่นที่ 2 ขึ้นไปจะทำงานร่วมกับ SDK เวอร์ชันขั้นต่ำของไคลเอ็นต์ Firebase ต่อไปนี้เพื่อรองรับฟังก์ชันที่เรียกใช้ได้ของ HTTPS

Firebase SDK สำหรับแพลตฟอร์ม Apple 10.28.0
Firebase SDK สำหรับ Android 21.0.0
Firebase Modular Web SDK เวอร์ชัน 9.7.0

หากต้องการเพิ่มฟังก์ชันการทำงานที่คล้ายกันในแอปที่สร้างบนแพลตฟอร์มที่ไม่รองรับ โปรดดูข้อกำหนดของโปรโตคอลสำหรับ https.onCall ส่วนที่เหลือของคู่มือนี้จะอธิบายวิธีการเขียน ติดตั้งใช้งาน และเรียกฟังก์ชันที่เรียกใช้ได้ของ HTTP สำหรับแพลตฟอร์ม Apple, Android, เว็บ, C++ และ Unity

เขียนและทำให้ฟังก์ชันที่เรียกใช้ได้ใช้งานได้

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

Node.js

// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");

// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");index.js

Python

# Dependencies for callable functions.
from firebase_functions import https_fn, options

# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_appmain.py

ใช้ตัวแฮนเดิลคำขอสำหรับแพลตฟอร์ม (functions.https.onCall) หรือ on_call) เพื่อสร้างฟังก์ชันที่เรียกใช้ได้ของ HTTPS เมธอดนี้จะใช้พารามิเตอร์คำขอ

Node.js

// Saves a message to the Firebase Realtime Database but sanitizes the
// text by removing swearwords.
exports.addmessage = onCall((request) => {
  // ...
});index.js

Python

@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
    """Saves a message to the Firebase Realtime Database but sanitizes the text
    by removing swear words."""main.py

พารามิเตอร์ request มีข้อมูลที่ส่งจากแอปไคลเอ็นต์รวมถึงบริบทเพิ่มเติม เช่น สถานะการตรวจสอบสิทธิ์ สำหรับฟังก์ชันที่เรียกใช้ได้ซึ่งบันทึกข้อความไปยัง Realtime Database เช่น data อาจมีข้อความพร้อมข้อมูลการตรวจสอบสิทธิ์ใน auth

Node.js

// Message text passed from the client.
const text = request.data.text;
// Authentication / user information is automatically added to the request.
const uid = request.auth.uid;
const name = request.auth.token.name || null;
const picture = request.auth.token.picture || null;
const email = request.auth.token.email || null;index.js

Python

# Message text passed from the client.
text = req.data["text"]main.py
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")main.py

ระยะห่างระหว่างตำแหน่งของฟังก์ชันที่เรียกใช้ได้กับตำแหน่งของไคลเอ็นต์การโทรอาจทำให้เวลาในการตอบสนองของเครือข่าย หากต้องการเพิ่มประสิทธิภาพ ให้ลองระบุตำแหน่งของฟังก์ชันที่เกี่ยวข้อง และตรวจสอบว่าตำแหน่งของ Callable ตรงกับตำแหน่งที่ตั้งค่าไว้เมื่อคุณเริ่มต้น SDK ในฝั่งไคลเอ็นต์

นอกจากนี้ คุณยังแนบเอกสารรับรอง App Check เพื่อช่วยปกป้องทรัพยากรแบ็กเอนด์จากการละเมิดได้ เช่น การฉ้อโกงผ่านการเรียกเก็บเงินหรือฟิชชิง ดูเปิดใช้การบังคับใช้ App Check สำหรับ Cloud Functions

การส่งผลลัพธ์กลับมา

หากต้องการส่งข้อมูลกลับไปยังไคลเอ็นต์ ให้แสดงผลข้อมูลที่เข้ารหัส JSON ได้ ตัวอย่างเช่น หากต้องการแสดงผลลัพธ์ของการดำเนินการเพิ่ม

Node.js

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: "+",
  operationResult: firstNumber + secondNumber,
};index.js

Python

return {
    "firstNumber": first_number,
    "secondNumber": second_number,
    "operator": "+",
    "operationResult": first_number + second_number
}main.py

ระบบจะส่งข้อความที่ผ่านการตรวจสอบจากตัวอย่างข้อความไปยังไคลเอ็นต์และไปยัง Realtime Database ใน Node.js คุณสามารถทำได้พร้อมกัน โดยใช้ JavaScript สัญญา:

Node.js

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize message.

return getDatabase().ref("/messages").push({
  text: sanitizedMessage,
  author: {uid, name, picture, email},
}).then(() => {
  logger.info("New Message written");
  // Returning the sanitized message to the client.
  return {text: sanitizedMessage};
})index.js

Python

# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text)  # Sanitize message.
db.reference("/messages").push({  # type: ignore
    "text": sanitized_message,
    "author": {
        "uid": uid,
        "name": name,
        "picture": picture,
        "email": email
    }
})
print("New message written")

# Returning the sanitized message to the client.
return {"text": sanitized_message}main.py

กำหนดค่า CORS (การแชร์ทรัพยากรข้ามโดเมน)

ใช้ตัวเลือก cors เพื่อควบคุมว่าต้นทางใดบ้างที่เข้าถึงฟังก์ชันของคุณได้

โดยค่าเริ่มต้น ฟังก์ชันที่เรียกใช้ได้มีการกำหนดค่า CORS ให้อนุญาตคำขอจากต้นทางทั้งหมด หากต้องการอนุญาตคำขอข้ามต้นทางบางรายการ แต่ไม่ใช่ทั้งหมด ให้ส่งรายการโดเมนเฉพาะหรือนิพจน์ทั่วไปที่ควรอนุญาต เช่น

Node.js

const { onCall } = require("firebase-functions/v2/https");

exports.getGreeting = onCall(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (request) => {
    return "Hello, world!";
  }
);

หากต้องการปฏิเสธคำขอข้ามต้นทาง ให้กำหนดนโยบาย cors เป็น false

จัดการข้อผิดพลาด

หากต้องการให้ไคลเอ็นต์ได้รับรายละเอียดข้อผิดพลาดที่มีประโยชน์ ให้แสดงผลข้อผิดพลาดจาก Callable โดยการส่ง (หรือสำหรับ Node.js ที่ส่งกลับ Promise ที่ถูกปฏิเสธ) อินสแตนซ์ของ functions.https.HttpsError หรือ https_fn.HttpsError ข้อผิดพลาดมีแอตทริบิวต์ code ที่อาจเป็นค่าใดค่าหนึ่งในรหัสสถานะ gRPC ข้อผิดพลาดจะมีสตริง message ซึ่งมีค่าเริ่มต้นเป็นสตริงว่าง และยังมีช่อง details ที่ไม่บังคับซึ่งมีค่าที่กำหนดเองได้อีกด้วย หากข้อผิดพลาดที่ไม่ใช่ HTTPS แสดงข้อผิดพลาดจากฟังก์ชัน ไคลเอ็นต์จะได้รับข้อผิดพลาดพร้อมข้อความ INTERNAL และโค้ด internal แทน

ตัวอย่างเช่น ฟังก์ชันอาจมีข้อผิดพลาดในการตรวจสอบความถูกต้องของข้อมูลและการตรวจสอบสิทธิ์พร้อมข้อความแสดงข้อผิดพลาดกลับไปยังไคลเอ็นต์การเรียกใช้ ดังนี้

Node.js

// Checking attribute.
if (!(typeof text === "string") || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("invalid-argument", "The function must be called " +
          "with one arguments \"text\" containing the message text to add.");
}
// Checking that the user is authenticated.
if (!request.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("failed-precondition", "The function must be " +
          "called while authenticated.");
}index.js

Python

# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
                              message=('The function must be called with one argument, "text",'
                                       " containing the message text to add."))

# Checking that the user is authenticated.
if req.auth is None:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
                              message="The function must be called while authenticated.")main.py

ทำให้ฟังก์ชันที่เรียกใช้ได้ใช้งานได้

หลังจากบันทึกฟังก์ชันที่เรียกใช้ได้เสร็จสมบูรณ์แล้วภายใน index.js ระบบจะทำให้ฟังก์ชันดังกล่าวใช้งานได้พร้อมกับฟังก์ชันอื่นๆ ทั้งหมดเมื่อคุณเรียกใช้ firebase deploy หากต้องการทำให้เฉพาะ Callable ใช้งานได้ ให้ใช้อาร์กิวเมนต์ --only ตามที่แสดงเพื่อทำการทำให้ใช้งานได้บางส่วน:

firebase deploy --only functions:addMessage

หากคุณพบข้อผิดพลาดด้านสิทธิ์เมื่อทำให้ฟังก์ชันใช้งานได้ โปรดตรวจสอบว่าได้กำหนดบทบาท IAM ที่เหมาะสมให้กับผู้ใช้ที่ใช้คำสั่งการทำให้ใช้งานได้

ตั้งค่าสภาพแวดล้อมการพัฒนาไคลเอ็นต์

ตรวจสอบว่าคุณมีคุณสมบัติตรงตามข้อกำหนดเบื้องต้น จากนั้นเพิ่มทรัพยากร Dependency และไลบรารีของไคลเอ็นต์ที่จำเป็นลงในแอป

iOS ขึ้นไป

ทำตามวิธีการเพิ่ม Firebase ลงในแอป Apple

ใช้ Swift Package Manager เพื่อติดตั้งและจัดการทรัพยากร Dependency ของ Firebase

เปิดโปรเจ็กต์แอปใน Xcode แล้วไปที่ไฟล์ > เพิ่มแพ็กเกจ
เมื่อได้รับข้อความแจ้ง ให้เพิ่มที่เก็บ SDK สำหรับแพลตฟอร์ม Firebase ของ Apple ดังนี้

  https://github.com/firebase/firebase-ios-sdk.git

เลือกไลบรารี Cloud Functions
เพิ่มแฟล็ก -ObjC ลงในส่วนแฟล็ก Linker อื่นๆ ของการตั้งค่าบิลด์ของเป้าหมาย
เมื่อเสร็จสิ้นแล้ว Xcode จะเริ่มแก้ปัญหาและดาวน์โหลดทรัพยากร Dependency ในเบื้องหลังโดยอัตโนมัติ

Web

ทำตามวิธีการเพื่อเพิ่ม Firebase ลงในเว็บแอป ตรวจสอบว่าได้เรียกใช้คำสั่งต่อไปนี้จากเทอร์มินัล
```
npm install firebase@10.12.2 --save
```

ต้องใช้ทั้ง Firebase Core และ Cloud Functions ด้วยตนเองดังนี้

 import { initializeApp } from 'firebase/app';
 import { getFunctions } from 'firebase/functions';

 const app = initializeApp({
     projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
     apiKey: '### FIREBASE API KEY ###',
     authDomain: '### FIREBASE AUTH DOMAIN ###',
   });
 const functions = getFunctions(app);

Android

ทำตามวิธีการเพื่อ เพิ่ม Firebase ลงในแอป Android
ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยทั่วไปจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่ม Dependency สำหรับไลบรารี Cloud Functions สำหรับ Android เราขอแนะนำให้ใช้ Firebase Android BoM เพื่อควบคุมการกำหนดเวอร์ชันไลบรารี
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.1.1"))

    // Add the dependency for the Cloud Functions library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-functions")
}
```
การใช้ Firebase Android BoM จะทำให้ แอปใช้ไลบรารี Firebase Android เวอร์ชันที่เข้ากันได้เสมอ
(ทางเลือก) เพิ่มทรัพยากร Dependency ของไลบรารี Firebase โดยไม่ต้องใช้ BoM

หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันไลบรารี Firebase แต่ละเวอร์ชันในบรรทัดทรัพยากร Dependency

โปรดทราบว่าหากคุณใช้ไลบรารี Firebase หลายในแอป เราขอแนะนำให้ใช้ BoM ในการจัดการเวอร์ชันไลบรารีซึ่งจะดูแลให้ทุกเวอร์ชันทำงานร่วมกันได้
```
dependencies {
    // Add the dependency for the Cloud Functions library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-functions:21.0.0")
}
```
หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ ตั้งแต่ เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนา Kotlin และ Java จะ ขึ้นอยู่กับโมดูลไลบรารีหลัก (ดูรายละเอียดได้ที่ คําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

เริ่มต้น SDK ของไคลเอ็นต์

เริ่มต้นอินสแตนซ์ของ Cloud Functions โดยทำดังนี้

Swift

lazy var functions = Functions.functions()CloudAddCell.swift

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];CloudAddCell.m

Web

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Kotlin+KTX

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functionsMainActivity.kt

Java

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();MainActivity.java