Saat membangun sistem Pub/Sub, pembukaan payload dapat membantu Anda terhubung ke sistem lain yang tidak mematuhi semua persyaratan sistem penerapan endpoint push Pub/Sub standar.
Berikut adalah beberapa potensi kasus penggunaan untuk membuka payload:
- Anda tidak ingin menulis kode parsing pesan khusus Pub/Sub untuk endpoint push HTTP.
- Anda lebih memilih menerima metadata pesan Pub/Sub sebagai header HTTP, bukan metadata di isi HTTP POST.
- Anda ingin mengirim pesan Pub/Sub dan mengecualikan metadata Pub/Sub, misalnya saat mengirim data ke API pihak ketiga.
Cara kerja pembukaan payload
Pembukaan payload adalah fitur yang menghapus semua metadata pesan Pub/Sub, kecuali data pesan. Dengan mengirim data pesan mentah, pelanggan dapat memproses pesan tanpa harus mematuhi persyaratan sistem Pub/Sub.
- Dengan pembukaan payload, data pesan dikirim langsung sebagai isi HTTP.
- Tanpa pembukaan payload, Pub/Sub mengirimkan objek JSON yang berisi beberapa kolom metadata pesan dan kolom data pesan. Dalam kasus ini, JSON harus diurai untuk mengambil data pesan, lalu didekode base64.
Menulis metadata
Setelah mengaktifkan pembukaan payload, Anda dapat menggunakan opsi tulis metadata yang menambahkan metadata pesan yang sebelumnya dihapus ke header permintaan.
- Tulis metadata diaktifkan. Tambahkan metadata pesan kembali ke header permintaan. Juga mengirimkan data pesan mentah yang telah didekode.
- Penulisan metadata dinonaktifkan. Hanya mengirimkan data pesan mentah yang telah didekode.
Metadata penulisan diekspos melalui Pub/Sub, argumen --push-no-wrapper-write-metadata
Google Cloud CLI, dan properti API NoWrapper
.
Secara default, nilai ini adalah null.
Sebelum memulai
- Pelajari langganan dan langganan push Pub/Sub. Pembukaan payload hanya dapat digunakan dengan langganan push.
- Pelajari cara mengonfigurasi langganan push.
Contoh untuk pesan yang dienkapsulasi dan tidak dienkapsulasi
Contoh berikut menggambarkan perbedaan antara mengirim pesan HTTP yang dienkapsulasi dan tidak dienkapsulasi. Dalam contoh ini, data pesan berisi string {"status": "Hello there"}
.
Untuk contoh ini, langganan dibuat dengan fitur pembukaan payload yang diaktifkan dan memublikasikan pesan ke mytopic
. Objek ini menggunakan kunci
pengurutan dengan nilai some-key
dan jenis media dideklarasikan sebagai
application/json
.
gcloud pubsub topics publish mytopic --message='{"status": "Hello there"}' --ordering-key="some-key" --attribute "Content-Type=application/json"
Bagian berikut menunjukkan perbedaan antara pesan yang di-wrap dan tidak di-wrap.
Pesan yang dibungkus
Contoh berikut menunjukkan pesan standar yang di-wrap Pub/Sub. Dalam hal ini, pembukaan payload tidak diaktifkan.
Publikasikan | Endpoint Push Menerima |
---|---|
data="{"status": "Hello there"}" ordering_key="some-key" attributes= { {"Content-Type", "application/json"} } |
Content-Length: 361 Content-Type: application/json User-Agent: CloudPubSub-Google Host: subscription-project.uc.r.appspot.com { "message": { "attributes": { "Content-Type": "application/json" }, "data": "eyJzdGF0dXMiOiAiSGVsbG8gdGhlcmUifQ==", // Base64 - {"status": "Hello there"} "messageId": "2070443601311540", "message_id": "2070443601311540", "publishTime": "2021-02-26T19:13:55.749Z", "publish_time": "2021-02-26T19:13:55.749Z" }, "subscription": "projects/myproject/..." } |
Pesan yang tidak di-unwrap dengan penulisan metadata dinonaktifkan
Contoh berikut menampilkan pesan yang tidak di-unwrapping dengan opsi tulis metadata dinonaktifkan. Dalam hal ini, header x-goog-pubsub-*
dan atribut pesan
tidak disertakan.
Publikasikan | Endpoint Push Menerima |
---|---|
data="{"status": "Hello there"}" ordering_key="some-key" attributes= { {"Content-Type", "application/json"} } |
Content-Length: 25 User-Agent: CloudPubSub-Google Host: subscription-project.uc.r.appspot.com {"status": "Hello there"} |
Pesan yang tidak di-unwrap dengan metadata penulisan diaktifkan
Contoh berikut menampilkan pesan yang tidak di-unwrap dengan opsi tulis metadata diaktifkan. Dalam hal ini, atribut pesan dan header x-goog-pubsub-*
disertakan.
Publikasikan | Endpoint Push Menerima |
---|---|
data="{"status": "Hello there"}" ordering_key="some-key" attributes= { {"Content-Type", "application/json"} } |
x-goog-pubsub-subscription-name: "projects/myproject/..." x-goog-pubsub-message-id: "2070443601311540" x-goog-pubsub-publish-time: "2021-02-26T19:13:55.749Z" x-goog-pubsub-ordering-key: "some-key" Content-Type: application/json Content-Length: 12 User-Agent: CloudPubSub-Google Host: subscription-project.uc.r.appspot.com {"status": "Hello there"} |
Mengonfigurasi pembukaan payload
Anda dapat mengaktifkan pengiriman push pembukaan payload untuk langganan menggunakan halaman Trusted Cloud konsol Detail Langganan, Google Cloud CLI, atau Library Klien.
Konsol
Di konsol Trusted Cloud , buka halaman Subscriptions.
Klik Buat langganan.
Di kolom Subscription ID, masukkan nama.
Untuk mengetahui informasi tentang cara memberi nama langganan, lihat Panduan untuk memberi nama topik atau langganan.
Pilih topik dari menu drop-down. Langganan menerima pesan dari topik.
Untuk Jenis pengiriman, pilih Push.
Untuk mengaktifkan pembukaan payload, pilih Aktifkan pembukaan payload.
(Opsional) Untuk mempertahankan metadata pesan di header permintaan, pilih Tulis metadata. Anda harus mengaktifkan opsi ini untuk menetapkan header Content-Type untuk pesan Anda.
Tentukan URL endpoint.
Pertahankan semua nilai default lainnya.
Klik Buat.
gcloud
Untuk mengonfigurasi langganan dengan pembukaan payload yang mencakup header HTTP standar, jalankan perintah gcloud pubsub subscriptions create
berikut:
gcloud pubsub subscriptions create SUBSCRIPTION \ --topic TOPIC \ --push-endpoint=PUSH_ENDPOINT \ --push-no-wrapper
Ganti kode berikut:
SUBSCRIPTION
: nama atau ID langganan pull Anda.TOPIC
: ID topik.PUSH_ENDPOINT
: URL yang akan digunakan sebagai endpoint untuk langganan ini. Misalnya,https://myproject.appspot.com/myhandler
--push-no-wrapper
: mengirimkan data pesan secara langsung sebagai isi HTTP.
Untuk mengonfigurasi langganan dengan pembukaan payload dan mengontrol penggunaan header x-goog-pubsub-*
, jalankan perintah berikut:
gcloud pubsub subscriptions create SUBSCRIPTION \ --topic TOPIC \ --push-endpoint=PUSH_ENDPOINT \ --push-no-wrapper \ --push-no-wrapper-write-metadata
--push-no-wrapper-write-metadata
: Jika benar (true), menulis metadata pesan Pub/Sub ke headerx-goog-pubsub-<KEY>:<VAL>
permintaan HTTP. Menulis atribut pesan Pub/Sub ke header<KEY>:<VAL>
permintaan HTTP.
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Pub/Sub Python API.
Java
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Java di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Pub/Sub Java API.
C++
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan C++ di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Pub/Sub C++ API.
Go
Contoh berikut menggunakan library klien Go Pub/Sub versi utama (v2). Jika Anda masih menggunakan library v1, lihat panduan migrasi ke v2. Untuk melihat daftar contoh kode v1, lihat contoh kode yang tidak digunakan lagi.
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Go di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Pub/Sub Go API.
Node.js
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Node.js di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API Node.js Pub/Sub.
Node.js
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Node.js di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API Node.js Pub/Sub.
Menetapkan header content-type dalam pesan Anda
Setelah mengaktifkan pembukaan payload, Pub/Sub tidak
otomatis menetapkan kolom header jenis media dalam permintaan Anda. Jika Anda tidak menetapkan kolom header Content-Type
secara eksplisit, server web yang memproses permintaan Anda dapat menetapkan nilai default application/octet-stream
atau menafsirkan permintaan dengan cara yang tidak terduga.
Jika Anda memerlukan header Content-Type
, pastikan Anda mendeklarasikannya secara eksplisit
pada saat publikasi untuk setiap pesan yang dipublikasikan. Untuk melakukannya, Anda harus
mengaktifkan Tulis metadata terlebih dahulu. Hasil pengaktifan Tulis metadata
ini ditampilkan dalam contoh yang diberikan.
Langkah berikutnya
- Jika Anda mengalami masalah dengan pembukaan payload, lihat Memecahkan masalah pembukaan payload.