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

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

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

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

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

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

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

SDK Firebase สำหรับ Apple แพลตฟอร์ม 11.2.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 มีข้อมูลที่ส่งมาจากแอปไคลเอ็นต์ รวมถึงบริบทเพิ่มเติม เช่น สถานะการตรวจสอบสิทธิ์ สำหรับฟังก์ชันที่เรียกใช้ได้ซึ่งบันทึก SMS ไปยัง 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

ระยะห่างระหว่างตำแหน่งของฟังก์ชันที่เรียกใช้ได้กับตําแหน่ง ของไคลเอ็นต์ที่โทรอาจสร้างเวลาในการตอบสนองของเครือข่าย หากต้องการเพิ่มประสิทธิภาพ ให้พิจารณาระบุตำแหน่งฟังก์ชันตามความเหมาะสม และตรวจสอบว่าได้ปรับตำแหน่งของฟังก์ชันที่เรียกใช้ได้ให้สอดคล้องกับตำแหน่งที่ตั้งไว้เมื่อคุณเริ่มต้น 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

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

โปรดส่งคืนข้อผิดพลาดจากฟังก์ชันเรียกใช้โดยส่ง (หรือสำหรับ 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 หากต้องการทําให้ใช้งานได้เพียงรายการเดียว ให้ใช้อาร์กิวเมนต์ --only ตามที่แสดงเพื่อทําการปรับใช้บางส่วน

firebase deploy --only functions:addMessage

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

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

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

iOS ขึ้นไป

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

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

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

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

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

Web

ทําตามวิธีการเพื่อเพิ่ม Firebase ลงในเว็บแอป อย่าลืมเรียกใช้คําสั่งต่อไปนี้จากเทอร์มินัล
```
npm install firebase@10.13.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.3.0"))

    // 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 เวอร์ชันที่เข้ากันได้อยู่เสมอ
(วิธีอื่น) เพิ่มไลบรารี 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