Trang này được dịch bởi Cloud Translation API.

Tiện ích Google Cloud Pub/Sub

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Phiên bản: 2.0.0

Xuất bản thông báo lên một chủ đề trong dịch vụ Google Cloud Pub/Sub.

Nội dung này cung cấp thông tin tham khảo để định cấu hình và sử dụng tiện ích này.

Điều kiện tiên quyết

Trước khi sử dụng tiện ích từ một proxy API bằng chính sách ExtensionCallout, bạn phải:

Tạo một chủ đề Cloud Pub/Sub, như mô tả trong phần Bắt đầu nhanh: Sử dụng bảng điều khiển.
Sau khi bạn có chủ đề, hãy cấp quyền để phát hành cho chủ đề Cloud Pub/Sub của bạn. Ví dụ: bạn có thể sử dụng vai trò roles/pubsub.publisher để xuất bản nội dung cho các chủ đề. Để biết thêm về các vai trò trong Cloud Pub/Sub, hãy xem phần Kiểm soát quyền truy cập.
Sử dụng GCP Console để tạo khoá cho tài khoản dịch vụ.
Sử dụng nội dung của tệp JSON khoá thu được khi thêm và định cấu hình tiện ích bằng tệp tham chiếu cấu hình.

Giới thiệu về Cloud Pub/Sub

Cloud Pub/Sub cung cấp tính năng nhắn tin không đồng bộ, nhiều đến nhiều, giúp tách biệt người gửi và người nhận. Cloud Pub/Sub cung cấp dịch vụ nhắn tin có độ trễ thấp và bền vững, giúp nhà phát triển nhanh chóng tích hợp các hệ thống được lưu trữ trên Google Cloud Platform và bên ngoài.

Nếu bạn mới bắt đầu sử dụng Cloud Pub/Sub, hãy xem hướng dẫn nhanh trong tài liệu về Cloud Pub/Sub.

Mẫu

Các ví dụ sau đây minh hoạ cách định cấu hình tính năng hỗ trợ cho các hành động của tiện ích Cloud Pub/Sub bằng chính sách ExtensionCallout.

Tin nhắn văn bản

Trong ví dụ này, thao tác publish phát hành một thông báo dưới dạng một chuỗi đơn giản đến một chủ đề được chỉ định trong cấu hình của tiện ích. Thao tác publish trả về mã nhận dạng của thông báo đã xuất bản trong chủ đề mà thông báo đó được xuất bản và ghi mã nhận dạng đó vào biến do thẻ <Output> chỉ định:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
    <DisplayName>Publish Message</DisplayName>
    <Connector>cloud-pub-sub-extension-example</Connector>
    <Action>publish</Action>
    <Input><![CDATA[
      {
          "message" : "My test message."
      }
    ]]></Input>
    <Output>topic.message</Output>
</ConnectorCallout>

Chính sách Chỉ định thông báo sau đây sử dụng giá trị của biến lưu trữ phản hồi của tiện ích để chỉ định tải trọng phản hồi. Mã thông báo được lưu trữ trong thuộc tính messageId của biến đầu ra:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
    <DisplayName>Get Topic Message ID</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{topic.message.messageId}</Payload>
    </Set>
</AssignMessage>

Dữ liệu phản hồi được trả về dưới dạng JSON:

{"messageId":"165918654986954"}

Do đó, giá trị của topic.message.messageId là 165918654986954.

Thông báo JSON

Trong ví dụ này, thao tác publish phát hành một thông báo dưới dạng JSON đến một chủ đề được chỉ định trong cấu hình của tiện ích. Thao tác publish trả về mã nhận dạng của thông báo đã xuất bản trong chủ đề mà thông báo đó được xuất bản và ghi mã nhận dạng đó vào biến do thẻ <Output> chỉ định:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
    <DisplayName>Publish Message</DisplayName>
    <Connector>cloud-pub-sub-extension-example</Connector>
    <Action>publish</Action>
    <Input><![CDATA[
      {
          "message" : { "info" : "My test message" }
      }
    ]]></Input>
    <Output>topic.message</Output>
</ConnectorCallout>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
    <DisplayName>Get Topic Message ID</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{topic.message.messageId}</Payload>
    </Set>
</AssignMessage>

Dữ liệu phản hồi được trả về dưới dạng JSON:

{"messageId":"165918654986954"}

Do đó, giá trị của topic.message.messageId là 165918654986954.

Thao tác

xuất bản

Xuất bản thông báo đến chủ đề được chỉ định trong cấu hình của tiện ích này.

Cú pháp

<Action>publish</Action>
<Input><![CDATA[{
  "message" : "message-to-publish" | JSON-structured-data,
  "customAttributes": JSON-array
}]]></Input>

Ví dụ về chuỗi

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : "My test message."
  }
]]></Input>

Ví dụ về dữ liệu có cấu trúc JSON

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : { "info" : "My test message" }
  }
]]></Input>

Ví dụ về thuộc tính tuỳ chỉnh

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : { "info" : "My test message" },
      "customAttributes": {"attr1": "foo", "attr2": "bar"}
  }
]]></Input>

Tham số yêu cầu

Thông số	Mô tả	Loại	Mặc định	Bắt buộc
tin nhắn	Thông báo cần xuất bản. Bạn có thể sử dụng một chuỗi đơn giản hoặc tạo cấu trúc cho thông báo bằng JSON do bạn thiết kế.	Chuỗi hoặc JSON	Không có	Có
customAttributes	Các thuộc tính tuỳ chỉnh cần thêm vào thông báo trong biểu mẫu: `"customAttributes": {"attr1": "foo", "attr2": "bar"}`.	Mảng JSON	Không có	Không

Phản hồi

JSON chứa mã nhận dạng của thông báo được xuất bản cho chủ đề. Ví dụ:

{"messageId":"165918654986954"}

Tài liệu tham khảo về cấu hình

Hãy sử dụng nội dung sau đây khi bạn định cấu hình và triển khai tiện ích này để sử dụng trong proxy API.

Các thuộc tính mở rộng phổ biến

Các thuộc tính sau có sẵn cho mỗi tiện ích.

Tài sản	Mô tả	Mặc định	Bắt buộc
`name`	Tên mà bạn đang đặt cho cấu hình của tiện ích này.	Không có	Có
`packageName`	Tên của gói tiện ích do Apigee Edge cung cấp.	Không có	Có
`version`	Số phiên bản của gói tiện ích mà bạn đang định cấu hình tiện ích.	Không có	Có
`configuration`	Giá trị cấu hình cụ thể cho tiện ích bạn đang thêm. Xem Thuộc tính cho gói tiện ích này	Không có	Có

Thuộc tính cho gói tiện ích này

Thuộc tính	Mô tả	Mặc định	Bắt buộc
`topic`	Chủ đề để xuất bản. Lấy giá trị này từ dịch vụ Pub/Sub, chẳng hạn như từ bảng điều khiển GCP cho dịch vụ. Ví dụ: tên chủ đề có thể có dạng `projects/GCP-PROJECT-ID/topics/TOPIC-NAME`	Không có.	Có.
`credentials`	Khi nhập vào bảng điều khiển Apigee Edge, đây là nội dung của tệp khoá tài khoản dịch vụ. Khi được gửi qua API quản lý, đây là một giá trị được mã hoá base64 được tạo từ tệp khoá tài khoản dịch vụ.	Không có.	Có.