将URL外部化 externalizing-urls

在Adobe Experience Manager (AEM)中,外部化器 ​是一个OSGI服务,它允许您通过为路径添加预配置的DNS作为前缀,以编程方式将资源路径(例如/path/to/my/page)转换为外部和绝对URL(例如https://www.mycompany.com/path/to/my/page)。

由于如果实例在Web层后面运行,则它无法知道自己的外部可见URL,并且有时必须在请求范围之外创建链接,因此,此服务提供了一个中心位置来配置这些外部URL并构建它们。

本页介绍如何配置​ Externalizer ​服务及其使用方法。 有关详细信息,请参阅Javadocs

配置Externalizer服务 configuring-the-externalizer-service

外部化器 ​服务允许您集中定义多个域,这些域可用于以编程方式为资源路径添加前缀。 每个域由唯一名称标识,该名称用于以编程方式引用域。

要为​ Externalizer ​服务定义域映射:

  1. 通过​ 工具,然后通过​ Web控制台 ​导航到配置管理器,或者输入:

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

  2. 单击​ Day CQ Link Externalizer ​以打开配置对话框。

    note note
    NOTE
    配置的直接链接是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外部化时未覆盖方案,则使用此选项。
    • server ​是主机名(可以是域名或ip地址)。

    • 端口 (可选)是端口号。

    • 仅当AEM作为Web应用程序安装在不同的上下文路径下时,才会设置​ contextpath(可选)。

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

    以下映射名称是预定义名称,必须设置这些名称,因为AEM依赖于它们:

    • local — 本地实例
    • author — 创作系统DNS
    • publish — 面向公众的网站DNS
    note note
    NOTE
    自定义配置允许您添加类别,如productionstaging,甚至添加外部非AEM系统,如my-internal-webservice。 避免在项目代码库的不同位置对这些URL进行硬编码很有用。
  4. 单击​ 保存 ​以保存更改。

NOTE
Adobe建议您将配置添加到存储库

使用Externalizer服务 using-the-externalizer-service

本节显示了如何使用​ Externalizer ​服务的几个示例:

  1. 在JSP中获取Externalizer服务:

    code language-java
    Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);
    
  2. 要将具有“发布”域的路径外部化:

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

    假定域映射:

    • publish https://www.website.com

    myExternalizedUrl最后得到的值为:

    • https://www.website.com/contextpath/my/page.html
  3. 要将具有“作者”域的路径外部化:

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

    假定域映射:

    • author https://author.website.com

    myExternalizedUrl最后得到的值为:

    • https://author.website.com/contextpath/my/page.html
  4. 要将具有“本地”域的路径外部化:

    code language-java
    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中找到更多示例。

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2