เรียกใช้ฟังก์ชันผ่านคำขอ HTTP


คุณทริกเกอร์ฟังก์ชันผ่านคำขอ HTTP ได้โดยใช้ functions.https ซึ่งช่วยให้คุณเรียกใช้ฟังก์ชันซิงโครนัสผ่านเมธอด HTTP ที่รองรับต่อไปนี้ GET, POST, PUT, DELETE และ OPTIONS

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

ทริกเกอร์ฟังก์ชันที่มีคำขอ HTTP

ใช้ functions.https เพื่อสร้างฟังก์ชันที่จัดการเหตุการณ์ HTTP ตัวแฮนเดิลเหตุการณ์สำหรับฟังก์ชัน HTTP จะคอยฟังเหตุการณ์ onRequest() ซึ่งรองรับเราเตอร์และแอปที่จัดการโดยเว็บเฟรมเวิร์ก Express

การใช้ออบเจ็กต์คำขอและการตอบกลับแบบด่วน

ออบเจ็กต์ Request ที่ใช้เป็นอาร์กิวเมนต์สำหรับ onRequest() ให้คุณเข้าถึงพร็อพเพอร์ตี้ของคำขอ HTTP ที่ไคลเอ็นต์ส่ง และออบเจ็กต์ Response จะระบุวิธีส่งการตอบกลับไปยังไคลเอ็นต์

exports.date = functions.https.onRequest((req, res) => {
  // ...
});

ใช้แอป Express ที่มีอยู่

เมื่อใช้ App เป็นอาร์กิวเมนต์สำหรับ onRequest() คุณจะส่งผ่านแอป Express เต็มรูปแบบไปยังฟังก์ชัน HTTP ได้ สามารถย้ายโค้ดแบบ Boilerplate ไปยังมิดเดิลแวร์ได้ ดังนี้

const express = require('express');
const cors = require('cors');

const app = express();

// Automatically allow cross-origin requests
app.use(cors({ origin: true }));

// Add middleware to authenticate requests
app.use(myMiddleware);

// build multiple CRUD interfaces:
app.get('/:id', (req, res) => res.send(Widgets.getById(req.params.id)));
app.post('/', (req, res) => res.send(Widgets.create()));
app.put('/:id', (req, res) => res.send(Widgets.update(req.params.id, req.body)));
app.delete('/:id', (req, res) => res.send(Widgets.delete(req.params.id)));
app.get('/', (req, res) => res.send(Widgets.list()));

// Expose Express API as a single Cloud Function:
exports.widgets = functions.https.onRequest(app);

เรียกใช้ฟังก์ชัน HTTP

หลังจากทำให้ฟังก์ชัน HTTP ใช้งานได้แล้ว คุณจะเรียกใช้ผ่าน URL ที่ไม่ซ้ำกันของฟังก์ชันได้ URL ประกอบด้วยข้อมูลต่อไปนี้ตามลําดับ

  • ภูมิภาค (หรือหลายภูมิภาค) ที่คุณทำให้ฟังก์ชันใช้งานได้ ฟังก์ชันที่ใช้งานจริงบางอย่างอาจต้องตั้งค่าตำแหน่งอย่างชัดเจนเพื่อลดเวลาในการตอบสนองของเครือข่าย
  • รหัสโปรเจ็กต์ Firebase
  • cloudfunctions.net
  • ชื่อฟังก์ชัน

ตัวอย่างเช่น URL ที่จะเรียกใช้ date() จะมีลักษณะดังนี้

https://us-central1-<project-id>.cloudfunctions.net/date

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

เมื่อใช้การกำหนดเส้นทางแอป Express ระบบจะเพิ่มชื่อฟังก์ชันเป็นคำนำหน้าเส้นทาง URL ในแอปที่คุณกำหนด เช่น URL ที่จะเรียกใช้ Getter ในตัวอย่างแอป Express ด้านบนจะมีลักษณะดังนี้

https://us-central1-<project-id>.cloudfunctions.net/widgets/<id>

หากเรียกใช้ฟังก์ชัน HTTP หลังไฟร์วอลล์หรือตัวกรอง IP คุณจะค้นหาที่อยู่ IP ที่ Google ใช้เพื่อให้บริการฟังก์ชัน HTTP ได้

ใช้โมดูลมิดเดิลแวร์กับ Cloud Functions

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

// Enable CORS using the `cors` express middleware.
cors(req, res, () => {
  // ...
});

อ่านค่าจากคำขอ

ตารางต่อไปนี้แสดงสถานการณ์ทั่วไปบางส่วน

ประเภทเนื้อหา เนื้อความของคำขอ พฤติกรรม
application/json '{"name":"John"}' request.body.name เท่ากับ "John"
application/octet-stream "ข้อความของฉัน" request.body เท่ากับ "6d792074657874" (ไบต์ดิบของคำขอ โปรดดูเอกสารประกอบเกี่ยวกับการบัฟเฟอร์ของ Node.js)
text/plain "ข้อความของฉัน" request.body เท่ากับ "ข้อความของฉัน"
application/x-www-form-urlencoded "name=John" request.body.name เท่ากับ "John"

การแยกวิเคราะห์นี้ดำเนินการโดยโปรแกรมแยกวิเคราะห์เนื้อหาต่อไปนี้

สมมติว่ามีการเรียกฟังก์ชันของคุณด้วยคำขอต่อไปนี้

curl -X POST -H "Content-Type:application/json" -H "X-MyHeader: 123" YOUR_HTTP_TRIGGER_ENDPOINT?foo=baz -d '{"text":"something"}'

ข้อมูลที่ส่งจะปรากฏภายใต้

คุณสมบัติ/วิธีการ ค่า
req.method "โพสต์"
req.get('x-myheader') "123"
req.query.foo "baz"
req.body.text "บางอย่าง"
req.rawBody ข้อมูลดิบ (ไม่ได้แยกวิเคราะห์) ไบต์ของคำขอ

ในตัวอย่างฟังก์ชัน date() ฟังก์ชันจะทดสอบทั้งพารามิเตอร์ของ URL และเนื้อความของค่า format เพื่อตั้งค่ารูปแบบวันที่/เวลาที่จะใช้ ดังนี้

let format = req.query.format;
format = req.body.format;
index.js

สิ้นสุดฟังก์ชัน HTTP

สิ้นสุดฟังก์ชัน HTTP ด้วย send(), redirect() หรือ end() เสมอ ไม่เช่นนั้น ฟังก์ชันอาจทำงานต่อไปและถูกบังคับให้สิ้นสุดการใช้งาน ดูข้อมูลเพิ่มเติมใน Sync, Async และ Promises

หลังจากเรียกข้อมูลและจัดรูปแบบเวลาของเซิร์ฟเวอร์โดยใช้โมดูล Node.js moment แล้ว ฟังก์ชัน date() จะสรุปโดยการส่งผลลัพธ์ในการตอบกลับ HTTP ดังนี้

const formattedDate = moment().format(`${format}`);
functions.logger.log('Sending Formatted date:', formattedDate);
res.status(200).send(formattedDate);
index.js

การเชื่อมต่อฟังก์ชัน HTTP กับโฮสติ้งของ Firebase

คุณเชื่อมต่อฟังก์ชัน HTTP กับโฮสติ้งของ Firebase ได้ คำขอบนเว็บไซต์โฮสติ้งของ Firebase สามารถทำพร็อกซีไปยังฟังก์ชัน HTTP ที่เฉพาะเจาะจงได้ ซึ่งทำให้คุณใช้โดเมนที่กำหนดเองกับฟังก์ชัน HTTP ได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการเชื่อมต่อ Cloud Functions กับโฮสติ้งของ Firebase