Powiązanie danych wejściowych języka Dapr State dla usługi Azure Functions

Warning

Rozszerzenie Dapr dla Azure Functions zostanie wycofane 20 kwietnia 2027 roku i planowane jest usunięcie z pakietów rozszerzenia tego dnia. Usunięcie dotyczy pakietu głównego rozszerzenia w wersji 4.42.0 i nowszych oraz pakietu rozszerzenia podglądowego w wersji 4.60.0 i nowszych.

To usunięcie dotyczy również wersji pakietów preinstalowanych lub cacheowanych w obrazach hostingowych Linuksa albo dystrybuowanych przez hosting Windows.

Migruj do Dapr client SDK lub API HTTP Dapr bezpośrednio z kodu funkcji i zastąp wyzwalacze Dapr funkcjami wyzwalanymi przez HTTP, które odbierają odwołania Dapr. Istniejące aplikacje mogą tymczasowo przypiąć główny pakiet lub [4.*, 4.42.0) pakiet podglądowy do [4.*, 4.60.0) .host.json Aplikacje .NET mogą nadal korzystać bezpośrednio z odpowiadających pakietów NuGet do Dapr. Ani przypinanie starszego pakietu, ani dalsze korzystanie z pakietów NuGet nie przedłuża wsparcia po 20 kwietnia 2027 roku ani nie zmienia daty usunięcia.

Powiązanie danych wejściowych stanu języka Dapr umożliwia odczytywanie stanu języka Dapr podczas wykonywania funkcji.

Aby uzyskać informacje na temat konfiguracji i szczegółów konfiguracji rozszerzenia Języka Dapr, zobacz Omówienie rozszerzenia Języka Dapr.

Example

Funkcję języka C# można utworzyć przy użyciu jednego z następujących trybów języka C#:

Model wykonania Description
Model izolowanego procesu roboczego Kod funkcji jest uruchamiany w osobnym procesie roboczym platformy .NET. Używaj z obsługiwanymi wersjami platform .NET i .NET Framework. Aby dowiedzieć się więcej, zobacz przewodnik dotyczący uruchamiania usługi Azure Functions w języku C# w izolowanym modelu procesu roboczego.
Model wewnątrzprocesowy Kod funkcji jest uruchamiany w tym samym procesie co proces hosta usługi Functions. Obsługuje tylko wersje long term support (LTS) platformy .NET. Aby dowiedzieć się więcej, zobacz Tworzenie funkcji biblioteki klas języka C# przy użyciu usługi Azure Functions.
[FunctionName("StateInputBinding")]
public static IActionResult Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", Route = "state/{key}")] HttpRequest req,
    [DaprState("statestore", Key = "{key}")] string state,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    return new OkObjectResult(state);
}

Poniższy przykład tworzy "RetrieveOrder" funkcję przy użyciu DaprStateInput powiązania z elementem DaprServiceInvocationTrigger:

@FunctionName("RetrieveOrder")
public String run(
        @DaprServiceInvocationTrigger(
            methodName = "RetrieveOrder") 
        String payload,
        @DaprStateInput(
            stateStore = "%StateStoreName%",
            key = "order")
        String product,
        final ExecutionContext context)

W poniższym przykładzie powiązanie wejściowe wywołania języka Dapr jest dodawane jako i extraInput sparowane z wyzwalaczem HTTP, który jest zarejestrowany przez app obiekt:

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

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

        const daprStateInputValue = context.extraInputs.get(daprStateInput);
        // print the fetched state value
        context.log(daprStateInputValue);

        return daprStateInputValue;
    }
});

Poniższe przykłady pokazują wyzwalacze Dapr w pliku function.json oraz kod PowerShell korzystający z tych powiązań.

Oto plik function.json dla elementu daprState:

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

Aby uzyskać więcej informacji na temat function.json właściwości pliku, zobacz sekcję Konfiguracja.

W kodzie:

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, $order
)

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

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

Write-Host "$jsonString"

W poniższym przykładzie przedstawiono powiązanie danych wejściowych języka Dapr State, które używa modelu programowania w języku Python w wersji 2. Aby użyć powiązania wraz daprState z daprServiceInvocationTrigger kodem aplikacji funkcji języka Python:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="RetrieveOrder")
@app.dapr_service_invocation_trigger(arg_name="payload", method_name="RetrieveOrder")
@app.dapr_state_input(arg_name="data", state_store="statestore", key="order")
def main(payload, data: str) :
    # Function should be invoked with this command: dapr invoke --app-id functionapp --method RetrieveOrder  --data '{}'
    logging.info('Python function processed a RetrieveOrder request from the Dapr Runtime.')
    logging.info(data)

Attributes

W modelu w trakcie procesu użyj stanu do odczytu Dapr do DaprState swojej funkcji, który obsługuje następujące parametry:

Parameter Description
StateStore Nazwa magazynu stanów do pobrania stanu.
Key Nazwa klucza do pobrania z określonego magazynu stanów.

Annotations

Adnotacja DaprStateInput umożliwia odczytywanie stanu języka Dapr do funkcji.

Element Description
stateStore Nazwa magazynu stanów Dapr.
key Wartość klucza magazynu stanów.

Configuration

W poniższej tabeli opisano właściwości konfiguracji powiązania ustawione w kodzie.

Property Description
stateStore Nazwa magazynu stanów.
key Nazwa klucza do pobrania z określonego magazynu stanów.

W poniższej tabeli opisano właściwości konfiguracji powiązania ustawione w pliku function.json.

właściwość function.json Description
key Nazwa klucza do pobrania z określonego magazynu stanów.
stateStore Nazwa magazynu stanów.

W poniższej tabeli opisano właściwości konfiguracji powiązania ustawione @dapp.dapr_state_input w kodzie języka Python.

Property Description
state_store Nazwa magazynu stanów.
key Wartość klucza tajnego. Nazwa klucza do pobrania z określonego magazynu stanów.

Zobacz sekcję Przykład, aby zapoznać się z kompletnymi przykładami.

Usage

Aby użyć powiązania wejściowego stanu dapr, rozpocznij od skonfigurowania składnika magazynu stanów Dapr. Więcej informacji na temat tego, który składnik ma być używany i jak go skonfigurować, znajdziesz w oficjalnej dokumentacji języka Dapr.

Aby użyć elementu daprState w języku Python w wersji 2, skonfiguruj projekt przy użyciu poprawnych zależności.

  1. Tworzenie i aktywowanie środowiska wirtualnego

  2. requirements.text W pliku dodaj następujący wiersz:

    azure-functions==1.18.0b3
    
  3. W terminalu zainstaluj bibliotekę języka Python.

    pip install -r .\requirements.txt
    
  4. local.setting.json Zmodyfikuj plik przy użyciu następującej konfiguracji:

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
    

Następne kroki

Dowiedz się więcej o zarządzaniu stanem dapr.