Mulai Cepat: Membuat fungsi Java di Azure dari baris perintah

  • Artikel

Dalam artikel ini, Anda menggunakan alat baris perintah untuk membuat fungsi Java yang merespons permintaan HTTP. Setelah menguji kode secara lokal, sebarkan kode ke lingkungan tanpa server Azure Functions.

Jika Maven bukan alat pengembangan pilihan Anda, lihat tutorial serupa kami untuk pengembang Java:

Menyelesaikan panduan mulai cepat ini dikenakan biaya kecil berupa beberapa sen USD atau kurang di akun Azure Anda.

Mengonfigurasi lingkungan lokal Anda

Sebelum memulai, Anda harus memiliki:

Instal Azure Functions Core Tools

Cara yang disarankan untuk menginstal Core Tools tergantung pada sistem operasi komputer pengembangan lokal Anda.

Langkah-langkah berikut menggunakan penginstal Windows (MSI) untuk menginstal Core Tools v4.x. Untuk informasi selengkapnya tentang penginstal berbasis paket lainnya, lihat Core Tools readme.

Unduh dan jalankan penginstal Core Tools, berdasarkan versi Windows Anda:

Jika sebelumnya Anda menggunakan penginstal Windows (MSI) untuk menginstal Core Tools di Windows, Anda harus menghapus instalan versi lama dari Tambahkan Hapus Program sebelum menginstal versi terbaru.

Membuat proyek fungsi lokal

Di Azure Functions, proyek fungsi adalah kontainer untuk satu atau beberapa fungsi individual yang masing-masing merespons pemicu tertentu. Semua fungsi dalam proyek memiliki konfigurasi lokal dan hosting yang sama. Di bagian ini, Anda membuat proyek fungsi yang berisi satu fungsi.

  1. Dalam folder kosong, jalankan perintah berikut ini untuk menghasilkan proyek Functions dari Maven archetype.

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

    Penting

    • Gunakan -DjavaVersion=11 jika Anda ingin fungsi Anda berjalan di Java 11. Untuk mempelajari lebih lanjut, lihat Versi Java.
    • Variabel lingkungan JAVA_HOME harus diatur ke lokasi penginstalan versi JDK yang benar untuk menyelesaikan artikel ini.

  2. Maven meminta nilai yang diperlukan untuk menyelesaikan pembuatan proyek pada penyebaran.
    Berikan nilai berikut saat diminta:

    Prompt Nilai Deskripsi
    groupId com.fabrikam Nilai yang secara unik mengidentifikasi proyek Anda dari semua proyek, mengikuti aturan penamaan paket untuk Java.
    artifactId fabrikam-functions Nilai yang merupakan nama jar, tanpa nomor versi.
    versi 1.0-SNAPSHOT Pilih nilai default.
    package com.fabrikam Nilai yang merupakan paket Java untuk kode fungsi yang dihasilkan. Gunakan default.

  3. Ketik Y atau tekan Enter untuk mengonfirmasi.

    Maven membuat file proyek di folder baru dengan nama artifactId, yang dalam contoh ini adalah fabrikam-functions.

  4. Navigasi ke folder proyek:

    cd fabrikam-functions

    Folder ini berisi berbagai file untuk proyek, termasuk file konfigurasi bernama local.settings.json dan host.json. Karena local.settings.json dapat berisi rahasia yang diunduh dari Azure, file dikecualikan dari kontrol sumber secara default dalam file .gitignore.

(Opsional) Memeriksa isi file

Jika diinginkan, Anda dapat melompat ke Menjalankan fungsi secara lokal dan memeriksa isi file nanti.

Function.java

Function.java berisi metode run yang menerima data permintaan dalam variabel request adalah HttpRequestMessage yang dihiasi dengan anotasi HttpTrigger, yang mendefinisikan perilaku pemicu.

package com.fabrikam;

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();
        }
    }
}

Pesan respons dibuat oleh API HttpResponseMessage.Builder.

pom.xml

Pengaturan untuk sumber daya Azure yang dibuat untuk menghosting aplikasi Anda ditentukan dalam elemen konfigurasi plugin dengan groupId dari com.microsoft.azure dalam file pom.xml yang dihasilkan. Misalnya, elemen konfigurasi di bawah ini menginstruksikan penyebaran berbasis Maven untuk membuat aplikasi fungsi di grup sumber daya java-functions-group di wilayah westus. Aplikasi fungsi itu sendiri berjalan pada Windows yang dihosting dalam paket java-functions-app-service-plan, yang secara default merupakan paket Penggunaan tanpa server.

<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>java-functions-group</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>westus</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>
        </runtime>
        <appSettings>
            <property>
                <name>FUNCTIONS_EXTENSION_VERSION</name>
                <value>~4</value>
            </property>
        </appSettings>
    </configuration>
    <executions>
        <execution>
            <id>package-functions</id>
            <goals>
                <goal>package</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Anda dapat mengubah pengaturan ini untuk mengontrol cara sumber daya dibuat di Azure, seperti dengan mengubah runtime.os dari windows ke linux sebelum penyebaran awal. Untuk daftar lengkap pengaturan yang didukung oleh plug-in Maven, lihat detail konfigurasi.

FunctionTest.java

Arketipe juga menghasilkan pengujian unit untuk fungsi Anda. Saat Anda mengubah fungsi untuk menambahkan pengikatan atau menambahkan fungsi baru ke proyek, Anda juga perlu mengubah pengujian dalam file FunctionTest.java.

Jalankan fungsi secara lokal

  1. Jalankan fungsi Anda dengan memulai host runtime Azure Functions lokal dari folder LocalFunctionProj:

    mvn clean package
mvn azure-functions:run

    Menjelang akhir output, baris berikut akan muncul:

     ...

 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
 ...

    Catatan

    Jika HttpExample tidak muncul seperti yang ditunjukkan di atas, Anda mungkin memulai hosting dari luar folder akar proyek. Dalam kasus ini, gunakan Ctrl+C untuk menghentikan hosting, navigasi ke folder akar proyek, dan jalankan perintah sebelumnya lagi.

  2. Salin URL fungsi HttpExample Anda dari output ini ke browser dan tambahkan string kueri ?name=<YOUR_NAME>, membuat URL lengkap seperti http://localhost:7071/api/HttpExample?name=Functions. Browser harus menampilkan pesan yang mengembalikan nilai string kueri Anda. Terminal tempat Anda memulai proyek juga menunjukkan output log saat Anda membuat permintaan.

  3. Jika sudah selesai, gunakan Ctrl+C dan pilih y untuk menghentikan hosting fungsi.

Menyebarkan proyek fungsi ke Azure

Aplikasi fungsi dan sumber daya terkait dibuat di Azure saat Anda pertama kali menyebarkan proyek fungsi Anda. Pengaturan untuk sumber daya Azure yang dibuat untuk menghosting aplikasi Anda ditentukan dalam file pom.xml. Dalam artikel ini, Anda akan menerima default.

Tip

Untuk membuat aplikasi fungsi yang berjalan di Linux, bukan Windows, ubah elemen runtime.os dalam file pom.xml dari windows ke linux. Menjalankan Linux dalam rencana pemakaian didukung di wilayah ini. Anda tidak dapat memiliki aplikasi yang berjalan di Linux dan aplikasi yang berjalan di Windows dalam grup sumber daya yang sama.

  1. Sebelum Anda dapat menyebarkan, masuk ke langganan Azure Anda menggunakan Azure CLI atau Azure PowerShell.

    az login

    Perintah az login memasukkan Anda ke akun Azure Anda.

  2. Gunakan perintah berikut untuk menerapkan proyek Anda ke aplikasi fungsi baru.

    mvn azure-functions:deploy

    Ini membuat sumber daya berikut di Azure:

    • Grup sumber daya. Dinamai sebagai java-functions-group.
    • Akun penyimpanan. Diperlukan oleh Functions. Nama ini dibuat secara acak berdasarkan persyaratan nama akun Azure Storage.
    • Rencana Hosting. Hosting tanpa server untuk aplikasi fungsi Anda di wilayah westus. Namanya adalah java-functions-app-service-plan.
    • Aplikasi fungsi. Aplikasi fungsi adalah unit penerapan dan eksekusi untuk fungsi Anda. Nama ini dibuat secara acak berdasarkan artifactIdAnda, ditambahkan dengan angka yang dibuat secara acak.

    Penyebaran mengemas file proyek dan menyebarkannya ke aplikasi fungsi baru menggunakan penyebaran zip. Kode berjalan dari paket penyebaran di Azure.

Penting

Akun penyimpanan digunakan untuk menyimpan data aplikasi penting, terkadang termasuk kode aplikasi itu sendiri. Anda harus membatasi akses dari aplikasi dan pengguna lain ke akun penyimpanan.

Menggunakan fungsi pada Azure

Karena fungsi Anda menggunakan pemicu HTTP, Anda memanggilnya dengan membuat permintaan HTTP ke URL-nya di browser atau dengan alat seperti curl.

Salin Panggilan URL lengkap yang ditampilkan dalam output perintah terbitkan ke bilah alamat browser, menambahkan parameter kueri ?name=Functions. Browser harus menampilkan output yang sama seperti saat Anda menjalankan fungsi secara lokal.

The output of the function run on Azure in a browser

Jalankan perintah berikut untuk melihat mendekati real-time log streaming:

func azure functionapp logstream <APP_NAME>

Di jendela terminal terpisah atau di browser, panggil lagi fungsi jarak jauh. Log verbose dari eksekusi fungsi di Azure ditampilkan di terminal.

Membersihkan sumber daya

Jika Anda melanjutkan ke langkah berikutnya dan menambahkan pengikatan output antrean Azure Storage, buat semua sumber daya Anda tetap di tempat saat Anda akan membuat apa yang telah Anda lakukan.

Jika tidak, gunakan perintah berikut untuk menghapus grup sumber daya dan semua sumber daya yang terkandung untuk menghindari timbulnya biaya lebih lanjut.

az group delete --name java-functions-group

Langkah berikutnya

Menyambungkan ke antrean Azure Storage