DocumentazioneAEM as a Cloud ServiceGuida utente

Esternalizzazione degli URL externalizing-urls

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Amministratore
  • Sviluppatore

In AEM, Externalizer è un servizio OSGi che consente di trasformare in modo programmatico un percorso di risorsa (ad esempio, /path/to/my/page) in un URL esterno e assoluto (ad esempio, https://www.mycompany.com/path/to/my/page) prefissando il percorso con un DNS preconfigurato.

Poiché un’istanza di AEM as a Cloud Service non può conoscere il proprio URL visibile esternamente e poiché a volte è necessario creare un collegamento al di fuori dell’ambito della richiesta, questo servizio fornisce una posizione centrale per configurare tali URL esterni e generarli.

Questo articolo spiega come configurare il servizio Externalizer e come utilizzarlo. Per informazioni tecniche sul servizio, vedi Javadocs.

Comportamento predefinito di Externalizer e Procedura di sostituzione default-behavior

Il servizio Externalizer associa una serie di identificatori di dominio a prefissi URL assoluti corrispondenti agli URL del servizio AEM generati per l'ambiente, ad esempio author https://author-p12345-e6789.adobeaemcloud.com e publish https://publish-p12345-e6789.adobeaemcloud.com. Gli URL di base per ciascuno di questi domini predefiniti vengono letti dalle variabili di ambiente definite da Cloud Manager.

Per riferimento, la configurazione OSGi predefinita per com.day.cq.commons.impl.ExternalizerImpl.cfg.json è effettivamente:

{
   "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]"
   ]
}
CAUTION
Le mappature di dominio local, author, preview e publish Externalizer predefinite nella configurazione OSGi devono essere mantenute con i valori $[env:...] originali elencati sopra.
La distribuzione di un file com.day.cq.commons.impl.ExternalizerImpl.cfg.json personalizzato in AEM as a Cloud Service che omette una qualsiasi di queste mappature di dominio predefinite può causare un comportamento imprevedibile dell'applicazione.

Per ignorare i valori preview e publish, utilizzare le variabili di ambiente Cloud Manager come descritto nell'articolo Configurazione di OSGi per AEM as a Cloud Service e impostazione delle variabili predefinite AEM_CDN_DOMAIN_PUBLISH e AEM_CDN_DOMAIN_PREVIEW.

Configurazione del servizio Externalizer configuring-the-externalizer-service

Il servizio Externalizer ti consente di definire a livello centrale il dominio che può essere utilizzato per prefissare in modo programmatico i percorsi delle risorse. Il servizio Externalizer deve essere utilizzato solo per le applicazioni con un singolo dominio.

NOTE
Come per l'applicazione di configurazioni OSGi per AEM as a Cloud Service, è necessario eseguire i passaggi seguenti in un'istanza sviluppatore locale e quindi confermare il codice del progetto per la distribuzione.

Per definire un mapping di dominio per il servizio Externalizer:

  1. Passa a Configuration Manager tramite:

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

  2. Fai clic su Day CQ Link Externalizer per aprire la finestra di dialogo di configurazione.

    Configurazione OSGi di Externalizer

    note note
    NOTE
    Il collegamento diretto alla configurazione è https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl

  3. Definisci una mappatura Domini. Una mappatura è costituita da un nome univoco che può essere utilizzato nel codice per fare riferimento al dominio, a uno spazio e al dominio:

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

    Dove:

    • scheme è in genere http o https, ma può essere un altro protocollo.

      • L’Adobe consiglia di utilizzare https per applicare i collegamenti https.
      • Viene utilizzato se il codice client non sostituisce lo schema quando viene richiesta l’esternalizzazione di un URL.

    • server è il nome host (nome di dominio o indirizzo ip).

    • port (facoltativo) è il numero di porta.

    • contextpath (facoltativo) è impostato solo se AEM è installato come WebApp in un percorso di contesto diverso.

    Esempio: production https://my.production.instance

    I seguenti nomi di mappatura sono predefiniti e devono sempre essere impostati in quanto AEM si basa su di essi:

    • local - l'istanza locale
    • author - DNS del sistema di authoring
    • publish - DNS del sito Web pubblico
    note note
    NOTE
    Una configurazione personalizzata consente di aggiungere una nuova categoria, ad esempio production, staging o anche sistemi esterni non AEM come my-internal-webservice. È utile evitare di codificare tali URL in posizioni diverse nella base di codice di un progetto.

  4. Fai clic su Salva per salvare le modifiche.

Utilizzo del servizio Externalizer using-the-externalizer-service

Questa sezione mostra alcuni esempi di utilizzo del servizio Externalizer.

NOTE
Non è necessario creare collegamenti assoluti nel contesto di HTML. Pertanto, non utilizzare questa utilità in tali casi.

  • Per esternalizzare un percorso con il dominio 'publish':

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

    Supponendo il mapping del dominio:

    • publish https://www.website.com

    • myExternalizedUrl termina con il valore:

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

  • Per esternalizzare un percorso con il dominio 'author':

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

    Supponendo il mapping del dominio:

    • author https://author.website.com

    • myExternalizedUrl termina con il valore:

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

  • Per esternalizzare un percorso con il dominio 'locale':

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

    Supponendo il mapping del dominio:

    • local https://publish-3.internal

    • myExternalizedUrl termina con il valore:

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

TIP
Puoi trovare altri esempi nei JavaScript.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab