Tutorial: Compilar um aplicativo Web do Spring Boot Java com o Serviço de Aplicativo do Azure no Linux e o Azure Cosmos DB

  • Artigo

Neste tutorial, você vai aprender a criar, configurar e implantar um aplicativo Spring Boot seguro no Serviço de Aplicativo do Azure que se conecta a um banco de dados MongoDB no Azure (na verdade, um banco de dados Cosmos DB com API do MongoDB). Quando terminar, você terá um aplicativo Java SE em execução no Serviço de Aplicativo do Azure no Linux.

Captura de tela do aplicativo Spring Boot armazenando dados no Cosmos DB.

Neste tutorial, você aprenderá a:

  • Crie uma arquitetura segura por padrão para o Serviço de Aplicativo do Azure e o Azure Cosmos DB com a API do MongoDB.
  • Proteja segredos de conexão usando uma identidade gerenciada e referências do Key Vault.
  • Implante um aplicativo de exemplo do Spring Boot no Serviço de Aplicativo de um repositório GitHub.
  • Acesse as configurações de aplicativo do Serviço de Aplicativo no código do aplicativo.
  • Faça atualizações e reimplante o código do aplicativo.
  • Transmita logs de diagnóstico do Serviço de Aplicativo.
  • Gerencie o aplicativo no portal do Azure.
  • Provisione a mesma arquitetura e implante usando o Azure Developer CLI.
  • Otimize seu fluxo de trabalho de desenvolvimento com o GitHub Codespaces e o GitHub Copilot.

Pré-requisitos

  • Uma conta do Azure com uma assinatura ativa. Se você ainda não tem uma conta do Azure, crie-a gratuitamente.
  • Uma conta do GitHub. você também pode obter uma gratuitamente.
  • Conhecimento de Java com desenvolvimento do Spring Framework.
  • (Opcional) Para experimentar o GitHub Copilot, uma conta do GitHub Copilot. Está disponível uma avaliação gratuita de 30 dias.
  • Uma conta do Azure com uma assinatura ativa. Se você ainda não tem uma conta do Azure, crie-a gratuitamente.
  • Azure Developer CLI instalada localmente. Você pode seguir as etapas com o Azure Cloud Shell porque ele já tem a Azure Developer CLI instalada.
  • Conhecimento de Java com desenvolvimento do Spring Framework.
  • (Opcional) Para experimentar o GitHub Copilot, uma conta do GitHub Copilot. Está disponível uma avaliação gratuita de 30 dias.

Ir para o final

Você pode implantar rapidamente o aplicativo de exemplo neste tutorial e vê-lo em execução no Azure. Basta executar os seguintes comandos no Azure Cloud Shell e seguir o prompt:

mkdir msdocs-spring-boot-mongodb-sample-app
cd msdocs-spring-boot-mongodb-sample-app
azd init --template msdocs-spring-boot-mongodb-sample-app
azd up

1. Execute o exemplo

Primeiro, você configura um aplicativo de exemplo baseado em dados como um ponto de partida. Para sua conveniência, o repositório de amostra inclui uma configuração de contêiner de desenvolvimento. O contêiner de desenvolvimento tem tudo de que você precisa para desenvolver um aplicativo, incluindo o banco de dados MongoDB, o cache e todas as variáveis de ambiente necessárias para a amostra de aplicativo. O contêiner de desenvolvimento pode ser executado em um codespace do GitHub, o que significa que você pode executar o exemplo em qualquer computador com um navegador da Web.

Etapa 1: em uma nova janela do navegador:

  1. Entre em sua conta do GitHub.
  2. Navegue até https://github.com/Azure-Samples/msdocs-spring-boot-mongodb-sample-app/fork.
  3. Desmarque Copiar somente a ramificação principal. Você quer todas as ramificações.
  4. Selecione Criar fork.

Uma captura de tela que mostra como criar um fork do repositório do GitHub de exemplo.

Etapa 2: na bifurcação do GitHub:

  1. Selecione principal> starter-no-infra para a ramificação inicial. Essa ramificação contém apenas o projeto de amostra e nenhuma configuração ou arquivos relacionados ao Azure.
  2. Selecione Código>Criar um codespace no starter-no-infra. O codespace leva alguns minutos para ser configurado.

Uma captura de tela mostrando como criar um codespace no GitHub.

Etapa 3: No terminal do codespace:

  1. Execute mvn package spring-boot:run.
  2. Quando vir a notificação Your application running on port 8080 is available., selecione Abrir no Navegador. Você deve ver o aplicativo de exemplo em uma nova guia do navegador. Para parar o servidor Jetty, digite Ctrl+C.

Uma captura de tela mostrando como executar o aplicativo de exemplo dentro do codespace do GitHub.

Dica

Você pode perguntar ao GitHub Copilot sobre esse repositório. Por exemplo:

  • @workspace O que esse projeto faz?
  • @workspace, como o aplicativo se conecta ao banco de dados?
  • @workspace O que a pasta .devcontainer faz?

Está enfrentando problemas? Confira a seção de Solução de problemas.

2. Criar o Serviço de Aplicativo e o Cosmos DB

Primeiro, você cria os recursos do Azure. As etapas usadas neste tutorial criam um conjunto de recursos seguros por padrão que incluem o Serviço de Aplicativo e o Azure Cosmos DB. Para o processo de criação, você especificará:

  • O Nome do aplicativo Web. É usado como parte do nome DNS para o seu aplicativo na forma de https://<app-name>-<hash>.<region>.azurewebsites.net.
  • A Região para executar o aplicativo fisicamente no mundo. Também é usado como parte do nome DNS para o seu aplicativo.
  • A pilha de runtime para o aplicativo. É aqui que você seleciona a versão do Java a ser usada para seu aplicativo.
  • O plano de hospedagem para o aplicativo. É o tipo de preço que inclui o conjunto de recursos e a capacidade de colocação em escala do seu aplicativo.
  • O Grupo de Recursos para o aplicativo. Um grupo de recursos permite agrupar (em um contêiner lógico) todos os recursos necessários do Azure para o aplicativo.

Entre no portal do Azure e siga estas etapas para criar seus recursos do Serviço de Aplicativo do Azure.

Etapa 1: no portal do Azure:

  1. Insira “banco de dados do aplicativo Web” na caixa de pesquisa na parte superior do portal do Azure.
  2. Selecione o item Web App + Banco de Dados no título Marketplace. Você também pode navegar diretamente para o assistente de criação.

Uma captura de tela mostrando como usar a caixa de pesquisa na barra de ferramentas superior para localizar o assistente de criação de Aplicativo Web + Banco de dados.

Etapa 2: na página Criar aplicativo Web + Banco de dados, preencha o formulário conforme mostrado a seguir.

  1. Grupo de Recursos: selecione Criar novo e use o nome msdocs-expressjs-mongodb-tutorial.
  2. Região: qualquer região do Azure próxima a você.
  3. Nome: msdocs-spring-cosmosdb-XYZ em que XYZ são quaisquer três caracteres aleatórios. Esse nome deve ser exclusivo no Azure.
  4. Pilha de runtime: Java 21.
  5. Pilha do servidor Web Java: Java SE (Servidor Web Inserido).
  6. Mecanismo: API do Cosmos DB para MongoDB. O Cosmos DB é um banco de dados NoSQL relacional e vetorial como serviço no Azure, totalmente gerenciado.
  7. Plano de hospedagem: Básico. Quando estiver pronto, você poderá escalar verticalmente até um tipo de preço de produção.
  8. Selecione Examinar + criar.
  9. Depois de concluir a validação, selecione Criar.

Uma captura de tela que mostra como configurar um novo aplicativo e banco de dados no assistente Aplicativo Web + Banco de Dados.

Etapa 3: a implantação leva alguns minutos para ser concluída. Depois que a implantação for concluída, selecione o botão Ir para o recurso. Você é levado diretamente para o aplicativo do Serviço de Aplicativo, mas os seguintes recursos são criados:

  • Grupo de recursos: o contêiner para todos os recursos criados.
  • Plano do Serviço de Aplicativo: define os recursos de computação para o Serviço de Aplicativo. É criado um plano do Linux na camada Básico.
  • Serviço de Aplicativo: representa seu aplicativo e é executado no plano de Serviço de Aplicativo.
  • Rede virtual: integrada ao aplicativo do Serviço de Aplicativo e isola o tráfego de rede de back-end.
  • Azure Cosmos DB: acessível somente a partir e por trás de seu ponto de extremidade privado. Um banco de dados é criado para você na conta do banco de dados.
  • Pontos de extremidade privados: acesse os pontos de extremidade para o servidor de banco de dados e o Cache Redis na rede virtual.
  • Zonas de DNS privado: habilitar a resolução DNS do servidor de banco de dados e o cache Redis na rede virtual.

Uma captura de tela mostrando o processo de implantação concluído.

Está enfrentando problemas? Confira a seção de Solução de problemas.

3. Proteger segredos de conexão

O assistente de criação gerou a cadeia de caracteres de conectividade para você já como uma configuração de aplicativo. No entanto, a melhor prática de segurança é manter os segredos fora do Serviço de Aplicativo completamente. Você moverá seus segredos para um cofre de chaves e alterará a configuração do aplicativo para uma referência do Key Vault com a ajuda dos Conectores de Serviço.

Etapa 1: na página Serviço de Aplicativo:

  1. no menu do lado esquerdo, selecione Configurações > Variáveis ​​de ambiente.
  2. Ao lado de AZURE_COSMOS_CONNECTIONSTRING, selecione Mostrar valor. Essa cadeia de conexão permite que você se conecte ao banco de dados Cosmos DB protegido por trás de um ponto de extremidade privado. No entanto, o segredo é salvo diretamente no aplicativo do Serviço de Aplicativo, o que não é a melhor opção. Você vai mudar isso.

Captura de tela mostrando como ver o valor de uma configuração de aplicativo.

Etapa 2: Criar um cofre de chaves para o gerenciamento seguro de segredos.

  1. Na barra de pesquisa superior, digite "cofre de chaves" e selecione Marketplace>Cofre de Chaves.
  2. No Grupo de Recursos, selecione msdocs-spring-cosmosdb-tutorial.
  3. Em Nome do cofre de chaves, digite um nome que consista apenas em letras e números.
  4. Em Região, configure-a como uma amostra de local como o grupo de recursos.

Captura de tela mostrando como criar um cofre de chaves.

Etapa 3:

  1. Selecione a guia Rede.
  2. Desmarcar Habilitar acesso público.
  3. Selecione Criar um ponto de extremidade privado.
  4. No Grupo de Recursos, selecione msdocs-spring-cosmosdb-tutorial.
  5. Em Nome do cofre de chaves, digite um nome que consista apenas em letras e números.
  6. Em Região, configure-a como uma amostra de local como o grupo de recursos.
  7. Na caixa de diálogo, em Local, selecione o mesmo local do seu aplicativo do Serviço de Aplicativo.
  8. No Grupo de Recursos, selecione msdocs-spring-cosmosdb-tutorial.
  9. Em Nome, digite msdocs-spring-cosmosdb-XYZVaultEndpoint.
  10. Em Rede virtual, selecione msdocs-spring-cosmosdb-XYZVnet.
  11. Em Sub-rede, msdocs-spring-cosmosdb-XYZSubnet.
  12. Selecione OK.
  13. Selecione Examinar + criare Criar. Aguarde a conclusão da implantação do cofre de chaves. Você deverá ver "Sua implantação está concluída".

Captura de tela mostrando como proteger um cofre de chaves com um ponto de extremidade privado.

Etapa 4:

  1. Na barra de pesquisa superior, digite msdocs-spring-cosmosdbe, em seguida, o nome do recurso do Serviço de Aplicativo msdocs-spring-cosmosdb-XYZ.
  2. Na página do Serviço de Aplicativo, no menu à esquerda, selecione Configurações > Conector de serviço. Já existe um conector, que o assistente de criação de aplicativos criou para você.
  3. Marque a caixa de seleção ao lado do conector e selecione Editar.
  4. Na guia Noções básicas, defina Tipo de cliente como SpringBoot. Essa opção cria as variáveis de ambiente específicas do Spring Boot para você.
  5. Selecione a guia Autenticação.
  6. Selecione Segredo do Repositório no Key Vault.
  7. Em Conexão do Cofre de Chaves, selecione Criar nova. Uma caixa de diálogo Criar conexão é aberta na parte superior da caixa de diálogo de edição.

Captura de tela mostrando como editar um conector de serviço com uma conexão de cofre de chaves.

Etapa 5: Na caixa de diálogo Criar conexão para a conexão do Cofre de Chaves:

  1. Em Cofre de Chaves, selecione o cofre de chaves que você criou anteriormente.
  2. Selecione Examinar + criar. Você deverá ver que a Identidade gerenciada atribuída pelo sistema está definida como Selecionada.
  3. Após a conclusão da validação, selecione Criar.

Captura de tela mostrando como configurar um conector de serviço do cofre de chaves.

Etapa 6: Você está de volta à caixa de diálogo de edição para o defaultConnector.

  1. Na guia Autenticação, aguarde até que o conector do cofre de chaves seja criado. Quando terminar, a lista suspensa Conexão do Key Vault a selecionará automaticamente.
  2. Selecione Avançar: Rede.
  3. Selecione Configurar regras de firewall para habilitar o acesso ao serviço de destino. Se estiver vendo a mensagem "Nenhum Ponto de Extremidade Privado no serviço de destino", ignore-a. O assistente de criação de aplicativos já protegeu o banco de dados Cosmos DB com um ponto de extremidade privado.
  4. Selecione Salvar. Aguarde até que a notificação Atualização bem-sucedida seja exibida.

Captura de tela mostrando a conexão do cofre de chaves selecionada no defaultConnector.

Etapa 7: para verificar suas alterações:

  1. No menu do lado esquerdo, selecione Variáveis de ambiente novamente.
  2. Certifique-se de que a configuração do aplicativo spring.data.mongodb.uri existe. O conector padrão a gerou para você e seu aplicativo Spring Boot já está usando a variável.
  3. Ao lado da configuração do aplicativo, selecione Mostrar valor. O valor deve ser @Microsoft.KeyVault(...), o que significa que é uma referência do cofre de chaves, porque o segredo agora é gerenciado no cofre de chaves.

Captura de tela mostrando como ver o valor da variável de ambiente do Spring Boot no Azure.

Está enfrentando problemas? Confira a seção de Solução de problemas.

4. Implantar código de amostra

Nesta etapa, você configurará a implantação do GitHub usando o GitHub Actions. É apenas uma das muitas maneiras de implantar no Serviço de Aplicativo, mas também uma ótima maneira de ter integração contínua em seu processo de implantação. Por padrão, cada git push em seu repositório GitHub inicia a ação de compilação e implantação.

Etapa 1: No menu à esquerda, selecione Implantação>Centro de implantação.

Uma captura de tela que mostra como abrir o Centro de Implantação no Serviço de Aplicativo.

Etapa 2: na página Centro de Implantação:

  1. Em Origem, selecione GitHub. Por padrão, o GitHub Actions é selecionado como o provedor de build.
  2. Entre em sua conta do GitHub e siga o prompt para autorizar o Azure.
  3. Em Organização, selecione sua conta.
  4. Em Repositório, selecione msdocs-spring-boot-mongodb-sample-app.
  5. Em Ramificação, selecione starter-no-infra. Essa é a mesma ramificação em que você trabalhou com seu aplicativo de exemplo, sem nenhum arquivo ou configuração relacionada ao Azure.
  6. Para Tipo de autenticação, selecione Identidade atribuída pelo usuário.
  7. No menu superior, selecione Salvar. O Serviço de Aplicativo confirma um arquivo de fluxo de trabalho no repositório GitHub escolhido, no diretório .github/workflows. Por padrão, o centro de implantação cria uma identidade atribuída pelo usuário para que o fluxo de trabalho seja autenticado usando o Microsoft Entra (autenticação OIDC). Para obter opções alternativas de autenticação, consulte Implantar no Serviço de Aplicativo usando o GitHub Actions.

Uma captura de tela que mostra como configurar o CI/CD usando o GitHub Actions.

Etapa 3:

  1. Selecione a guia Logs. Veja se uma nova implantação já foi executada, mas o status aparece como Falhou.
  2. Selecione Criar/Implantar Logs. Uma guia do navegador é aberta na guia Ações do seu repositório bifurcado no GitHub. Em Anotações, você verá o erro The string 'java21' is not valid SeVer notation for a Java version. Se quiser, selecione a etapa da compilação com falha na página para obter mais informações.

Captura de tela mostrando um erro na página de Logs do centro de implantação.

Etapa 4: O erro mostra que algo deu errado durante o fluxo de trabalho do GitHub. Para corrigir, primeiro efetue pull das alterações mais recentes para o seu codespace. De volta ao codespace do GitHub da sua amostra de bifurcação, execute git pull origin starter-no-infra. Isso puxa o arquivo de fluxo de trabalho recém-confirmado para o seu codespace.

Uma captura de tela mostrando o git pull dentro de um codespace do GitHub.

Etapa 5 (Opção 1: Com o GitHub Copilot):

  1. Inicie uma nova sessão de chat selecionando a exibição Chat e escolha +.
  2. Pergunte: "@workspace, por que estou recebendo o seguinte erro nas ações do GitHub: a cadeia de caracteres "java21" não é uma notação SemVer válida para uma versão java." O Copilot talvez lhe forneça uma explicação e poderá até mesmo fornecer o link para o arquivo de fluxo de trabalho que você precisa corrigir.
  3. Abra .github/workflows/starter-no-infra_msdocs-spring-cosmosdb-123.yaml no explorer e efetue a correção sugerida. O GitHub Copilot não oferece a mesma resposta todas as vezes; talvez seja necessário fazer mais perguntas para ajustar sua resposta. Para obter dicas, confira O que posso fazer com o GitHub Copilot no meu codespace?

Uma captura de tela mostrando como fazer uma pergunta em uma nova sessão de chat do GitHub Copilot.

Etapa 5 (Opção 2: Sem o GitHub Copilot):

  1. Abra .github/workflows/starter-no-infra_msdocs-spring-cosmosdb-123.yaml no explorer e localize a ação setup-java@v4.
  2. Altere o valor de java-version para '21'.

Captura de tela mostrando um codespace do GitHub e o arquivo de fluxo de trabalho gerado automaticamente aberto.

Etapa 6:

  1. Selecione a extensão Controle do código-fonte.
  2. Na caixa de texto, digite uma mensagem de commit, como Fix error in java-version. Ou selecione e permita que o GitHub Copilot gere uma mensagem de confirmação para você.
  3. Selecione Confirmare confirme com Sim.
  4. Selecione Sincronizar alterações 1e confirme com OK.

Uma captura de tela mostrando as alterações em que está sendo feito commit e que estão sendo enviadas por push ao GitHub.

Etapa 7: de volta à página Centro de Implantação no portal do Azure:

  1. Na guia Logs, selecione Atualizar. Uma nova execução de implantação já foi iniciada após as alterações confirmadas.
  2. No item de log da execução da implantação, selecione a entrada Compilar/Implantar Logs com o carimbo de data/hora mais recente.

Captura de tela mostrando uma implantação bem-sucedida na página de Logs do centro de implantação.

Etapa 8: você será levado para o repositório do GitHub e verá que a ação do GitHub está em execução. O arquivo do fluxo de trabalho define dois estágios separados, compilar e implantar. Aguarde a execução do GitHub para mostrar um status de Concluído.

Captura de tela mostrando uma execução bem-sucedida do GitHub.

Está enfrentando problemas? Confira a seção de Solução de problemas.

5. Navegar até o aplicativo

Etapa 1: na página Serviço de Aplicativo:

  1. No menu esquerdo, selecione Visão geral.
  2. Selecione a URL do aplicativo.

Captura de tela que mostra como inicializar um Serviço de Aplicativo no portal do Azure.

Etapa 2: adicione algumas tarefas à lista. Parabéns! Você está executando um aplicativo web no Serviço de Aplicativo do Azure, com uma conectividade segura com o Azure Cosmos DB.

Captura de tela do aplicativo web Spring Boot com o Cosmos DB em execução no Azure.

Está enfrentando problemas? Confira a seção de Solução de problemas.

6. Logs de diagnóstico de fluxo

O Serviço de Aplicativo do Azure captura todas as mensagens geradas no console para ajudar você a diagnosticar problemas com seu aplicativo. O aplicativo de exemplo inclui instruções de log padrão do Log4j para demonstrar essa funcionalidade, conforme mostrado no snippet a seguir:

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Etapa 1: na página Serviço de Aplicativo:

  1. No menu à esquerda, selecione Logs do Serviço de Aplicativo.
  2. Em Log do aplicativo, selecione Sistema de arquivos.
  3. No menu superior, selecione Salvar.

Uma captura de tela mostrando como habilitar logs nativos no Serviço de Aplicativo no portal do Azure.

Etapa 2: no menu esquerdo, selecione Fluxo de log. Você verá os logs do seu aplicativo, incluindo os logs de plataforma e os logs de dentro do contêiner.

Captura de tela mostrando como exibir o fluxo de logs no portal do Azure.

Saiba mais sobre o registro em log em aplicativos Java na série em Habilitar o OpenTelemetry do Azure Monitor para aplicativos.NET, Node.js, Python e Java.

Está enfrentando problemas? Confira a seção de Solução de problemas.

7. Limpar os recursos

Quando tiver terminado, você poderá excluir todos os recursos de sua assinatura do Azure ao excluir o grupo de recursos.

Etapa 1: na barra de pesquisa, na parte superior do portal do Azure:

  1. Insira o nome do grupo de recursos.
  2. Selecione o grupo de recursos.

Uma captura de tela mostrando como pesquisar e navegar para um grupo de recursos no portal do Azure.

Etapa 2: na página Grupo de recursos, selecione Excluir grupo de recursos.

Uma captura de tela mostrando o local do botão **Excluir Grupo de Recursos** no portal do Azure.

Etapa 3:

  1. Confirme sua exclusão digitando o nome do grupo de recursos.
  2. Selecione Excluir.
  3. Confirme com Excluir novamente.

Uma captura de tela do diálogo de confirmação para excluir um grupo de recursos no portal do Azure.

2. Criar recursos do Azure e implantar um aplicativo de amostra

Nesta etapa, você criará os recursos do Azure e implantará um aplicativo de amostra no Serviço de Aplicativo no Linux. As etapas usadas neste tutorial criam um conjunto de recursos seguros por padrão que incluem o Serviço de Aplicativo e o Azure Cosmos DB.

O contêiner de desenvolvimento já tem a CLI do Desenvolvedor do Azure (AZD).

  1. Na raiz do repositório, execute azd init.

    azd init --template javase-app-service-cosmos-redis-infra

  2. Quando solicitado, dê as seguintes respostas:

    Pergunta Resposta
    O diretório atual não está vazio. Deseja inicializar um projeto aqui em “<seu diretório>”? S
    O que você gostaria de fazer com esses arquivos? Manter meus arquivos existentes inalterados
    Insira um novo nome do ambiente Digite um nome exclusivo. O modelo do AZD usa esse nome como parte do nome DNS do seu aplicativo Web no Azure (<app-name>-<hash>.azurewebsites.net). São permitidos caracteres alfanuméricos e hífens.

  3. Entre em sua conta do Azure usando o comando azd auth login e seguindo o prompt:

    azd auth login

  4. Crie os recursos necessários do Azure e implante o código do aplicativo com o comando azd up. Siga o prompt para selecionar a assinatura e o local desejados para os recursos do Azure.

    azd up

    O comando azd up leva cerca de 15 minutos para ser concluído (o cache Redis leva mais tempo). Ele também compila e implanta o código do aplicativo, mas você modificará seu código posteriormente para trabalhar com o Serviço de Aplicativo. Durante a execução, o comando fornece mensagens sobre o processo de provisionamento e implantação, incluindo um link para a implantação no Azure. Quando ele é concluído, o comando também exibe um link para o aplicativo de implantação.

    Esse modelo do AZD contém arquivos (azure.yaml e o diretório infra) que geram uma arquitetura segura por padrão com os seguintes recursos do Azure:

    • Grupo de recursos: o contêiner para todos os recursos criados.
    • Plano do Serviço de Aplicativo: define os recursos de computação para o Serviço de Aplicativo. É criado um plano do Linux na camada B1.
    • Serviço de Aplicativo: representa seu aplicativo e é executado no plano de Serviço de Aplicativo.
    • Rede virtual: integrada ao aplicativo do Serviço de Aplicativo e isola o tráfego de rede de back-end.
    • Conta do Azure Cosmos DB com a API do MongoDB: acessível somente a partir e por trás do seu ponto de extremidade privado. Um banco de dados é criado para você no servidor.
    • Cache do Azure para Redis: acessível somente de dentro da rede virtual.
    • Cofre de chaves: acessível somente a partir e por trás do seu ponto de extremidade privado. Usado para gerenciar segredos para o aplicativo do Serviço de Aplicativo.
    • Pontos de extremidade privados: acesse pontos de extremidade para o cofre de chaves, o servidor de banco de dados e o cache Redis na rede virtual.
    • Zonas DNS privadas: habilite a resolução de DNS do banco de dados Cosmos DB, do cache Redis e do cofre de chaves na rede virtual.
    • Workspace do Log Analytics: atua como o contêiner de destino para seu aplicativo enviar seus logs, em que também poderá consultar os logs.

Está enfrentando problemas? Confira a seção de Solução de problemas.

3. Verificar cadeias de conexão

O modelo do AZD que você usa já gerou as variáveis de conectividade como configurações do aplicativo e as envia para o terminal para sua conveniência. As configurações do aplicativo são uma maneira de manter os segredos de conexão fora do seu repositório de códigos.

  1. Na saída do AZD, localize as configurações do aplicativo spring.data.mongodb.uri. Somente os nomes da configuração são exibidos. Elas têm esta aparência na saída do AZD:

     App Service app has the following app settings:
         - spring.data.mongodb.uri
         - spring.data.mongodb.database
         - spring.redis.host
         - spring.redis.port
         - spring.redis.password
         - spring.redis.database
         - spring.redis.ssl
         - spring.cloud.azure.keyvault.secret.credential.managed_identity_enabled
         - spring.cloud.azure.keyvault.secret.endpoint
         - azure.keyvault.uri
         - azure.keyvault.scope

    spring.data.mongodb.uri contém o URI de conexão com o banco de dados Cosmos DB no Azure. Trata-se de uma variável padrão do Spring Data que seu aplicativo já está usando no arquivo src/main/resources/application.properties.

  2. No explorer, navegue até src/main/resources/application.properties e veja que seu aplicativo Spring Boot já está usando a variável spring.data.mongodb.uri para acessar dados.

  3. Para sua conveniência, a saída do modelo do AZD mostra o link direto para a página de configurações do aplicativo. Localize o link e abra-o em uma nova guia do navegador.

    Se você observar o valor de spring.data.mongodb.uri, deverá ser @Microsoft.KeyVault(...), o que significa que é uma referência do cofre de chaves porque o segredo é gerenciado no cofre de chaves.

Está enfrentando problemas? Confira a seção de Solução de problemas.

4. Navegar até o aplicativo

  1. Na saída do AZD, localize a URL do seu aplicativo e navegue até ela no navegador. O URL fica assim na saída do AZD:

     Deploying services (azd deploy)

   (✓) Done: Deploying service web
   - Endpoint: https://<app-name>-<hash>.azurewebsites.net/

  2. Adicione algumas tarefas à lista.

    Uma captura de tela do aplicativo Web Tomcat com MySQL em execução no Azure mostrando tarefas.

    Parabéns! Você está executando um aplicativo web no Serviço de Aplicativo do Azure, com uma conectividade segura com o Azure Cosmos DB.

Está enfrentando problemas? Confira a seção de Solução de problemas.

5. Transmitir logs de diagnóstico

O Serviço de Aplicativo do Azure pode capturar logs de console para ajudá-lo a diagnosticar problemas com o aplicativo. Por conveniência, o modelo do AZD já habilitou o registro em log ao sistema de arquivos local e está enviando para um workspace do Log Analytics.

O aplicativo de exemplo inclui instruções de log padrão do Log4j para demonstrar essa funcionalidade, conforme mostrado no snippet a seguir:

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Na saída do AZD, localize o link para transmitir logs do Serviço de Aplicativo e navegue até ele no navegador. O link tem esta aparência na saída do AZD:

Stream App Service logs at: https://portal.azure.com/#@/resource/subscriptions/<subscription-guid>/resourceGroups/<group-name>/providers/Microsoft.Web/sites/<app-name>/logStream

Saiba mais sobre o registro em log em aplicativos Java na série em Habilitar o OpenTelemetry do Azure Monitor para aplicativos.NET, Node.js, Python e Java.

Está enfrentando problemas? Confira a seção de Solução de problemas.

6. Limpar os recursos

Para excluir todos os recursos do Azure no ambiente de implantação atual, execute azd down e siga os prompts.

azd down

Solução de problemas

O modo de exibição de implantação do portal do Azure Cosmos DB mostra um status de Conflito

Dependendo da sua assinatura e da região que selecionar, você talvez veja o status de implantação do Azure Cosmos DB como Conflict, com a seguinte mensagem nos detalhes da Operação:

Sorry, we are currently experiencing high demand in <region> region, and cannot fulfill your request at this time.

Esse erro provavelmente é causado por um limite da sua assinatura para a região que você selecionou. Tente escolher uma região diferente para sua implantação.

O aplicativo de exemplo implantado não mostra o aplicativo de lista de tarefas

Se você vir uma página Hey, Java developers! em vez do aplicativo de lista de tarefas, o Serviço de Aplicativo provavelmente ainda estará carregando o contêiner atualizado da implantação de código mais recente. Aguarde alguns minutos e atualize a página.

Perguntas frequentes

Quanto custa essa configuração?

O preço dos recursos criados são os seguintes:

  • O plano do Serviço de Aplicativo é criado na camada Básica e pode ser ampliado ou reduzido. Confira Preço do Serviço de Aplicativo.
  • A conta do Azure Cosmos DB é criada no nível Sem servidor e há um pequeno custo associado a esse nível. Veja Preços do Microsoft Azure Cosmos DB.
  • O Cache do Azure para Redis é criado na camada Básico com o tamanho mínimo do cache. Há um pequeno custo associado a essa camada. Você pode dimensioná-la para níveis de desempenho mais altos para maior disponibilidade, clustering e outros recursos. Consulte Preço do Cache do Azure para Redis.
  • A rede virtual não incorre em cobrança, a menos que você configure uma funcionalidade extra, como emparelhamento. Consulte os Preços da Rede Virtual do Azure.
  • A zona DNS privada incorre em uma pequena cobrança. Consulte os Preços do DNS do Azure.

Como faço para executar a migração de banco de dados com o banco de dados do Cosmos DB por trás da rede virtual?

O contêiner Java SE no Serviço de Aplicativo já tem conectividade de rede com o Cosmos DB, mas não contém nenhuma ferramenta de migração ou outras ferramentas do MongoDB. Você tem algumas opções:

  • Execute as migrações do banco de dados automaticamente quando o aplicativo for iniciado, como com o Hibernate e/ou o Flyway.
  • Na sessão SSH do aplicativo, instale uma ferramenta de migração como a CLI do Flyway e, a seguir, execute o script de migração. Lembre-se de que a ferramenta instalada não persistirá após uma reinicialização do aplicativo, a menos que esteja no diretório /home.
  • Integre o Azure Cloud Shell à rede virtual e execute as migrações do banco de dados a partir de lá.

Como o desenvolvimento de aplicativos local funciona com o GitHub Actions?

Usando como exemplo o arquivo de fluxo de trabalho gerado automaticamente do Serviço de Aplicativo, cada git push inicia uma nova compilação e execução de implantação. A partir de um clone local do repositório do GitHub, você faz as atualizações desejadas e efetua push para o GitHub. Por exemplo:

git add .
git commit -m "<some-message>"
git push origin main

Não tenho permissões para criar uma identidade atribuída pelo usuário

Consulte Configurar a implantação do GitHub Actions no Centro de Implantação.

O que posso fazer com o GitHub Copilot em meu codespace?

Você deve ter percebido que o modo de exibição de chat do GitHub Copilot já estava lá quando você criou o codespace. Para sua conveniência, incluímos a extensão de chat do GitHub Copilot na definição de contêiner (confira .devcontainer/devcontainer.json). No entanto, você precisa de uma conta do GitHub Copilot (avaliação gratuita de 30 dias disponível).

Algumas dicas para você ao falar com o GitHub Copilot:

  • Em uma única sessão de chat, as perguntas e respostas se baseiam umas nas outras e você pode ajustar suas perguntas para ajustar a resposta que receber.
  • Por padrão, o GitHub Copilot não tem acesso a nenhum arquivo em seu repositório. Para fazer perguntas sobre um arquivo, abra o arquivo no editor primeiro.
  • Para permitir que o GitHub Copilot tenha acesso a todos os arquivos no repositório ao preparar suas respostas, comece sua pergunta com @workspace. Para obter mais informações, consulte Use the @workspace agent.
  • Na sessão de chat, o GitHub Copilot pode sugerir alterações e (com @workspace) até mesmo onde fazer as alterações, mas não tem permissão para fazer as alterações para você. Cabe a você adicionar as alterações sugeridas e testá-las.

Próximas etapas

Saiba mais sobre como executar aplicativos Java no Serviço de Aplicativo no guia do desenvolvedor.

Configurar um aplicativo Java para o Serviço de Aplicativo do Azure

Saiba como proteger seu aplicativo com um domínio e um certificado personalizados.

 Segurança com domínios e certificados personalizados