將URL外部化

在AEM中, Externalizer 是OSGI服務,可讓您以程式設計方式轉換資源路徑(例如 /path/to/my/page)轉換成外部和絕對URL (例如, https://www.mycompany.com/path/to/my/page),將路徑加上預先設定的DNS當作前置詞。

由於執行個體在網頁層後面執行時無法知道其外部可見的URL,而且由於有時必須在請求範圍之外建立連結,此服務會提供一個中央位置,以設定這些外部URL並建置它們。

本頁面說明如何設定 Externalizer 服務及其使用方式。 如需詳細資訊,請參閱 Javadocs.

設定Externalizer服務

Externalizer 服務可讓您集中定義多個網域,以便以程式設計方式為資源路徑加上前置詞。 每個網域都由唯一名稱來識別,該名稱以程式設計方式參考該網域。

若要定義領域對應,請執行下列動作: Externalizer 服務:

  1. 透過以下方式瀏覽至設定管理員: 工具,則 網頁主控台,或輸入:

    https://<host>:<port>/system/console/configMgr

  2. 按一下 Day CQ連結外部化器 以開啟組態對話方塊。

    注意

    設定的直接連結為 https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl

    aem-externalizer-01

  3. 定義 網域 對應:對應包含唯一名稱,可用於程式碼中參照網域、空格和網域:

    <unique-name> [scheme://]server[:port][/contextpath]

    其中:

    • 配置 通常為http或https,但也可以是ftp等。

      • 必要時使用https強制執行https連結
      • 若使用者端代碼在要求外部化URL時未覆寫配置,則會使用它。
    • 伺服器 是主機名稱(可以是網域名稱或ip位址)。

    • 連線埠 (選用)是連線埠號碼。

    • contextpath (選用)只有當AEM安裝為Webapp且位於不同的內容路徑下時,才會設定。

    例如:production https://my.production.instance

    下列對應名稱是預先定義的,必須一律設定為AEM依賴這些名稱:

    • local — 本機執行個體
    • author — 編寫系統DNS
    • publish — 面向公眾的網站DNS
    注意

    自訂設定可讓您新增類別,例如 productionstaging 甚至外部非AEM系統,例如 my-internal-webservice. 避免在專案的程式碼基底中跨不同位置對這類URL進行硬式編碼很有用。

  4. 按一下 儲存 以儲存變更。

注意

Adobe建議您 將設定新增至存放庫.

使用Externalizer服務

本節提供幾個範例,說明如何 Externalizer 服務可用於:

  1. 若要在JSP中取得Externalizer服務:

    Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);
    
  2. 若要使用「發佈」網域外部化路徑:

    String myExternalizedUrl = externalizer.publishLink(resolver, "/my/page") + ".html";
    

    假設網域對應:

    • publish https://www.website.com

    myExternalizedUrl 最後會得到值:

    • https://www.website.com/contextpath/my/page.html
  3. 若要使用「作者」網域外部化路徑:

    String myExternalizedUrl = externalizer.authorLink(resolver, "/my/page") + ".html";
    

    假設網域對應:

    • author https://author.website.com

    myExternalizedUrl 最後會得到值:

    • https://author.website.com/contextpath/my/page.html
  4. 若要使用「本機」網域外部化路徑:

    String myExternalizedUrl = externalizer.externalLink(resolver, Externalizer.LOCAL, "/my/page") + ".html";
    

    假設網域對應:

    • local https://publish-3.internal

    myExternalizedUrl 最後會得到值:

    • https://publish-3.internal/contextpath/my/page.html
  5. 如需更多範例,請參閱 Javadocs.

本頁內容