Pengikatan output Status Dapr untuk Azure Functions

Pengikatan output status Dapr memungkinkan Anda menyimpan nilai ke status Dapr selama eksekusi fungsi.

Untuk informasi tentang penyiapan dan detail konfigurasi ekstensi Dapr, lihat gambaran umum ekstensi Dapr.

Contoh

Fungsi C# dapat dibuat menggunakan salah satu mode C# berikut:

Model eksekusi	Deskripsi
Model pekerja terisolasi	Kode fungsi Anda berjalan dalam proses pekerja .NET terpisah. Gunakan dengan versi .NET dan .NET Framework yang didukung. Untuk mempelajari lebih lanjut, lihat Mengembangkan fungsi proses pekerja terisolasi .NET.
Model dalam proses	Kode fungsi Anda berjalan dalam proses yang sama dengan proses host Azure Functions. Hanya mendukung versi Dukungan Jangka Panjang (LTS) .NET. Untuk mempelajari lebih lanjut, lihat Mengembangkan fungsi pustaka kelas .NET.

Sedang dalam proses

Contoh berikut menunjukkan penggunaan pengikatan output status Dapr untuk mempertahankan status baru ke penyimpanan status.

[FunctionName("StateOutputBinding")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] IAsyncCollector<string> state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
    await state.AddAsync(requestBody);

    return new OkResult();
}

Proses terisolasi

Sampel lainnya untuk pengikatan status output Dapr tersedia di repositori GitHub.

[Function("StateOutputBinding")]
[DaprStateOutput("statestore", Key = "{key}")]
public static string Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "state/{key}")] HttpRequestData req,
    FunctionContext functionContext)
{
    var log = functionContext.GetLogger("StateOutputBinding");
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = new StreamReader(req.Body).ReadToEnd();

    return requestBody;
}

Contoh berikut membuat "CreateNewOrderHttpTrigger" fungsi menggunakan pengikatan DaprStateOutput dengan HttpTrigger:

@FunctionName("CreateNewOrderHttpTrigger")
public String run(
        @HttpTrigger(
            name = "req",
            methods = {HttpMethod.POST},
            authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
        @DaprStateOutput(
            stateStore = "%StateStoreName%",
            key = "product")
        OutputBinding<String> product,
        final ExecutionContext context) {
    context.getLogger().info("Java HTTP trigger (CreateNewOrderHttpTrigger) processed a request.");
}

Node.js v4

Dalam contoh berikut, pengikatan output status Dapr dipasangkan dengan pemicu HTTP, yang didaftarkan oleh app objek:

const { app, trigger } = require('@azure/functions');

app.generic('StateOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "state/{key}",
        name: "req"
    }),
    return: daprStateOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");

        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { value : payload };
    }
});

Node.js v3

Contoh berikut menunjukkan pemicu Dapr dalam file function.json dan kode JavaScript yang menggunakan pengikatan tersebut.

Berikut adalah file function.json untuk daprState output:

{
  "bindings": 
    {
      "type": "daprState",
      "direction": "out",
      "name": "dapr",
      "stateStore": "statestore",
      "key": "{key}",
      "daprAddress": "%daprAddress%"
    }
}

Untuk informasi selengkapnya tentang properti file function.json , lihat bagian Konfigurasi .

Berikut kode JavaScript:

module.exports = async function (context, req) {
    context.log('JavaScript HTTP trigger function processed a request.');

    context.bindings.dapr = {
        // stateStore: 'statestore-if-not-in-function.json'
        // key: 'key-if-not-in-function.json'
        value: req.body
    };
};

Contoh berikut menunjukkan pemicu Dapr dalam file function.json dan kode PowerShell yang menggunakan pengikatan tersebut.

Berikut adalah file function.json untuk daprState output:

{
  "bindings": 
    {
      "type": "daprState",
      "stateStore": "%StateStoreName%",
      "direction": "out",
      "name": "order",
      "key": "order"
    }
}

Untuk informasi selengkapnya tentang properti file function.json , lihat bagian Konfigurasi .

Dalam kode:

using namespace System
using namespace Microsoft.Azure.WebJobs
using namespace Microsoft.Extensions.Logging
using namespace Microsoft.Azure.WebJobs.Extensions.Dapr
using namespace Newtonsoft.Json.Linq

param (
    $payload
)

# C# function processed a CreateNewOrder request from the Dapr Runtime.
Write-Host "PowerShell function processed a CreateNewOrder request from the Dapr Runtime."

# Payload must be of the format { "data": { "value": "some value" } }

# Convert the object to a JSON-formatted string with ConvertTo-Json
$jsonString = $payload| ConvertTo-Json

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name order -Value $payload["data"]

Python v2

Contoh berikut menunjukkan pengikatan output Status Dapr, yang menggunakan model pemrograman Python v2. Untuk digunakan daprState dalam kode aplikasi fungsi Python Anda:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerFunc")
@app.route(route="req", auth_level=dapp.auth_level.ANONYMOUS)
@app.dapr_state_output(arg_name="state", state_store="statestore", key="newOrder")
def main(req: func.HttpRequest, state: func.Out[str] ) -> str:
    # request body must be passed this way '{\"value\": { \"key\": \"some value\" } }'
    body = req.get_body()
    if body is not None:
        state.set(body.decode('utf-8'))
        logging.info(body.decode('utf-8'))
    else:
        logging.info('req body is none')
    return 'ok'

Python v1

Contoh berikut menunjukkan pengikatan output Status Dapr, yang menggunakan model pemrograman Python v1.

Berikut adalah file function.json untuk daprState:

{
  "scriptFile": "__init__.py",
  "bindings": 
    {
      "type": "daprState",
      "stateStore": "%StateStoreName%",
      "direction": "out",
      "name": "order",
      "key": "order"
    }
}

Untuk informasi selengkapnya tentang properti file function.json , lihat bagian Konfigurasi .

Berikut adalah kode Python:

import logging
import json
import azure.functions as func

def main(payload,
         order: func.Out[str]) -> None:
    logging.info('Python function processed a CreateNewOrder request from the Dapr Runtime.')  
    payload_json = json.loads(payload)
    logging.info(payload_json["data"])
    order.set(json.dumps(payload_json["data"]))

Atribut

Sedang dalam proses

Dalam model dalam proses, gunakan DaprState untuk menentukan pengikatan output status Dapr, yang mendukung parameter ini:

Parameter	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
StateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
Kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
Nilai	Harus diisi. Nilai yang disimpan.	❌	✔️

Proses terisolasi

Dalam model pekerja yang terisolasi, gunakan DaprStateOutput untuk menentukan pengikatan output status Dapr, yang mendukung parameter ini:

Parameter	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
StateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
Kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
Nilai	Harus diisi. Nilai yang disimpan.	❌	✔️

Anotasi

Anotasi DaprStateOutput memungkinkan Anda untuk berfungsi mengakses penyimpanan status.

Elemen	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Konfigurasi

Node.js v4

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda tetapkan dalam kode.

Properti	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Node.js v3

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda atur di file function.json.

Properti function.json	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda atur di file function.json.

Properti function.json	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Python v2

Tabel berikut menjelaskan properti konfigurasi pengikatan untuk @dapp.dapr_state_output yang Anda tetapkan dalam kode Python Anda.

Properti	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Python v1

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda atur di file function.json.

Properti function.json	Deskripsi	Dapat dikirim melalui Atribut	Dapat dikirim melalui RequestBody
stateStore	Nama penyimpanan status untuk menyimpan status.	✔️	❌
kunci	Nama kunci untuk menyimpan status dalam penyimpanan status.	✔️	✔️
value	Harus diisi. Nilai yang disimpan.	❌	✔️

Jika properti didefinisikan dalam Atribut dan RequestBody, prioritas diberikan ke data yang disediakan dalam RequestBody.

Lihat Bagian contoh untuk contoh lengkapnya.

Penggunaan

Untuk menggunakan pengikatan output status Dapr, mulailah dengan menyiapkan komponen penyimpanan status Dapr. Anda dapat mempelajari selengkapnya tentang komponen mana yang akan digunakan dan cara menyiapkannya dalam dokumentasi Resmi Dapr.

• Spesifikasi komponen penyimpanan status Dapr
• Cara: Menyimpan status

Python v2

Untuk menggunakan daprState di Python v2, siapkan proyek Anda dengan dependensi yang benar.

1. Membuat dan mengaktifkan lingkungan virtual.

2. Di file Anda requirements.text , tambahkan baris berikut:

   azure-functions==1.18.0b3
   

3. Di terminal, instal pustaka Python.

   pip install -r .\requirements.txt
   

4. Ubah file Anda local.setting.json dengan konfigurasi berikut:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

Model Python v1 tidak memerlukan perubahan tambahan, selain menyiapkan penyimpanan status.

Langkah berikutnya

Pelajari selengkapnya tentang manajemen status Dapr.