Aplicativo React react-app

AEM Headless as a Cloud Service

Aplicativos de exemplo são uma ótima maneira de explorar as capacidades headless do Adobe Experience Manager (AEM). Este aplicativo React demonstra como consultar conteúdo usando APIs AEM GraphQL usando consultas persistentes. O AEM Headless Client para JavaScript é usado para executar as consultas persistentes do GraphQL que alimentam o aplicativo.

Aplicativo React com AEM Headless

Exibir o código-fonte no GitHub

A tutorial passo a passo completo descrever como este aplicativo React foi criado está disponível.

Pré-requisitos prerequisites

As seguintes ferramentas devem ser instaladas localmente:

Requisitos do AEM

O aplicativo React funciona com as seguintes opções de implantação de AEM. Todas as implantações exigem o Site WKND v3.0.0+ a ser instalado.

O aplicativo React foi projetado para se conectar a um Publicação no AEM ambiente, no entanto, ele pode originar conteúdo do AEM Author se a autenticação for fornecida na configuração do aplicativo React.

Como usar

  1. Clonar o adobe/aem-guides-wknd-graphql repositório:

    code language-shell
    $ git clone git@github.com:adobe/aem-guides-wknd-graphql.git
    
  2. Edite o aem-guides-wknd-graphql/react-app/.env.development arquivo e definir REACT_APP_HOST_URI para apontar para seu AEM alvo.

    Atualize o método de autenticação se estiver se conectando a uma instância de autor.

    code language-plain
    # Server namespace
    REACT_APP_HOST_URI=https://publish-p123-e456.adobeaemcloud.com
    
    #AUTH (Choose one method)
    # Authentication methods: 'service-token', 'dev-token', 'basic' or leave blank to use no authentication
    REACT_APP_AUTH_METHOD=basic
    
    # For Bearer auth, use DEV token (dev-token) from Cloud console
    REACT_APP_DEV_TOKEN=dev-token
    
    # For Service toke auth, provide path to service token file (download file from Cloud console)
    REACT_APP_SERVICE_TOKEN=auth/service-token.json
    
    # For Basic auth, use AEM ['user','pass'] pair (eg for Local AEM Author instance)
    REACT_APP_BASIC_AUTH_USER=admin
    REACT_APP_BASIC_AUTH_PASS=admin
    
  3. Abra um terminal e execute os comandos:

    code language-shell
    $ cd aem-guides-wknd-graphql/react-app
    $ npm install
    $ npm start
    
  4. Uma nova janela do navegador deve ser carregada em http://localhost:3000

  5. Uma lista de aventuras do site de referência WKND deve ser exibida no aplicativo.

O código

Abaixo está um resumo de como o aplicativo React é criado, como ele se conecta ao AEM Headless para recuperar conteúdo usando consultas persistentes do GraphQL e como esses dados são apresentados. O código completo pode ser encontrado em GitHub.

Consultas persistentes

Seguindo as práticas recomendadas do AEM Headless, o aplicativo React usa consultas persistentes do AEM GraphQL para consultar dados de aventura. O aplicativo usa duas consultas persistentes:

  • wknd/adventures-all consulta persistente, que retorna todas as aventuras no AEM com um conjunto abreviado de propriedades. Essa consulta persistente direciona a lista de aventura da visualização 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 retorna uma única aventura de slug (uma propriedade personalizada que identifica exclusivamente uma aventura) com um conjunto completo de propriedades. Essa consulta persistente possibilita as exibições de detalhes 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
      }
    }
  }
}

Executar consulta persistente do GraphQL

As consultas persistentes de AEM são executadas por HTTP GET e, portanto, o Cliente AEM Headless para JavaScript é usado para executar as consultas persistentes do GraphQL contra o AEM e carregue o conteúdo de aventura no aplicativo.

Cada consulta persistente tem um React correspondente useEffect gancho em src/api/usePersistedQueries.js, que chama de forma assíncrona o ponto de acesso de consulta persistente do AEM HTTP GET e retorna os dados de aventura.

Cada função, por sua vez, chama a variável aemHeadlessClient.runPersistedQuery(...), executando a consulta persistente do GraphQL.

// src/api/usePersistedQueries.js

/**
 * React custom hook that returns a list of adevntures by activity. If no activity is provided, all adventures are returned.
 *
 * Custom hook that calls the 'wknd-shared/adventures-all' or 'wknd-shared/adventures-by-activity' persisted query.
 *
 * @returns an array of Adventure JSON objects, and array of errors
 */
export function useAdventuresByActivity(adventureActivity, params = {}) {
  ...
  let queryVariables = params;

  // If an activity is provided (i.e "Camping", "Hiking"...) call wknd-shared/adventures-by-activity query
  if (adventureActivity) {
    // The key is 'activity' as defined in the persisted query
    queryVariables = { ...queryVariables, activity: adventureActivity };

    // Call the AEM GraphQL persisted query named "wknd-shared/adventures-by-activity" with parameters
    response = await fetchPersistedQuery("wknd-shared/adventures-by-activity", queryVariables);
  } else {
    // Else call the AEM GraphQL persisted query named "wknd-shared/adventures-all" to get all adventures
    response = await fetchPersistedQuery("wknd-shared/adventures-all", queryVariables);
  }

  ...
}

...
/**
 * Private function that invokes the AEM Headless client.
 *
 * @param {String} persistedQueryName the fully qualified name of the persisted query
 * @param {*} queryParameters an optional JavaScript object containing query parameters
 * @returns the GraphQL data or an error message
 */
async function fetchPersistedQuery(persistedQueryName, queryParameters) {
  let data;
  let err;

  try {
    // AEM GraphQL queries are asynchronous, either await their return or use Promise-based .then(..) { ... } syntax
    const response = await aemHeadlessClient.runPersistedQuery(
      persistedQueryName,
      queryParameters
    );
    // The GraphQL data is stored on the response's data field
    data = response?.data;
  } catch (e) {
    // An error occurred, return the error messages
    err = e
      .toJSON()
      ?.map((error) => error.message)
      ?.join(", ");
    console.error(e.toJSON());
  }

  return { data, err };
}

Exibições

O aplicativo React usa duas visualizações para apresentar os dados de aventura na experiência da web.

  • src/components/Adventures.js

    Chamadas getAdventuresByActivity(..) de src/api/usePersistedQueries.js e exibe as aventuras retornadas em uma lista.

  • src/components/AdventureDetail.js

    Chama o getAdventureBySlug(..) usando o slug parâmetro passado pela seleção de aventura no Adventures e exibe os detalhes de uma única aventura.

Variáveis de ambiente

Vários variáveis de ambiente são usados para se conectar a um ambiente AEM. O padrão se conecta ao AEM Publicação em execução em http://localhost:4503. Atualize o .env.development arquivo, para alterar a conexão AEM:

  • REACT_APP_HOST_URI=https://publish-p123-e456.adobeaemcloud.com: Definir para host de destino do AEM

  • REACT_APP_GRAPHQL_ENDPOINT=/content/graphql/global/endpoint.json: Defina o caminho do endpoint do GraphQL. Isso não é usado por este aplicativo React, pois este aplicativo usa apenas consultas persistentes.

  • REACT_APP_AUTH_METHOD=: o método de autenticação preferencial. Opcional, por padrão, nenhuma autenticação é usada.

    • service-token: usar credenciais de serviço para obter um token de acesso no AEM as a Cloud Service
    • dev-token: Use o token de desenvolvimento para desenvolvimento local no AEM as a Cloud Service
    • basic: use user/pass para desenvolvimento local com AEM Author local
    • Deixe em branco para se conectar ao AEM sem autenticação
  • REACT_APP_AUTHORIZATION=admin:admin: defina credenciais básicas de autenticação para usar se estiver se conectando a um ambiente de autor de AEM (somente para desenvolvimento). Se você estiver se conectando a um Ambiente de publicação, essa configuração não será necessária.

  • REACT_APP_DEV_TOKEN: cadeia de caracteres do token de desenvolvimento. Para se conectar à instância remota, além da autenticação básica (user:pass), você pode usar a autenticação de portador com o token DEV do console da nuvem

  • REACT_APP_SERVICE_TOKEN: Caminho para o arquivo de credenciais de serviço. Para se conectar à instância remota, a autenticação também pode ser feita com o token de serviço (baixe o arquivo do Console do desenvolvedor).

Solicitações de Proxy AEM

Ao usar o servidor de desenvolvimento de webpack (npm start) o projeto depende de um configuração de proxy usar http-proxy-middleware. O arquivo está configurado em src/setupProxy.js e depende de várias variáveis de ambiente personalizadas definidas em .env e .env.development.

Se você se conectar a um ambiente de autor de AEM, a variável o método de autenticação precisa ser configurado.

Compartilhamento de recursos entre origens (CORS)

Esse aplicativo React depende de uma configuração CORS baseada em AEM sendo executada no ambiente AEM de destino e presume que o aplicativo React é executado em http://localhost:3000 no modo de desenvolvimento. Revise oDocumentação de implantação do AEM Headless para obter mais informações sobre como configurar o CORS.

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