Usando bibliotecas do lado do cliente em AEM como Cloud Service

As experiências digitais dependem muito do processamento no cliente, conduzido por códigos complexos de JavaScript e CSS. AEM bibliotecas do lado do cliente (clientlibs) permitem organizar e armazenar centralmente essas bibliotecas do lado do cliente no repositório. Em conjunto com o processo de compilação front-end no arquétipo do AEM Project, o gerenciamento do código front-end para o seu projeto AEM se torna simples.

As vantagens de usar clientlibs em AEM incluem:

  • O código do cliente é armazenado no repositório como todo o outro código e conteúdo do aplicativo
  • Clientlibs no AEM podem agregação todos os CSS e JS em um único arquivo
  • Exponha clientlibs por um caminho que pode ser acessado pelo dispatcher
  • Permite a regravação de caminhos para arquivos ou imagens referenciados

Clientlibs são a solução integrada para fornecer CSS e Javascript da AEM.

DICA

Os desenvolvedores front-end que estão criando CSS e Javascript para projetos AEM também devem se familiarizar com o AEM Project Archetype e seu processo de compilação front-end automatizado.

O que são bibliotecas do lado do cliente

Os sites exigem JavaScript e CSS, bem como recursos estáticos, como ícones e fontes da Web, para serem processados no cliente. Uma clientlib é AEM mecanismo de referência (por categoria, se necessário) e que serve tais recursos.

AEM coleta o CSS e o Javascript do site em um único arquivo, em um local central, para garantir que apenas uma cópia de qualquer recurso seja incluída na saída HTML. Isso maximiza a eficiência do delivery e permite que esses recursos sejam mantidos centralmente no repositório por proxy, mantendo o acesso protegido.

Desenvolvimento front-end para AEM como Cloud Service

Todos os ativos JavaScript, CSS e outros ativos front-end devem ser mantidos no módulo ui.front-end do AEM Project Archetype. A flexibilidade do arquétipo permite usar as ferramentas da Web modernas de sua escolha para criar e gerenciar esses recursos.

O arquétipo pode então compilar os recursos em um único arquivo CSS e JS, incorporando-os automaticamente em um cq:clientLibraryFolder no repositório.

Estrutura da pasta da biblioteca do lado do cliente

Uma pasta de biblioteca do lado do cliente é um nó de repositório do tipo cq:ClientLibraryFolder. Sua definição na notação CND é

[cq:ClientLibraryFolder] > sling:Folder
  - dependencies (string) multiple
  - categories (string) multiple
  - embed (string) multiple
  - channels (string) multiple
  • cq:ClientLibraryFolder os nós podem ser colocados em qualquer lugar dentro da /apps subárvore do repositório.
  • Use a propriedade categories do nó para identificar as categorias de biblioteca às quais ele pertence.

Cada cq:ClientLibraryFolder é preenchido com um conjunto de arquivos JS e/ou CSS, juntamente com alguns arquivos de suporte (veja abaixo). As propriedades importantes de cq:ClientLibraryFolder são configuradas da seguinte maneira:

  • allowProxy: Como todas as clientlibs devem ser armazenadas em apps, essa propriedade permite o acesso às bibliotecas de clientes por meio do servlet proxy. Consulte Localizando uma pasta de biblioteca de cliente e Usando o Servlet de bibliotecas de cliente proxy abaixo.
  • categories: Identifica as categorias nas quais o conjunto de arquivos JS e/ou CSS nesse cq:ClientLibraryFolder outono. A propriedade categories, que tem vários valores, permite que uma pasta de biblioteca faça parte de mais de uma categoria (veja abaixo como isso pode ser útil).

Se a pasta da biblioteca do cliente contiver um ou mais arquivos de origem que, em tempo de execução, serão mesclados em um único arquivo JS e/ou CSS. O nome do arquivo gerado é o nome do nó com a extensão .js ou .css do nome do arquivo. Por exemplo, o nó de biblioteca chamado cq.jquery resulta no arquivo gerado chamado cq.jquery.js ou cq.jquery.css.

As pastas da biblioteca do cliente contêm os seguintes itens:

  • Os arquivos de origem JS e/ou CSS
  • Recursos estáticos compatíveis com estilos CSS, como ícones, fontes da Web etc.
  • Um arquivo js.txt e/ou um arquivo css.txt que identifica os arquivos de origem a serem mesclados nos arquivos JS e/ou CSS gerados

Arquitetura clientlib

Criando Pastas de Biblioteca do Lado do Cliente

As bibliotecas do cliente devem estar localizadas em /apps. Isso é feito para isolar melhor o código do conteúdo e da configuração.

Para que as bibliotecas do cliente em /apps sejam acessíveis, um servidor proxy é usado. As ACLs ainda são aplicadas na pasta da biblioteca do cliente, mas o servlet permite que o conteúdo seja lido por /etc.clientlibs/ se a propriedade allowProxy estiver definida como true.

  1. Abra o CRXDE Lite em um navegador da Web (https://<host>:<port>/crx/de).
  2. Selecione a pasta /apps e clique em Criar > Criar nó.
  3. Digite um nome para a pasta da biblioteca e, na lista Type, selecione cq:ClientLibraryFolder. Clique em OK e, em seguida, clique em Salvar tudo.
  4. Para especificar a categoria ou as categorias às quais a biblioteca pertence, selecione o nó cq:ClientLibraryFolder, adicione a seguinte propriedade e clique em Salvar tudo:
    • Nome: categories
    • Tipo: String
    • Valor: O nome da categoria
    • Vários: Selecionado
  5. Para que as bibliotecas do cliente sejam acessíveis via proxy em /etc.clientlibs, selecione o nó cq:ClientLibraryFolder, adicione a seguinte propriedade e clique em Salvar tudo:
    • Nome: allowProxy
    • Tipo: booliano
    • Valor: true
  6. Se precisar gerenciar recursos estáticos, crie uma subpasta chamada resources abaixo da pasta da biblioteca do cliente.
    • Se você armazenar recursos estáticos na pasta resources, eles não poderão ser referenciados em uma instância de publicação.
  7. Adicione arquivos de origem à pasta da biblioteca.
    • Normalmente, isso é feito pelo processo de compilação front-end do AEM Project Archetype.
    • Se desejar, você pode organizar os arquivos de origem em subpastas.
  8. Selecione a pasta da biblioteca do cliente e clique em Criar > Criar arquivo.
  9. Na caixa Nome do arquivo, digite um dos seguintes nomes de arquivo e clique em OK:
    • js.txt: Use esse nome de arquivo para gerar um arquivo JavaScript.
    • css.txt: Use esse nome de arquivo para gerar uma folha de estilos em cascata.
  10. Abra o arquivo e digite o seguinte texto para identificar a raiz do caminho dos arquivos de origem:
    • #base=*[root]*
    • Substitua [root] pelo caminho para a pasta que contém os arquivos de origem, em relação ao arquivo TXT. Por exemplo, use o seguinte texto quando os arquivos de origem estiverem na mesma pasta que o arquivo TXT:
      • #base=.
    • O código a seguir define a raiz como a pasta chamada mobile abaixo do nó cq:ClientLibraryFolder:
      • #base=mobile
  11. Nas linhas abaixo de #base=[root], digite os caminhos dos arquivos de origem relativos à raiz. Coloque cada nome de arquivo em uma linha separada.
  12. Clique em Salvar tudo.

Servindo bibliotecas do lado do cliente

Quando a pasta da biblioteca do cliente estiver configurada conforme necessário, os seus clientlibs poderão ser solicitados via proxy. Como exemplo:

  • Você tem uma clientlib em /apps/myproject/clientlibs/foo
  • Você tem uma imagem estática em /apps/myprojects/clientlibs/foo/resources/icon.png

A propriedade allowProxy permite solicitar:

  • A clientlib via j/etc.clientlibs/myprojects/clientlibs/foo.js
  • A imagem estática via /etc.clientlibs/myprojects/clientlibs/foo/resources/icon.png

Carregando bibliotecas de clientes por HTL

Depois que seus clientlibs forem armazenados e gerenciados com êxito na pasta da biblioteca do cliente, eles poderão ser acessados via HTL.

As bibliotecas do cliente são carregadas por meio de um modelo auxiliar fornecido pela AEM, que pode ser acessado por meio de data-sly-use. Os modelos de ajuda estão disponíveis neste arquivo, que pode ser chamado por meio de data-sly-call.

Cada modelo auxiliar espera uma opção categories para fazer referência às bibliotecas de clientes desejadas. Essa opção pode ser uma matriz de valores de string ou uma string contendo uma lista de valores separados por vírgula.

Consulte a documentação HTL para obter mais detalhes sobre como carregar clientlibs via HTL.

Bibliotecas do cliente em Autor versus Publicar

A maioria dos clientlibs será necessária na instância de publicação AEM. Ou seja, a maioria dos propósitos dos clientlibs é produzir a experiência do usuário final do conteúdo. Para clientlibs em instâncias de publicação, ferramentas de compilação front-end podem ser usadas e implantadas por meio de pastas de biblioteca de cliente, conforme descrito acima.

No entanto, algumas vezes, as bibliotecas do cliente podem ser necessárias para personalizar a experiência de criação. Por exemplo, personalizar uma caixa de diálogo pode exigir a implantação de pequenos bits de CSS ou JS para a instância de criação AEM.

Gerenciando bibliotecas de clientes no autor

Se precisar usar as bibliotecas do cliente no autor, você poderá criar suas bibliotecas do cliente em /apps usando os mesmos métodos de publicação, mas escreva-os diretamente em /apps/.../clientlibs/foo em vez de criar um projeto inteiro para gerenciá-lo.

Em seguida, você pode "conectar" ao JS de criação adicionando suas bibliotecas de cliente a uma categoria predefinida da biblioteca de cliente.

Ferramentas de depuração

AEM fornece várias ferramentas para depurar e testar pastas da biblioteca do cliente.

Bibliotecas do Discover Client

O componente /libs/cq/granite/components/dumplibs/dumplibs gera uma página de informações sobre todas as pastas da biblioteca do cliente no sistema. O nó /libs/granite/ui/content/dumplibs tem o componente como um tipo de recurso. Para abrir a página, use o seguinte URL (alterando o host e a porta, conforme necessário):

https://<host>:<port>/libs/granite/ui/content/dumplibs.test.html

As informações incluem o caminho e o tipo da biblioteca (CSS ou JS) e os valores dos atributos da biblioteca, como categorias e dependências. As tabelas subsequentes na página mostram as bibliotecas em cada categoria e canal.

Consulte Saída gerada

O componente dumplibs inclui um seletor de teste que exibe o código-fonte gerado para as tags ui:includeClientLib. A página inclui código para diferentes combinações de atributos js, css e temáticos.

  1. Use um dos seguintes métodos para abrir a página Saída de teste:
    • Na página dumplibs.html, clique no link no texto Clique aqui para obter o teste de saída.
    • Abra o seguinte URL no navegador da Web (use um host e uma porta diferentes, conforme necessário):
      • http://<host>:<port>/libs/granite/ui/content/dumplibs.html
    • A página padrão mostra a saída de tags sem valor para o atributo categoria.
  2. Para ver a saída de uma categoria, digite o valor da propriedade categories da biblioteca do cliente e clique em Enviar Query.

Recursos adicionais da pasta da biblioteca de clientes

Há vários outros recursos que são suportados pelas pastas da biblioteca do cliente no AEM. No entanto, estes não são necessários para AEM como Cloud Service e, como tal, a sua utilização é desencorajada. Eles estão listados aqui para estarem completos.

AVISO

Esses recursos adicionais das Pastas de biblioteca do cliente não são necessários em AEM como Cloud Service e, como tal, seu uso é desencorajado. Eles estão listados aqui para estarem completos.

Adobe Granite HTML LIbrary Manager

As configurações adicionais da biblioteca do cliente podem ser controladas pelo painel Adobe Granite HTML Library Manager do Console do Sistema em https://<host>:<port>/system/console/configMgr).

Propriedades adicionais da pasta

As propriedades adicionais da pasta incluem permitir o controle de dependências e incorporações, mas geralmente não são mais necessárias e seu uso é desencorajado:

  • dependencies: Esta é uma lista de outras categorias da biblioteca do cliente das quais esta pasta da biblioteca depende. Por exemplo, dados dois nós cq:ClientLibraryFolder F e G, se um arquivo em F exigir outro arquivo em G para funcionar corretamente, pelo menos um dos categories de G deve estar entre dependencies de F.
  • embed: Usado para incorporar código de outras bibliotecas. Se o nó F incorporar nós G e H, o HTML resultante será uma concatenação de conteúdo dos nós G e H.

Vincular a dependências

Quando o código na pasta da biblioteca do cliente fizer referência a outras bibliotecas, identifique as outras bibliotecas como dependências. A tag ui:includeClientLib que faz referência à pasta da biblioteca do cliente faz com que o código HTML inclua um link para o arquivo da biblioteca gerado, bem como as dependências.

As dependências devem ser outras cq:ClientLibraryFolder. Para identificar dependências, adicione uma propriedade ao nó cq:ClientLibraryFolder com os seguintes atributos:

  • Nome: dependências
  • Tipo: String[]
  • Valores: O valor da propriedade categoria do nó cq:ClientLibraryFolder do qual a pasta da biblioteca atual depende.

Por exemplo, /etc/clientlibs/myclientlibs/publicmain tem uma dependência na biblioteca cq.jquery. A página que faz referência à biblioteca principal do cliente gera HTML que inclui o seguinte código:

<script src="/etc/clientlibs/foundation/cq.jquery.js" type="text/javascript">
<script src="/etc/clientlibs/mylibs/publicmain.js" type="text/javascript">

Incorporando código de outras bibliotecas

Você pode incorporar código de uma biblioteca de cliente em outra biblioteca de cliente. No tempo de execução, os arquivos JS e CSS gerados da biblioteca de incorporação incluem o código da biblioteca incorporada.

A incorporação do código é útil para fornecer acesso às bibliotecas que são armazenadas em áreas protegidas do repositório.

Pastas da biblioteca de clientes específicas do aplicativo

É uma prática recomendada manter todos os arquivos relacionados ao aplicativo em sua pasta de aplicativos abaixo de /app. Também é uma prática recomendada negar o acesso de visitantes do site à pasta /app. Para satisfazer ambas as práticas recomendadas, crie uma pasta de biblioteca de cliente abaixo da pasta /etc que incorpora a biblioteca de cliente que está abaixo de /app.

Use a propriedade categoria para identificar a pasta da biblioteca do cliente a ser incorporada. Para incorporar a biblioteca, adicione uma propriedade ao nó de incorporação cq:ClientLibraryFolder, usando os seguintes atributos de propriedade:

  • Nome: embed
  • Tipo: String[]
  • Valor: O valor da propriedade categoria do cq:ClientLibraryFolder nó a ser incorporado.

Usando a incorporação para minimizar solicitações

Em alguns casos, você pode descobrir que o HTML final gerado para a página típica pela sua instância de publicação inclui um número relativamente grande de elementos <script>.

Nesses casos, pode ser útil combinar todo o código da biblioteca do cliente necessário em um único arquivo para que o número de solicitações de ida e volta no carregamento da página seja reduzido. Para fazer isso, você pode embed as bibliotecas necessárias na biblioteca de cliente específica do aplicativo usando a propriedade embed do nó cq:ClientLibraryFolder.

Caminhos em arquivos CSS

Quando você incorpora arquivos CSS, o código CSS gerado usa caminhos para recursos relativos à biblioteca de incorporação. Por exemplo, a biblioteca acessível ao público /etc/client/libraries/myclientlibs/publicmain incorpora a biblioteca /apps/myapp/clientlib do cliente:

O arquivo main.css contém o seguinte estilo:

body {
  padding: 0;
  margin: 0;
  background: url(images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

O arquivo CSS gerado pelo nó publicmain contém o seguinte estilo, usando o URL da imagem original:

body {
  padding: 0;
  margin: 0;
  background: url(../../../apps/myapp/clientlib/styles/images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

Consulte Arquivos incorporados na saída HTML

Para rastrear a origem do código incorporado ou garantir que as bibliotecas de clientes incorporadas produzam os resultados esperados, você pode ver os nomes dos arquivos que estão sendo incorporados no tempo de execução. Para ver os nomes dos arquivos, anexe o parâmetro debugClientLibs=true ao URL da sua página da Web. A biblioteca gerada contém @import instruções em vez do código incorporado.

No exemplo na seção anterior Incorporando código de outras bibliotecas, a pasta da biblioteca de cliente /etc/client/libraries/myclientlibs/publicmain incorpora a pasta da biblioteca de cliente /apps/myapp/clientlib. Anexar o parâmetro à página da Web produz o seguinte link no código-fonte da página da Web:

<link rel="stylesheet" href="/etc/clientlibs/mycientlibs/publicmain.css">

A abertura do arquivo publicmain.css revela o seguinte código:

@import url("/apps/myapp/clientlib/styles/main.css");
  1. Na caixa de endereço do navegador da Web, anexe o seguinte texto ao URL do seu HTML:
    • ?debugClientLibs=true
  2. Quando a página for carregada, visualização a fonte da página.
  3. Clique no link fornecido como href para o elemento de link para abrir o arquivo e visualização o código fonte.

Uso de pré-processadores

AEM permite pré-processadores e entregas conectáveis com suporte para YUI Compressor para CSS e JavaScript e Google Closure Compiler (GCC) para JavaScript com YUI definido como AEM pré-processador padrão.

Os pré-processadores conectáveis permitem uma utilização flexível, incluindo:

  • Definindo ScriptProcessors que podem processar fontes de script
  • Os processadores podem ser configurados com opções
  • Os processadores podem ser usados para a miniificação, mas também para casos não-reduzidos
  • A clientlib pode definir qual processador usar
OBSERVAÇÃO

Por padrão, AEM usa o Compressor YUI. Consulte a documentação do YUI Compressor GitHub para obter uma lista de problemas conhecidos. Mudar para o compressor GCC para clientlibs específicos pode resolver alguns problemas observados ao utilizar IU.

CUIDADO

Não coloque uma biblioteca minimizada em uma biblioteca cliente. Em vez disso, forneça a biblioteca bruta e, se for necessário a miniificação, use as opções dos pré-processadores.

Uso

Você pode optar por configurar a configuração dos pré-processadores por biblioteca do cliente ou por todo o sistema.

  • Adicione as propriedades multivalue cssProcessor e jsProcessor no nó clientlibrary
  • Ou defina a configuração padrão do sistema por meio da configuração HTML Library Manager OSGi

Uma configuração de pré-processador no nó clientlib tem prioridade sobre a configuração OSGI.

Formato e exemplos

Formato
config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;
Compressor YUI para Minificação CSS e GCC para JS
cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]
Digitar para pré-processar e, em seguida, GCC para minificar e ofuscar
jsProcessor: [
   "default:typescript",
   "min:typescript",
   "min:gcc;obfuscate=true"
]
Opções adicionais de GCC
failOnWarning (defaults to "false")
languageIn (defaults to "ECMASCRIPT5")
languageOut (defaults to "ECMASCRIPT5")
compilationLevel (defaults to "simple") (can be "whitespace", "simple", "advanced")

Para obter mais detalhes sobre as opções de GCC, consulte a documentação da GCC.

Definir Miniador Padrão do Sistema

A IU é definida como a miniatura padrão no AEM. Para alterar para GCC, siga estas etapas.

  1. Ir para o Apache Felix Config Manager em (http://<host>:<portY/system/console/configMgr)
  2. Localize e edite o Gerenciador de biblioteca HTML Granite do Adobe.
  3. Ative a opção Minify (se ainda não estiver ativada).
  4. Defina o valor Configurações padrão do processador JS como min:gcc.
    • As opções podem ser passadas se separadas por um ponto-e-vírgula, por exemplo min:gcc;obfuscate=true.
  5. Clique em Salvar para salvar as alterações.

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free