將URL外部化

在AEM中， 外置器 是OSGi服務，可讓您以程式設計方式轉換資源路徑(例如， /path/to/my/page)放入外部和絕對URL(例如 https://www.mycompany.com/path/to/my/page)，方法是使用預先設定的DNS來預先修正路徑。

由於AEMas a Cloud Service例項無法知道其外部可見的URL，而且有時必須在要求範圍外建立連結，因此此服務可提供集中位置來設定這些外部URL並建置這些URL。

本文說明如何配置Externalizer服務及如何使用它。 有關服務的技術詳細資訊，請參閱 Javadocs.

Externalizer的預設行為和How to Override

現成可用的Externalizer服務會將幾個網域識別碼對應至符合為環境產生之AEM服務URL的絕對URL前置詞，例如 author https://author-p12345-e6789.adobeaemcloud.com 和 publish https://publish-p12345-e6789.adobeaemcloud.com. 這些預設網域的每個基本URL都會從Cloud Manager定義的環境變數中讀取。

若要參考，請使用 com.day.cq.commons.impl.ExternalizerImpl.cfg.json 有效：

{
   "externalizer.domains": [
      "local $[env:AEM_EXTERNALIZER_LOCAL;default=http://localhost:4502]",
      "author $[env:AEM_EXTERNALIZER_AUTHOR;default=http://localhost:4502]",
      "publish $[env:AEM_EXTERNALIZER_PUBLISH;default=http://localhost:4503]",
      "preview $[env:AEM_EXTERNALIZER_PREVIEW;default=http://localhost:4503]"
   ]
}
注意

預設 local, author, preview，和 publish OSGi配置中的外部化程式域映射必須保留為原始 $[env:...] 以上所列的值。

部署自訂 com.day.cq.commons.impl.ExternalizerImpl.cfg.json 檔案到AEM的as a Cloud Service，若省略這些現成可用的網域對應，可能會導致無法預測的應用程式行為。

若要覆寫 preview 和 publish 值，請使用Cloud Manager環境變數，如文章所述 為AEM as a Cloud Service配置OSGi 並設定預先定義的 AEM_CDN_DOMAIN_PUBLISH 和 AEM_CDN_DOMAIN_PREVIEW 變數。

配置Externalizer服務

Externalizer服務允許您集中定義可用於以寫程式方式為資源路徑前置詞的域。 Externalizer服務僅應用於具有單個域的應用程式。

注意

套用任何 AEMas a Cloud Service的OSGi設定， 應在本機開發人員執行個體上執行下列步驟，然後提交至您的專案程式碼以進行部署。

要定義Externalizer服務的域映射，請執行以下操作：

  1. 透過以下網址導覽至Configuration Manager:

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

  2. 按一下 Day CQ Link Externalizer 開啟「配置」對話框。

    Externalizer OSGi配置

    注意

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

  3. 定義 網域 對應。 映射由唯一名稱組成，該名稱可用於代碼中以引用域、空格和域：

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

    其中：

    • scheme 通常是http或https，但可以是其他通訊協定。

      • 建議使用https強制https連結。
      • 若要求將URL外部化時用戶端代碼未覆寫配置，則會使用此URL。

    • server 是主機名（域名或ip地址）。

    • port （可選）是埠號。

    • contextpath （選用）只有在AEM安裝為位於不同內容路徑下的網頁應用程式時才會設定。

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

    下列對應名稱是預先定義的，且必須一律設定，因為AEM需仰賴這些名稱：

    • local — 本機執行個體
    • author — 編寫系統DNS
    • publish — 公開對應的網站DNS
    注意

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

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

使用Externalizer服務

本節介紹如何使用Externalizer服務的一些示例。

注意

不應在HTML內容中建立絕對連結。 因此，不應在此類情況下使用此實用程式。

  • 若要將具有'publish'網域的路徑外部化：

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

    假設網域對應：

    • publish https://www.website.com

    • myExternalizedUrl 結尾為值：

    • https://www.website.com/contextpath/my/page.html

  • 若要將具有「作者」網域的路徑外部化：

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

    假設網域對應：

    • author https://author.website.com

    • myExternalizedUrl 結尾為值：

    • https://author.website.com/contextpath/my/page.html

  • 要將具有'local'域的路徑外部化：

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

    假設網域對應：

    • local https://publish-3.internal

    • myExternalizedUrl 結尾為值：

    • https://publish-3.internal/contextpath/my/page.html

秘訣

您可以在 Javadocs.

本頁內容