این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

با Pub/Sub یک برنامه Google Chat پشت فایروال بسازید

این صفحه نحوه ایجاد یک برنامه چت با استفاده از Pub/Sub را توضیح می‌دهد. این نوع معماری برای برنامه Chat در صورتی مفید است که سازمان شما دارای دیوار آتش باشد، که می تواند از ارسال پیام Chat به برنامه Chat شما جلوگیری کند، یا اگر برنامه Chat از Google Workspace Events API استفاده می کند. با این حال، این معماری دارای محدودیت‌های زیر است، زیرا این برنامه‌های چت فقط می‌توانند پیام‌های ناهمزمان ارسال و دریافت کنند:

نمی توان از دیالوگ ها در پیام ها استفاده کرد. در عوض، از پیام کارت استفاده کنید.
نمی‌توان کارت‌های جداگانه را با پاسخ همگام به‌روزرسانی کرد. در عوض، کل پیام را با فراخوانی متد patch به‌روزرسانی کنید.

نمودار زیر معماری یک برنامه چت ساخته شده با Pub/Sub را نشان می دهد:

معماری یک برنامه چت اجرا شده با Pub/Sub.

در نمودار قبل، کاربر در حال تعامل با برنامه Pub/Sub Chat دارای جریان اطلاعات زیر است:

یک کاربر پیامی را در Chat به یک برنامه Chat ارسال می‌کند، یا در یک پیام مستقیم یا در فضای Chat، یا رویدادی در فضای Chat رخ می‌دهد که برنامه Chat اشتراک فعالی برای آن دارد.
چت پیام را به یک موضوع Pub/Sub ارسال می کند.
یک سرور برنامه، که یا یک سیستم ابری یا درون محل است که حاوی منطق برنامه چت است، در موضوع Pub/Sub مشترک می شود تا پیام را از طریق فایروال دریافت کند.
به صورت اختیاری، برنامه چت می‌تواند با Chat API تماس بگیرد تا پیام‌ها را به صورت ناهمزمان ارسال کند یا عملیات دیگری را انجام دهد.

پیش نیازها

جاوا

یک حساب Google Workspace با دسترسی به Google Chat .
یک پروژه Google Cloud .
مطمئن شوید که صورت‌حساب پروژه Cloud خود را روشن کرده‌اید. نحوه تأیید وضعیت صورت‌حساب پروژه‌های خود را بیاموزید.
جاوا 11 یا بالاتر.
آپاچی ماون

محیط را تنظیم کنید

قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.

در کنسول Google Cloud، Google Chat API و Pub/Sub API را فعال کنید.
API ها را فعال کنید

Pub/Sub را راه اندازی کنید

یک موضوع Pub/Sub ایجاد کنید که Chat API بتواند به آن پیام ارسال کند. توصیه می کنیم در هر برنامه چت از یک موضوع استفاده کنید.
با اختصاص نقش Pub/Sub Publisher به حساب سرویس زیر ، به Chat اجازه انتشار در موضوع بدهید :
```
chat-api-push@system.gserviceaccount.com
```
یک حساب سرویس برای برنامه Chat ایجاد کنید تا با Pub/Sub و Chat مجوز دهید و فایل کلید خصوصی را در فهرست کاری خود ذخیره کنید.
یک اشتراک کششی برای موضوع ایجاد کنید .
نقش مشترک Pub/Sub Subscriber را در اشتراک برای حساب سرویسی که قبلا ایجاد کرده اید اختصاص دهید .

فیلمنامه را بنویسید

جاوا

در یک CLI، اعتبار حساب خدمات را ارائه دهید :
```
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
```
در پوشه کاری خود، یک فایل به نام pom.xml ایجاد کنید.

در فایل pom.xml کد زیر را قرار دهید:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.google.chat.pubsub</groupId>
<artifactId>java-pubsub-app</artifactId>
<version>0.1.0</version>

<name>java-pubsub-app</name>

<properties>
  <maven.compiler.target>11</maven.compiler.target>
  <maven.compiler.source>11</maven.compiler.source>
</properties>

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.26.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.9.1</version>
  </dependency>
  <dependency>
    <groupId>com.google.api-client</groupId>
    <artifactId>google-api-client</artifactId>
    <version>1.32.1</version>
  </dependency>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-pubsub</artifactId>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.14.2</version>
  </dependency>
</dependencies>

<build>
  <pluginManagement>
    <plugins>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.0</version>
      </plugin>
    </plugins>
  </pluginManagement>
</build>
</project>

در پوشه کاری خود، ساختار دایرکتوری src/main/java را ایجاد کنید.
در پوشه src/main/java ، فایلی به نام Main.java ایجاد کنید.

در Main.java کد زیر را قرار دهید:

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.ByteArrayContent;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpTransport;
import com.google.cloud.pubsub.v1.AckReplyConsumer;
import com.google.cloud.pubsub.v1.MessageReceiver;
import com.google.cloud.pubsub.v1.Subscriber;
import com.google.pubsub.v1.PubsubMessage;
import com.google.pubsub.v1.ProjectSubscriptionName;
import java.io.FileInputStream;
import java.util.Collections;

public class Main {

  public static final String CREDENTIALS_PATH_ENV_PROPERTY = "GOOGLE_APPLICATION_CREDENTIALS";

  // Google Cloud Project ID
  public static final String PROJECT_ID = PROJECT_ID;

  // Cloud Pub/Sub Subscription ID
  public static final String SUBSCRIPTION_ID = SUBSCRIPTION_ID

  public static void main(String[] args) throws Exception {
    ProjectSubscriptionName subscriptionName =
        ProjectSubscriptionName.of(PROJECT_ID, SUBSCRIPTION_ID);

    // Instantiate app, which implements an asynchronous message receiver.
    EchoApp echoApp = new EchoApp();

    // Create a subscriber for <var>SUBSCRIPTION_ID</var> bound to the message receiver
    final Subscriber subscriber =
        Subscriber.newBuilder(subscriptionName, echoApp).build();
    System.out.println("Starting subscriber...");
    subscriber.startAsync();

    // Wait for termination
    subscriber.awaitTerminated();
  }
}

/ **
* A demo app which implements {@link MessageReceiver} to receive messages. It simply echoes the
* incoming messages.
*/
class EchoApp implements MessageReceiver {

  // Path to the private key JSON file of the service account to be used for posting response
  // messages to Google Chat.
  // In this demo, we are using the same service account for authorizing with Cloud Pub/Sub to
  // receive messages and authorizing with Google Chat to post messages. If you are using
  // different service accounts, please set the path to the private key JSON file of the service
  // account used to post messages to Google Chat here.
  private static final String SERVICE_ACCOUNT_KEY_PATH =
      System.getenv(Main.CREDENTIALS_PATH_ENV_PROPERTY);

  // Developer code for Google Chat API scope.
  private static final String GOOGLE_CHAT_API_SCOPE = "https://www.googleapis.com/auth/chat.bot";

  // Response URL Template with placeholders for space id.
  private static final String RESPONSE_URL_TEMPLATE =
      "https://chat.googleapis.com/v1/__SPACE_ID__/messages";

  // Response echo message template.
  private static final String RESPONSE_TEMPLATE = "You said: `__MESSAGE__`";

  private static final String ADDED_RESPONSE = "Thank you for adding me!";

  GoogleCredential credential;
  HttpTransport httpTransport;
  HttpRequestFactory requestFactory;

  EchoApp() throws Exception {
    credential =
        GoogleCredential.fromStream(new FileInputStream(SERVICE_ACCOUNT_KEY_PATH))
            .createScoped(Collections.singleton(GOOGLE_CHAT_API_SCOPE));
    httpTransport = GoogleNetHttpTransport.newTrustedTransport();
    requestFactory = httpTransport.createRequestFactory(credential);
  }

  // Called when a message is received by the subscriber.
  @Override
  public void receiveMessage(PubsubMessage pubsubMessage, AckReplyConsumer consumer) {
    System.out.println("Id : " + pubsubMessage.getMessageId());
    // handle incoming message, then ack/nack the received message
    try {
      ObjectMapper mapper = new ObjectMapper();
      JsonNode dataJson = mapper.readTree(pubsubMessage.getData().toStringUtf8());
      System.out.println("Data : " + dataJson.toString());
      handle(dataJson);
      consumer.ack();
    } catch (Exception e) {
      System.out.println(e);
      consumer.nack();
    }
  }

  public void handle(JsonNode eventJson) throws Exception {
    JsonNodeFactory jsonNodeFactory = new JsonNodeFactory(false);
    ObjectNode responseNode = jsonNodeFactory.objectNode();

    // Construct the response depending on the event received.

    String eventType = eventJson.get("type").asText();
    switch (eventType) {
      case "ADDED_TO_SPACE":
        responseNode.put("text", ADDED_RESPONSE);
        // An app can also be added to a space by @mentioning it in a message. In that case, we fall
        // through to the MESSAGE case and let the app respond. If the app was added using the
        // invite flow, we just post a thank you message in the space.
        if(!eventJson.has("message")) {
          break;
        }
      case "MESSAGE":
        responseNode.put("text",
            RESPONSE_TEMPLATE.replaceFirst(
                "__MESSAGE__", eventJson.get("message").get("text").asText()));
        // In case of message, post the response in the same thread.
        ObjectNode threadNode = jsonNodeFactory.objectNode();
        threadNode.put("name", eventJson.get("message").get("thread").get("name").asText());
        responseNode.put("thread", threadNode);
        break;
      case "REMOVED_FROM_SPACE":
      default:
        // Do nothing
        return;
    }

    // Post the response to Google Chat.

    String URI =
        RESPONSE_URL_TEMPLATE.replaceFirst(
            "__SPACE_ID__", eventJson.get("space").get("name").asText());
    GenericUrl url = new GenericUrl(URI);

    HttpContent content =
        new ByteArrayContent("application/json", responseNode.toString().getBytes("UTF-8"));
    HttpRequest request = requestFactory.buildPostRequest(url, content);
    com.google.api.client.http.HttpResponse response = request.execute();
  }
}

موارد زیر را جایگزین کنید:

PROJECT_ID : شناسه پروژه Google Cloud.
SUBSCRIPTION_ID : شناسه اشتراک برای اشتراک Pub/Sub که قبلا ایجاد کرده‌اید.

برنامه را در چت منتشر کنید

در کنسول Google Cloud، به منو > APIs & Services > Enabled APIs & Services > Google Chat API > Configuration بروید.
به تنظیمات بروید
برنامه چت را برای Pub/Sub پیکربندی کنید:
1. در نام برنامه ، Quickstart App وارد کنید.
2. در URL آواتار ، https://developers.google.com/chat/images/quickstart-app-avatar.png را وارد کنید.
3. در توضیحات ، Quickstart app وارد کنید.
4. در بخش عملکرد ، دریافت پیام های 1:1 و پیوستن به فضاها و مکالمات گروهی را انتخاب کنید.
5. در تنظیمات اتصال ، Cloud Pub/Sub را انتخاب کنید و نام موضوع Pub/Sub را که قبلا ایجاد کرده‌اید، جای‌گذاری کنید.
6. در قسمت Visibility ، این برنامه Google Chat را برای افراد و گروه‌های خاصی در دامنه خود در دسترس قرار دهید را انتخاب کنید و آدرس ایمیل خود را وارد کنید.
7. در زیر گزارش‌ها ، Log errors to Logging را انتخاب کنید.
روی ذخیره کلیک کنید.

این برنامه برای دریافت و پاسخ به پیام ها در چت آماده است.

اسکریپت را اجرا کنید

در یک CLI، به دایرکتوری کاری خود بروید و اسکریپت را اجرا کنید:

جاوا

mvn compile exec:java -Dexec.mainClass=Main

هنگامی که کد را اجرا می کنید، برنامه شروع به گوش دادن به پیام های منتشر شده در موضوع Pub/Sub می کند.

برنامه چت خود را تست کنید

برای آزمایش برنامه چت خود، یک فضای پیام مستقیم با برنامه چت باز کنید و یک پیام ارسال کنید:

Google Chat را با استفاده از حساب Google Workspace که هنگام اضافه کردن خود به عنوان آزمایش‌کننده معتمد ارائه کرده‌اید، باز کنید.
به Google Chat بروید
روی گپ جدید کلیک کنید.
در قسمت افزودن 1 یا چند نفر ، نام برنامه چت خود را تایپ کنید.
برنامه چت خود را از نتایج انتخاب کنید. یک پیام مستقیم باز می شود.
توجه: اگر برنامه Chat خود را در لیست نتایج نمی‌بینید، مطمئن شوید که حساب Google Workspace خود را در تنظیمات Visibility صفحه پیکربندی Chat API در کنسول Google Cloud قرار داده‌اید.
در پیام مستقیم جدید با برنامه، Hello تایپ کرده و enter فشار دهید.

برای افزودن آزمایش‌کنندگان مورد اعتماد و کسب اطلاعات بیشتر درباره آزمایش ویژگی‌های تعاملی، به تست ویژگی‌های تعاملی برای برنامه‌های گپ Google مراجعه کنید.

عیب یابی

وقتی یک برنامه یا کارت Google Chat خطایی را برمی‌گرداند، رابط Chat پیامی را نشان می‌دهد که می‌گوید «مشکلی پیش آمده است». یا "نمی توان به درخواست شما رسیدگی کرد." گاهی اوقات Chat UI هیچ پیام خطایی را نمایش نمی دهد، اما برنامه یا کارت Chat نتیجه غیرمنتظره ای ایجاد می کند. برای مثال، ممکن است پیام کارت ظاهر نشود.

اگرچه ممکن است پیام خطا در رابط کاربری گپ نمایش داده نشود، پیام‌های خطای توصیفی و داده‌های گزارش در دسترس هستند تا به شما کمک کنند هنگام فعال بودن ثبت خطا برای برنامه‌های گپ، خطاها را برطرف کنید. برای راهنمایی برای مشاهده، اشکال‌زدایی و رفع خطاها، به عیب‌یابی و رفع خطاهای Google Chat مراجعه کنید.

پاک کردن

برای جلوگیری از تحمیل هزینه به حساب Google Cloud خود برای منابع استفاده شده در این آموزش، توصیه می کنیم پروژه Cloud را حذف کنید.

احتیاط: حذف یک پروژه دارای اثرات زیر است:

همه چیز در پروژه حذف می شود. اگر از یک پروژه موجود برای این آموزش استفاده کرده اید، وقتی آن را حذف می کنید، هر کار دیگری را که در پروژه انجام داده اید نیز حذف می کنید.
شناسه های پروژه سفارشی گم می شوند. وقتی این پروژه را ایجاد کردید، ممکن است یک ID پروژه سفارشی ایجاد کرده باشید که می خواهید در آینده از آن استفاده کنید. برای حفظ URL هایی که از شناسه پروژه استفاده می کنند، مانند URL در appspot.com، به جای حذف کل پروژه، منابع انتخاب شده در داخل پروژه را حذف کنید.

اگر قصد دارید چندین آموزش و شروع سریع را کاوش کنید، استفاده مجدد از پروژه ها می تواند به شما کمک کند از فراتر رفتن از محدودیت های سهمیه پروژه جلوگیری کنید.

در کنسول Google Cloud، به صفحه مدیریت منابع بروید. روی > IAM & Admin > Manage Resources کلیک کنید.
به Resource Manager بروید
در لیست پروژه، پروژه ای را که می خواهید حذف کنید انتخاب کنید و سپس روی حذف کلیک کنید.
در گفتگو، ID پروژه را تایپ کنید و سپس بر روی Shut down کلیک کنید تا پروژه حذف شود.

مطالب مرتبط

برای افزودن ویژگی‌های بیشتر به برنامه چت، موارد زیر را ببینید:
- پیام های کارت تعاملی ایجاد کنید
- به دستورات اسلش پاسخ دهید
معماری برنامه چت را انتخاب کنید