نشر الموصِّل

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

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

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

mvn package -DskipTests

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

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

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

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

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

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

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

لبدء دعم الجهات الخارجية، اتّبِع الخطوات التالية:

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

3. نفِّذ أمر 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.

4. استخدِم 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.

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

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

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

1. افتح وحدة تحكّم المشرف في Google.
2. انقر على رمز "التطبيقات". ستظهر صفحة "إدارة التطبيقات".
3. انقر على Google Workspace. ستظهر صفحة "إدارة تطبيقات Google Workspace".
4. انتقِل للأسفل وانقر على Cloud Search. ستظهر صفحة "إعدادات Google Workspace".
5. انقر على مصادر بيانات الجهات الخارجية. تظهر صفحة "مصادر البيانات".
6. انقر على الدائرة الصفراء التي تحمل علامة +. سيظهر مربّع الحوار "إضافة مصدر بيانات جديد".
7. في حقل الاسم المعروض، اكتب "برنامج تعليمي".
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 واحد. يعرض هذا الإجراء مجموعة من 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();
}

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

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