Função Spring Cloud no Azure

  • Artigo

Este artigo explica-lhe como utilizar funções do Spring Cloud Function para desenvolver uma função Java e publicá-la nas Funções do Azure. Quando terminar, o seu código de função é executado no Plano de Consumo no Azure e pode ser acionado com um pedido HTTP.

Se não tiver uma subscrição do Azure, crie uma conta gratuita antes de começar.

Pré-requisitos

Para desenvolver funções com o Java, tem de ter o seguinte instalado:

Importante

  1. Você deve definir a JAVA_HOME variável de ambiente para o local de instalação do JDK para concluir este início rápido.
  2. Certifique-se de que a versão das ferramentas principais é, pelo menos, 4.0.5455.

O que vamos construir

Vamos criar uma função clássica "Olá, Mundo" que é executada no Azure Functions e configurada com a Spring Cloud Function.

A função recebe um objeto JSON, que contém um nome de usuário, e envia de volta um UserGreeting objeto, que contém a mensagem de boas-vindas para esse usuário.

O projeto está disponível no exemplo Spring Cloud Function in Azure do repositório azure-function-java-worker no GitHub. Você pode usar esse exemplo diretamente se quiser ver o trabalho final descrito neste início rápido.

Criar um novo projeto do Maven

Vamos criar um projeto Maven vazio e configurá-lo com o Spring Cloud Function e o Azure Functions.

Em uma pasta vazia, crie um novo arquivo pom.xml e copie/cole o conteúdo do arquivo pom.xml do projeto de exemplo.

Nota

Este ficheiro utiliza dependências Maven do Spring Boot e do Spring Cloud Function, e configura os plug-ins Maven do Spring Boot e das Funções do Azure.

Você precisa personalizar algumas propriedades para seu aplicativo:

  • <functionAppName> é o nome da sua Função do Azure
  • <functionAppRegion> é o nome da região do Azure onde a sua Função é implementada
  • <functionResourceGroup> é o nome do grupo de recursos do Azure que você está usando

Altere essas propriedades diretamente perto da parte superior do arquivo pom.xml , conforme mostrado no exemplo a seguir:

    <properties>
        <java.version>11</java.version>

        <!-- Spring Boot start class. WARNING: correct class must be set -->
        <start-class>com.example.DemoApplication</start-class>

        <!-- customize those properties. WARNING: the functionAppName should be unique across Azure -->
        <azure.functions.maven.plugin.version>1.29.0</azure.functions.maven.plugin.version>
        <functionResourceGroup>my-spring-function-resource-group</functionResourceGroup>
        <functionAppServicePlanName>my-spring-function-service-plan</functionAppServicePlanName>
        <functionAppName>my-spring-function</functionAppName>
        <functionPricingTier>Y1</functionPricingTier>
        <functionAppRegion>eastus</functionAppRegion>
    </properties>

Criar ficheiros de configuração do Azure

Crie uma pasta src/main/resources e adicione os seguintes arquivos de configuração do Azure Functions a ela.

host.json:

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[4.*, 5.2.0)"
  },
  "functionTimeout": "00:10:00"
}

local.settings.json:

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "java",
    "FUNCTIONS_EXTENSION_VERSION": "~4",
    "AzureWebJobsDashboard": ""
  }
}

Criar objetos de domínio

As Funções do Azure podem receber e enviar objetos no formato JSON. Agora vamos criar nossos User objetos e Greeting que representam nosso modelo de domínio. Pode criar objetos mais complexos, com mais propriedades, se quiser personalizar este início rápido e torná-lo mais interessante para si.

Crie uma pasta src/main/java/com/exemplo/model e adicione os dois ficheiros seguintes:

User.java:

package com.example.model;

public class User {

    private String name;

    public User() {
    }

    public User(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

Greeting.java:

package com.example.model;

public class Greeting {

    private String message;

    public Greeting() {
    }

    public Greeting(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

Criar a aplicação Spring Boot

Este aplicativo gerencia toda a lógica de negócios e tem acesso ao ecossistema completo do Spring Boot. Esse recurso oferece dois benefícios principais em relação a uma Função do Azure padrão:

  • Ele não depende das APIs do Azure Functions, portanto, você pode portá-lo facilmente para outros sistemas. Por exemplo, você pode reutilizá-lo em um aplicativo Spring Boot normal.
  • Você pode usar todas as @Enable anotações do Spring Boot para adicionar novos recursos.

Na pasta sRC/main/java/com/exemplo, crie o seguinte ficheiro, que é uma aplicação Spring Boot normal:

DemoApplication.java:

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(DemoApplication.class, args);
    }
}

Agora crie o seguinte arquivo na pasta src/main/java/com/example/hello . Este código contém um componente Spring Boot que representa a função que queremos executar:

Olá.java:

package com.example.hello;

import com.example.model.*;
import org.springframework.stereotype.Component;
import java.util.function.Function;

@Component
public class Hello implements Function<User, Greeting> {

    @Override
    public Greeting apply(User user) {
        return new Greeting("Hello, " + user.getName() + "!\n");
    }
}

Nota

A função Hello é bastante específica:

  • É um java.util.function.Function. Ele contém a lógica de negócios e usa uma API Java padrão para transformar um objeto em outro.
  • Como ele tem a anotação, é um Spring Bean, e por padrão seu nome é o mesmo que a @Component classe, mas começando com um caractere minúsculo: hello. Seguir essa convenção de nomenclatura é importante se você quiser criar outras funções em seu aplicativo. O nome deve corresponder ao nome do Azure Functions que criaremos na próxima seção.

Publicar a Função do Azure

Para se beneficiar da API completa do Azure Functions, agora codificamos uma Função do Azure que delega sua execução à Função Spring Cloud criada na etapa anterior.

Na pasta src/main/java/com/example/hello, crie o seguinte arquivo de classe de função do Azure:

HelloHandler.java:

package com.example.hello;

import com.microsoft.azure.functions.*;
import com.microsoft.azure.functions.annotation.AuthorizationLevel;
import com.microsoft.azure.functions.annotation.FunctionName;
import com.microsoft.azure.functions.annotation.HttpTrigger;
import com.example.model.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.Optional;

@Component
public class HelloHandler {

    @Autowired
    private Hello hello;

    @FunctionName("hello")
    public HttpResponseMessage execute(
        @HttpTrigger(name = "request", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<User>> request, ExecutionContext context) {
        User user = request.getBody()
                           .filter(u -> u.getName() != null)
                           .orElseGet(() -> new User(request.getQueryParameters().getOrDefault("name", "world")));
        context.getLogger().info("Greeting user name: " + user.getName());
        return request.createResponseBuilder(HttpStatus.OK)
                      .body(hello.apply(user))
                      .header("Content-Type", "application/json")
                      .build();
    }
}

Esta classe Java é uma Função do Azure, com as seguintes características especiais:

  • A classe tem a @Component anotação, por isso é um Spring Bean.
  • O nome da função, conforme definido pela @FunctionName("hello") anotação, é hello.
  • A classe implementa uma Função do Azure real, para que você possa usar a API completa do Azure Functions aqui.

Adicionar testes de unidades

Esta etapa é opcional, mas recomendada para validar se o aplicativo funciona corretamente.

Crie uma pasta src/test/java/com/example e adicione os seguintes testes JUnit:

HelloTest.java:

package com.example;

import com.example.hello.Hello;
import com.example.model.Greeting;
import com.example.model.User;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;

public class HelloTest {

    @Test
    public void test() {
        Greeting result = new Hello().apply(new User("foo"));
        assertThat(result.getMessage()).isEqualTo("Hello, foo!\n");
    }
}

Pode agora testar a sua Função do Azure com o Maven:

mvn clean test

Executar a Função localmente

Antes de implementar a sua aplicação na Função do Azure, vamos primeiro testá-la localmente.

Primeiro, precisa de empacotar a aplicação num ficheiro Jar:

mvn package

Agora que a aplicação está empacotada, pode executá-la ao utilizar o plug-in Maven azure-functions:

mvn azure-functions:run

A Função do Azure deverá agora estar disponível no seu localhost através da porta 7071. Pode testar a função ao enviar-lhe um pedido POST com um objeto User no formato JSON. Por exemplo, ao utilizar o cURL:

curl -X POST http://localhost:7071/api/hello -d "{\"name\":\"Azure\"}"

A Função deverá responder com um objeto Greeting, ainda no formato JSON:

{
  "message": "Hello, Azure!\n"
}

Aqui está uma captura de tela da solicitação cURL na parte superior da tela e a Função do Azure local na parte inferior:

Azure Function running locally

Depurar a função localmente

As seções a seguir descrevem como depurar a função.

Depurar usando Intellij IDEA

Abra o projeto no Intellij IDEA e, em seguida, crie uma configuração de execução de depuração JVM remota para anexar. Para obter mais informações, consulte Tutorial: Depuração remota.

Create a Remote JVM Debug run configuration

Execute o aplicativo com o seguinte comando:

mvn azure-functions:run -DenableDebug

Quando o aplicativo é iniciado, você vê a seguinte saída:

Worker process started and initialized.
Listening for transport dt_socket at address: 5005

Inicie a depuração do projeto no IntelliJ IDEA. Você vê a seguinte saída:

Connected to the target VM, address: 'localhost:5005', transport: 'socket'

Marque os pontos de interrupção que deseja depurar. O Intellij IDEA entrará no modo de depuração após o envio de uma solicitação.

Depurar usando o Visual Studio Code

Abra o projeto no Visual Studio Code e, em seguida, configure o seguinte conteúdo do arquivo launch.json :

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Attach to Remote Program",
            "request": "attach",
            "hostName": "127.0.0.1",
            "port": 5005
        }
    ]
}

Execute o aplicativo com o seguinte comando:

mvn azure-functions:run -DenableDebug

Quando o aplicativo é iniciado, você vê a seguinte saída:

Worker process started and initialized.
Listening for transport dt_socket at address: 5005

Inicie a depuração do projeto no Visual Studio Code e, em seguida, marque os pontos de interrupção que você deseja depurar. O Visual Studio Code entrará no modo de depuração depois de enviar uma solicitação. Para obter mais informações, consulte Executando e depurando Java.

Implementar a Função nas Funções do Azure

Agora, você vai publicar a Função do Azure na produção. Lembre-se de que o <functionAppName>, <functionAppRegion>e <functionResourceGroup> as propriedades que você definiu em seu arquivo pom.xml são usados para configurar sua função.

Nota

O plug-in do Maven precisa ser autenticado com o Azure. Se você tiver a CLI do Azure instalada, use az login antes de continuar. Para obter mais opções de autenticação, consulte Autenticação no repositório azure-maven-plugins .

Execute o Maven para implementar automaticamente a função:

mvn azure-functions:deploy

Em seguida, aceda ao portal do Azure para localizar o Function App criado.

Selecione a função:

  • Na descrição geral da função, anote o URL da mesma.
  • Para verificar a função de execução, selecione Registrar streaming no menu de navegação.

Agora, como você fez na seção anterior, use cURL para acessar a função em execução, como mostrado no exemplo a seguir. Certifique-se de substituir your-function-name pelo seu nome de função real.

curl https://your-function-name.azurewebsites.net/api/hello -d "{\"name\":\"Azure\"}"

Tal como na secção anterior, a Função deverá responder com um objeto Greeting, ainda no formato JSON:

{
  "message": "Hello, Azure!\n"
}

Parabéns! Tem uma função do Spring Cloud Function em execução nas Funções do Azure! Para obter mais informações e exemplos de funções do Spring Cloud, consulte os seguintes recursos:

Próximos passos

Para saber mais sobre o Spring e o Azure, avance para o centro de documentação relativa ao Spring no Azure.

Spring no Azure