The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

分階段無頭式部署

Storefront Reference Architecture (SFRA) 及 SiteGenesis 的使用者現在可以分階段推出無頭技術。例如,您可以使用 PWA Kit 為產品頁面部署全新的體驗,但讓結帳流程繼續使用 SFRA,直到踏入轉往無頭式架構的下一階段。這種分階段的方法可以協助您更快開始,並將邁向無頭式架構之路上的阻礙降至最低。

這份指南將說明如何使用工作階段橋接和路由規則,來讓 PWA Kit 推動一組頁面,並讓 SFRA 推動另一組頁面,實現順暢無縫的使用者體驗。

若要深入瞭解如何在分階段無頭式部署情況下使用 Einstein Activities,請參閱分階段無頭式部署的 Einstein Activities

這份指南中的指示將說明如何結合 PWA Kit 和 SFRA 流程,但相同的指示也適用於 SiteGenesis。

要讓購物者能順暢無縫地在不同網店架構驅動的頁面之間瀏覽,需要使用一種稱為「工作階段橋接」的技術。工作階段橋接會使用 Cookie,在不同系統之間共用購物者的重新整理權杖和工作階段權杖。

解鎖工作階段橋接的關鍵就在於 Shopper Login and API Access Service (SLAS),這是一種新的標準式驗證、授權解決方案,可透過 HTTP 要求進行存取。SLAS 的購物者驗證採用 OpenID Connect,而 Commerce Cloud 的 Shopper API 授權則採用 OAuth 2。

當購物者瀏覽無頭式網店時,您使用 SLAS 來要求存取權杖和重新整理權杖,並將它們作為 Cookie 儲存在購物者的瀏覽器中。您可以使用 HTTP set-cookie 標頭或用戶端 JavaScript 來設定 Cookie。當購物者從 SFRA 頁面轉換到 PWA Kit 頁面 (反之亦然) 時,包含重新整理權杖的 Cookie 將會和 HTTP 要求一起傳送,而網店程式碼可使用重新整理權杖來讓使用者登入。

Plugin SLAS 負責管理 B2C Commerce 工作階段 (與 dwsid 有關) 及 SLAS 工作階段 (與 access_token 有關)。工作階段橋接會將 dwsidaccess_token 連結到同一個購物者工作階段。

Plugin SLAS 使用 2 種工作階段橋接方法:

  1. SLAS 工作階段橋接 (API:getSessionBridgeAccessToken)
    • 僅供 Plugin SLAS 用於新訪客登入
    • 工作階段橋接後不會產生新的 dwsid,因此網店不需要重新轉譯,可以收到 200 OK 回應。
  2. OCAPI 工作階段橋接 (API:Obtain OCAPI Session)
    • 供 Plugin SLAS 用於已註冊購物者登入重新整理權杖登入
    • 工作階段橋接後會產生新的 dwsid,因此網店需要重新整理,必須收到 302 重新導向回應。

分階段無頭式部署的第一步是設定您的 PWA Kit 應用程式來使用 SLAS (若尚未執行)。請依照我們的設定 API 存取指南中的指示進行。

如果您的 Plugin SLAS 安裝為 7.0.0 或以上版本,則您的 PWA Kit 專案必須使用或完全升級至 2.7.1 或以上版本的 Retail React App 範本。

若要啟用 SFRA 進行分階段無頭式部署,您必須安裝 Plugin SLAS 插件。插件的 README 中提供了完整的安裝說明。

除了工作階段橋接之外,Plugin SLAS 插件還允許您實作其他便利於購物者的功能,像是 90 天使用者工作階段和購物車保留。

SLAS 插件使用者的重要考量

Plugin SLAS 插件會對不同 API 發出多個呼叫,這可能會影響網店效能。在新增插件至 Production 網店之前,請先比較您的網店使用或不使用此插件的效能表現,以決定它是否適合您。

插件也會在下列情況中造成重新導向:

  • 當購物者還沒有工作階段 Cookie 時
  • 當購物者的工作階段 Cookie 已到期時
  • 當搜尋引擎正在檢索您的網站時

目前,此插件僅會取代對 B2C Commerce 系統的直接登入,該系統的憑證均儲存在 Salesforce 內。

如果搭配使用願望清單外掛程式,則訪客的願望清單不會在登入為註冊使用者時進行傳輸。

在使用插件之前,請參閱 GitHub 上的問題頁面

因為 Plugin SLAS 插件是專為 SFRA 設計的,您必須編寫額外的程式碼,才能將其用於 SiteGenesis。SiteGenesis 實作可以在購物者驗證和授權流程中的各個點,利用插件中的程式碼。

因為插件使用 B2C Commerce Web 服務架構來處理 SLAS API 呼叫,所以 SiteGenesis 實作可以對插件實作的 Web 服務提出要求。這些 Web 服務包括訪客登入、已註冊客戶登入、權杖重新整理、登出、合併訪客購物車。插件也實作了一項服務來合併 API 工作階段和網店工作階段。

SiteGenesis 實作也可以使用自訂 Hook (app.plugin.slas.login) 來實現讓訪客和已註冊使用者以 SLAS 登入。檢查 dw.system.request.onSession 中插件的 onSession Hook 裡的自訂程式碼,看看它如何用 SLAS 取代 Script API 來進行購物者登入。

若要使用 PWA Kit 進行工作階段橋接,您必須修改 commerce-api/auth.js 中處理 API 授權的程式碼,以便使用 Cookie 而不是本機儲存。

如果您的 PWA Kit 專案是使用 2.7.x 版本的 Retail React App 範本所產生,您可以在 auth.js 中取消註解這行程式碼,以便切換至 CookieStorage 儲存權杖。這是在 SFRA 和 PWA Kit 網站之間管理工作階段的必要條件。

您也必須修改 commerce-api/auth.js 中的程式碼,在購物者登入之後呼叫工作階段橋接 API。若要這麼做,您必須取消註解 auth.js 中的這行程式碼

為了節省您的時間,我們建立了一個包含所有變更的檔案替代版本,可在 GitHub 上的公開 gist 取得。

如果您的 PWA Kit 專案是使用 3.0.0 或以上版本的 Retail React App 範本所產生,則上述變更都已預設啟用,您無需對程式碼進行其他變更。

授權流程從重新整理權杖開始。若重新整理權杖 Cookie 可用,則 PWA Kit 應用程式會將重新整理權杖交換為存取權杖。否則,應用程式會根據 OAuth 2.1 標準的定義,開始授權代碼授予流程。也會遵循 Proof Key for Code Exchange (PKCE) 流程。

當 SLAS 授予新的存取權杖和新的重新整理權杖時,應用程式會將它們儲存在 Cookie 中。接著,應用程式會向 OCAPI 的建立工作階段端點 (/session) 提出 POST 要求。此端點會建立一個由 SFRA 使用的工作階段。應用程式將此工作階段權杖儲存在 Cookie 中。

由 PWA Kit 應用程式建立的 Cookie:

  • cc-nx-g - SLAS 訪客購物者重新整理權杖
  • cc-nx - SLAS 已註冊購物者重新整理權杖
  • token - SLAS 存取權杖
  • dwsid - Demandware 工作階段 ID

購物者登入 PWA Kit 頁面後,必須呼叫 OCAPI 工作階段橋接,以便在每次 PWA Kit 頁面的購物者驗證狀態發生改變時通知 SFRA 頁面。同樣地,PWA Kit 會在 LocalStorage 中維護一份重新整理權杖,於每次要求之前先跟儲存於 CookieStorage 的重新整理權杖鍵和值進行比較。如果權杖不同,PWA Kit 會使目前的工作階段失效並重新觸發授權流程,使工作階段與 SFRA 保持同步。

為了確保使用者在分階段部署期間享有無縫體驗,您需要將流量路由到兩個不同的來源:Managed Runtime 環境和您的 B2C Commerce 執行個體。這個流量路由作業可以由內容傳遞網路 (CDN) 處理。

想像以下情境:

您有一個在 www.mystorefront.com 上運作的現有 SFRA 網店。您知曉無頭式架構的好處,想要利用 PWA Kit 來提供高效能又吸引人的體驗。同時,您也想降低時程的風險,因此您選擇以分階段的方式推出 PWA Kit 網店。

您設定 CDN 將漏斗最上方的頁面要求傳送至 PWA Kit:首頁 (/)、類別清單頁面 (/category)、產品詳細資料頁面 (/product)。這些 PWA Kit 頁面部署到 mystorefront.mobify-storefront.com 上運作的 Managed Runtime 環境。當購物者決定購買時,CDN 會將購物者重新導向到在 www.mystorefront.com 上運作的現有 SFRA 結帳頁面。

為了處理流量路由,您可以選擇 Salesforce (由 Cloudflare 技術支援) 的嵌入式 CDN (eCDN) 解決方案,或選擇其他供應商的 CDN。

若要使用 eCDN 將流量路由到 Managed Runtime,請使用 Commerce API 端點 createMrtRules

API 支援使用 Cloudflare 規則表達式將流量路由到 Managed Runtime。它支援以「規則」語言撰寫的可用欄位子集。支援下列欄位:

  • http.host,符合主機名稱
  • http.request.uri.path,比對要求路徑
  • http.request.uri,同時比對要求路徑和查詢字串
  • http.cookie,比對 Cookie

您可對 Proxy 區域的每個執行個體要求 100 條個別規則,對舊版區域的 dev/prod 執行個體要求二者總計 100 條個別規則。

  • eCDN 僅適用於 prod 和 dev 執行個體,不可用於 Sandbox 或 ODS 執行個體。
  • Staging 執行個體必須使用 eCDN API 連至 eCDN。如需更多資訊,請參閱 B2C Commerce Infocenter 上的為 Staging 設定 eCDN,以及 Rhino Inquisitor 部落格的這篇文章
  • eCDN 不支援根據地理位置進行路由。

為了協助設計來源規則,請先收集 PWA Kit 頁面的完整路由清單。對於根據 Retail React App 範本建立的 PWA Kit 專案,其路由列在 app/routes.jsx 中。由於 PWA Kit 的伺服器端轉譯系統使用內部路由來處理 Proxy 和靜態資產,因此您還必須在路由規則中包含 /mobify/*

在我們的範例情境中,下列路由必須在您的 CDN 中設定:

建立來源規則,納入清單上的所有 PWA Kit 路由,以便將要求轉送到 Managed Runtime 環境 (即我們範例情境中的 mystorefront.mobify-storefront.com)。

下圖顯示我們稍早提到的範例情境 eCDN 設定:

相關圖表

根據預設,PWA Kit 專案的 Retail React App 範本具有與 SFRA 不同的 URL 路由模式。例如,Retail React App 中產品詳細資料頁面的 URL 路徑為 /products/{productId},而 SFRA 的模式則是 /{categoryId}/{productId}

我們建議您變更 PWA Kit 網店中的路由模式,來符合 SFRA 網站。若您無法符合特定頁面 (像是當類別 ID 在 URL 中不可用時的產品清單頁面) 的 URL 模式,您可以使用 Redirect Cartridge 來設定縮小差距的重新導向。插件的 README 中提供了完整的安裝說明。

若要完成分階段無頭式部署的設定過程,您必須再對 PWA Kit 專案進行幾項變更。

根據預設,PWA Kit 使用 History API 來進行瀏覽。當購物者點擊使用 React Router 的 <Link> 元件所建立的連結時,它會觸發軟性導覽,連至與 app/routes.jsx 中定義的路由物件路徑相符的元件。若要連結至非 PWA Kit 頁面 (例如由 SFRA 驅動的頁面),您必須從 app/routes.jsx 中移除與 URL 路徑名稱相符的所有路由。

例如,如果您的 PWA Kit 專案是使用 2.7.x 版本3.x 版本的 Retail React App 範本所產生,而且沒有使用擴充性:從路由陣列中移除結帳。 Remove-checkout-route

如果您的 PWA Kit 專案是使用 3.x 版本的 Retail React App 範本所產生,而且使用擴充性,則您可以覆寫 overrides/app/routes.jsx 檔案,使用 JavaScript 過濾掉連到非 PWA Kit 頁面的連結。 我們建立了一個包含所有變更的 overrides/app/routes.jsx 檔案覆寫範例,以過濾掉 /cart/checkout 路由,您可在 GitHub 上的公開 gist 取得。

最後,在 app/routes.jsx 中更新 PWA 全部擷取 (catch-all) 路由 (/*)。將 PWA <PageNotFound /> 元件替換為連至預設來源的重新導向。

對於 PIG 執行個體,客戶可以使用 eCDN 來「分割」SFRA (或 SG) 和 MRT 來源之間的流量。但是,eCDN 不支援 SIG 執行個體和 ODS。若要在 SIG 執行個體本機上設定及測試分階段部署網站,客戶必須使用自己的反向 Proxy 或 CDN 來分割流量。

我們已建立一個範例 Node.js 應用程式,可用來開發及測試 PWA Kit 與 SFRA/SiteGenesis 之間的混合式部署購物者流程。 Repo 的 README 中提供設定反向 Proxy 的安裝與設定指示。

我們已彙整成一段示範影片,顯示在 SIG 執行個體上設定分階段部署的步驟:

Phased Rollouts on SIG

您可以設定 ODS 使用與您 Production 設定類似的別名設定,協助讓您的本機和 Production 設定保持完全相同。例如,透過設定 Sandbox,讓混合式網站在 / URI 上可用,就能確保 pwa-kit 傳送的 URL 不需要轉換為包含網站 ID。這通常是 Production 網站的設定方式。

若要在 Business Manager 中啟用別名,請依照 Trailhead 上關於 Salesforce B2C Commerce 主機名稱別名的課程指示進行。

您可以將 PWA Kit 路由設定為所有傳出 URL (例如用於 SFRA 的 URL) 都加上前綴,以包含 /s/SiteID 前綴。這可確保您的執行個體是以通常用於 Sandbox 的方式接收控制器 URL,而不需要明確設定主機名稱別名。請注意,這可能不適合 Production 設定,所以您可能想要為 Production 和 Sandbox 部署使用不同的 catch-all 路由。

若要設定路由前綴,請在 app/routes.jsxoverrides/app/routes.jsx 中更新 PWA catch-all 路由 (/*)。