O desenvolvimento de projetos AEM Commerce com base na Commerce Integration Framework (CIF) para AEM segue as mesmas regras e práticas recomendadas de outros projetos AEM. Leia primeiro estes itens:
Um ambiente de desenvolvimento local é recomendado para trabalhar com projetos da CIF.
As instruções a seguir ajudam a configurar um ambiente de desenvolvimento de AEM local para AEM Commerce (usando a CIF com foco para AEM 6.5). Se estiver usando AEM as a Cloud Service, consulte a seção AEM Commerce as a Cloud Service documentação.
O complemento AEM Commerce para AEM 6.5 também conhecido. O complemento CIF também está disponível para desenvolvimento local e é fornecido como um pacote AEM. Ele pode ser baixado do Portal de distribuição de software como um pacote de recursos.
Devem ser instalados:
É possível baixar o complemento CIF no Portal de distribuição de software, procure por "complemento AEM Commerce".
Use sempre a versão mais recente do complemento CIF.
Para desenvolvimento de projeto da CIF local, siga as etapas abaixo e siga o complemento CIF:
Obtenha a versão AEM 6.5 e instale o AEM 6.5 Service Pack. AEM 6.5 Service Pack 7 é necessário, no entanto, recomendamos instalar o último service pack disponível.
Descompacte o AEM .jar para criar a pasta crx-quickstart
e execute:
java -jar <jar name> -unpack
Crie uma pasta crx-quickstart/install
Copie o complemento CIF de todos os pacotes, baixados do Portal de distribuição de software, no crx-quickstart/install
pasta.
Como alternativa, o pacote complementar da CIF também pode ser instalado por meio do Gerenciador de pacotes.
Verifique a configuração por meio do console OSGI: http://localhost:4502/system/console/osgi-installer
. A lista deve incluir os pacotes relacionados ao complemento CIF, o pacote de conteúdo e as configurações OSGI. Certifique-se de que todos os pacotes sejam iniciados.
Há duas maneiras de iniciar seu projeto do AEM Commerce usando a CIF.
O Arquétipo de projeto do AEM é a principal ferramenta para inicializar um projeto pré-configurado e começar a usar a CIF. Os Componentes principais da CIF e todas as configurações necessárias podem ser incluídos em um projeto gerado com uma opção extra.
Use o Arquétipo de projeto do AEM 25 ou posterior para gerar o projeto.
Consulte as instruções de uso do Arquétipo de projeto do AEM sobre como gerar um projeto do AEM. Para incluir a CIF no projeto, use a opção includeCommerce
.
Por exemplo:
mvn -B archetype:generate \
-D archetypeGroupId=com.adobe.granite.archetypes \
-D archetypeArtifactId=aem-project-archetype \
-D aemVersion=6.5.5 \
-D appTitle="My Site" \
-D appId="mysite" \
-D groupId="com.mysite" \
-D frontendModule=general \
-D includeExamples=n \
-D includeCommerce=y
Os Componentes principais da CIF podem ser usados em qualquer projeto, incluindo o all
pacote ou individual usando o pacote de conteúdo da CIF e os pacotes OSGI relacionados. Para adicionar os Componentes principais da CIF manualmente a um projeto, use as seguintes dependências:
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>core-cif-components-apps</artifactId>
<type>zip</type>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>core-cif-components-config</artifactId>
<type>zip</type>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>core-cif-components-core</artifactId>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>graphql-client</artifactId>
<version>x.y.z</version>
</dependency>
<dependency>
<groupId>com.adobe.commerce.cif</groupId>
<artifactId>magento-graphql</artifactId>
<version>x.y.z</version>
</dependency>
Uma segunda opção para iniciar um projeto da CIF é clonar e usar a loja de referência AEM Venia. A loja de referência AEM Venia é um exemplo de aplicativo de vitrine de referência que demonstra o uso dos Componentes principais da CIF para o AEM. Ela serve como um conjunto de exemplos de práticas recomendadas e um ponto de partida potencial para desenvolver sua própria funcionalidade.
Para começar a usar a loja de referência Venia, basta clonar a variável Repositório Git e comece a personalizar o projeto de acordo com suas necessidades.
O projeto da loja de referência Venia contém dois perfis de construção para o AEM as a Cloud Service e o AEM 6.5. Verifique o arquivo readme.md do projeto para ver como eles são usados. Para AEM 6.5, use o classic
perfil.
Para conectar seu projeto ao sistema de comércio, AEM deve ser configurado com o terminal GraphQL do seu sistema de comércio.
Ambos, um projeto gerado pelo Arquétipo de projeto AEM ou Loja de referência Venia AEMjá inclua um configuração padrão que deve ser adaptado.
Substitua o valor da variável url
em com.adobe.cq.commerce.graphql.client.impl.GraphqlClientImpl~default.cfg.json
com o terminal GraphQL do sistema de comércio usado pelo projeto.
O complemento AEM Commerce e os Componentes principais da CIF se conectam ao endpoint comercial do GraphQL por meio do servidor AEM e diretamente pelo navegador. Por padrão, os Componentes principais da CIF do lado do cliente e as ferramentas de criação do complemento CIF conectam-se ao /api/graphql
. Se necessário, isso pode ser ajustado através da configuração do Cloud Service da CIF (veja abaixo).
O complemento CIF fornece um servlet proxy da GraphQL em /api/graphql
. Se você não planeja usar um Dispatcher de AEM local, é recomendável configurar também o servlet proxy do GraphQL.
Navegue até http://localhost:4502/system/console/configMgr e crie uma configuração OSGI para a variável Adobe CIF GraphQL Proxy Configuration
serviço. Use o mesmo terminal GraphQL do seu sistema de comércio usado para o cliente GraphQL acima.