Краткое руководство. Создание функции Java в Azure из командной строкиQuickstart: Create a Java function in Azure from the command line

В этой статье используются средства командной строки для создания функции Java, которая отвечает на HTTP-запросы.In this article, you use command-line tools to create a Java function that responds to HTTP requests. После тестирования кода в локальной среде его необходимо развернуть в бессерверной среде Функций Azure.After testing the code locally, you deploy it to the serverless environment of Azure Functions.

Выполнение этого краткого руководства предполагает небольшую дополнительную плату в несколько центов США в учетной записи Azure.Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Примечание

Если вы не хотите использовать Maven в качестве средства разработки, ознакомьтесь с аналогичными руководствами для разработчиков Java по использованию Gradle, IntelliJ IDEA и 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.

Настройка локальной средыConfigure your local environment

Перед началом работы убедитесь, что у вас есть такие компоненты.Before you begin, you must have the following:

Проверка предварительных условийPrerequisite check

  • В окне терминала или командном окне запустите func --version, чтобы убедиться, что используется версия Azure Functions Core Tools 3.x.In a terminal or command window, run func --version to check that the Azure Functions Core Tools are version 3.x.

  • Выполните команду az --version, чтобы убедиться, что используется версия Azure CLI 2.4 или более поздняя.Run az --version to check that the Azure CLI version is 2.4 or later.

  • Выполните команду az login, чтобы войти в Azure и проверить активную подписку.Run az login to sign in to Azure and verify an active subscription.

Создание локального проекта службы "Функции"Create a local function project

В Функциях Azure проект функций представляет собой контейнер для одной или нескольких отдельных функций, каждая из которых реагирует на конкретный триггер.In Azure Functions, a function project is a container for one or more individual functions that each responds to a specific trigger. Все функции в проекте совместно используют те же локальные конфигурации и конфигурации размещения.All functions in a project share the same local and hosting configurations. В этом разделе вы создадите проект функций, содержащий одну функцию.In this section, you create a function project that contains a single function.

  1. В пустой папке выполните следующую команду, чтобы создать проект функций из архетипа 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
    

    Важно!

    • Используйте -DjavaVersion=11, чтобы функции выполнялись на Java 11.Use -DjavaVersion=11 if you want your functions to run on Java 11. Дополнительные сведения см. в разделе Версии Java.To learn more, see Java versions.
    • Чтобы выполнить задания из этой статьи, переменной среды JAVA_HOME необходимо присвоить расположение установки правильной версии 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 запрашивает значения, которые позволят завершить создание проекта развертывания.Maven asks you for values needed to finish generating the project on deployment.
    Предоставьте следующие значения в ответ на соответствующие запросы:Provide the following values when prompted:

    promptPrompt ЗначениеValue ОписаниеDescription
    groupIdgroupId com.fabrikam Это значение уникально идентифицирует проект среди всех остальных. Оно должно соответствовать правилам именования пакетов для Java.A value that uniquely identifies your project across all projects, following the package naming rules for Java.
    artifactIdartifactId fabrikam-functions Это значение содержит имя JAR-файла, без номера версии.A value that is the name of the jar, without a version number.
    versionversion 1.0-SNAPSHOT Выберите значение по умолчанию.Choose the default value.
    packagepackage com.fabrikam Это значение определяет пакет Java для создаваемого кода функции.A value that is the Java package for the generated function code. Используйте значение по умолчанию.Use the default.
  3. Введите Y или нажмите клавишу ВВОД для подтверждения.Type Y or press Enter to confirm.

    Maven создаст файлы проекта в новой папке с именем artifactId, то есть fabrikam-functions в нашем примере.Maven creates the project files in a new folder with a name of artifactId, which in this example is fabrikam-functions.

  4. Перейдите в папку проекта:Navigate into the project folder:

    cd fabrikam-functions
    

    Эта папка содержит различные файлы проекта, в том числе файлы конфигурации local.settings.json и host.json.This folder contains various files for the project, including configurations files named local.settings.json and host.json. Файл local.settings.json может содержать секреты, скачанные из Azure, поэтому файл по умолчанию исключен из системы управления версиями в GITIGNORE-файле.Because local.settings.json can contain secrets downloaded from Azure, the file is excluded from source control by default in the .gitignore file.

Проверка содержимого файла (дополнительно)(Optional) Examine the file contents

При необходимости можно сразу перейти к локальному запуску функции и просмотреть содержимое файла позже.If desired, you can skip to Run the function locally and examine the file contents later.

Function.javaFunction.java

Файл Function.java содержит метод run, получающий данные запроса в переменной request. Это запрос HttpRequestMessage, дополненный заметкой HttpTrigger, которая определяет поведение триггера.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();
        }
    }
}

Сообщение-ответ создается API HttpResponseMessage.Builder.The response message is generated by the HttpResponseMessage.Builder API.

pom.xmlpom.xml

Параметры ресурсов Azure, созданных для размещения приложения, определяются в элементе конфигурации подключаемого модуля с groupId com.microsoft.azure в созданном файле pom.xml.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. Например, элемент конфигурации ниже указывает развертыванию на основе Maven, что приложение-функцию необходимо создать в группе ресурсов java-functions-group в области 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. Само приложение-функция работает в Windows, размещенном в плане java-functions-app-service-plan, который по умолчанию является бессерверным планом потребления.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>

Вы можете изменить эти параметры, чтобы управлять созданием ресурсов в Azure, например, изменив runtime.os с windows на linux перед первоначальным развертыванием.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. Полный список параметров, поддерживаемых подключаемым модулем Maven, см. в сведениях о конфигурации.For a complete list of settings supported by the Maven plug-in, see the configuration details.

FunctionTest.javaFunctionTest.java

Архетип также создает модульный тест для функции.The archetype also generates a unit test for your function. При изменении функции для добавления привязок или добавления новых функций в проект необходимо также изменить тесты в файле 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.

Локальное выполнение функцииRun the function locally

  1. Выполните функцию, запустив локальное хост-приложение среды выполнения Функций Azure из папки LocalFunctionProj:Run your function by starting the local Azure Functions runtime host from the LocalFunctionProj folder:

    mvn clean package
    mvn azure-functions:run
    

    Ближе к концу выходных данных появятся следующие строки: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
     ...
    
     

    Примечание

    Если результат HttpExample не похож на пример выше, скорее всего, вы запустили основное приложение из папки, отличной от корневой папки проекта.If HttpExample doesn't appear as shown above, you likely started the host from outside the root folder of the project. В этом случае остановите хост-приложение клавишами CTRL+C, перейдите в корневую папку проекта и снова выполните указанную выше команду.In that case, use Ctrl+C to stop the host, navigate to the project's root folder, and run the previous command again.

  2. Скопируйте URL-адрес функции HttpExample из этих выходных данных в браузер и добавьте строку запроса ?name=<YOUR_NAME>, сформировав полный URL-адрес, например 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. В браузере должно отобразиться сообщение, например Hello Functions:The browser should display a message like Hello Functions:

    Получившаяся функция выполняется локально в браузере

    Терминал, в котором вы запустили проект, также выводит данные журнала при выполнении запросов.The terminal in which you started your project also shows log output as you make requests.

  3. Когда все будет готово, нажмите клавиши Ctrl+C и выберите y, чтобы отключить хост-приложение функции.When you're done, use Ctrl+C and choose y to stop the functions host.

Развертывание проекта функций в AzureDeploy the function project to Azure

Приложение-функция и связанные ресурсы создаются в Azure при первом развертывании проекта функции.A function app and related resources are created in Azure when you first deploy your functions project. Параметры ресурсов Azure, созданных для размещения приложения, определяются в файле pom.xml.Settings for the Azure resources created to host your app are defined in the pom.xml file. В этой статье вы примете значения по умолчанию.In this article, you'll accept the defaults.

Совет

Чтобы создать приложение-функцию, работающее в Linux вместо Windows, измените элемент runtime.os в файле pom.xml с windows на 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. Работа Linux в плане потребления поддерживается в этих регионах.Running Linux in a consumption plan is supported in these regions. Приложения, работающие в Linux, и приложения, работающие под управлением ОС Windows, не могут находиться в одной группе ресурсов.You can't have apps that run on Linux and apps that run on Windows in the same resource group.

  1. Прежде чем выполнять развертывание, войдите в подписку Azure с помощью Azure CLI или Azure PowerShell.Before you can deploy, sign in to your Azure subscription using either Azure CLI or Azure PowerShell.

    az login
    

    Чтобы войти в учетную запись Azure, выполните команду az login.The az login command signs you into your Azure account.

  2. Используйте следующую команду, чтобы развернуть проект в виде нового приложения-функции.Use the following command to deploy your project to a new function app.

    mvn azure-functions:deploy
    

    Это создает в Azure такие ресурсы:This creates the following resources in Azure:

    • группа ресурсов;Resource group. С именем java-functions-group.Named as java-functions-group.
    • учетная запись хранения;Storage account. Требуется для Функций Azure.Required by Functions. Это имя создается случайным образом на основе требований к именованию учетных записей хранения.The name is generated randomly based on Storage account name requirements.
    • План размещения.Hosting plan. Бессерверное размещение для приложения-функции в регионе, который указан в параметре westus.Serverless hosting for your function app in the westus region. Имя java-functions-app-service-plan.The name is java-functions-app-service-plan.
    • Приложение-функция.Function app. Приложение-функция представляет собой минимальную единицу развертывания и выполнения для ваших функций.A function app is the deployment and execution unit for your functions. Имя создается случайным образом на основе artifactId, к которому добавляется случайное число.The name is randomly generated based on your artifactId, appended with a randomly generated number.

    Развертывание упаковывает файлы проекта и развертывает их в новом приложении-функции из ZIP-файлаThe deployment packages the project files and deploys them to the new function app using zip deployment. Код выполняется из пакета развертывания в Azure.The code runs from the deployment package in Azure.

Вызов функции в AzureInvoke the function on Azure

Функция использует триггер HTTP, поэтому ее необходимо вызывать через HTTP-запрос по URL-адресу в браузере или с помощью такого средства, как 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.

Скопируйте полный URL-адрес вызова Invoke URL , показанный в выходных данных команды publish, в адресную строку браузера, добавив параметр запроса &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. В браузере должны отображаться выходные данные, аналогичные данным при локальном запуске функции.The browser should display similar output as when you ran the function locally.

Выходные данные функции, выполняемой в Azure в браузере

Выполните следующую команду, чтобы просмотреть журналы потоковой передачи в режиме, близком к реальному времени:Run the following command to view near real-time streaming logs:

func azure functionapp logstream <APP_NAME> 

В отдельном окне терминала или в браузере снова вызовите удаленную функцию.In a separate terminal window or in the browser, call the remote function again. В окне терминала отображается подробный журнал выполнения функции в Azure.A verbose log of the function execution in Azure is shown in the terminal.

Очистка ресурсовClean up resources

Если вы намерены перейти к следующему шагу и добавить выходную привязку очереди службы хранилища Azure, можете сохранить все ресурсы, которые пригодятся на этом этапе.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.

В противном случае используйте следующую команду, чтобы удалить группу ресурсов и все содержащиеся в ней ресурсы и избежать дополнительных расходов.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

Дальнейшие действияNext steps