JavaScript SDK

負荷構成

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

SDKは、読み込み構成と読み込みオプションを使用して、次のものを指定します。

エンティティをロードする必要があるかどうか。
エンティティを読み込む必要があるカルチャ。
エンティティにロードするメンバー。

メモ

負荷構成はStylelabs.M.Framework.Essentials.LoadConfigurationsにあります。荷重オプションはStylelabs.M.Framework.Essentials.LoadOptionsにあります。

先端

サーバーのオーバーヘッドを最小限に抑えるには、読み込みオプションと設定を使用して、読み込みデータの量を最小限に抑えてください。

このセクションでは、最初にさまざまな負荷オプションについて説明し、次に負荷オプションと共に負荷構成を使用する方法について説明します。

ロードオプション

ロードオプションは、特定のアイテムをロードする方法を指定する原子単位のようなものです。現在サポートされているロード・オプションは次のとおりです。

カルチャーロードオプション
プロパティのロードオプション
リレーション・ロード・オプション

すべてのロードオプションには、一般的なユースケースのためのデフォルトインスタンス、静的インスタンス、および読み取り専用インスタンスがあります。また、読み込みオプションにはコピーコンストラクタがあります。これを使用して、読み取り専用の読み込みオプションをコピーして変更できるようにすることができます。

上記のすべてのロードオプションクラスには、次のようなLoadOption列挙型プロパティがあります。

None
Default
Custom
All

Customに設定すると、オブジェクトはPropertyLoadOptionのプロパティ名のリストを指定して、ロードする対象を指定する必要があります。LoadOptionがCustomに設定されていない場合、リストは無視されます。

カルチャーロードオプション

デフォルトのカルチャ読み込みオプションは次のとおりです。

CultureLoadOption.All Sitecore Content Hubに登録されているすべてのカルチャを読み込みます。
CultureLoadOption.DefaultデフォルトのカルチャをSitecore Content Hubに読み込みます。
CultureLoadOption.Noneカルチャをロードしません。

手記

エンティティがカルチャなしで読み込まれると、エンティティにはカルチャに依存するプロパティはありません。エンティティが特定のカルチャセットに読み込まれると、カルチャに依存するプロパティはそれらのカルチャでのみ使用できます。

特定のカルチャのセットを読み込むには、次のいずれかの方法を使用して新しいCultureLoadOptionを作成します。

ロケール識別子 (LCID) をコンマ区切りリストとして渡すと、次のようになります。

import { CultureLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/culture-load-option";

var cultures = [
  "en-US", 
  "nl-BE"
];

new CultureLoadOption(cultures);

CultureInfoインスタンスをカンマ区切りリストとして渡すことにより、次のようになります。

import { CultureLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/culture-load-option";

var cultures: CultureInfo[] = [
  "en-US",
  "nl-BE"
];

new CultureLoadOption(cultures);

プロパティのロードオプション

デフォルトのプロパティ読み込みオプションは次のとおりです。

PropertyLoadOption.Allエンティティのすべてのプロパティを読み込みます。
PropertyLoadOption.Noneエンティティのプロパティはロードされません。

特定のプロパティセットを読み込むには、次のいずれかの方法を使用して新しいPropertyLoadOptionを作成します。

プロパティ名をカンマ区切りリストとして渡します。

import { PropertyLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/property-load-option";

var names = ["propertyName1", "propertyName2"]
new PropertyLoadOption(names);

プロパティ名の任意のタイプのコレクション ( IEnumerableから派生) を渡します。

import { PropertyLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/property-load-option";

new PropertyLoadOption("propertyName1");

リレーション・ロード・オプション

デフォルトのリレーションロードオプションは次のとおりです。

RelationLoadOption.Allエンティティ上のすべてのリレーションをロードします。
RelationLoadOption.Noneエンティティにリレーションはロードされません。

特定のリレーションのセットをロードするには、次のいずれかの方法を使用して新しいRelationLoadOptionを作成します。

リレーションの名前をカンマ区切りのリストとして渡します。

import { RelationLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/relation-load-option";

var names = ["relationName1", "relationName2"]
new RelationLoadOption(names);

リレーション名の任意のタイプのコレクション( IEnumerableから派生)を渡します。

import { RelationLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/relation-load-option";

new RelationLoadOption("relationName1");

負荷構成

ローディング構成は、複数のロードオプションを集約する分子単位のようなものです。

手記

読み込み構成には、既定の構成値もあり、コピーコンストラクターをサポートします。

手記

QueryとLoadConfigurationの分割により、IQueryLoadConfigurationはSDK内部でのみ使用する必要があります。

エンティティの負荷構成

構成は、次のもので構成されます。

CultureLoadOption
PropertyLoadOption
RelationLoadOption

以下は、デフォルトのエンティティロード設定です。

EntityLoadConfiguration.Minimalカルチャ、プロパティ、またはリレーションを含まないエンティティを読み込みます。使用可能なのは、システム・プロパティ ( ID、Definition、Created on、Created byなど) のみです。
EntityLoadConfiguration.Default既定のカルチャのエンティティ、すべてのプロパティを読み込み、リレーションを読み込みません。
EntityLoadConfiguration.DefaultCultureFull既定のカルチャのエンティティを、すべてのプロパティとすべての関係と共に読み込みます。
EntityLoadConfiguration.Fullすべてのカルチャ、すべてのプロパティ、およびすべての関係のエンティティをロードします。

カスタム構成は、次の方法で作成します。

import { EntityLoadConfiguration } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/entity-load-configuration";
import { CultureLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/culture-load-option";
import { PropertyLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/property-load-option";
import { RelationLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/relation-load-option";

new EntityLoadConfiguration(
  CultureLoadOption.Default,
  new PropertyLoadOption([
    "Title",
    "FileName"
  ]),
  new RelationLoadOption([
    "AssetTypeToAsset"
  ])
);

この例では、カルチャなしでエンティティを読み込み、TitleプロパティとFileNameプロパティ、およびAssetTypeToAssetリレーションを読み込みます。

手記

また、コンストラクタの代わりにプロパティを使用してロードオプションを設定することもできます。

手記

EntityLoadConfigurationが指定されていない場合、SDKは常にDefault構成を使用します。

エンティティ負荷構成ビルダー

このIEntityLoadConfigurationには、負荷構成を簡単に作成または拡張するためのビルダーが付属しています。

次の例は、最小負荷設定から開始し、2つのリレーションを追加します。

import { EntityLoadConfiguration } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/entity-load-configuration";

EntityLoadConfiguration.Minimal.builder().withRelations(["Relation1", "Relation2"]).build();

これは、次の複数の部分で構成されています。

EntityLoadConfiguration.Minimalデフォルトで提供されている負荷構成から開始されます。
Builder() - 新しい構成を構築するには、ビルダーを取得する必要があります。
WithRelations(new { "Relation1", "Relation2" }) ビルダー内の負荷構成を変更します。これは、他のすべてのビルダーメソッドとチェーンできます。
.Build() ビルドプロセスを終了し、最終的な読み込み構成を取得します。

この記事を改善するための提案がある場合は、お知らせください!