Avvio rapido: Creare una funzione Java in Azure dalla riga di comandoQuickstart: Create a Java function in Azure from the command line

In questo articolo vengono usati gli strumenti da riga di comando per creare una funzione Java che risponde alle richieste HTTP.In this article, you use command-line tools to create a Java function that responds to HTTP requests. Dopo aver testato il codice in locale, verrà distribuito nell'ambiente serverless di Funzioni di Azure.After testing the code locally, you deploy it to the serverless environment of Azure Functions.

Le procedure illustrate in questa guida di avvio rapido comportano l'addebito di qualche centesimo (USD) o meno nell'account Azure.Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Nota

Se si preferisce non usare Maven come strumento di sviluppo, vedere le esercitazioni simili per sviluppatori Java che usano Gradle, IntelliJ IDEA e Visual Studio Code.If Maven is not your preferred development tool, check out our similar tutorials for Java developers using Gradle, IntelliJ IDEA and Visual Studio Code.

Configurare l'ambiente localeConfigure your local environment

Per eseguire le procedure descritte è necessario:Before you begin, you must have the following:

Controllo dei prerequisitiPrerequisite check

  • In una finestra di comando o di terminale eseguire func --version per verificare che la versione di Azure Functions Core Tools sia 3.x.In a terminal or command window, run func --version to check that the Azure Functions Core Tools are version 3.x.

  • Eseguire az --version per verificare che la versione dell'interfaccia della riga di comando di Azure sia 2.4 o successiva.Run az --version to check that the Azure CLI version is 2.4 or later.

  • Eseguire az login per accedere ad Azure e verificare la presenza di una sottoscrizione attiva.Run az login to sign in to Azure and verify an active subscription.

Creare un progetto di funzione localeCreate a local function project

In Funzioni di Azure un progetto di funzione è un contenitore per una o più funzioni singole che rispondono ognuna a un trigger specifico.In Azure Functions, a function project is a container for one or more individual functions that each responds to a specific trigger. Tutte le funzioni di un progetto condividono le stesse configurazioni locali e di hosting.All functions in a project share the same local and hosting configurations. In questa sezione viene creato un progetto di funzione che contiene una singola funzione.In this section, you create a function project that contains a single function.

  1. In una cartella vuota eseguire il comando seguente per generare il progetto di Funzioni da un archetipo Maven.In an empty folder, run the following command to generate the Functions project from a Maven archetype.

    mvn archetype:generate -DarchetypeGroupId=com.microsoft.azure -DarchetypeArtifactId=azure-functions-archetype -DjavaVersion=8
    

    Importante

    • Usare -DjavaVersion=11 per eseguire le funzioni in Java 11.Use -DjavaVersion=11 if you want your functions to run on Java 11. Per altre informazioni, vedere Versioni di Java.To learn more, see Java versions.
    • Per completare questo articolo, è necessario impostare la variabile di ambiente JAVA_HOME sul percorso di installazione della versione corretta di JDK.The JAVA_HOME environment variable must be set to the install location of the correct version of the JDK to complete this article.
  2. Maven chiede i valori necessari per completare la generazione del progetto nella distribuzione.Maven asks you for values needed to finish generating the project on deployment.
    Quando richiesto, specificare i valori seguenti:Provide the following values when prompted:

    PromptPrompt valoreValue DescrizioneDescription
    groupIdgroupId com.fabrikam Un valore che identifica in modo univoco il progetto tra tutti gli altri, seguendo le regole di denominazione dei pacchetti per Java.A value that uniquely identifies your project across all projects, following the package naming rules for Java.
    artifactIdartifactId fabrikam-functions Un valore che corrisponde al nome del jar, senza un numero di versione.A value that is the name of the jar, without a version number.
    versionversion 1.0-SNAPSHOT Scegliere il valore predefinito.Choose the default value.
    packagepackage com.fabrikam Un valore che corrisponde al pacchetto Java per il codice della funzione generato.A value that is the Java package for the generated function code. Usare il valore predefinito.Use the default.
  3. Digitare Y o premere INVIO per confermare.Type Y or press Enter to confirm.

    Maven crea i file di progetto in una nuova cartella denominata artifactId, che in questo esempio è fabrikam-functions.Maven creates the project files in a new folder with a name of artifactId, which in this example is fabrikam-functions.

  4. Passare alla cartella del progetto:Navigate into the project folder:

    cd fabrikam-functions
    

    Questa cartella contiene vari file per il progetto, inclusi i file di configurazione denominati local.settings.json e host.json.This folder contains various files for the project, including configurations files named local.settings.json and host.json. Poiché local.settings.json può contenere segreti scaricati da Azure, per impostazione predefinita il file viene escluso dal controllo del codice sorgente nel file con estensione gitignore.Because local.settings.json can contain secrets downloaded from Azure, the file is excluded from source control by default in the .gitignore file.

(Facoltativo) Esaminare il contenuto del file(Optional) Examine the file contents

Se si vuole, è possibile passare a Eseguire la funzione localmente ed esaminare il contenuto del file in un secondo momento.If desired, you can skip to Run the function locally and examine the file contents later.

Function.javaFunction.java

Function.java contiene un metodo run che riceve i dati della richiesta nella variabile request come oggetto HttpRequestMessage decorato con l'annotazione HttpTrigger, che definisce il comportamento del trigger.Function.java contains a run method that receives request data in the request variable is an HttpRequestMessage that's decorated with the HttpTrigger annotation, which defines the trigger behavior.

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.functions;

import com.microsoft.azure.functions.ExecutionContext;
import com.microsoft.azure.functions.HttpMethod;
import com.microsoft.azure.functions.HttpRequestMessage;
import com.microsoft.azure.functions.HttpResponseMessage;
import com.microsoft.azure.functions.HttpStatus;
import com.microsoft.azure.functions.annotation.AuthorizationLevel;
import com.microsoft.azure.functions.annotation.FunctionName;
import com.microsoft.azure.functions.annotation.HttpTrigger;

import java.util.Optional;

/**
 * Azure Functions with HTTP Trigger.
 */
public class Function {
    /**
     * This function listens at endpoint "/api/HttpExample". Two ways to invoke it using "curl" command in bash:
     * 1. curl -d "HTTP Body" {your host}/api/HttpExample
     * 2. curl "{your host}/api/HttpExample?name=HTTP%20Query"
     */
    @FunctionName("HttpExample")
    public HttpResponseMessage run(
            @HttpTrigger(
                name = "req",
                methods = {HttpMethod.GET, HttpMethod.POST},
                authLevel = AuthorizationLevel.ANONYMOUS)
                HttpRequestMessage<Optional<String>> request,
            final ExecutionContext context) {
        context.getLogger().info("Java HTTP trigger processed a request.");

        // Parse query parameter
        final String query = request.getQueryParameters().get("name");
        final String name = request.getBody().orElse(query);

        if (name == null) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST).body("Please pass a name on the query string or in the request body").build();
        } else {
            return request.createResponseBuilder(HttpStatus.OK).body("Hello, " + name).build();
        }
    }
}

Il messaggio di risposta viene generato dall'API HttpResponseMessage.Builder.The response message is generated by the HttpResponseMessage.Builder API.

pom.xmlpom.xml

Le impostazioni per le risorse di Azure create per ospitare l'app sono definite nell'elemento configuration del plug-in con un elemento groupId di com.microsoft.azure nel file pom.xml generato.Settings for the Azure resources created to host your app are defined in the configuration element of the plugin with a groupId of com.microsoft.azure in the generated pom.xml file. Ad esempio, l'elemento configuration seguente indica a una distribuzione basata su Maven di creare un'app per le funzioni nel gruppo di risorse java-functions-group nell'area westus.For example, the configuration element below instructs a Maven-based deployment to create a function app in the java-functions-group resource group in the westus region. L'app per le funzioni viene eseguita in Windows ospitata nel piano java-functions-app-service-plan, che per impostazione predefinita è un piano a consumo serverless.The function app itself runs on Windows hosted in the java-functions-app-service-plan plan, which by default is a serverless Consumption plan.

<plugin>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-functions-maven-plugin</artifactId>
    <version>${azure.functions.maven.plugin.version}</version>
    <configuration>
        <!-- function app name -->
        <appName>${functionAppName}</appName>
        <!-- function app resource group -->
        <resourceGroup>${functionResourceGroup}</resourceGroup>
        <!-- function app service plan name -->
        <appServicePlanName>java-functions-app-service-plan</appServicePlanName>
        <!-- function app region-->
        <!-- refers https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Functions:-Configuration-Details#supported-regions for all valid values -->
        <region>${functionAppRegion}</region>
        <!-- function pricingTier, default to be consumption if not specified -->
        <!-- refers https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Functions:-Configuration-Details#supported-pricing-tiers for all valid values -->
        <!-- <pricingTier></pricingTier> -->

        <!-- Whether to disable application insights, default is false -->
        <!-- refers https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Functions:-Configuration-Details for all valid configurations for application insights-->
        <!-- <disableAppInsights></disableAppInsights> -->
        <runtime>
            <!-- runtime os, could be windows, linux or docker-->
            <os>windows</os>
            <javaVersion>8</javaVersion>
            <!-- for docker function, please set the following parameters -->
            <!-- <image>[hub-user/]repo-name[:tag]</image> -->
            <!-- <serverId></serverId> -->
            <!-- <registryUrl></registryUrl>  -->
        </runtime>
        <appSettings>
            <property>
                <name>FUNCTIONS_EXTENSION_VERSION</name>
                <value>~3</value>
            </property>
        </appSettings>
    </configuration>
    <executions>
        <execution>
            <id>package-functions</id>
            <goals>
                <goal>package</goal>
            </goals>
        </execution>
    </executions>
</plugin>

È possibile modificare queste impostazioni per controllare la modalità di creazione delle risorse in Azure, ad esempio cambiando runtime.os da windows a linux prima della distribuzione iniziale.You can change these settings to control how resources are created in Azure, such as by changing runtime.os from windows to linux before initial deployment. Per un elenco completo delle impostazioni supportate dal plug-in Maven, vedere i dettagli di configurazione.For a complete list of settings supported by the Maven plug-in, see the configuration details.

FunctionTest.javaFunctionTest.java

L'archetipo genera anche uno unit test per la funzione.The archetype also generates a unit test for your function. Quando si modifica la funzione per aggiungere i binding o si aggiungono nuove funzioni al progetto, sarà necessario modificare anche i test nel file FunctionTest.java.When you change your function to add bindings or add new functions to the project, you'll also need to modify the tests in the FunctionTest.java file.

Eseguire la funzione in localeRun the function locally

  1. Eseguire la funzione avviando l'host di runtime locale di Funzioni di Azure nella cartella LocalFunctionProj:Run your function by starting the local Azure Functions runtime host from the LocalFunctionProj folder:

    mvn clean package
    mvn azure-functions:run
    

    Verso la fine dell'output, verranno visualizzate le righe seguenti:Toward the end of the output, the following lines should appear:

     ...
    
     Now listening on: http://0.0.0.0:7071
     Application started. Press Ctrl+C to shut down.
    
     Http Functions:
    
             HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
     ...
    
     

    Nota

    Se HttpExample non viene visualizzato come illustrato sopra, è probabile che l'host non sia stato avviato dalla cartella radice del progetto.If HttpExample doesn't appear as shown above, you likely started the host from outside the root folder of the project. In tal caso, premere CTRL+C per arrestare l'host, passare alla cartella radice del progetto ed eseguire di nuovo il comando precedente.In that case, use Ctrl+C to stop the host, navigate to the project's root folder, and run the previous command again.

  2. Copiare l'URL della funzione HttpExample da questo output in un browser e aggiungere la stringa di query ?name=<YOUR_NAME>, rendendo l'URL completo come http://localhost:7071/api/HttpExample?name=Functions.Copy the URL of your HttpExample function from this output to a browser and append the query string ?name=<YOUR_NAME>, making the full URL like http://localhost:7071/api/HttpExample?name=Functions. Nel browser dovrebbe essere visualizzato un messaggio simile a Hello Functions:The browser should display a message like Hello Functions:

    Risultato della funzione eseguita in locale nel browser

    Il terminale in cui è stato avviato il progetto mostra anche l'output del log quando si effettuano le richieste.The terminal in which you started your project also shows log output as you make requests.

  3. Al termine, premere CTRL+C e scegliere y per arrestare l'host di Funzioni.When you're done, use Ctrl+C and choose y to stop the functions host.

Distribuire il progetto di funzione in AzureDeploy the function project to Azure

La prima volta che si distribuisce il progetto di Funzioni, in Azure vengono create un'app per le funzioni e le risorse correlate.A function app and related resources are created in Azure when you first deploy your functions project. Le impostazioni per le risorse di Azure create per ospitare l'app sono definite nel file pom.xml.Settings for the Azure resources created to host your app are defined in the pom.xml file. In questo articolo verranno accettate le impostazioni predefinite.In this article, you'll accept the defaults.

Suggerimento

Per creare un'app per le funzioni in esecuzione in Linux anziché in Windows, modificare l'elemento runtime.os nel file pom.xml da windows a linux.To create a function app running on Linux instead of Windows, change the runtime.os element in the pom.xml file from windows to linux. L'esecuzione di Linux in un piano a consumo è supportata in queste aree.Running Linux in a consumption plan is supported in these regions. Non è possibile avere nello stesso gruppo di risorse app eseguite in Linux e app eseguite in Windows.You can't have apps that run on Linux and apps that run on Windows in the same resource group.

  1. Prima della distribuzione, accedere alla sottoscrizione di Azure usando l'interfaccia della riga di comando di Azure o Azure PowerShell.Before you can deploy, sign in to your Azure subscription using either Azure CLI or Azure PowerShell.

    az login
    

    Il comando az login consente di accedere all'account Azure.The az login command signs you into your Azure account.

  2. Usare il comando seguente per distribuire il progetto in una nuova app per le funzioni.Use the following command to deploy your project to a new function app.

    mvn azure-functions:deploy
    

    In Azure verranno create le risorse seguenti:This creates the following resources in Azure:

    • Gruppo di risorse.Resource group. Il nome è java-functions-group.Named as java-functions-group.
    • Account di archiviazione.Storage account. Richiesto da Funzioni.Required by Functions. Il nome viene generato in modo casuale in base ai requisiti di denominazione degli account di archiviazione.The name is generated randomly based on Storage account name requirements.
    • Piano di hosting.Hosting plan. Hosting serverless per l'app per le funzioni nell'area westus.Serverless hosting for your function app in the westus region. Il nome è java-functions-app-service-plan.The name is java-functions-app-service-plan.
    • App per le funzioni.Function app. Un'app per le funzioni è l'unità di distribuzione ed esecuzione per le funzioni.A function app is the deployment and execution unit for your functions. Il nome viene generato in modo casuale in base al valore di artifactId, a cui viene aggiunto un numero generato in modo casuale.The name is randomly generated based on your artifactId, appended with a randomly generated number.

    La distribuzione inserisce i file di progetto in un pacchetto e li distribuisce nella nuova app per le funzioni tramite ZipDeploy.The deployment packages the project files and deploys them to the new function app using zip deployment. Il codice viene eseguito dal pacchetto di distribuzione in Azure.The code runs from the deployment package in Azure.

Richiamare la funzione in AzureInvoke the function on Azure

Poiché la funzione usa un trigger HTTP, è possibile richiamarla eseguendo una richiesta HTTP al relativo URL nel browser o con uno strumento come curl.Because your function uses an HTTP trigger, you invoke it by making an HTTP request to its URL in the browser or with a tool like curl.

Copiare l' URL di richiamo completo visualizzato nell'output del comando publish nella barra degli indirizzi di un browser, aggiungendo il parametro di query &name=Functions.Copy the complete Invoke URL shown in the output of the publish command into a browser address bar, appending the query parameter &name=Functions. Nel browser dovrebbe essere visualizzato un output simile a quello visualizzato quando è stata eseguita la funzione in locale.The browser should display similar output as when you ran the function locally.

Output della funzione eseguita in Azure in un browser

Eseguire il comando seguente per visualizzare i log in streaming quasi in tempo reale:Run the following command to view near real-time streaming logs:

func azure functionapp logstream <APP_NAME> 

In una finestra del terminale separata o nel browser chiamare di nuovo la funzione remota.In a separate terminal window or in the browser, call the remote function again. Nel terminale viene visualizzato un log dettagliato dell'esecuzione della funzione in Azure.A verbose log of the function execution in Azure is shown in the terminal.

Pulire le risorseClean up resources

Se si continua con il passaggio successivo e si aggiunge un binding di output della coda di Archiviazione di Azure, mantenere tutte le risorse esistenti per poterle riutilizzare.If you continue to the next step and add an Azure Storage queue output binding, keep all your resources in place as you'll build on what you've already done.

In caso contrario, usare il comando seguente per eliminare il gruppo di risorse e tutte le relative risorse contenute per evitare di incorrere in costi aggiuntivi.Otherwise, use the following command to delete the resource group and all its contained resources to avoid incurring further costs.

az group delete --name java-functions-group

Passaggi successiviNext steps