نشر الموصِّل

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

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

غيِّر دليل العمل إلى cloud-search-samples/end-to-end/connector directory ونفِّذ هذا الأمر:

mvn package -DskipTests

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

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

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

1. ارجع إلى Google Cloud Console.
2. في شريط التنقّل الأيمن، انقر على بيانات الاعتماد. تظهر صفحة "بيانات الاعتماد".
3. انقر على القائمة المنسدلة + إنشاء بيانات اعتماد واختَر حساب الخدمة. ستظهر لك صفحة "إنشاء حساب خدمة".
4. في الحقل اسم حساب الخدمة، أدخِل "البرنامج التعليمي".
5. سجِّل قيمة رقم تعريف حساب الخدمة (بعد اسم حساب الخدمة مباشرةً). يتم استخدام هذه القيمة لاحقًا.
6. انقر على إنشاء. سيظهر مربّع الحوار "أذونات حساب الخدمة (اختيارية)".
7. انقر على متابعة. يظهر مربّع الحوار "منح المستخدمين إذن الوصول إلى حساب الخدمة هذا (اختياري)".
8. انقر على تم. تظهر شاشة "بيانات الاعتماد".
9. ضمن "حسابات الخدمة"، انقر على عنوان البريد الإلكتروني لحساب الخدمة. تظهر صفحة "تفاصيل حساب العميل الخدمة".
10. ضمن "المفاتيح"، انقر على القائمة المنسدلة إضافة مفتاح واختَر إنشاء مفتاح جديد. يظهر مربّع الحوار "إنشاء مفتاح خاص".
11. انقر على إنشاء.
12. (اختياري) إذا ظهر مربّع الحوار "هل تريد السماح بالتنزيلات على console.cloud.google.com؟"، انقر على السماح.
13. يتم حفظ ملف المفتاح الخاص على جهاز الكمبيوتر. دوِّن الموقع الجغرافي للملف الذي تم تنزيله. يُستخدَم هذا الملف لضبط موصِّل المحتوى كي تتمكّن من مصادقة نفسها عند استدعاء Google Cloud Search APIs.

بدء دعم الجهات الخارجية

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

ملاحظة: إذا تم تنفيذ دليل Cloud Search التعليمي بنجاح، يعني هذا أنّه سبق لك إعداد دعم الجهات الخارجية لـ Cloud Search ويمكنك تخطي هذه الخطوة.

لبدء استخدام ميزة "البحث في Cloud" مع تطبيقات تابعة لجهات خارجية، اتّبِع الخطوات التالية:

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

2. استخدِم مساحة OAuth 2 في Google للحصول على رمز دخول:

   1. انقر على الإعدادات وضع علامة في المربّع استخدِم بيانات اعتماد المصادقة الخاصة بك.
   2. أدخِل معرِّف العميل وسر العميل من الخطوة 1.
   3. انقر على إغلاق (Close).
   4. في حقل النطاقات، اكتب https://www.googleapis.com/auth/cloud_search.settings وانقر على تفويض. تعرض واجهة OAuth 2 رمز تفويض.
   5. انقر على Exchange authorization code for tokens (تبديل رمز التفويض بالرموز المميّزة). يتم عرض رمز مميّز.

3. لبدء استخدام واجهة برمجة التطبيقات التابعة لجهة خارجية مع Cloud Search، استخدِم الأمر curl التالي. احرص على استبدال [YOUR_ACCESS_TOKEN] بالرمز المميّز الذي تم الحصول عليه في الخطوة 2.

   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. على سبيل المثال:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   }
   

   إذا لم تنجح، يُرجى التواصل مع فريق دعم Cloud Search.

4. استخدِم operations.get للتأكّد من أنّه تمت بدء معالجة طلبات المساعدة التابعة لجهات خارجية:

   curl \
   'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
   [YOUR_API_KEY]' \
   --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
   --header 'Accept: application/json' \
   --compressed
   

   عند اكتمال عملية الإعداد التابعة لجهة خارجية، يتم ضبط الحقل done على true. على سبيل المثال:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   done: true
   }
   

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

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

ملاحظة: يجب أن ينفّذ مشرف النطاق هذه الخطوات.

1. افتح وحدة تحكّم المشرف في Google.
2. انقر على رمز التطبيقات. تظهر صفحة "إدارة التطبيقات".
3. انقر على Google Workspace. تظهر صفحة "إدارة تطبيقات Google Workspace".
4. انتقِل للأسفل وانقر على Cloud Search. تظهر صفحة "إعدادات Google Workspace" .
5. انقر على مصادر بيانات الجهات الخارجية. تظهر صفحة "مصادر البيانات".
6. انقر على الرمز الدائري الأصفر +. سيظهر مربّع الحوار "إضافة مصدر بيانات جديد".
7. في حقل الاسم المعروض، اكتب "tutorial".
8. في حقل عناوين البريد الإلكتروني لحساب الخدمة، أدخِل عنوان البريد الإلكتروني لحساب الخدمة الذي أنشأته في القسم السابق. إذا لم تكن تعرف عنوان البريد الإلكتروني لحساب الخدمة، ابحث عن القيمة في صفحة حسابات الخدمة.
9. انقر على إضافة. يظهر مربّع الحوار "تمّ إنشاء مصدر البيانات بنجاح".
10. انقر على حسنًا. دوِّن رقم تعريف المصدر لمصدر البيانات الذي تم إنشاؤه حديثًا. يُستخدم معرّف المصدر في ضبط موصِّل المحتوى.

إنشاء رمز دخول شخصي لواجهة GitHub API

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

1. سجِّل الدخول إلى GitHub.
2. في أعلى يسار الصفحة، انقر على صورة ملفك الشخصي. ستظهر قائمة منسدلة.
3. انقر على الإعدادات.
4. انقر على إعدادات المطوّر.
5. انقر على رموز الوصول الشخصية.
6. انقر على إنشاء رمز دخول شخصي.
7. في الحقل ملاحظة، أدخِل "الدليل التوجيهي حول Cloud Search".
8. تحقَّق من نطاق public_repo.
9. انقر على إنشاء رمز مميّز.
10. سجِّل الرمز المميّز الذي تم إنشاؤه. ويستخدمه الموصّل لاستدعاء واجهات برمجة تطبيقات GitHub ويقدّم حصة واجهة برمجة التطبيقات لإجراء الفهرسة.

ضبط الموصّل

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

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

تعديل المخطّط

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

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 لحزمة SDK وتشغِّلها.

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 الذي تقدّمه حزمة SDK ينفّذ استراتيجية تنقّل تستفيد من قوائم انتظار Cloud Search لتتبُّع حالة العناصر في الفهرس. وتفوّض هذه الوظيفة إلى GithubRepository، الذي ينفّذه موصل النماذج، للوصول إلى المحتوى من GitHub.

التنقّل في مستودعات 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 repo واحد. تعرض هذه الطريقة مجموعة من 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();
}

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

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