AEM Administración de hosts

AEM AEM AEM La implementación de una aplicación sin encabezado requiere atención a cómo se construyen las direcciones URL de la para garantizar que se utiliza el host/dominio correcto. Los tipos de solicitud/URL principales que se deben tener en cuenta son:

  • Solicitudes HTTP a AEM API de GraphQL
  • URL de imagen AEM a recursos de imagen a los que se hace referencia en Fragmentos de contenido y entregados por el servicio de imágenes de

AEM AEM Por lo general, una aplicación sin encabezado de interactúa con un único servicio de ID tanto para la API de GraphQL como para las solicitudes de imagen. AEM AEM El servicio cambia en función de la implementación de la aplicación sin encabezado de:

AEM Tipo de implementación sin encabezado
AEM entorno de
AEM servicio de
Producción
Producción
Publicación
Creación de previsualización
Producción
Vista previa
Desarrollo
Desarrollo
Publicación

AEM Para gestionar las permutaciones del tipo de implementación, cada implementación de aplicación se crea con una configuración que especifica el servicio de la aplicación al que se va a conectar. AEM AEM A continuación, el host/dominio del servicio de configurado se utiliza para construir las URL de la API de GraphQL y las URL de la imagen de la. AEM Para determinar el método correcto para administrar las configuraciones dependientes de la versión, consulte la documentación del marco de trabajo de la aplicación sin encabezado de la aplicación (por ejemplo, React, iOS™ Android, etc.), ya que el método varía según el marco de trabajo.

Tipo de cliente
SPA Aplicación de una sola página ()
Componente web/JS
Móvil
De servidor a servidor
AEM configuración de hosts de

A continuación se muestran ejemplos de posibles enfoques para construir direcciones URL para AEM API de GraphQL y solicitudes de imagen, para varios marcos y plataformas sin encabezado populares.

AEM Solicitudes de API de GraphQL

Las solicitudes de GET AEM HTTP desde la aplicación sin encabezado a las API de GraphQL AEM de la aplicación deben configurarse para que interactúen con el servicio correcto, tal como se describe en la sección tabla anterior.

Al utilizar AEM SDK sin encabezado de AEM AEM AEM (disponible para JavaScript basado en explorador, JavaScript basado en servidor y Java™), un host puede inicializar el objeto de cliente sin encabezado de la con el servicio de autenticación para conectarse a él.

AEM AEM Al desarrollar un cliente sin encabezado personalizado, asegúrese de que el host del servicio de sea parametrizable en función de los parámetros de compilación.

Ejemplos

AEM A continuación, se muestran ejemplos de cómo las solicitudes de API de GraphQL AEM pueden tener el valor de host de que se puede configurar para varios marcos de aplicaciones sin encabezado.

Ejemplo de React

En este ejemplo, se basa de forma flexible en AEM Aplicación React sin encabezadoAEM , ilustra cómo se pueden configurar las solicitudes de API de GraphQL AEM para conectarse a diferentes servicios de en función de variables de entorno.

Las aplicaciones de React deben utilizar AEM Cliente sin encabezado para JavaScript AEM para interactuar con las API de GraphQL de la. AEM AEM AEM El cliente sin encabezado de la, proporcionado por el cliente sin encabezado de la aplicación para JavaScript, debe inicializarse con el host de servicio de la aplicación al que se conecta.

Archivo de entorno de React

React utiliza archivos de entorno personalizados, o .env archivos, almacenados en la raíz del proyecto para definir valores específicos de la generación. Por ejemplo, la variable .env.development contiene valores utilizados para durante el desarrollo, mientras que .env.production contiene valores utilizados para las versiones de producción.

  • .env.development
code language-none
# Environment variable used to specify the AEM service the React app will connect to when running under this profile
REACT_APP_AEM_HOST=https://publish-p123-e456.adobeaemcloud.com
...

.env archivos para otros usos se puede especificar por postfijación .env y un descriptor semántico, como .env.stage o .env.production. Different .env Los archivos de se pueden utilizar al ejecutar o crear la aplicación React, configurando el REACT_APP_ENV antes de ejecutar un npm comando.

Por ejemplo, la aplicación de React package.json puede contener lo siguiente scripts configuración:

  • package.json
code language-none
...
"scripts": {
  "build:development": "REACT_APP_ENV=development npm run build",
  "build:stage": "REACT_APP_ENV=stage npm run build",
  "build:production": "REACT_APP_ENV=production npm run build"
},
...

AEM cliente sin encabezado

El AEM Cliente sin encabezado para JavaScript AEM AEM contiene un cliente sin encabezado de que realiza solicitudes HTTP a las API de GraphQL de la. AEM AEM El cliente sin encabezado de la debe inicializarse con el host de la interfaz con el que interactúa, utilizando el valor del activo .env archivo.

  • src/api/headlessClient.js
code language-none
const { AEMHeadless } = require('@adobe/aem-headless-client-js');
...
// Get the environment variables for configuring the headless client,
// specifically the `REACT_APP_AEM_HOST` which contains the AEM service host.
const {
    REACT_APP_AEM_HOST,         // https://publish-p123-e456.adobeaemcloud.com
    REACT_APP_GRAPHQL_ENDPOINT,
} = process.env;
...

// Initialize the AEM Headless client with the AEM Service host, which dictates the AEM service provides the GraphQL data.
export const aemHeadlessClient = new AEMHeadless({
    serviceURL: REACT_APP_AEM_HOST,
    endpoint: REACT_APP_GRAPHQL_ENDPOINT
});

React useEffect(…) gancho

AEM AEM Los enlaces personalizados de React useEffect llaman al cliente sin encabezado de la, inicializado con el host, en nombre del componente React que procesa la vista.

  • src/api/persistedQueries.js
code language-javascript
import { aemHeadlessClient , mapErrors} from "./headlessClient";
...
// The exported useEffect hook
export const getAdventureByPath = async function(adventurePath) {
    const queryVariables = {'adventurePath': adventurePath};
    return executePersistedQuery('wknd-shared/adventures-by-path', queryVariables);
}
...
// Private function that invokes the aemHeadlessClient
const executePersistedQuery = async function(persistedQueryPath, queryVariables) {
    let data;
    let errors;

    try {
        // Run the persisted query using using the aemHeadlessClient that's initialized with the AEM host
        const response = await aemHeadlessClient.runPersistedQuery(persistedQueryPath, queryVariables);
        // The GraphQL data is stored on the response's data field
        data = response.data;
        errors = response.errors ? mapErrors(response.errors) : undefined;
    } catch (e) {
        console.error(e.toJSON());
        errors = e;
    }

    return {data, errors};
}

Componente React

El gancho useEffect personalizado, useAdventureByPath AEM se importa y se utiliza para obtener los datos mediante el cliente sin encabezado de y, finalmente, para procesar el contenido al usuario final.

  • 'src/components/AdventureDetail.js'
code language-javascript
import { useAdventureByPath } from './api/persistedQueries';
...
// Query AEM GraphQL APIs via the useEffect hook that invokes the AEM Headless client initialized with the AEM host
let { data, error } = useAdventureByPath('/content/dam/wknd-shared/en/adventures/bali-surf-camp/adobestock-175749320.jpg')

...
Ejemplo de iOS™

Este ejemplo, basado en la variable AEM aplicación iOS™ de ejemploAEM , ilustra cómo se pueden configurar las solicitudes de API de GraphQL AEM para conectarse a diferentes hosts en función de la configuración de los parámetros de la aplicación de la interfaz de usuario de la aplicación de red () variables de configuración específicas de la versión.

Las aplicaciones de iOSAEM AEM ™ requieren un cliente sin encabezado personalizado para poder interactuar con las API de GraphQL de la interfaz de usuario de. AEM AEM El cliente sin encabezado de la debe escribirse de modo que el host de servicio de la sea configurable.

Generar configuración

El archivo de configuración XCode contiene los detalles de configuración predeterminados.

  • Config.xcconfig
code language-swift
// The http/https protocol scheme used to access the AEM_HOST
AEM_SCHEME = https

// Target hostname for AEM service, do not include the scheme: http:// or https://
AEM_HOST = publish-p123-e789.adobeaemcloud.com
...

AEM Inicialice el cliente personalizado sin encabezado

El AEM aplicación de iOS sin encabezado de ejemplo AEM utiliza un cliente sin encabezado personalizado que se inicializa con los valores de configuración de AEM_SCHEME y AEM_HOST.

code language-swift
...
let aemScheme: String = try Configuration.value(for: "AEM_SCHEME")  // https
let aemHost: String = try Configuration.value(for: "AEM_HOST")      // publish-p123-e456.adobeaemcloud.com

let aemHeadlessClient = Aem(scheme: aemScheme, host: aemHost);

AEM El cliente personalizado sin encabezado (api/Aem.swift) contiene un método makeRequest(..) AEM que prefija las solicitudes de API de GraphQL AEM con la configuración de la scheme y host.

  • api/Aem.swift
code language-swift
/// #makeRequest(..)
/// Generic method for constructing and executing AEM GraphQL persisted queries
private func makeRequest(persistedQueryName: String, params: [String: String] = [:]) -> URLRequest {
    // Encode optional parameters as required by AEM
    let persistedQueryParams = params.map { (param) -> String in
        encode(string: ";\(param.key)=\(param.value)")
    }.joined(separator: "")

    // Construct the AEM GraphQL persisted query URL, including optional query params
    let url: String = "\(self.scheme)://\(self.host)/graphql/execute.json/" + persistedQueryName + persistedQueryParams;

    var request = URLRequest(url: URL(string: url)!);

    return request;
}

Se pueden crear nuevos archivos de configuración de compilación AEM para conectarse a diferentes servicios de la. Los valores específicos de la compilación para AEM_SCHEME y AEM_HOST AEM AEM se utilizan en función de la compilación seleccionada en XCode, lo que da como resultado el cliente personalizado sin encabezado para conectarse con el servicio de correcto.

Ejemplo de Android™

Este ejemplo, basado en la variable AEM aplicación de ejemplo para Android™ sin encabezadoAEM , ilustra cómo se pueden configurar las solicitudes de API de GraphQL AEM para conectarse a diferentes servicios de en función de variables de configuración específicas de la compilación (o variantes).

Las aplicaciones de Android™ (cuando se escriben en Java™) deben utilizar el AEM Cliente sin encabezado para Java™ AEM para interactuar con las API de GraphQL de la. AEM AEM AEM El cliente sin encabezado de la, proporcionado por el cliente sin encabezado de la aplicación para Java™, debe inicializarse con el host de servicio al que se conecta.

Generar archivo de configuración

Las aplicaciones de Android™ definen "productFlavors", que se utilizan para crear artefactos para diferentes usos.
AEM Este ejemplo muestra cómo se pueden definir dos tipos de productos de Android™, proporcionando hosts de servicio diferentes (AEM_HOST) valores para desarrollo (dev) y producción (prod) utiliza.

En el build.gradle archivo, un nuevo flavorDimension nombrado env se ha creado.

En el env dimensión, dos productFlavors están definidas: dev y prod. Cada productFlavor utiliza buildConfigField AEM para establecer variables específicas de la compilación que definan el servicio de la al que se va a conectar.

  • app/build.gradle
code language-gradle
android {
    ...
    flavorDimensions 'env'
    productFlavors {
        dev {
            dimension 'env'
            applicationIdSuffix '.dev'
            buildConfigField "String", "AEM_HOST", '"http://10.0.2.2:4503"'
            ...
        }
        prod {
            dimension 'env'
            buildConfigField "String", "AEM_HOST", '"https://publish-p123-e789.adobeaemcloud.com"'
            ...
        }
    }
    ...
}

Cargador de Android™

Inicialice el AEMHeadlessClient AEM creador, proporcionado por el cliente sin encabezado para Java™ con la variable AEM_HOST valor de la variable buildConfigField field.

  • app/src/main/java/com/adobe/wknd/androidapp/loader/AdventuresLoader.java
code language-java
public class AdventuresLoader extends AsyncTaskLoader<AdventureList> {
    ...

    @Override
    public AdventureList loadInBackground() {
        ...
        // Initialize the AEM Headless client using the AEM Host exposed via BuildConfig.AEM_HOST
        AEMHeadlessClientBuilder builder = AEMHeadlessClient.builder().endpoint(BuildConfig.AEM_HOST);
        AEMHeadlessClient client = builder.build();
        // With the AEM headless client initialized, make GraphQL persisted query calls to AEM
        ...
    }
    ...
}

Cuando cree la aplicación de Android™ para diferentes usos, especifique el env AEM y se utiliza el valor de host correspondiente.

AEM URL de imagen de

AEM AEM Las solicitudes de imagen de la aplicación sin encabezado a los usuarios deben configurarse para que interactúen con el servicio de correcto, tal como se describe en la sección tabla anterior.

Adobe recomienda utilizar imágenes optimizadas disponible a través de la _dynamicUrl AEM en las API de GraphQL de la. El _dynamicUrl AEM AEM El campo devuelve una URL sin host que puede ir precedida por el host de servicio de que se utiliza para consultar las API de GraphQL de la. Para el _dynamicUrl El campo de la respuesta de GraphQL tiene este aspecto:

{
    ...
    "_dynamicUrl": "/adobe/dynamicmedia/deliver/dm-aid--dd42d814-88ec-4c4d-b5ef-e3dc4bc0cb42/example.jpg?preferwebp=true",
    ...
}

Ejemplos

AEM A continuación, se muestran ejemplos de cómo las direcciones URL de imagen pueden prefijar el valor de host que se hace configurable para varios marcos de aplicación sin encabezado. En los ejemplos se supone el uso de consultas de GraphQL que devuelven referencias de imagen utilizando _dynamicUrl field.

Por ejemplo:

Consulta persistente de GraphQL

Esta consulta de GraphQL devuelve una referencia de imagen de _dynamicUrl. Como se ve en el Respuesta de GraphQL que excluye un host.

query ($path: String!) {
  adventureByPath(_path: $path, _assetTransform: { format: JPG, preferWebp: true }) {
    item {
      title,
      primaryImage {
        ... on ImageRef {
          _dynamicUrl
        }
      }
    }
  }
}

Respuesta de GraphQL

Esta respuesta de GraphQL devuelve el de la referencia de imagen _dynamicUrl que excluye un host.

{
  "data": {
    "adventureByPath": {
      "item": {
        "adventurePrimaryImage": {
          "_dynamicUrl": "/adobe/dynamicmedia/deliver/dm-aid--de43411-88ec-4c4d-b5ef-e3dc4bc0cb42/adobestock-175749320.jpg?preferwebp=true",
        }
      }
    }
  }
}
Ejemplo de React

Este ejemplo, basado en la variable AEM ejemplo de aplicación React sin encabezadoAEM , ilustra cómo se pueden configurar las direcciones URL de imagen para conectarse a los servicios de correctos en función de las variables de entorno.

Este ejemplo muestra el prefijo de la referencia de imagen _dynamicUrl , con un campo configurable REACT_APP_AEM_HOST Variable de entorno React.

Archivo de entorno de React

React utiliza archivos de entorno personalizados, o .env archivos, almacenados en la raíz del proyecto para definir valores específicos de la generación. Por ejemplo, la variable .env.development contiene valores utilizados para durante el desarrollo, mientras que .env.production contiene valores utilizados para las versiones de producción.

  • .env.development
code language-none
# Environment variable used to specify the AEM service the React app will connect to when running under this profile
REACT_APP_AEM_HOST=https://publish-p123-e456.adobeaemcloud.com
...

.env archivos para otros usos se puede especificar por postfijación .env y un descriptor semántico, como .env.stage o .env.production. Different .env El archivo se puede utilizar al ejecutar o crear la aplicación React, configurando el REACT_APP_ENV antes de ejecutar un npm comando.

Por ejemplo, la aplicación de React package.json puede contener lo siguiente scripts configuración:

  • package.json
code language-none
...
"scripts": {
  "build:development": "REACT_APP_ENV=development npm run build",
  "build:stage": "REACT_APP_ENV=stage npm run build",
  "build:production": "REACT_APP_ENV=production npm run build"
},
...

Componente React

El componente React importa el REACT_APP_AEM_HOST variable de entorno y prefija la imagen _dynamicUrl , para proporcionar una URL de imagen totalmente resoluble.

Esto mismo REACT_APP_AEM_HOST AEM La variable de entorno se utiliza para inicializar el cliente sin encabezado de la que utiliza useAdventureByPath(..) enlace useEffect personalizado que se utiliza para extraer los datos de GraphQL AEM de los datos de los informes de. Utilizando la misma variable para construir la solicitud de API de GraphQL AEM como la dirección URL de la imagen, asegúrese de que la aplicación React interactúa con el mismo servicio de para ambos casos de uso.

  • 'src/components/AdventureDetail.js'
code language-javascript
...
// Import the AEM origin from the app's environment configuration
const AEM_HOST = env.process.REACT_APP_AEM_HOST; // https://publish-p123-e456.adobeaemcloud.com

let { data, error } = useAdventureByPath('/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp')

return (
    // Prefix the image src URL with the AEM host
    <img src={AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl }>
    {/* Resulting in: <img src="https://publish-p123-e456.adobeaemcloud.com/adobe/dynamicmedia/deliver/dm-aid--de43411-88ec-4c4d-b5ef-e3dc4bc0cb42/adobestock-175749320.jpg"/>  */}
)
Ejemplo de iOS™

Este ejemplo, basado en la variable AEM aplicación iOS™ de ejemploAEM AEM , ilustra cómo se pueden configurar las direcciones URL de imagen de la para conectarse a distintos hosts en función de variables de configuración específicas de la versión.

Generar configuración

El archivo de configuración XCode contiene los detalles de configuración predeterminados.

  • Config.xcconfig
code language-swift
// The http/https protocol scheme used to access the AEM_HOST
AEM_SCHEME = https

// Target hostname for AEM service, do not include the scheme: http:// or https://
AEM_HOST = publish-p123-e789.adobeaemcloud.com
...

Generador de URL de imagen

Entrada Aem.swiftAEM , la implementación personalizada de cliente sin encabezado de la, una función personalizada imageUrl(..) toma la ruta de la imagen como se indica en la _dynamicUrl en la respuesta de GraphQL AEM, y la antepone con el host de. A continuación, esta función se invoca en las vistas de iOS cada vez que se procesa una imagen.

  • WKNDAdventures/AEM/Aem.swift
code language-swift
class Aem: ObservableObject {
    let scheme: String
    let host: String
    ...
    init(scheme: String, host: String) {
        self.scheme = scheme
        self.host = host
    }
    ...
    /// Prefixes AEM image dynamicUrl with the AEM scheme/host
    func imageUrl(dynamicUrl: String) -> URL {
        return URL(string: "\(self.scheme)://\(self.host)\(dynamicUrl)")!
    }
    ...
}

Vista de iOS

La vista iOS y los prefijos de la imagen _dynamicUrl , para proporcionar una URL de imagen totalmente resoluble.

  • WKNDAdventures/Views/AdventureListItemView.swift
code language-swift
import SDWebImageSwiftUI
...
struct AdventureListItemView: View {
    @EnvironmentObject private var aem: Aem

    var adventure: Adventure

    var body: some View {
        HStack {
            // Path the image dynamicUrl to `aem.imageUrl(..)` to prepend the AEM service host
            AdventureRowImage(imageUrl: aem.imageUrl(dynamicUrl: adventure.image()))
            Text(adventure.title)
            Spacer()
        }
    }
}
...

Se pueden crear nuevos archivos de configuración de compilación AEM para conectarse a diferentes servicios de la. Los valores específicos de la compilación para AEM_SCHEME y AEM_HOST AEM AEM se utilizan en función de la compilación seleccionada en XCode, lo que da como resultado que el cliente personalizado sin encabezado interactúe con el servicio de correcto.

Ejemplo de Android™

Este ejemplo, basado en la variable AEM aplicación de ejemplo para Android™ sin encabezadoAEM AEM , ilustra cómo se pueden configurar las direcciones URL de imagen de la para conectarse a diferentes servicios de segmentación en función de variables de configuración específicas de la compilación (o variantes).

Generar archivo de configuración

Las aplicaciones de Android™ definen "productFlavors", que se utilizan para crear artefactos para diferentes usos.
AEM Este ejemplo muestra cómo se pueden definir dos tipos de productos de Android™, proporcionando hosts de servicio diferentes (AEM_HOST) valores para desarrollo (dev) y producción (prod) utiliza.

En el build.gradle archivo, un nuevo flavorDimension nombrado env se ha creado.

En el env dimensión, dos productFlavors están definidas: dev y prod. Cada productFlavor utiliza buildConfigField AEM para establecer variables específicas de la compilación que definan el servicio de la al que se va a conectar.

  • app/build.gradle
code language-gradle
android {
    ...
    flavorDimensions 'env'
    productFlavors {
        dev {
            dimension 'env'
            applicationIdSuffix '.dev'
            buildConfigField "String", "AEM_HOST", '"http://10.0.2.2:4503"'
            ...
        }
        prod {
            dimension 'env'
            buildConfigField "String", "AEM_HOST", '"https://publish-p123-e789.adobeaemcloud.com"'
            ...
        }
    }
    ...
}

AEM Cargando la imagen de la

El Android™ utiliza un ImageGetter AEM para recuperar y almacenar en caché localmente los datos de imagen de los recursos de la. Entrada prepareDrawableFor(..) AEM AEM el host de servicio de, definido en la configuración de la versión activa, se utiliza para anteponer la ruta de la imagen que crea una dirección URL solucionable a la dirección de correo electrónico que se va a utilizar para la creación de.

  • app/src/main/java/com/adobe/wknd/androidapp/loader/RemoteImagesCache.java
code language-java
...
public class RemoteImagesCache implements Html.ImageGetter {
    ...
    private final Map<String, Drawable> drawablesByPath = new HashMap<>();
    ...
    public void prepareDrawableFor(String path) {
        ...

        // Prefix the image path with the build config AEM_HOST variable
        String urlStr = BuildConfig.AEM_HOST + path;

        URL url = new URL(urlStr);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        // Get the image data from AEM
        Drawable drawable = Drawable.createFromStream(is, new File(path).getName());
        ...
        // Save the image data into the cache using the path as the key
        drawablesByPath.put(path, drawable);
        ...
    }

    @Override
    public Drawable getDrawable(String dynamicUrl) {
        // Get the image data from the cache using the dynamicUrl as the key
        return drawablesByPath.get(dynamicUrl);
    }
}

Vista de Android™

La vista de Android™ obtiene los datos de imagen mediante el RemoteImagesCache uso del _dynamicUrl valor de la respuesta de GraphQL.

  • app/src/main/java/com/adobe/wknd/androidapp/AdventureDetailFragment.java
code language-java
...
public class AdventureDetailFragment extends Fragment implements LoaderManager.LoaderCallbacks<Adventure> {
    ...
    private ImageView adventureDetailImage;
    ...

    private void updateContent() {
        ...
        adventureDetailImage.setImageDrawable(RemoteImagesCache.getInstance().getDrawable(adventure.getPrimaryImageDynamicUrl()));
        ...
    }
...
}

Cuando cree la aplicación de Android™ para diferentes usos, especifique el env AEM y se utiliza el valor de host correspondiente.

recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4