Next.jsマルチサイトアドオン

GraphQLSiteInfoService

GraphQLSiteInfoServiceはGraphQL Edgeエンドポイントを使ってSitecoreから設定済みのサイト情報(SiteInfo)のリストを取得します。サイト情報にはサイト名、ホスト名、デフォルト言語が含まれます。

サイト情報の設定はSXAのサイト定義フィールドを使って行います。

!重要このサービスはSXAベースのサイトのみを取得し、設定ベースのサイト定義は含まれていません。

Next.js Multisiteアドオンは、/scripts/config/plugins/multisite.tsファイル内にJSS設定プラグインを提供し、GraphQLSiteInfoServiceを使ってサイト情報を取得し、生成されたsrc/temp/configファイル内のsitesプロパティに保存します。

SiteResolver

SiteResolverクラスは、提供されたサイト情報リスト(SiteInfo)に基づいてホスト名またはサイト名を解析します。

!注ホスト名でサイトを解決するために、SiteResolverクラスはgetByHostメソッドを使用します。このメソッドは、|、,、または ;で区切られた1つ以上のホスト名を含む文字列を受け入れます。また、ワイルドカード(*)も受け入れます。

getByHost方式は、ジェネリック/ワイルドカードホスト名よりも特定のホスト名を優先します:

「order.eu.site.com」→「*.eu.site.com」→「*.site.com」→「*」

同じホスト名で定義された複数のサイトがある場合、このメソッドは最初に見つけたサイトを優先します。

サイト情報のリストはSiteResolverプラグインで収集され、アプリケーションのシングルトン実装に提供されます。アプリは、例えばPage Props Factoryで名前で検索したり、MultisiteMiddlewareでホスト名で検索したりする際に、/src/lib/site-resolver/index.tsファイルでデフォルトで定義されたシングルトン実装を使用します。

サイト収集プロセスには2つのSiteResolverプラグインが関わっています:

• DefaultPluginは/src/lib/site-resolver/plugins/default.tsファイルで定義され、ベースnextjsテンプレートによって提供され、ワイルドカード*ホスト名を使ってconfig.sitecoresiteNameとconfig.defaultLanguageから設定されたサイトを読み込みます。デフォルトでは、config.sitecoresiteNameとconfig.defaultLanguageの値は以下から来ます:
  • JSS 21.6.0以降では、SITECORE_SITE_NAME環境変数からconfig.sitecoreSiteNameを設定しています。古いバージョンのJSSでは、JSS_APP_NAME環境変数からconfig.jssAppNameを設定できます。そうでなければ、package.jsonファイルのconfig.appNameプロパティからです。
  • config.defaultLanguage- 環境変数DEFAULT_LANGUAGEから設定されている場合。そうでなければ、package.jsonファイルのconfig.languageプロパティから。
• MultisitePluginは/src/lib/site-resolver/plugins/multisite.tsファイルで定義され、Next.jsマルチサイトアドオンによって提供されます。構成されたサイトの後のconfig.sitesリストに基づいてビルド時に取得したサイトを読み込みます。

最初に設定されたサイトを追加することで、ワイルドカードホスト名の取得サイトよりも優先度が高くなります。これは、まだホスティングを設定しておらず、複数のサイトがワイルドカードを使っているアプリケーション開発段階で役立ちます。 より具体的なホスト名を設定した後は、それらのサイトが優先されます。

MultisiteMiddleware

MultisiteMiddlewareNext.jsミドルウェアハンドラはホスト名に基づいて適切なSitecoreサイトに書き換えます。ミドルウェアプラグインは、/src/lib/middleware/plugins/multisite.tsファイルに定義されたマルチサイトミドルウェアハンドラーを使用します。

MultisiteMiddlewareミドルウェアハンドラー:

• リクエストされたホストヘッダーに基づいて SiteResolver でサイトを解決します。
• sc_siteクッキーにはサイト名の値、x-sc-rewriteヘッダーには書き換えられたパスの値を設定し、ミドルウェアを使った後に再利用可能です。
• 特定のサイトへの応答を、サイトの書き換えパスを使って書き換えます。

!ヒント例えば、プレビューURLのように各サイトごとに専用ドメインVercel持っていない場合。その場合、sc_siteクエリ文字列パラメータを指定することで、アプリケーションに特定のサイトを強制的に使うことができます。例えば、https://foo.site.com?sc\_site=bar。

sc_siteクッキーはサイト閲覧中の次のリクエストに使われるため、すべてのリクエストにこれを追加する必要はありません。この動作はuseCookieResolutionオプションによって設定されます。useCookieResolutionオプションを有効にするのはVercelプレビュー展開(process.env.VERCEL_ENV === 'preview')のみです。

normalizeSiteRewrite

normalizeSiteRewrite関数はサイトリライトパスからサイトデータを削除します(例えば、アプリケーションが適切にレイアウトデータを取得できるように)。これは、/src/lib/extract-path/plugins/multisite.tsファイル内のマルチサイトパス抽出プラグインで使用されます。

getSiteRewriteData

getSiteRewriteData関数は、書き換えパスからサイトデータ(site_name)を抽出します。これは/src/lib/page-props-factory/plugins/site.tsファイルのマルチサイトPage Props Factoryプラグインで利用されています。

MultisiteGraphQLSitemapService

MultisiteGraphQLSitemapServiceは複数のサイトの静的生成のためにページリストを取得するために使用されます。