کانکتور را مستقر کنید

این صفحه از آموزش Cloud Search نحوه راه‌اندازی یک منبع داده و رابط محتوا برای فهرست کردن داده‌ها را نشان می‌دهد. برای شروع از ابتدای این آموزش، به آموزش شروع به کار Cloud Search مراجعه کنید

کانکتور را بسازید

دایرکتوری کاری خود را به دایرکتوری cloud-search-samples/end-to-end/connector تغییر دهید و این دستور را اجرا کنید:

mvn package -DskipTests

این فرمان وابستگی های مورد نیاز برای ساخت کانکتور محتوا را دانلود کرده و کد را کامپایل می کند.

اعتبار حساب سرویس ایجاد کنید

رابط برای فراخوانی Cloud Search API به اعتبارنامه حساب سرویس نیاز دارد. برای ایجاد اعتبار:

1. به کنسول Google Cloud برگردید.
2. در پیمایش سمت چپ، روی اعتبارنامه کلیک کنید. صفحه "Credential" ظاهر می شود.
3. روی فهرست کشویی + ایجاد اعتبارنامه کلیک کنید و حساب سرویس را انتخاب کنید. صفحه "ایجاد حساب سرویس" ظاهر می شود.
4. در قسمت نام حساب سرویس ، "آموزش" را وارد کنید.
5. به مقدار شناسه حساب سرویس (درست بعد از نام حساب سرویس) توجه کنید. این مقدار بعدا استفاده می شود.
6. روی CREATE کلیک کنید. گفتگوی "مجوزهای حساب سرویس (اختیاری)" ظاهر می شود.
7. روی ادامه کلیک کنید. گفتگوی "اعطای دسترسی کاربران به این حساب سرویس (اختیاری)" ظاهر می شود.
8. روی انجام شد کلیک کنید. صفحه "Credentials" ظاهر می شود.
9. در قسمت Service Accounts، روی ایمیل حساب سرویس کلیک کنید. صفحه "جزئیات حساب سرویس" ظاهر می شود.
10. در زیر کلیدها، روی لیست کشویی ADD KEY کلیک کنید و Create new key را انتخاب کنید. گفتگوی "ایجاد کلید خصوصی" ظاهر می شود.
11. روی CREATE کلیک کنید.
12. (اختیاری) اگر "آیا می خواهید بارگیری ها را در console.cloud.google.com مجاز کنید؟" گفتگو ظاهر می شود، روی Allow کلیک کنید.
13. یک فایل کلید خصوصی در رایانه شما ذخیره می شود. به محل فایل دانلود شده توجه کنید. این فایل برای پیکربندی رابط محتوا استفاده می‌شود تا بتواند هنگام فراخوانی Google Cloud Search API خود را احراز هویت کند.

پشتیبانی شخص ثالث را راه اندازی کنید

قبل از اینکه بتوانید با هر API دیگری Cloud Search تماس بگیرید، باید پشتیبانی شخص ثالث را برای Google Cloud Search راه اندازی کنید.

توجه: اگر آموزش Cloud Search را با موفقیت اجرا کردید، قبلاً پشتیبانی شخص ثالث را برای Cloud Search راه اندازی کرده اید و می توانید از این مرحله رد شوید.

برای راه اندازی پشتیبانی شخص ثالث برای Cloud Search:

1. پروژه پلتفرم Cloud Search شما حاوی اطلاعات کاربری حساب سرویس است. با این حال، به خاطر مقداردهی اولیه پشتیبانی شخص ثالث، باید اعتبار برنامه وب را ایجاد کنید. برای دستورالعمل‌های مربوط به نحوه ایجاد اعتبارنامه برنامه وب، به ایجاد اعتبارنامه مراجعه کنید. پس از انجام این مرحله، باید یک شناسه مشتری و فایل مخفی مشتری داشته باشید.

2. از زمین بازی OAuth 2 Google برای دریافت رمز دسترسی استفاده کنید:

   1. روی تنظیمات کلیک کنید و User your own auth credentials را علامت بزنید.
   2. شناسه مشتری و رمز سرویس گیرنده را از مرحله 1 وارد کنید.
   3. روی Close کلیک کنید.
   4. در قسمت scopes، https://www.googleapis.com/auth/cloud_search.settings را تایپ کنید و روی تأیید کلیک کنید. زمین بازی OAuth 2 یک کد مجوز را برمی گرداند.
   5. روی کد مجوز تبادل برای توکن‌ها کلیک کنید. یک توکن برگردانده می شود.

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 Admin را باز کنید.
2. روی نماد برنامه ها کلیک کنید. صفحه "Apps Administration" ظاهر می شود.
3. روی Google Workspace کلیک کنید. صفحه "Apps Google Workspace Administration" ظاهر می شود.
4. به پایین بروید و روی Cloud Search کلیک کنید. صفحه "تنظیمات Google Workspace" ظاهر می شود.
5. روی منابع داده شخص ثالث کلیک کنید. صفحه "منابع داده" ظاهر می شود.
6. روی زرد گرد + کلیک کنید. گفتگوی "افزودن منبع داده جدید" ظاهر می شود.
7. در قسمت نمایش نام ، عبارت "tutorial" را تایپ کنید.
8. در قسمت آدرس های ایمیل حساب سرویس ، آدرس ایمیل اکانت سرویسی که در قسمت قبلی ایجاد کرده اید را وارد کنید. اگر آدرس ایمیل حساب سرویس را نمی‌دانید، مقدار آن را در صفحه حساب‌های سرویس جستجو کنید.
9. روی ADD کلیک کنید. گفتگوی "منبع داده با موفقیت ایجاد شد" ظاهر می شود.
10. روی * OK کلیک کنید. به شناسه منبع برای منبع داده جدید ایجاد شده توجه کنید. شناسه منبع برای پیکربندی کانکتور محتوا استفاده می شود.

یک نشانه دسترسی شخصی برای API GitHub ایجاد کنید

برای داشتن سهمیه کافی، کانکتور نیاز به دسترسی تأیید شده به GitHub API دارد. برای سادگی، کانکتور به جای OAuth از نشانه های دسترسی شخصی استفاده می کند. توکن های شخصی امکان احراز هویت را به عنوان کاربر با مجموعه محدودی از مجوزهای مشابه OAuth می دهند.

1. وارد GitHub شوید.
2. در گوشه سمت راست بالا، روی عکس نمایه خود کلیک کنید. یک منوی کشویی ظاهر می شود.
3. روی تنظیمات کلیک کنید.
4. روی تنظیمات برنامه‌نویس کلیک کنید.
5. روی گزینه های دسترسی شخصی کلیک کنید.
6. روی ایجاد نشانه دسترسی شخصی کلیک کنید.
7. در قسمت یادداشت ، «آموزش جستجوی ابری» را وارد کنید.
8. محدوده public_repo را بررسی کنید.
9. روی Generate Token کلیک کنید.
10. به توکن تولید شده توجه کنید. توسط کانکتور برای فراخوانی API های GitHub استفاده می شود و سهمیه API را برای انجام نمایه سازی فراهم می کند.

کانکتور را پیکربندی کنید

پس از ایجاد اعتبار و منبع داده، پیکربندی رابط را به‌روزرسانی کنید تا شامل این مقادیر باشد:

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 است. نمایه سازی مخزن حدود 1 دقیقه طول می کشد. پس از نمایه سازی اولیه، رابط به نظرسنجی برای تغییرات در مخزن که باید در فهرست جستجوی ابری منعکس شود، ادامه می دهد.

در حال بررسی کد

بخش های باقی مانده نحوه ساخت کانکتور را بررسی می کنند.

شروع برنامه

نقطه ورود به کانکتور کلاس 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 یک استراتژی پیمایش را اجرا می کند که از صف های جستجوی ابری برای ردیابی وضعیت موارد در فهرست استفاده می کند. برای دسترسی به محتوا از 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() مربوطه به ساخت نمایش آیتم برای جستجوی ابری رسیدگی می‌کند. به عنوان مثال، برای ساختن نمایندگی برای آیتم های محتوا:

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();
}

بعد، رابط جستجو را مستقر کنید.

قبلی بعدی