Codelab: สร้างเซิร์ฟเวอร์ข้อความ Push

เคท เจฟฟรีส์
Kate Jeffreys
เคย์ซ บาสก์
เคย์เซ บาสก์
X GitHub ภาพแตก

Codelab นี้แสดงวิธีสร้างเซิร์ฟเวอร์ข้อความ Push แบบทีละขั้นตอน เมื่อเสร็จสิ้น Codelab คุณจะมีเซิร์ฟเวอร์ที่ทำสิ่งต่อไปนี้

  • ติดตามการสมัครรับข้อมูลข้อความ Push (เช่น เซิร์ฟเวอร์จะสร้างระเบียนฐานข้อมูลใหม่เมื่อไคลเอ็นต์เลือกใช้ข้อความ Push และจะลบบันทึกฐานข้อมูลที่มีอยู่เมื่อไคลเอ็นต์เลือกไม่ใช้)
  • ส่งข้อความ Push ถึงลูกค้ารายเดียว
  • ส่งข้อความ Push ให้กับลูกค้าที่สมัครใช้บริการทั้งหมด

Codelab นี้เน้นช่วยให้คุณเรียนรู้จากการลงมือทำ และไม่ได้พูดถึงแนวคิดมากนัก ดูข้อความ Push ทำงานอย่างไร เพื่อเรียนรู้เกี่ยวกับแนวคิดข้อความ Push

รหัสไคลเอ็นต์ของ Codelab นี้เสร็จสมบูรณ์แล้ว คุณจะใช้งานเฉพาะเซิร์ฟเวอร์ใน Codelab นี้เท่านั้น หากต้องการดูวิธีใช้ไคลเอ็นต์ข้อความ Push โปรดดู Codelab: สร้างไคลเอ็นต์ข้อความ Push

โปรดไปที่ push-notifications-server-codelab-complete (แหล่งที่มา) เพื่อดูโค้ดทั้งหมด

ความเข้ากันได้กับเบราว์เซอร์

เป็นที่ทราบกันดีว่า Codelab นี้ใช้ได้กับระบบปฏิบัติการและเบราว์เซอร์ต่อไปนี้

  • Windows: Chrome และ Edge
  • macOS: Chrome, Firefox
  • Android: Chrome, Firefox

เป็นที่ทราบกันดีว่า Codelab นี้ไม่ใช้งานได้กับระบบปฏิบัติการ (หรือชุดระบบปฏิบัติการและเบราว์เซอร์ต่อไปนี้)

  • macOS: Brave, Edge, Safari
  • iOS

สแต็กแอปพลิเคชัน

  • เซิร์ฟเวอร์สร้างขึ้นจาก Express.js
  • ไลบรารี Node.js web-push จะจัดการกับตรรกะข้อความ Push ทั้งหมด
  • ระบบจะเขียนข้อมูลการสมัครใช้บริการเป็นไฟล์ JSON โดยใช้ lowdb

คุณไม่จำเป็นต้องใช้เทคโนโลยีเหล่านี้เพื่อใช้งานข้อความ Push เราเลือกเทคโนโลยีเหล่านี้เพราะให้ประสบการณ์ Codelab ที่เชื่อถือได้

การตั้งค่า

รับสำเนาของโค้ดที่แก้ไขได้

ตัวแก้ไขโค้ดที่คุณเห็นทางด้านขวาของวิธีการเหล่านี้จะเรียกว่า UI ของ Glitch ทั่วทั้ง Codelab นี้

  1. คลิกรีมิกซ์เพื่อแก้ไขเพื่อทำให้โปรเจ็กต์แก้ไขได้

ตั้งค่าการตรวจสอบสิทธิ์

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

  1. เปิดเทอร์มินัล Glitch โดยคลิกเครื่องมือแล้วคลิกเทอร์มินัล
  2. จากนั้นเรียกใช้ npx web-push generate-vapid-keys คัดลอกคีย์ส่วนตัวและค่าคีย์สาธารณะ
  3. เปิด .env และอัปเดต VAPID_PUBLIC_KEY และ VAPID_PRIVATE_KEY ตั้งค่า VAPID_SUBJECT เป็น mailto:test@test.test ค่าทั้งหมดเหล่านี้ควรอยู่ใน เครื่องหมายคำพูดคู่ หลังจากอัปเดตแล้ว ไฟล์ .env ควรมีลักษณะดังนี้
VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
  1. ปิดเทอร์มินัล Glitch
  1. เปิด public/index.js
  2. ให้แทนที่ VAPID_PUBLIC_KEY_VALUE_HERE ด้วยค่าคีย์สาธารณะ

จัดการการสมัครใช้บริการ

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

บันทึกข้อมูลการสมัครใช้บริการใหม่

  1. หากต้องการดูตัวอย่างเว็บไซต์ ให้กดดูแอป แล้วกดเต็มหน้าจอ เต็มหน้าจอ
  1. คลิกลงทะเบียน Service Worker ในแท็บแอป ในช่องสถานะ คุณควร เห็นข้อความที่มีลักษณะดังนี้
Service worker registered. Scope: https://desert-cactus-sunset.glitch.me/
  1. ในแท็บแอป ให้คลิกติดตามเพื่อส่ง เบราว์เซอร์หรือระบบปฏิบัติการอาจถามคุณว่าต้องการให้เว็บไซต์ส่งข้อความ Push หรือไม่ คลิก Allow (หรือวลีที่เทียบเท่าที่เบราว์เซอร์/ระบบปฏิบัติการใช้) ในช่องสถานะ คุณควรเห็นข้อความ ที่คล้ายคลึงกับข้อความต่อไปนี้
Service worker subscribed to push.  Endpoint: https://fcm.googleapis.com/fcm/send/…
  1. กลับไปที่โค้ดโดยคลิกดูซอร์สโค้ดใน UI ของ Glitch
  2. เปิดบันทึก Glitch โดยคลิกเครื่องมือ แล้วคลิกบันทึก คุณควรเห็น /add-subscription ตามด้วยข้อมูลบางอย่าง /add-subscription คือ URL ที่ไคลเอ็นต์จะส่งคำขอPOSTเมื่อต้องการสมัครรับข้อความ Push ข้อมูลที่ตามมาคือข้อมูลการสมัครใช้บริการของลูกค้าที่คุณต้องบันทึกไว้
  3. เปิด server.js
  4. อัปเดตตรรกะของตัวแฮนเดิลเส้นทาง /add-subscription ด้วยโค้ดต่อไปนี้
app.post('/add-subscription', (request, response) => {
  console.log('/add-subscription');
  console.log(request.body);
  console.log(`Subscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .push(request.body)
    .write();
  response.sendStatus(200);
});

ลบข้อมูลการสมัครใช้บริการเดิม

  1. กลับไปที่แท็บแอป
  2. คลิกยกเลิกการสมัครรับข้อความ Push
  3. ดูบันทึก Glitch อีกครั้ง คุณควรเห็น /remove-subscription ตามด้วยข้อมูลการสมัครใช้บริการของลูกค้า
  4. อัปเดตตรรกะของตัวแฮนเดิลเส้นทาง /remove-subscription ด้วยโค้ดต่อไปนี้
app.post('/remove-subscription', (request, response) => {
  console.log('/remove-subscription');
  console.log(request.body);
  console.log(`Unsubscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .remove({endpoint: request.body.endpoint})
    .write();
  response.sendStatus(200);
});

ส่งการแจ้งเตือน

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

  1. อัปเดตตรรกะของตัวแฮนเดิลเส้นทาง /notify-me ด้วยโค้ดต่อไปนี้
app.post('/notify-me', (request, response) => {
  console.log('/notify-me');
  console.log(request.body);
  console.log(`Notifying ${request.body.endpoint}`);
  const subscription = 
      db.get('subscriptions').find({endpoint: request.body.endpoint}).value();
  sendNotifications([subscription]);
  response.sendStatus(200);
});
  1. อัปเดตฟังก์ชัน sendNotifications() ด้วยโค้ดต่อไปนี้
function sendNotifications(subscriptions) {
  // TODO
  // Create the notification content.
  const notification = JSON.stringify({
    title: "Hello, Notifications!",
    options: {
      body: `ID: ${Math.floor(Math.random() * 100)}`
    }
  });
  // Customize how the push service should attempt to deliver the push message.
  // And provide authentication information.
  const options = {
    TTL: 10000,
    vapidDetails: vapidDetails
  };
  // Send a push message to each client specified in the subscriptions array.
  subscriptions.forEach(subscription => {
    const endpoint = subscription.endpoint;
    const id = endpoint.substr((endpoint.length - 8), endpoint.length);
    webpush.sendNotification(subscription, notification, options)
      .then(result => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Result: ${result.statusCode}`);
      })
      .catch(error => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Error: ${error} `);
      });
  });
}
  1. อัปเดตตรรกะของตัวแฮนเดิลเส้นทาง /notify-all ด้วยโค้ดต่อไปนี้
app.post('/notify-all', (request, response) => {
  console.log('/notify-all');
  response.sendStatus(200);
  console.log('Notifying all subscribers');
  const subscriptions =
      db.get('subscriptions').cloneDeep().value();
  if (subscriptions.length > 0) {
    sendNotifications(subscriptions);
    response.sendStatus(200);
  } else {
    response.sendStatus(409);
  }
});
  1. กลับไปที่แท็บแอป
  2. คลิกยกเลิกการสมัครรับอีเมล Push แล้วคลิกสมัครรับข้อมูลเพื่อส่งอีกครั้ง ซึ่งเป็นสิ่งจำเป็นเท่านั้น เนื่องจาก Glitch จะเริ่มต้นโปรเจ็กต์อีกครั้งทุกครั้งที่คุณแก้ไขโค้ด และโปรเจ็กต์ได้รับการกำหนดค่าให้ลบฐานข้อมูลเมื่อเริ่มต้นระบบ
  3. คลิกแจ้งเตือนฉัน คุณควรได้รับข้อความ Push ชื่อควรเป็น Hello, Notifications! และเนื้อหาควรเป็น ID: <ID> โดยที่ <ID> เป็นหมายเลขสุ่ม
  4. เปิดแอปในเบราว์เซอร์หรืออุปกรณ์อื่นๆ แล้วลองสมัครรับข้อความ Push แล้วคลิกปุ่มแจ้งเตือนทั้งหมด คุณควรได้รับการแจ้งเตือนเดียวกันบน อุปกรณ์ทั้งหมดที่สมัครไว้ (กล่าวคือ รหัสในเนื้อหาข้อความ Push ควรเหมือนกัน)

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

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