Uso de bibliotecas do lado do cliente no AEM as a Cloud Service using-client-side-libraries

As experiências digitais dependem muito do processamento do lado do cliente orientado por códigos JavaScript e CSS complexos. Bibliotecas do lado do cliente do AEM (clientlibs) permitem organizar e armazenar centralmente essas bibliotecas do lado do cliente no repositório. Juntamente com o processo de build de front-end no arquétipo de Projeto AEM, gerenciar o código de front-end para o seu projeto AEM se torna simples.

As vantagens de usar clientlibs no AEM incluem:

As clientlibs são a solução integrada para fornecer CSS e JavaScript do AEM.

O que são bibliotecas do lado do cliente what-are-clientlibs

Os sites exigem que o JavaScript e o CSS, além de recursos estáticos, como ícones e fontes da Web, sejam processados no lado do cliente. Uma clientlib é um mecanismo AEM que faz referência (por categoria, se necessário) e serve esses recursos.

O 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 do HTML. Isso maximiza a eficiência da entrega e permite que esses recursos sejam mantidos centralmente no repositório via proxy, mantendo o acesso seguro.

Desenvolvimento de front-end para o AEM as a Cloud Service fed-for-aemaacs

Todos os ativos de JavaScript, CSS e outros ativos de front-end devem ser mantidos no módulo ui.frontend do Arquétipo de projeto AEM. A flexibilidade do arquétipo permite usar suas ferramentas da Web modernas preferidas para criar e gerenciar esses recursos.

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

Estrutura da pasta da biblioteca do lado do cliente clientlib-folders

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

[cq:ClientLibraryFolder] > sling:Folder
  - dependencies (string) multiple
  - categories (string) multiple
  - embed (string) multiple
  - channels (string) multiple

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

Se a pasta da biblioteca do cliente contiver um ou mais arquivos de código-fonte que, no 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 de nome de arquivo .js ou .css. 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:

Criação de pastas de bibliotecas do lado do cliente creating-clientlib-folders

As bibliotecas de clientes devem estar localizadas em /apps. Essa regra é necessária para isolar melhor o código do conteúdo e da configuração.

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

Disponibilização de bibliotecas do lado do cliente serving-clientlibs

Assim que a pasta da biblioteca do cliente for configurada conforme necessário, suas clientlibs poderão ser solicitadas via proxy. Como exemplo:

A propriedade allowProxy permite solicitar:

Carregamento de bibliotecas de clientes via HTL loading-via-htl

Depois que as clientlibs forem armazenadas e gerenciadas com êxito na pasta da biblioteca do cliente, elas poderão ser acessadas por HTL.

As bibliotecas de clientes são carregadas por meio de um modelo auxiliar fornecido pelo AEM, que pode ser acessado por meio de data-sly-use. Modelos auxiliares estão disponíveis neste arquivo, que pode ser chamado através 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 cadeias de caracteres ou uma cadeia 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 de clientes no Autor versus Publish clientlibs-author-publish

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

No entanto, há momentos em que as bibliotecas de clientes 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 na instância de criação do AEM.

Gerenciamento de bibliotecas de clientes no Author clientlibs-on-author

Se você precisar usar bibliotecas de clientes no autor, poderá criar suas bibliotecas de clientes em /apps usando os mesmos métodos de publicação, mas escreva-as 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 clientes a uma categoria de biblioteca de clientes pronta para uso.

Ferramentas de depuração debugging-tools

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

Descubra bibliotecas de clientes discover-client-libraries

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), bem como 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 see-generated-output

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

Recursos adicionais da pasta da biblioteca do cliente additional-features

Há vários outros recursos compatíveis com as pastas da biblioteca do cliente no AEM. No entanto, elas não são necessárias no AEM as a Cloud Service e, portanto, seu uso não é incentivado. Eles estão listados aqui para fins de integridade.

Adobe Granite HTML LIbrary Manager html-library-manager

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

Propriedades adicionais da pasta additional-folder-properties

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

Vinculação a Dependências linking-to-dependencies

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 de biblioteca gerado e as dependências.

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

Por exemplo, o /etc/clientlibs/myclientlibs/publicmain tem uma dependência na biblioteca cq.jquery. A página que faz referência à biblioteca cliente principal gera um 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">

Como incorporar código de outras bibliotecas embedding-code-from-other-libraries

Você pode incorporar o código de uma biblioteca do cliente a outra biblioteca do 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 armazenadas em áreas seguras do repositório.

Pastas de bibliotecas de clientes específicas do aplicativo app-specific-client-library-folders

É uma prática recomendada manter todos os arquivos relacionados a aplicativos em sua pasta de aplicativos abaixo de /apps. Também é uma prática recomendada negar acesso aos visitantes do site à pasta /apps. Para atender às duas práticas recomendadas, crie uma pasta de biblioteca do cliente abaixo da pasta /etc que incorpora a biblioteca do cliente que está abaixo de /apps.

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

Utilização de incorporação para minimizar solicitações using-embedding-to-minimize-requests

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 no em um único arquivo para reduzir o número de solicitações de ida e volta no carregamento da página. Para fazer isso, você pode embed as bibliotecas necessárias na biblioteca do cliente específica do aplicativo usando a propriedade embed do nó cq:ClientLibraryFolder.

Caminhos em arquivos CSS paths-in-css-files

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

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 a 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 do HTML see-embedded-files

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

No exemplo da seção anterior Incorporando Código de Outras Bibliotecas, a pasta da biblioteca cliente /etc/client/libraries/myclientlibs/publicmain incorpora a pasta da biblioteca 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">

Abrir o arquivo publicmain.css revela o seguinte código:

@import url("/apps/myapp/clientlib/styles/main.css");

Uso de pré-processadores using-preprocessors

O AEM permite pré-processadores conectáveis e é fornecido com suporte ao Compactador YUI para CSS e JavaScript e ao Compilador de Fechamento Google (GCC) para JavaScript AEM com YUI definido como o pré-processador padrão do.

Os pré-processadores conectáveis permitem um uso flexível, incluindo:

Uso usage

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

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

Formato e exemplos format-and-examples

Formato format

config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;

Compactador YUI para Minificação CSS e GCC para JS yui-compressor-for-css-minification-and-gcc-for-js

cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]

Digitar script para pré-processar e, em seguida, GCC para minificar e ofuscar typescript-to-preprocess-and-then-gcc-to-minify-and-obfuscate

jsProcessor: [
   "default:typescript",
   "min:typescript",
   "min:gcc;obfuscate=true"
]

Opções adicionais de GCC additional-gcc-options

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 do GCC, consulte a documentação do GCC.

Definir Minificador Padrão do Sistema set-system-default-minifier

A interface do usuário é definida como o minificador padrão no AEM. Para alterar isso para GCC, siga estas etapas.