Aplicación Next.js

[AEM sin encabezado as a Cloud Service]{class="badge informative"}

Las aplicaciones de ejemplo son una buena manera de explorar las capacidades sin encabezado de Adobe Experience Manager AEM (). AEM Esta aplicación Next.js muestra cómo realizar consultas en el contenido mediante API de GraphQL de utilizando consultas persistentes. AEM El cliente sin encabezado para JavaScript se utiliza para ejecutar las consultas persistentes de GraphQL que alimentan la aplicación.

AEM Aplicación Next.js con sin encabezado

Ver el código fuente en GitHub

Requisitos previos prerequisites

Las siguientes herramientas deben instalarse localmente:

AEM requisitos de

AEM La aplicación Next.js funciona con las siguientes opciones de implementación de. Todas las implementaciones requieren WKND compartido v3.0.0+ o Sitio WKND 3.0.0+ AEM que se va a instalar en el entorno as a Cloud Service de la.

Esta aplicación Next.js de ejemplo está diseñada para conectarse a AEM Publicación de servicio.

AEM Requisitos de autor de

Next.js está diseñado para conectarse a AEM Publicación de y acceder a contenido no protegido. AEM El archivo Next.js se puede configurar para que se conecte a la interfaz de usuario de Autor mediante la interfaz de usuario de la interfaz de usuario de. .env propiedades que se describen a continuación. AEM AEM Las imágenes proporcionadas desde Autor de la requieren autenticación y, por lo tanto, el usuario que acceda a la aplicación Next.js también debe iniciar sesión en Autor de la.

Cómo usar

  1. Clonar el adobe/aem-guides-wknd-graphql repositorio:

    code language-shell
    $ git clone git@github.com:adobe/aem-guides-wknd-graphql.git
    
  2. Edite el aem-guides-wknd-graphql/next-js/.env.local archivo y establecer NEXT_PUBLIC_AEM_HOST AEM al servicio de la.

    code language-plain
    # AEM service
    NEXT_PUBLIC_AEM_HOST=https://publish-p123-e456.adobeaemcloud.com/
    ...
    

    AEM AEM Si se conecta a servicio de Author, la autenticación debe proporcionarse ya que el servicio de Author es seguro de forma predeterminada.

    AEM Para usar un conjunto de cuentas de la cuenta de local AEM_AUTH_METHOD=basic y proporcione el nombre de usuario y la contraseña en la AEM_AUTH_USER y AEM_AUTH_PASSWORD propiedades.

    code language-plain
    ...
    # The variables are not prefixed with NEXT_PUBLIC so they are only available server-side
    AEM_AUTH_METHOD=basic
    AEM_AUTH_USER=aem-user-account
    AEM_AUTH_PASSWORD=password-for-the-aem-user-account
    

    Para utilizar un AEM Token de desarrollo local as a Cloud Service set AEM_AUTH_METHOD=dev-token y proporcione el valor de token de desarrollo completo en la variable AEM_AUTH_DEV_TOKEN propiedad.

    code language-plain
    ...
    # The variables are not prefixed with NEXT_PUBLIC so they are only available server-side
    AEM_AUTH_METHOD=dev-token
    AEM_AUTH_DEV_TOKEN=my-dev-token
    
  3. Edite el aem-guides-wknd-graphql/next-js/.env.local archivar y validar NEXT_PUBLIC_AEM_GRAPHQL_ENDPOINT AEM se establece en el extremo de GraphQL de la aplicación correspondiente.

    Al utilizar WKND compartido o Sitio WKND, use el wknd-shared Extremo de API de GraphQL.

    code language-plain
    ...
    NEXT_PUBLIC_AEM_GRAPHQL_ENDPOINT=wknd-shared
    ...
    
  4. Abra un símbolo del sistema e inicie la aplicación Next.js con los siguientes comandos:

    code language-shell
    $ cd aem-guides-wknd-graphql/next-js
    $ npm install
    $ npm run dev
    
  5. Una nueva ventana del explorador abre la aplicación Next.js en http://localhost:3000

  6. La aplicación Next.js muestra una lista de aventuras. Al seleccionar una aventura, se abren sus detalles en una nueva página.

El código

AEM A continuación se muestra un resumen de cómo se crea la aplicación Next.js, cómo se conecta a la aplicación sin encabezado para recuperar contenido mediante consultas persistentes de GraphQL y cómo se presentan esos datos. El código completo se encuentra en GitHub.

Consultas persistentes

AEM AEM Siguiendo las prácticas recomendadas de sin encabezado de la aplicación, Next.js utiliza consultas persistentes de GraphQL de la aplicación para consultar los datos de aventura de la aplicación de la manera más rápida y sencilla. La aplicación utiliza dos consultas persistentes:

  • wknd/adventures-all AEM consulta persistente, que devuelve todas las aventuras en con un conjunto abreviado de propiedades de, que se han guardado de forma predeterminada. Esta consulta persistente genera la lista de aventuras de la vista inicial.
# Retrieves a list of all Adventures
#
# Optional query variables:
# - { "offset": 10 }
# - { "limit": 5 }
# - {
#    "imageFormat": "JPG",
#    "imageWidth": 1600,
#    "imageQuality": 90
#   }
query ($offset: Int, $limit: Int, $sort: String, $imageFormat: AssetTransformFormat=JPG, $imageWidth: Int=1200, $imageQuality: Int=80) {
  adventureList(
    offset: $offset
    limit: $limit
    sort: $sort
    _assetTransform: {
      format: $imageFormat
      width: $imageWidth
      quality: $imageQuality
      preferWebp: true
  }) {
    items {
      _path
      slug
      title
      activity
      price
      tripLength
      primaryImage {
        ... on ImageRef {
          _path
          _dynamicUrl
        }
      }
    }
  }
}
  • wknd/adventure-by-slug consulta persistente, que devuelve una sola aventura de slug (una propiedad personalizada que identifica de forma exclusiva una aventura) con un conjunto completo de propiedades. Esta consulta persistente activa las vistas de detalles de aventura.
# Retrieves an Adventure Fragment based on it's unique slug.
#
# Required query variables:
# - {"slug": "bali-surf-camp"}
#
# Optional query variables:
# - {
#     "imageFormat": "JPG",
#     "imageSeoName": "my-adventure",
#     "imageWidth": 1600,
#     "imageQuality": 90
#   }
#
# This query returns an adventure list but since the the slug property is set to be unique in the Content Fragment Model, only a single Content Fragment is expected.

query ($slug: String!, $imageFormat:AssetTransformFormat=JPG, $imageSeoName: String, $imageWidth: Int=1200, $imageQuality: Int=80) {
  adventureList(
    filter: {slug: {_expressions: [{value: $slug}]}}
    _assetTransform: {
      format: $imageFormat
      seoName: $imageSeoName
      width: $imageWidth
      quality: $imageQuality
      preferWebp: true
  }) {
    items {
      _path
      title
      slug
      activity
      adventureType
      price
      tripLength
      groupSize
      difficulty
      price
      primaryImage {
        ... on ImageRef {
          _path
          _dynamicUrl
        }
      }
      description {
        json
        plaintext
        html
      }
      itinerary {
        json
        plaintext
        html
      }
    }
    _references {
      ... on AdventureModel {
        _path
        slug
        title
        price
        __typename
      }
    }
  }
}

Ejecutar consulta persistente de GraphQL

AEM Las consultas persistentes se ejecutan a través de la GET HTTP y, por lo tanto, la variable AEM Cliente sin encabezado para JavaScript está acostumbrado a ejecutar las consultas de GraphQL persistentes AEM contra y cargar el contenido de la aventura en la aplicación.

Cada consulta persistente tiene una función correspondiente en src/lib//aem-headless-client.jsAEM , que llama al punto final de GraphQL de la y devuelve los datos de la aventura.

Cada función, a su vez, invoca el aemHeadlessClient.runPersistedQuery(...), ejecutando la consulta GraphQL persistente.

// src/lib/aem-headless-client.js

...
/**
 * Invokes the 'adventures-all` persisted query using the parameterizable namespace.
 *
 * @returns a GraphQL response of all adventures.
 */
async getAllAdventures() {
  const queryAdventuresAll = process.env.NEXT_PUBLIC_AEM_GRAPHQL_ENDPOINT + '/adventures-all';

  try {
    return await this.aemHeadlessClient.runPersistedQuery(queryAdventuresAll);
  } catch(e) {
    console.error(e)
  }
}

// And so on, and so forth ...

async getAdventureSlugs(queryVariables) { ... }

async getAdventuresBySlug(slug, queryVariables) { ... }
...

Páginas

La aplicación Next.js utiliza dos páginas para presentar los datos de la aventura.

  • src/pages/index.js

    Usos getServerSideProps() de Next.js para llamar a getAllAdventures() y muestra cada aventura como una tarjeta.

    El uso de getServerSiteProps() permite la representación del lado del servidor de esta página Next.js.

  • src/pages/adventures/[...slug].js

    A Ruta dinámica de Next.js que muestra los detalles de una sola aventura. Esta ruta dinámica recupera previamente los datos de cada aventura mediante getStaticProps() de Next.js mediante una llamada a getAdventureBySlug(slug, queryVariables) uso del slug parámetro pasado a través de la selección de aventuras en adventures/index.js página, y queryVariables para controlar el formato, anchura y calidad de la imagen.

    La ruta dinámica puede recuperar previamente los detalles de todas las aventuras utilizando getStaticPaths() de Next.js y rellenando todas las permutaciones de ruta posibles en función de la lista completa de aventuras devueltas por la consulta de GraphQL getAdventurePaths()

    El uso de getStaticPaths() y getStaticProps(..) permitía la generación estática del sitio de estas páginas de Next.js.

Configuración de implementación

Las aplicaciones Next.js, especialmente en el contexto del procesamiento del lado del servidor (SSR) y la generación del lado del servidor (SSG), no requieren configuraciones de seguridad avanzadas como el uso compartido de recursos de origen cruzado (CORS).

AEM AEM Sin embargo, si Next.js realiza solicitudes HTTP a las que se debe acceder desde el contexto del cliente, es posible que se requieran las configuraciones de seguridad en las que se realiza la petición de acceso desde el. Revise la AEM Tutorial de implementación de aplicación de una sola página sin encabezado para obtener más información.

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