Saiba como personalizar a Camada de dados do cliente do Adobe com conteúdo de componentes de AEM personalizados. Saiba como usar APIs fornecidas por AEM Componentes principais para estender e personalizar a camada de dados.
Neste tutorial, você explorará várias opções para estender a camada de dados do cliente do Adobe atualizando a WKND Componente Byline. Este é um componente personalizado e as lições aprendidas neste tutorial podem ser aplicadas a outros componentes personalizados.
A ambiente de desenvolvimento local é necessário para concluir este tutorial. Capturas de tela e vídeo são capturados usando o SDK as a Cloud Service AEM executado em um macOS. Comandos e códigos são independentes do sistema operacional local, a menos que observado de outra forma.
Novo no AEM as a Cloud Service? Consulte o guia a seguir para configurar um ambiente de desenvolvimento local usando o SDK do AEM as a Cloud Service.
Novo no AEM 6.5? Confira o guia a seguir para configurar um ambiente de desenvolvimento local.
Este tutorial estende o componente Byline no site de referência WKND. Clonar e instalar a base de código WKND no ambiente local.
Iniciar um Início Rápido local autor instância de AEM em execução em http://localhost:4502.
Abra uma janela de terminal e clone a base de código WKND usando Git:
$ git clone git@github.com:adobe/aem-guides-wknd.git
Implante a base de código WKND em uma instância local de AEM:
$ cd aem-guides-wknd
$ mvn clean install -PautoInstallSinglePackage
Se estiver usando o AEM 6.5 e o service pack mais recente, adicione classic
perfil para o comando Maven:
mvn clean install -PautoInstallSinglePackage -Pclassic
Abra uma nova janela do navegador e faça logon no AEM. Abra um Revista tipo de página: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.
Você deve ver um exemplo do componente Byline que foi adicionado à página como parte de um Fragmento de experiência. Você pode exibir o Fragmento de experiência em http://localhost:4502/editor.html/content/experience-fragments/wknd/language-masters/en/contributors/stacey-roswells/byline.html
Abra as ferramentas do desenvolvedor e insira o seguinte comando no Console:
window.adobeDataLayer.getState();
Inspect a resposta para ver o estado atual da camada de dados em um site AEM. Você deve ver informações sobre a página e os componentes individuais.
Observe que o componente Byline não está listado na Camada de dados.
Para inserir dados sobre o componente na camada de dados, primeiro devemos atualizar o Modelo do Sling do componente. Em seguida, atualize a interface Java do Byline e a implementação do Modelo do Sling para adicionar um novo método getData()
. Esse método conterá as propriedades que queremos injetar na camada de dados.
No IDE de sua escolha, abra o aem-guides-wknd
projeto. Navegue até o core
módulo.
Abra o arquivo Byline.java
at core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java
.
Adicione um novo método à interface:
public interface Byline {
...
/***
* Return data about the Byline Component to populate the data layer
* @return String
*/
String getData();
}
Abra o arquivo BylineImpl.java
at core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java
.
Essa é a implementação da variável Byline
e é implementado como um Modelo do Sling.
Adicione as seguintes declarações de importação ao início do arquivo:
import java.util.HashMap;
import java.util.Map;
import org.apache.sling.api.resource.Resource;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.adobe.cq.wcm.core.components.util.ComponentUtils;
O fasterxml.jackson
As APIs são usadas para serializar os dados que queremos expor como JSON. O ComponentUtils
dos Componentes principais AEM são usados para verificar se a camada de dados está ativada.
Adicionar o método não implementado getData()
para BylineImple.java
:
public class BylineImpl implements Byline {
...
@Override
public String getData() {
Resource bylineResource = this.request.getResource();
// Use ComponentUtils to verify if the DataLayer is enabled
if (ComponentUtils.isDataLayerEnabled(bylineResource)) {
//Create a map of properties we want to expose
Map<String, Object> bylineProperties = new HashMap<String,Object>();
bylineProperties.put("@type", bylineResource.getResourceType());
bylineProperties.put("name", this.getName());
bylineProperties.put("occupation", this.getOccupations());
bylineProperties.put("fileReference", image.getFileReference());
//Use AEM Core Component utils to get a unique identifier for the Byline component (in case multiple are on the page)
String bylineComponentID = ComponentUtils.getId(bylineResource, this.currentPage, this.componentContext);
// Return the bylineProperties as a JSON String with a key of the bylineResource's ID
try {
return String.format("{\"%s\":%s}",
bylineComponentID,
// Use the ObjectMapper to serialize the bylineProperties to a JSON string
new ObjectMapper().writeValueAsString(bylineProperties));
} catch (JsonProcessingException e) {
LOGGER.error("Unable to generate dataLayer JSON string", e);
}
}
// return null if the Data Layer is not enabled
return null;
}
}
No método acima, um novo HashMap
é usada para capturar as propriedades que queremos expor como JSON. Observe que os métodos existentes como getName()
e getOccupations()
são usadas. @type
representa o tipo de recurso exclusivo do componente, isso permite que um cliente identifique eventos e/ou acionadores facilmente com base no tipo de componente.
O ObjectMapper
é usada para serializar as propriedades e retornar uma string JSON. Essa cadeia de caracteres JSON pode ser inserida na camada de dados.
Abra uma janela de terminal. Crie e implante apenas o core
módulo que usa suas habilidades Maven:
$ cd aem-guides-wknd/core
$ mvn clean install -PautoInstallBundle
Em seguida, atualize o Byline
HTL. HTL (Linguagem de modelo de HTML) é o modelo usado para renderizar o HTML do componente.
Um atributo de dados especial data-cmp-data-layer
em cada Componente de AEM é usado para expor sua camada de dados. O JavaScript fornecido pelos Componentes principais AEM procura esse atributo de dados, cujo valor é preenchido com a string JSON retornada pelo Modelo de sling Byline getData()
e injeta os valores na camada de Dados do cliente do Adobe.
No IDE, abra o aem-guides-wknd
projeto. Navegue até o ui.apps
módulo.
Abra o arquivo byline.html
at ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html
.
Atualizar byline.html
para incluir a data-cmp-data-layer
atributo:
<div data-sly-use.byline="com.adobe.aem.guides.wknd.core.models.Byline"
data-sly-use.placeholderTemplate="core/wcm/components/commons/v1/templates.html"
data-sly-test.hasContent="${!byline.empty}"
+ data-cmp-data-layer="${byline.data}"
class="cmp-byline">
...
O valor de data-cmp-data-layer
foi definida como "${byline.data}"
em que byline
é o Modelo do Sling atualizado anteriormente. .data
é a notação padrão para chamar um método Getter Java em HTL de getData()
executado no exercício anterior.
Abra uma janela de terminal. Crie e implante apenas o ui.apps
módulo que usa suas habilidades Maven:
$ cd aem-guides-wknd/ui.apps
$ mvn clean install -PautoInstallPackage
Retorne ao navegador e abra novamente a página com um componente Byline: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.
Abra as ferramentas do desenvolvedor e inspecione a fonte de HTML da página do componente Byline:
Você deve ver que a variável data-cmp-data-layer
foi preenchida com a Cadeia JSON do Modelo Sling.
Abra as ferramentas do desenvolvedor do navegador e insira o seguinte comando no Console:
window.adobeDataLayer.getState();
Navegue abaixo da resposta em component
para encontrar a instância do byline
componente foi adicionado à camada de dados:
Você deve ver uma entrada como a seguinte:
byline-136073cfcb:
@type: "wknd/components/byline"
fileReference: "/content/dam/wknd/en/contributors/stacey-roswells.jpg"
name: "Stacey Roswells"
occupation: (3) ["Artist", "Photographer", "Traveler"]
parentId: "page-30d989b3f8"
Observe que as propriedades expostas são as mesmas adicionadas no HashMap
no Modelo do Sling.
A Camada de dados do cliente do Adobe é orientada por eventos e um dos eventos mais comuns para acionar uma ação é a cmp:click
evento. Os componentes principais do AEM facilitam o registro do seu componente com a ajuda do elemento de dados: data-cmp-clickable
.
Os elementos clicáveis geralmente são um botão CTA ou um link de navegação. Infelizmente, o componente Byline não tem nenhum desses componentes, mas registraremos de qualquer maneira, pois isso pode ser comum para outros componentes personalizados.
Abra o ui.apps
no IDE
Abra o arquivo byline.html
at ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html
.
Atualizar byline.html
para incluir a data-cmp-clickable
no atributo Byline name elemento:
<h2 class="cmp-byline__name"
+ data-cmp-clickable="${byline.data ? true : false}">
${byline.name}
</h2>
Abra um novo terminal. Crie e implante apenas o ui.apps
módulo que usa suas habilidades Maven:
$ cd aem-guides-wknd/ui.apps
$ mvn clean install -PautoInstallPackage
Retorne ao navegador e abra novamente a página com o componente Byline adicionado: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.
Para testar nosso evento, adicionaremos alguns JavaScript manualmente usando o console do desenvolvedor. Consulte Uso da camada de dados do cliente do Adobe com componentes principais AEM para assistir a um vídeo sobre como fazer isso.
Abra as ferramentas do desenvolvedor do navegador e insira o seguinte método no Console:
function bylineClickHandler(event) {
var dataObject = window.adobeDataLayer.getState(event.eventInfo.path);
if (dataObject != null && dataObject['@type'] === 'wknd/components/byline') {
console.log("Byline Clicked!");
console.log("Byline name: " + dataObject['name']);
}
}
Este método simples deve lidar com o clique do nome do componente Byline.
Insira o seguinte método no Console:
window.adobeDataLayer.push(function (dl) {
dl.addEventListener("cmp:click", bylineClickHandler);
});
O método acima envia um ouvinte de evento para a camada de dados para ouvir o cmp:click
e chama a função bylineClickHandler
.
É importante not para atualizar o navegador durante todo este exercício, caso contrário, o JavaScript do console será perdido.
No navegador, com a variável Console abrir, clique no nome do autor no componente Linha de bytes:
Você deve ver a mensagem do console Byline Clicked!
e o nome Byline.
O cmp:click
evento é o mais fácil de se conectar. Para componentes mais complexos e para rastrear outros comportamentos, é possível adicionar javascript personalizado para adicionar e registrar novos eventos. Um ótimo exemplo é o componente carrossel, que dispara um cmp:show
sempre que um slide for alternado. Consulte a código fonte para obter mais detalhes.
Quando o Modelo do Sling era atualizado anteriormente no capítulo, optamos por criar a cadeia de caracteres JSON usando um HashMap
e configurar cada uma das propriedades manualmente. Esse método funciona bem para componentes únicos pequenos, no entanto, para componentes que estendem os Componentes principais do AEM, isso pode resultar em muito código extra.
Uma classe de utilidade, DataLayerBuilder
, existe para executar a maior parte do elevador pesado. Isso permite que as implementações estendam apenas as propriedades desejadas. Vamos atualizar o Modelo do Sling para usar o DataLayerBuilder
.
Retorne ao IDE e navegue até o core
módulo.
Abra o arquivo Byline.java
at core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java
.
Modifique o getData()
para retornar um tipo de ComponentData
import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
...
public interface Byline {
...
/***
* Return data about the Byline Component to populate the data layer
* @return ComponentData
*/
ComponentData getData();
}
ComponentData
é um objeto fornecido pelos Componentes principais AEM. Ele resulta em uma string JSON, exatamente como no exemplo anterior, mas também executa muito trabalho adicional.
Abra o arquivo BylineImpl.java
at core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java
.
Adicione as seguintes declarações de importação:
import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
import com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder;
Substitua o getData()
com o seguinte método:
@Override
public ComponentData getData() {
Resource bylineResource = this.request.getResource();
// Use ComponentUtils to verify if the DataLayer is enabled
if (ComponentUtils.isDataLayerEnabled(bylineResource)) {
return DataLayerBuilder.extending(getImage().getData()).asImageComponent()
.withTitle(this::getName)
.build();
}
// return null if the Data Layer is not enabled
return null;
}
O componente Byline reutiliza partes do Componente principal da imagem para exibir uma imagem que representa o autor. No trecho acima, a variável DataLayerBuilder é usada para estender a camada de dados do Image
componente. Isso preenche previamente o objeto JSON com todos os dados sobre a imagem usada. Também faz algumas das funções de rotina, como definir a variável @type
e o identificador exclusivo do componente. Observe que o método é muito pequeno!
A única propriedade estendeu o withTitle
que é substituído pelo valor de getName()
.
Abra uma janela de terminal. Crie e implante apenas o core
módulo que usa suas habilidades Maven:
$ cd aem-guides-wknd/core
$ mvn clean install -PautoInstallBundle
Retorne ao IDE e abra o byline.html
arquivo em ui.apps
Atualize o HTL para usar byline.data.json
para preencher o data-cmp-data-layer
atributo:
<div data-sly-use.byline="com.adobe.aem.guides.wknd.core.models.Byline"
data-sly-use.placeholderTemplate="core/wcm/components/commons/v1/templates.html"
data-sly-test.hasContent="${!byline.empty}"
- data-cmp-data-layer="${byline.data}"
+ data-cmp-data-layer="${byline.data.json}"
Lembre-se de que agora estamos retornando um objeto do tipo ComponentData
. Este objeto inclui um método getter getJson()
e isso é usado para preencher a variável data-cmp-data-layer
atributo.
Abra uma janela de terminal. Crie e implante apenas o ui.apps
módulo que usa suas habilidades Maven:
$ cd aem-guides-wknd/ui.apps
$ mvn clean install -PautoInstallPackage
Retorne ao navegador e abra novamente a página com o componente Byline adicionado: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.
Abra as ferramentas do desenvolvedor do navegador e insira o seguinte comando no Console:
window.adobeDataLayer.getState();
Navegue abaixo da resposta em component
para encontrar a instância do byline
componente:
Você deve ver uma entrada como a seguinte:
byline-136073cfcb:
@type: "wknd/components/byline"
dc:title: "Stacey Roswells"
image:
@type: "image/jpeg"
repo:id: "142658f8-4029-4299-9cd6-51afd52345c0"
repo:modifyDate: "2019-10-25T23:49:51Z"
repo:path: "/content/dam/wknd/en/contributors/stacey-roswells.jpg"
xdm:tags: []
parentId: "page-30d989b3f8"
repo:modifyDate: "2019-10-18T20:17:24Z"
Observe que agora há um image
dentro do byline
entrada do componente. Isso tem muito mais informações sobre o ativo no DAM. Observe também que a variável @type
e a id exclusiva (neste caso, byline-136073cfcb
) foram preenchidas automaticamente, bem como a variável repo:modifyDate
que indica quando o componente foi modificado.
Outro exemplo de extensão da camada de dados pode ser visualizado inspecionando o ImageList
componente na base de código WKND:
ImageList.java
- Interface Java na core
módulo.ImageListImpl.java
- Modelo do Sling na core
módulo.image-list.html
- Modelo HTL na ui.apps
módulo.É um pouco mais difícil incluir propriedades personalizadas como occupation
ao usar a variável DataLayerBuilder. No entanto, se você estender um Componente principal que inclui uma Imagem ou Página, o utilitário economiza muito tempo.
Se estiver criando uma camada de dados avançada para objetos reutilizados em uma implementação, é recomendável extrair os elementos da camada de dados em seus próprios objetos Java específicos da camada de dados. Por exemplo, os Componentes principais de comércio adicionaram interfaces para ProductData
e CategoryData
já que podem ser usados em muitos componentes em uma implementação do Commerce. Revisão o código no acordo de recompra aem-CIF-core-components para obter mais detalhes.
Você acabou de explorar algumas maneiras de estender e personalizar a Camada de dados do cliente do Adobe com componentes AEM!