Bagikan melalui

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.

Example

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

Execution model Description
Model pekerja terisolasi Kode fungsi Anda berjalan dalam proses kerja .NET yang terpisah. Gunakan dengan versi .NET dan .NET Framework yang didukung. Untuk mempelajari selengkapnya, lihat Panduan untuk menjalankan C# Azure Functions dalam model pekerja yang terisolasi.
In-process model Kode fungsi Anda berjalan dalam proses yang sama dengan proses host Functions. Hanya mendukung versi Dukungan Jangka Panjang (LTS) .NET. Untuk mempelajari lebih lanjut, lihat Mengembangkan fungsi pustaka kelas C# dengan menggunakan Azure Functions.

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

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.");
}

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

The following examples show Dapr triggers in a function.json file and PowerShell code that uses those bindings.

Here's the function.json file for daprState output:

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

For more information about function.json file properties, see the Configuration section.

In code:

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"]

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'

Attributes

In the in-process model, use the DaprState to define a Dapr state output binding, which supports these parameters:

Parameter Description Dapat dikirim melalui Atribut Dapat dikirim melalui RequestBody
StateStore Nama penyimpanan status untuk menyimpan status. ✔️ ❌
Key Nama kunci untuk menyimpan status dalam penyimpanan status. ✔️ ✔️
Value Required. Nilai yang disimpan. ❌ ✔️

Annotations

Anotasi DaprStateOutput memungkinkan Anda untuk berfungsi mengakses penyimpanan status.

Element Description Dapat dikirim melalui Atribut Dapat dikirim melalui RequestBody
stateStore Nama penyimpanan status untuk menyimpan status. ✔️ ❌
key Nama kunci untuk menyimpan status dalam penyimpanan status. ✔️ ✔️
value Required. Nilai yang disimpan. ❌ ✔️

Configuration

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

Property Description Dapat dikirim melalui Atribut Dapat dikirim melalui RequestBody
stateStore Nama penyimpanan status untuk menyimpan status. ✔️ ❌
key Nama kunci untuk menyimpan status dalam penyimpanan status. ✔️ ✔️
value Required. Nilai yang disimpan. ❌ ✔️

The following table explains the binding configuration properties that you set in the function.json file.

function.json property Description Dapat dikirim melalui Atribut Dapat dikirim melalui RequestBody
stateStore Nama penyimpanan status untuk menyimpan status. ✔️ ❌
key Nama kunci untuk menyimpan status dalam penyimpanan status. ✔️ ✔️
value Required. Nilai yang disimpan. ❌ ✔️

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

Property Description Dapat dikirim melalui Atribut Dapat dikirim melalui RequestBody
stateStore Nama penyimpanan status untuk menyimpan status. ✔️ ❌
key Nama kunci untuk menyimpan status dalam penyimpanan status. ✔️ ✔️
value Required. Nilai yang disimpan. ❌ ✔️

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

See the Example section for complete examples.

Usage

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.

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

Next steps

Pelajari selengkapnya tentang manajemen status Dapr.

  • Last updated on