Ferramentas de desenvolvedor do AEM para Eclipse aem-developer-tools-for-eclipse

Ferramentas para desenvolvedores do Experience Manager para o logotipo Eclipse

Visão geral overview

As Ferramentas para desenvolvedores do Experience Manager para Eclipse são um plug-in Eclipse baseado no plug-in Eclipse para Apache Sling lançado com a Licença do Apache 2.

Ele oferece vários recursos que facilitam o desenvolvimento do AEM:

  • Integração perfeita com instâncias do AEM por meio do Eclipse Server Connector
  • Sincronização para conteúdo e pacotes OSGi
  • Suporte à depuração com recurso de troca a quente de código
  • Bootstrap simples de projetos do AEM por meio de um assistente de criação de projeto específico
  • Fácil edição das propriedades do JCR

Requisitos requirements

Antes de usar as Ferramentas do desenvolvedor do AEM, é necessário:

  • Baixe e instale o Eclipse IDE para desenvolvedores Enterprise Java e Web.
    • A versão 1.4.0 das Ferramentas de desenvolvedor do AEM para Eclipse é compatível com Eclipse 2022-12 (4.26) ou mais recente e requer Java 17 ou mais recente para ser executada.
  • Configure a instalação do Eclipse para garantir que você tenha pelo menos 1 GB de memória heap, editando o arquivo de configuração eclipse.ini conforme descrito nas Perguntas frequentes sobre o Eclipse.
NOTE
No macOS, clique com o botão direito do mouse em Eclipse.app e selecione Mostrar Conteúdo do Pacote para encontrar seu eclipse.ini.

Como instalar as ferramentas de desenvolvedor do AEM para Eclipse how-to-install-the-aem-developer-tools-for-eclipse

Quando tiver atendido aos requisitos acima, você poderá instalar o plug-in de ferramentas do desenvolvedor da seguinte maneira:

  1. Abra o Site de Ferramentas do Desenvolvedor do AEM.

  2. Copie o Link de Instalação.

    • Como alternativa, você pode baixar um arquivo em vez de usar o link de instalação.
    • Este método permite a instalação offline, mas você não recebe notificações automáticas de atualização.
  3. No Eclipse, abra o menu Ajuda.

  4. Clique em Instalar novo software.

  5. Clique em Adicionar….

  6. No campo Nome, digite AEM Developer Tools.

  7. No campo Local, copie a URL de instalação.

  8. Clique em Adicionar.

  9. Verifique os plug-ins do AEM e do Sling.

  10. Clique em Avançar.

  11. Na janela Detalhes da Instalação, revise os itens a serem instalados e clique novamente em Avançar.

  12. Aceite os contratos de licença e clique em Concluir.

  13. Na caixa de diálogo Autoridades de Confiança exibida, selecione a autoridade/site https://eclipse.adobe.com e clique em Confiar em Selecionados.

  14. Na caixa de diálogo Artefatos de Confiança exibida, selecione os signatários do código e clique em Confiar em Selecionados.

  15. Clique em RestartNow para reiniciar o Eclipse.

A perspectiva da AEM the-aem-perspective

No Eclipse, uma Perspectiva determina as ações e visualizações disponíveis em uma janela e permite a interação orientada a tarefas com recursos no Eclipse. Para obter mais detalhes sobre perspectivas, consulte a documentação do Eclipse..

As Ferramentas de desenvolvimento do Experience Manager para Eclipse fornecem uma perspectiva do AEM que oferece controle total sobre seus projetos e instâncias do AEM. Para abrir a perspectiva do AEM:

  1. Na barra de menus do Eclipse, selecione Janela > Perspectiva > Abrir Perspectiva > Outras.
  2. Selecione AEM no diálogo e clique em Abrir.

A perspectiva do AEM no Eclipse

Exemplo de projeto de vários módulos sample-multi-module-project

As Ferramentas de desenvolvedor do Experience Manager para Eclipse vêm com uma amostra de projeto de vários módulos que ajuda você a se familiarizar rapidamente com uma configuração de projeto no Eclipse. Ele também serve como um guia de práticas recomendadas para vários recursos do AEM, aproveitando o Arquétipo de Projetos AEM.

Siga estas etapas para criar o projeto de amostra:

  1. No menu Arquivo > Novo > Projeto, navegue até a seção AEM e selecione Projeto de vários módulos de exemplo do AEM.

    Projeto de vários módulos de amostra do AEM

  2. Clique em Avançar.

    note note
    NOTE
    Esta etapa pode demorar porque m2eclipse deve verificar os catálogos de arquétipo.
  3. com.adobe.aem : aem-project-archetype : <highest-number> deve ser selecionado automaticamente no menu suspenso Arquétipo. Selecione uma versão anterior, se desejar. Clique em Avançar.

    Selecionar versão do arquétipo

  4. Forneça os seguintes campos para o projeto de amostra:

    • Nome
    • Id Do Grupo
    • Id do artefato
    • appId - Talvez seja necessário expandir as opções Avançado para definir esse valor.
    • appTitle - Talvez seja necessário expandir as opções Avançado para definir esse valor.
    • Pacote - Talvez seja necessário expandir as opções Avançado para definir este valor.

    Definir propriedades do arquétipo

  5. Clique em Avançar.

  6. Configure um servidor AEM ao qual o Eclipse se conecta selecionando Configurar novo servidor e fornecendo um nome de servidor e os detalhes de conexão necessários.

    Conectar-se ao servidor do AEM

    • Para usar o recurso de depuração, você precisa iniciar o AEM no modo de depuração fornecendo o parâmetro -agentlib, por exemplo:
    code language-text
    $ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar aem-author-p4502.jar
    
    note tip
    TIP
    Para obter mais detalhes sobre como depurar seu projeto em execução em um AEM SDK local, consulte o documento Depuração remota do AEM SDK.
  7. Clique em Concluir.

A estrutura do projeto é criada. Pode levar algum tempo para baixar os artefatos necessários no projeto.

NOTE
Em uma nova instalação ou quando as dependências do Maven não tiverem sido baixadas anteriormente, o Eclipse poderá relatar que o projeto foi criado com erros. Nesse caso, siga o procedimento descrito na seção Resolvendo Definição de Projeto Inválida.

Como Importar Projetos Existentes how-to-import-existing-projects

Use o recurso Novo Projeto para criar a estrutura básica do projeto.

  1. Siga as instruções para criar um Projeto de Vários Módulos de Amostra, que cria uma estrutura básica de projeto com uma separação íntegra de preocupações:

    • PROJECT.ui.apps para conteúdo de /apps e /etc
    • PROJECT.ui.content para /content criado
    • PROJECT.core para pacotes Java
    • PROJECT.it.launcher e PROJECT.it.tests para testes de integração
  2. Substitua o conteúdo do projeto PROJECT.ui.apps pelas pastas apps e etc do pacote:

    1. No painel Project Explorer, expanda PROJECT.ui.apps > src > main > content > jcr_root > apps.
    2. Clique com o botão direito do mouse na pasta apps e escolha Mostrar em > System Explorer.
    3. Exclua as pastas apps e etc lá.
    4. No mesmo local, coloque as pastas apps e etc do seu pacote de conteúdo.
    5. No Eclipse, clique com o botão direito do mouse no projeto PROJECT.ui.apps e escolha Atualizar.
  3. Em seguida, faça o mesmo para PROJECT.ui.content e substitua sua pasta de conteúdo pela de seus pacotes:

    1. No painel Project Explorer, expanda PROJECT.ui.content > src > main > content > jcr_root > content.
    2. Clique com o botão direito do mouse na pasta de conteúdo mais profundo e escolha Mostrar em > System Explorer.
    3. Exclua a pasta de conteúdo lá.
    4. No mesmo local, coloque a pasta de conteúdo do seu pacote de conteúdo.
    5. No Eclipse, clique com o botão direito do mouse no projeto PROJECT.ui.content e escolha Atualizar.
  4. Atualize os filter.xml arquivos desses dois projetos para corresponder ao conteúdo do seu pacote de conteúdo abrindo o META-INF/vault/filter.xml arquivo do seu pacote de conteúdo em um editor de texto/código separado.

    • Este é um exemplo de como o arquivo filter.xml pode ser:
    code language-xml
    <?xml version="1.0" encoding="UTF-8"?>
    <workspaceFilter version="1.0">
        <filter root="/apps/foo"/>
        <filter root="/apps/foundation/components/bar"/>
        <filter root="/etc/designs/foo"/>
        <filter root="/content/foo"/>
        <filter root="/content/dam/foo"/>
        <filter root="/content/usergenerated/content/foo"/>
    </workspaceFilter>
    
  5. Quanto ao conteúdo do seu pacote que foi dividido em dois projetos, você também deve dividir essas regras de filtro em dois e atualizar os arquivos filter.xml dos dois projetos adequadamente.

    1. No Eclipse, abra PROJECT.ui.apps/src/main/content/META-INF/filter.xml.

    2. Substitua o conteúdo do elemento <workspaceFilter> pelas regras do seu pacote que começam com /apps e /etc

      • Por exemplo:

        code language-xml
        <?xml version="1.0" encoding="UTF-8"?>
        <workspaceFilter version="1.0">
           <filter root="/apps/foo"/>
           <filter root="/apps/foundation/components/bar"/>
           <filter root="/etc/designs/foo"/>
        </workspaceFilter>
        
    3. Em seguida, abra PROJECT.ui.content/src/main/content/META-INF/filter.xml.

    4. Substitua as regras pelas do seu pacote que começam com /content.

      • Por exemplo:

        code language-xml
        <?xml version="1.0" encoding="UTF-8"?>
        <workspaceFilter version="1.0">
           <filter root="/content/foo"/>
           <filter root="/content/dam/foo"/>
           <filter root="/content/usergenerated/content/foo"/>
        </workspaceFilter>
        
  6. Certifique-se de salvar todas as alterações. Agora você pode sincronizar esse novo conteúdo para sua instância do AEM.

  7. No painel Servidores, verifique se a conexão foi iniciada e, se for o caso, não a inicie.

  8. Clique no ícone Limpar e publicar.

Depois de concluído, o pacote deve estar em execução na sua instância. Ao salvar, qualquer alteração é sincronizada automaticamente com a instância.

Se quiser recriar um pacote de seu projeto, clique com o botão direito do mouse em PROJECT.ui.apps ou PROJECT.ui.content e escolha Executar como > Instalação do Maven.

Agora você tem uma pasta de destino criada com seu pacote (chamada, por exemplo, PROJECT.ui.apps-0.0.1-SNAPSHOT.zip).

Resolução de problemas troubleshooting

Resolvendo Definição de Projeto Inválida resolving-invalid-project-definition

Para resolver dependências inválidas e a definição do projeto, proceda da seguinte maneira:

  1. Selecione todos os projetos criados.
  2. Clique com o botão direito do mouse em.
  3. No menu de contexto, selecione Maven > Atualizar projetos.
  4. Verificar Forçar Atualizações de Instantâneos/Versões.
  5. Clique em OK.

O Eclipse baixa as dependências necessárias. Isso pode demorar um pouco.

Mais informações more-information

A ferramenta oficial do Apache Sling IDE para o site do Eclipse fornece informações adicionais úteis:

A documentação oficial Eclipse a seguir pode ajudar a configurar seu ambiente:

recommendation-more-help
51c6a92d-a39d-46d7-8e3e-2db9a31c06a2