نشر الموصِّل

توضّح هذه الصفحة من الدليل التوجيهي لخدمة Cloud Search كيفية إعداد مصدر بيانات وموصّل محتوى لفهرسة البيانات. للبدء من بداية هذا الدليل التوجيهي، يُرجى الرجوع إلى الدليل التوجيهي لبدء استخدام Cloud Search

إنشاء الموصّل

غيِّر دليل العمل إلى الدليل cloud-search-samples/end-to-end/connector وشغِّل الأمر التالي:

mvn package -DskipTests

يؤدي هذا الأمر إلى تنزيل التبعيات المطلوبة لإنشاء موصّل المحتوى وتجميع الرمز.

إنشاء بيانات اعتماد حساب الخدمة

يتطلّب الموصّل بيانات اعتماد حساب الخدمة لاستدعاء واجهات برمجة تطبيقات Cloud Search. لإنشاء بيانات الاعتماد:

عُد إلى Google Cloud Console.
في شريط التنقل الأيمن، انقر على بيانات الاعتماد. ستظهر صفحة "بيانات الاعتماد".
انقر على القائمة المنسدلة + إنشاء بيانات اعتماد واختَر حساب الخدمة. ستظهر صفحة "إنشاء حساب خدمة".
في حقل اسم حساب الخدمة ، أدخِل "الدليل التوجيهي".
دوِّن قيمة "رقم تعريف حساب الخدمة" (بعد "اسم حساب الخدمة" مباشرةً). سيتم استخدام هذه القيمة لاحقًا.
انقر على إنشاء. سيظهر مربّع الحوار "أذونات حساب الخدمة (اختيارية)".
انقر على متابعة. سيظهر مربّع الحوار "منح المستخدمين إذن الوصول إلى حساب الخدمة هذا (اختياري)".
انقر على تم. ستظهر شاشة "بيانات الاعتماد".
ضمن "حسابات الخدمة"، انقر على عنوان البريد الإلكتروني لحساب الخدمة. ستظهر صفحة "تفاصيل حساب الخدمة".
ضمن "المفاتيح"، انقر على القائمة المنسدلة إضافة مفتاح واختَر إنشاء مفتاح جديد. سيظهر مربّع الحوار "إنشاء مفتاح خاص".
انقر على إنشاء.
(اختياري) إذا ظهر مربّع الحوار "هل تريد السماح بعمليات التنزيل على console.cloud.google.com؟"، انقر على السماح.
يتم حفظ ملف مفتاح خاص على جهاز الكمبيوتر. دوِّن موقع الملف الذي تم تنزيله. يُستخدَم هذا الملف لضبط موصّل المحتوى حتى يتمكّن من المصادقة على نفسه عند استدعاء واجهات برمجة تطبيقات Google Cloud Search.

تهيئة إمكانية استخدام خدمات الجهات الخارجية

يجب تهيئة إمكانية استخدام خدمات الجهات الخارجية في Google Cloud Search قبل استدعاء أيّ من واجهات برمجة تطبيقات Cloud Search الأخرى.

لتهيئة إمكانية استخدام خدمات الجهات الخارجية:

أنشئ بيانات اعتماد لتطبيق الويب في مشروع منصة Cloud Search. راجِع إنشاء بيانات اعتماد. تحتاج إلى معرّف العميل وسر العميل.
احصل على رمز دخول باستخدام الـ OAuth 2.0 Playground:
1. انقر على إعدادات OAuth 2.0 (رمز الإعدادات) وعلِّم على استخدام بيانات اعتماد OAuth الخاصة بك.
2. أدخِل معرّف العميل وسر العميل.
3. في حقل النطاقات، أدخِل https://www.googleapis.com/auth/cloud_search.settings وانقر على تفويض واجهات برمجة التطبيقات.
4. انقر على تبديل رمز التفويض بالرموز المميّزة.
شغِّل أمر curl هذا، مع استبدال [YOUR_ACCESS_TOKEN] بالرمز المميّز:
```
curl --request POST \
'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed
```
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على operation. إذا تعذّر ذلك، يُرجى التواصل مع فريق دعم Cloud Search.

استخدِم operations.get للتحقّق من التهيئة:

curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressed

تكتمل التهيئة عندما تكون قيمة done هي true.

إنشاء مصدر البيانات

بعد ذلك، أنشئ مصدر بيانات في وحدة تحكّم المشرف. يوفر مصدر البيانات مساحة اسم لفهرسة المحتوى باستخدام الموصّل.

افتح وحدة تحكّم المشرف في Google.
انقر على رمز "التطبيقات". ستظهر صفحة "إدارة التطبيقات".
انقر على Google Workspace. ستظهر صفحة "إدارة تطبيقات Google Workspace".
انتقِل إلى أسفل الصفحة وانقر على Cloud Search. ستظهر صفحة "إعدادات Google Workspace".
انقر على مصادر بيانات الجهات الخارجية. ستظهر صفحة "مصادر البيانات".
انقر على الرمز + الأصفر المستدير. سيظهر مربّع الحوار "إضافة مصدر بيانات جديد".
في حقل الاسم المعروض ، اكتب "الدليل التوجيهي".
في حقل عناوين البريد الإلكتروني لحسابات الخدمة ، أدخِل عنوان البريد الإلكتروني لحساب الخدمة الذي أنشأته في القسم السابق. إذا كنت لا تعرف الـ بريد الإلكتروني لحساب الخدمة، ابحث عن القيمة في صفحة حسابات الخدمة.
انقر على إضافة. سيظهر مربّع الحوار "تم إنشاء مصدر البيانات بنجاح".
انقر على *حسنًا. دوِّن رقم تعريف المصدر لمصدر البيانات الذي تم إنشاؤه حديثًا. يُستخدَم رقم تعريف المصدر لضبط موصّل المحتوى.

إنشاء رمز دخول شخصي لواجهة برمجة تطبيقات GitHub

يتطلّب الموصّل وصولاً مصادقًا إلى واجهة برمجة تطبيقات GitHub للحصول على حصة كافية. لتبسيط العملية، يستخدِم الموصّل رموز الدخول الشخصية بدلاً من OAuth. تسمح الرموز الشخصية بالمصادقة كمستخدم لديه مجموعة محدودة من الأذونات مشابهة لـ OAuth.

سجِّل الدخول إلى GitHub.
في أعلى يسار الصفحة، انقر على صورة ملفك الشخصي. ستظهر قائمة منسدلة.
انقر على الإعدادات.
انقر على إعدادات المطوِّر.
انقر على رموز الدخول الشخصية.
انقر على إنشاء رمز دخول شخصي.
في حقل ملاحظة ، أدخِل "الدليل التوجيهي لخدمة Cloud Search".
علِّم على نطاق public_repo.
انقر على إنشاء الرمز المميز.
دوِّن الرمز المميز الذي تم إنشاؤه. يستخدمه الموصّل لاستدعاء واجهات برمجة تطبيقات GitHub ويوفر حصة واجهة برمجة التطبيقات لإجراء الفهرسة.

ضبط الموصّل

بعد إنشاء بيانات الاعتماد ومصدر البيانات، عدِّل إعدادات الموصّل لتضمين هذه القيم:

من سطر الأوامر، غيِّر الدليل إلى cloud-search-samples/end-to-end/connector/.
افتح الملف sample-config.properties باستخدام محرِّر نصوص.
اضبط المَعلمة api.serviceAccountPrivateKeyFile على مسار ملف بيانات اعتماد الخدمة التي نزّلتها سابقًا.
اضبط المَعلمة api.sourceId على رقم تعريف مصدر البيانات الذي أنشأته سابقًا.
اضبط المَعلمة github.user على اسم المستخدم الخاص بك على GitHub.
اضبط المَعلمة github.token على رمز الدخول الذي أنشأته سابقًا.
احفظ الملف.

تعديل المخطط

يفهرس الموصّل المحتوى المنظَّم وغير المنظَّم. قبل فهرسة البيانات، يجب تعديل مخطط مصدر البيانات. شغِّل الأمر التالي لتعديل المخطط:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
    -Dexec.args="-Dconfig=sample-config.properties"

تشغيل الموصّل

لتشغيل الموصّل وبدء الفهرسة، شغِّل الأمر:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
    -Dexec.args="-Dconfig=sample-config.properties"

الإعدادات التلقائية للموصّل هي فهرسة مستودع واحد في مؤسسة googleworkspace. تستغرق فهرسة المستودع دقيقة واحدة تقريبًا. بعد الفهرسة الأولية، يواصل الموصّل التحقّق من التغييرات التي تطرأ على المستودع والتي يجب أن تظهر في فهرس Cloud Search.

مراجعة الرمز

تتناول الأقسام المتبقية كيفية إنشاء الموصّل.

بدء التطبيق

نقطة الدخول إلى الموصّل هي الفئة GithubConnector. تنشئ طريقة main مثيلاً من IndexingApplication في حزمة تطوير البرامج وتبدأه.

GithubConnector.java

عرض على GitHub

/**
 * Main entry point for the connector. Creates and starts an indexing
 * application using the {@code ListingConnector} template and the sample's
 * custom {@code Repository} implementation.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new GithubRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args)
      .build();
  application.start();
}

ListingConnector الذي توفّره حزمة تطوير البرامج تنفّذ استراتيجية اجتياز تستخدِم قوائم انتظار Cloud Search لتتبُّع حالة العناصر في الفهرس. وتفوِّض هذه الاستراتيجية الوصول إلى المحتوى من GitHub إلى GithubRepository الذي ينفّذه موصّل النموذج.

اجتياز مستودعات GitHub

أثناء عمليات المسح الكاملة، يتم استدعاء الطريقة getIds() لإرسال العناصر التي قد تحتاج إلى الفهرسة إلى قائمة الانتظار.

يمكن للموصّل فهرسة مستودعات أو مؤسسات متعددة. للحدّ من تأثير حدوث خطأ، يتم اجتياز مستودع GitHub واحد في كل مرة. يتم عرض نقطة تحقّق مع نتائج الاجتياز تحتوي على قائمة المستودعات التي سيتم فهرستها في عمليات الاستدعاء اللاحقة لـ getIds(). في حال حدوث خطأ، يتم استئناف الفهرسة في المستودع الحالي بدلاً من البدء من جديد.

GithubRepository.java

عرض على GitHub

/**
 * Gets all of the existing item IDs from the data repository. While
 * multiple repositories are supported, only one repository is traversed
 * per call. The remaining repositories are saved in the checkpoint
 * are traversed on subsequent calls. This minimizes the amount of
 * data that needs to be reindex in the event of an error.
 *
 * <p>This method is called by {@link ListingConnector#traverse()} during
 * <em>full traversals</em>. Every document ID and metadata hash value in
 * the <em>repository</em> is pushed to the Cloud Search queue. Each pushed
 * document is later polled and processed in the {@link #getDoc(Item)} method.
 * <p>
 * The metadata hash values are pushed to aid document change detection. The
 * queue sets the document status depending on the hash comparison. If the
 * pushed ID doesn't yet exist in Cloud Search, the document's status is
 * set to <em>new</em>. If the ID exists but has a mismatched hash value,
 * its status is set to <em>modified</em>. If the ID exists and matches
 * the hash value, its status is unchanged.
 *
 * <p>In every case, the pushed content hash value is only used for
 * comparison. The hash value is only set in the queue during an
 * update (see {@link #getDoc(Item)}).
 *
 * @param checkpoint value defined and maintained by this connector
 * @return this is typically a {@link PushItems} instance
 */
@Override
public CheckpointCloseableIterable<ApiOperation> getIds(byte[] checkpoint)
    throws RepositoryException {
  List<String> repositories;
  // Decode the checkpoint if present to get the list of remaining
  // repositories to index.
  if (checkpoint != null) {
    try {
      FullTraversalCheckpoint decodedCheckpoint = FullTraversalCheckpoint
          .fromBytes(checkpoint);
      repositories = decodedCheckpoint.getRemainingRepositories();
    } catch (IOException e) {
      throw new RepositoryException.Builder()
          .setErrorMessage("Unable to deserialize checkpoint")
          .setCause(e)
          .build();
    }
  } else {
    // No previous checkpoint, scan for repositories to index
    // based on the connector configuration.
    try {
      repositories = scanRepositories();
    } catch (IOException e) {
      throw toRepositoryError(e, Optional.of("Unable to scan repositories"));
    }
  }

  if (repositories.isEmpty()) {
    // Nothing left to index. Reset the checkpoint to null so the
    // next full traversal starts from the beginning
    Collection<ApiOperation> empty = Collections.emptyList();
    return new CheckpointCloseableIterableImpl.Builder<>(empty)
        .setCheckpoint((byte[]) null)
        .setHasMore(false)
        .build();
  }

  // Still have more repositories to index. Pop the next repository to
  // index off the list. The remaining repositories make up the next
  // checkpoint.
  String repositoryToIndex = repositories.get(0);
  repositories = repositories.subList(1, repositories.size());

  try {
    log.info(() -> String.format("Traversing repository %s", repositoryToIndex));
    Collection<ApiOperation> items = collectRepositoryItems(repositoryToIndex);
    FullTraversalCheckpoint newCheckpoint = new FullTraversalCheckpoint(repositories);
    return new CheckpointCloseableIterableImpl.Builder<>(items)
        .setHasMore(true)
        .setCheckpoint(newCheckpoint.toBytes())
        .build();
  } catch (IOException e) {
    String errorMessage = String.format("Unable to traverse repo: %s",
        repositoryToIndex);
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

تتعامل الطريقة collectRepositoryItems() مع اجتياز مستودع GitHub واحد. تعرض هذه الطريقة مجموعة من ApiOperations تمثّل العناصر التي سيتم إرسالها إلى قائمة الانتظار. يتم إرسال العناصر كاسم مورد وقيمة تجزئة تمثّل الحالة الحالية للعنصر.

تُستخدَم قيمة التجزئة في عمليات الاجتياز اللاحقة لمستودعات GitHub. توفر هذه القيمة عملية تحقّق بسيطة لتحديد ما إذا كان المحتوى قد تغيّر بدون الحاجة إلى تحميل محتوى إضافي. يضع الموصّل جميع العناصر في قائمة الانتظار بدون تمييز. إذا كان العنصر جديدًا أو تغيّرت قيمة التجزئة، يصبح متاحًا للاستطلاع في قائمة الانتظار. وإلا، يتم اعتبار العنصر غير معدَّل.

GithubRepository.java

عرض على GitHub

/**
 * Fetch IDs to  push in to the queue for all items in the repository.
 * Currently captures issues & content in the master branch.
 *
 * @param name Name of repository to index
 * @return Items to push into the queue for later indexing
 * @throws IOException if error reading issues
 */
private Collection<ApiOperation> collectRepositoryItems(String name)
    throws IOException {
  List<ApiOperation> operations = new ArrayList<>();
  GHRepository repo = github.getRepository(name);

  // Add the repository as an item to be indexed
  String metadataHash = repo.getUpdatedAt().toString();
  String resourceName = repo.getHtmlUrl().getPath();
  PushItem repositoryPushItem = new PushItem()
      .setMetadataHash(metadataHash);
  PushItems items = new PushItems.Builder()
      .addPushItem(resourceName, repositoryPushItem)
      .build();

  operations.add(items);
  // Add issues/pull requests & files
  operations.add(collectIssues(repo));
  operations.add(collectContent(repo));
  return operations;
}

معالجة قائمة الانتظار

بعد اكتمال عملية الاجتياز الكاملة، يبدأ الموصّل في استطلاع قائمة الانتظار بحثًا عن العناصر التي يجب فهرستها. يتم استدعاء الطريقة getDoc() لكل عنصر يتم سحبه من قائمة الانتظار. تقرأ هذه الطريقة العنصر من GitHub وتحوِّله إلى التمثيل المناسب للفهرسة.

بما أنّ الموصّل يعمل على بيانات مباشرة قد يتم تغييرها في أي وقت، تتحقّق الطريقة getDoc() أيضًا من أنّ العنصر في قائمة الانتظار لا يزال صالحًا وتحذف أي عناصر من الفهرس لم تعُد موجودة.

GithubRepository.java

عرض على GitHub

/**
 * Gets a single data repository item and indexes it if required.
 *
 * <p>This method is called by the {@link ListingConnector} during a poll
 * of the Cloud Search queue. Each queued item is processed
 * individually depending on its state in the data repository.
 *
 * @param item the data repository item to retrieve
 * @return the item's state determines which type of
 * {@link ApiOperation} is returned:
 * {@link RepositoryDoc}, {@link DeleteItem}, or {@link PushItem}
 */
@Override
public ApiOperation getDoc(Item item) throws RepositoryException {
  log.info(() -> String.format("Processing item: %s ", item.getName()));
  Object githubObject;
  try {
    // Retrieve the item from GitHub
    githubObject = getGithubObject(item.getName());
    if (githubObject instanceof GHRepository) {
      return indexItem((GHRepository) githubObject, item);
    } else if (githubObject instanceof GHPullRequest) {
      return indexItem((GHPullRequest) githubObject, item);
    } else if (githubObject instanceof GHIssue) {
      return indexItem((GHIssue) githubObject, item);
    } else if (githubObject instanceof GHContent) {
      return indexItem((GHContent) githubObject, item);
    } else {
      String errorMessage = String.format("Unexpected item received: %s",
          item.getName());
      throw new RepositoryException.Builder()
          .setErrorMessage(errorMessage)
          .setErrorType(RepositoryException.ErrorType.UNKNOWN)
          .build();
    }
  } catch (FileNotFoundException e) {
    log.info(() -> String.format("Deleting item: %s ", item.getName()));
    return ApiOperations.deleteItem(item.getName());
  } catch (IOException e) {
    String errorMessage = String.format("Unable to retrieve item: %s",
        item.getName());
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

لكل من كائنات GitHub التي يفهرسها الموصّل، تتعامل طريقة indexItem() المقابلة مع إنشاء تمثيل العنصر لخدمة Cloud Search. على سبيل المثال، لإنشاء التمثيل لعناصر المحتوى:

GithubRepository.java

عرض على GitHub

/**
 * Build the ApiOperation to index a content item (file).
 *
 * @param content      Content item to index
 * @param previousItem Previous item state in the index
 * @return ApiOperation (RepositoryDoc if indexing,  PushItem if not modified)
 * @throws IOException if unable to create operation
 */
private ApiOperation indexItem(GHContent content, Item previousItem)
    throws IOException {
  String metadataHash = content.getSha();

  // If previously indexed and unchanged, just requeue as unmodified
  if (canSkipIndexing(previousItem, metadataHash)) {
    return notModified(previousItem.getName());
  }

  String resourceName = new URL(content.getHtmlUrl()).getPath();
  FieldOrValue<String> title = FieldOrValue.withValue(content.getName());
  FieldOrValue<String> url = FieldOrValue.withValue(content.getHtmlUrl());

  String containerName = content.getOwner().getHtmlUrl().getPath();
  String programmingLanguage = FileExtensions.getLanguageForFile(content.getName());

  // Structured data based on the schema
  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("organization", content.getOwner().getOwnerName());
  structuredData.put("repository", content.getOwner().getName());
  structuredData.put("path", content.getPath());
  structuredData.put("language", programmingLanguage);

  Item item = IndexingItemBuilder.fromConfiguration(resourceName)
      .setTitle(title)
      .setContainerName(containerName)
      .setSourceRepositoryUrl(url)
      .setItemType(IndexingItemBuilder.ItemType.CONTAINER_ITEM)
      .setObjectType("file")
      .setValues(structuredData)
      .setVersion(Longs.toByteArray(System.currentTimeMillis()))
      .setHash(content.getSha())
      .build();

  // Index the file content too
  String mimeType = FileTypeMap.getDefaultFileTypeMap()
      .getContentType(content.getName());
  AbstractInputStreamContent fileContent = new InputStreamContent(
      mimeType, content.read())
      .setLength(content.getSize())
      .setCloseInputStream(true);
  return new RepositoryDoc.Builder()
      .setItem(item)
      .setContent(fileContent, IndexingService.ContentFormat.RAW)
      .setRequestMode(IndexingService.RequestMode.SYNCHRONOUS)
      .build();
}

بعد ذلك، انشر واجهة البحث.

السابق التالي

نشر الموصِّل تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

إنشاء الموصّل

إنشاء بيانات اعتماد حساب الخدمة

تهيئة إمكانية استخدام خدمات الجهات الخارجية

إنشاء مصدر البيانات

إنشاء رمز دخول شخصي لواجهة برمجة تطبيقات GitHub

ضبط الموصّل

تعديل المخطط

تشغيل الموصّل

مراجعة الرمز

بدء التطبيق

اجتياز مستودعات GitHub

معالجة قائمة الانتظار

نشر الموصِّل