Introdução a SDK do Azure e Maven

Este artigo mostra como usar o Apache Maven para criar aplicativos com o SDK do Azure para Java. Neste artigo, você configura um novo projeto com o Maven, cria projetos com o Maven e usa as ferramentas de imagem nativa GraalVM para criar binários nativos específicos da plataforma.

O projeto do SDK do Azure para Java inclui um arquétipo Maven que pode acelerar a inicialização de um novo projeto. O arquétipo do SDK do Azure para Java Maven cria um novo aplicativo, com arquivos e uma estrutura de diretório que segue as práticas recomendadas. Em particular, o arquétipo do SDK do Azure para Java Maven cria um novo projeto Maven com os seguintes recursos:

• Uma dependência da versão mais recente do azure-sdk-bom BOM, que garante que todas as dependências do SDK do Azure para Java estejam alinhadas e oferece a melhor experiência de desenvolvedor possível.
• Suporte interno para compilação de imagem nativa de GraalVM.
• Suporte para gerar um novo projeto com um conjunto especificado de bibliotecas de clientes do SDK do Azure para Java.
• Integração com o SDK do Azure para ferramentas de compilação do Java, que fornece análise durante o tempo de compilação do seu projeto para garantir que muitas práticas recomendadas sejam seguidas.

Pré-requisitos

• Java Developer Kit, versão 8 ou posterior. Para obter a melhor experiência, use a versão 17.
• Apache Maven

Criar um novo projeto maven

O arquétipo Maven do SDK do Azure para Java está disponível no Maven Central. Você pode usar o arquétipo diretamente para inicializar um novo aplicativo executando o seguinte comando:

mvn archetype:generate \
    -DarchetypeGroupId=com.azure.tools \
    -DarchetypeArtifactId=azure-sdk-archetype

Depois de inserir esse comando, uma série de prompts solicita detalhes sobre seu projeto para que o arquétipo possa gerar a saída certa para você. A tabela a seguir descreve as propriedades para as quais você precisa fornecer valores:

Como alternativa, você pode fornecer esses valores ao chamar o comando de arquétipo mostrado anteriormente. Essa abordagem é útil, por exemplo, para fins de automação. Você pode especificar os valores como parâmetros usando a sintaxe maven padrão de acrescentar -D ao nome do parâmetro, por exemplo:

-DjavaVersion=17

Suporte à versão do Java

Como prática recomendada, use uma versão Java LTS ao implantar em produção. Por padrão, o arquétipo maven do SDK do Azure seleciona a versão mais recente do LTS, que atualmente define uma linha de base do Java 17. No entanto, você pode substituir o comportamento padrão definindo o parâmetro javaVersion.

Usar a ferramenta de build do SDK do Azure para Java

O projeto do SDK do Azure para Java inclui uma ferramenta de compilação do Maven que você pode adicionar aos seus projetos. Essa ferramenta é executada localmente e não envia dados para Microsoft. Você pode configurar a ferramenta para gerar um relatório ou falhar no build quando determinadas condições forem atendidas. Esse recurso ajuda a garantir a conformidade com as práticas recomendadas, como as seguintes práticas:

• A validação do uso correto do azure-sdk-for-java BOM, incluindo o uso da versão mais recente e o uso dessa para definir as versões de dependência nas bibliotecas de clientes do SDK do Azure para Java. Para obter mais informações, consulte a seção Adicionar o SDK do Azure para Java a um projeto existente seção.
• Validação para garantir que bibliotecas de cliente antigas do Azure não sejam usadas quando houver versões mais recentes e aprimoradas.

O relatório também fornece informações sobre o uso de APIs beta.

Você pode configurar a ferramenta de build em um arquivo POM maven do projeto, conforme mostrado no exemplo a seguir. Certifique-se de substituir o espaço reservado {latest_version} pela versão mais recente listada online.

<build>
  <plugins>
    <plugin>
      <groupId>com.azure.tools</groupId>
      <artifactId>azure-sdk-build-tool</artifactId>
      <version>{latest_version}</version>
    </plugin>
  </plugins>
</build>

Depois de adicionar a ferramenta de build a um projeto do Maven, execute a ferramenta chamando mvn compile azure:run. Dependendo da configuração fornecida, você pode esperar ver falhas de build ou arquivos de relatório gerados que podem informá-lo sobre possíveis problemas antes que eles se tornem mais sérios. Execute essa ferramenta como parte do pipeline de CI/CD. À medida que a ferramenta de build evolui, a equipe de desenvolvimento publica novas versões. Verifique com frequência se há novas versões e atualize conforme apropriado.

Você pode configurar a ferramenta de build para habilitar ou desabilitar recursos específicos. Para essa configuração, adicione uma seção configuration no XML mostrado anteriormente. Nessa seção, defina as configurações mostradas na tabela a seguir. Qualquer configuração que não seja explicitamente mencionada usa o valor padrão especificado na tabela.

Adicionar o SDK do Azure para Java a um projeto existente

Para simplificar o gerenciamento de versões de dependências, a equipe do SDK do Azure para Java publica o BOM do cliente do SDK do Azure para Java mensalmente. Este arquivo BOM inclui todos os pacotes de cliente do SDK do Azure para Java de disponibilidade geral (GA), com as versões compatíveis de suas dependências.

Para usar versões de dependência para uma biblioteca de clientes do SDK do Azure para Java listada na BOM, adicione o trecho de código a seguir ao arquivo pom.xml do projeto. Substitua o espaço reservado {bom_version_to_target} pela versão mais recente da BOM do SDK do Azure para Java. Substitua o espaço reservado {artifactId} pelo nome do pacote SDK do serviço Azure.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure</groupId>
      <artifactId>azure-sdk-bom</artifactId>
      <version>{bom_version_to_target}</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>{artifactId}</artifactId>
  </dependency>
</dependencies>

Você pode encontrar todos os lançamentos da BOM do SDK do Azure para Java em azure-sdk-bom. Use a versão mais recente para aproveitar os recursos mais recentes do SDK do Azure para bibliotecas de cliente Java.

Usar o Maven para definir dependências de projeto pode tornar o gerenciamento de seus projetos mais simples. Ao usar o BOM do SDK do Azure e o arquétipo Maven do SDK do Azure, você pode acelerar seu projeto e, ao mesmo tempo, ter mais confiança no versionamento das dependências no longo prazo. Use o BOM para manter as dependências alinhadas e atualizadas.

Além de adicionar o SDK do Azure BOM, inclua também a ferramenta de build do SDK do Azure para Java. Essa ferramenta ajuda a diagnosticar muitos problemas comumente encontrados ao criar aplicativos, conforme descrito anteriormente neste artigo.

Incluir um pacote que não está no BOM

O SDK do Azure para o cliente Java BOM inclui apenas bibliotecas ga (disponibilidade geral). Se você quiser usar um pacote que ainda esteja em beta ou uma versão de biblioteca diferente da incluída no BOM, especifique a versão da dependência do Maven junto com groupId e artifactId na seção de dependências. Você pode optar por ter dependências que usam versões BOM e dependências com versões substituídas no mesmo arquivo POM do projeto, conforme mostrado no exemplo a seguir:

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-messaging-eventhubs</artifactId> <!-- Use the dependency version that is in the BOM -->
  </dependency>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-messaging-servicebus</artifactId>
    <version>7.4.0</version> <!-- Override the Service Bus dependency version specified in the BOM -->
  </dependency>
</dependencies>

Se você usar essa abordagem e especificar versões diretamente em seu projeto, poderá obter conflitos de versão de dependência. Esses conflitos surgem porque pacotes diferentes podem depender de diferentes versões de dependências comuns, e essas versões podem não ser compatíveis entre si. Quando ocorrem conflitos, você pode experimentar um comportamento indesejável em tempo de compilação ou runtime. Conte com versões que estão no SDK do Azure BOM, a menos que seja necessário. Para obter mais informações sobre como lidar com dependências ao usar o SDK do Azure para Java, consulte Solucionar problemas de conflitos de versão de dependência.

Criar uma imagem nativa com GraalVM

Você pode usar GraalVM para criar uma imagem nativa de um aplicativo Java. A GraalVM compila o código Java antecipadamente em código de máquina nativo, o que pode gerar ganhos drásticos de desempenho em determinadas situações. O SDK do Azure para Java fornece os metadados necessários em cada uma de suas bibliotecas de clientes para dar suporte à compilação de imagem nativa GraalVM.

Para começar, instale o GraalVM e prepare seu sistema de desenvolvimento para compilar imagens nativas. O processo de instalação de GraalVM é simples, e a documentação de GraalVM fornece instruções passo a passo para instalação de GraalVM e usando GraalVM para instalar native-image. Siga cuidadosamente a seção de pré-requisitos para instalar os compiladores nativos necessários para o seu sistema operacional.

O arquétipo do SDK do Azure para Java Maven pode configurar seu build para dar suporte à compilação de imagem nativa GraalVM, mas você também pode adicioná-lo a um build do Maven existente. Você pode encontrar instruções para Maven no site da GraalVM.

Em seguida, você está pronto para executar uma compilação de imagem nativa. Você pode usar ferramentas padrão do Maven para usar a imagem nativa GraalVM. Para o Maven, use o seguinte comando:

mvn clean package -Pnative

Depois de executar esse comando, o GraalVM gera um executável nativo para a plataforma em que está sendo executado. O executável aparece no diretório /target do maven do seu projeto. Agora você pode executar seu aplicativo com esse arquivo executável e ele deve ser executado de forma semelhante a um aplicativo Java padrão.

Próximas etapas