Dapr State-uitvoerbinding voor Azure Functions

Met de Dapr-statusuitvoerbinding kunt u een waarde opslaan in een Dapr-status tijdens het uitvoeren van een functie.

Zie het overzicht van de Dapr-extensie voor meer informatie over het instellen en configureren van de Dapr-extensie.

Opmerking

U kunt een C#-functie maken met behulp van een van de volgende C#-modi:

Uitvoeringsmodel	Beschrijving
Geïsoleerde werkrolmodel	Uw functiecode wordt uitgevoerd in een afzonderlijk .NET-werkproces. Gebruiken met ondersteunde versies van .NET en .NET Framework. Zie .NET geïsoleerde werkprocesfuncties ontwikkelen voor meer informatie.
Model in proces	Uw functiecode wordt uitgevoerd in hetzelfde proces als het Functions-hostproces. Ondersteunt alleen LTS-versies (Long Term Support) van .NET. Zie .NET-klassebibliotheekfuncties ontwikkelen voor meer informatie.

In-proces

In het volgende voorbeeld ziet u hoe u de uitvoerbinding dapr-status gebruikt om een nieuwe status in het statusarchief te behouden.

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

Geïsoleerd proces

Meer voorbeelden voor de Dapr-uitvoerstatusbinding zijn beschikbaar in de GitHub-opslagplaats.

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

In het volgende voorbeeld wordt een "CreateNewOrderHttpTrigger" functie gemaakt met behulp van de DaprStateOutput binding met een 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

In het volgende voorbeeld wordt de Uitvoerbinding dapr-status gekoppeld aan een HTTP-trigger, die is geregistreerd door het app object:

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

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en JavaScript-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprState uitvoer:

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

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

Dit is de JavaScript-code:

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

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en PowerShell-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprState uitvoer:

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

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

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

Python v2

In het volgende voorbeeld ziet u een Dapr State-uitvoerbinding, die gebruikmaakt van het v2 Python-programmeermodel. Ga als volgt te werk om deze te gebruiken daprState in de code van uw Python-functie-app:

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

In het volgende voorbeeld ziet u een Dapr State-uitvoerbinding, die gebruikmaakt van het python-programmeermodel v1.

Dit is het function.json-bestand voor daprState:

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

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

Dit is de Python-code:

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

Kenmerken

In-proces

Gebruik in het procesmodel de DaprState definitie van een Dapr-statusuitvoerbinding, die ondersteuning biedt voor deze parameters:

Parameter	Description	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
StateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
Code	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
Value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Geïsoleerd proces

Gebruik in het geïsoleerde werkrolmodel de DaprStateOutput definitie van een Dapr-statusuitvoerbinding, die ondersteuning biedt voor deze parameters:

Parameter	Description	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
StateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
Code	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
Value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Aantekeningen

Met de DaprStateOutput aantekening kunt u toegang krijgen tot een statusarchief.

Element	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Configuratie

Node.js v4

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in de code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Node.js v3

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Python v2

In de volgende tabel worden de bindingsconfiguratie-eigenschappen @dapp.dapr_state_output uitgelegd die u in uw Python-code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Python v1

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
stateStore	De naam van het statusarchief om de status op te slaan.	✔️	❌
key	De naam van de sleutel om de status op te slaan in het statusarchief.	✔️	✔️
value	Vereist. De waarde die wordt opgeslagen.	❌	✔️

Als eigenschappen zijn gedefinieerd in zowel kenmerken als RequestBody, wordt prioriteit gegeven aan gegevens die zijn opgegeven in RequestBody.

Zie de sectie Voorbeeld voor volledige voorbeelden.

Gebruik

Als u de Dapr-statusuitvoerbinding wilt gebruiken, begint u met het instellen van een Dapr-statusarchiefonderdeel. Meer informatie over welk onderdeel u moet gebruiken en hoe u dit kunt instellen in de officiële Dapr-documentatie.

• Specificaties van dapr state store-onderdelen
• Procedure: Status opslaan

Python v2

Als u het daprState project in Python v2 wilt gebruiken, stelt u uw project in met de juiste afhankelijkheden.

1. Een virtuele omgeving maken en activeren.

2. Voeg in het requirements.text bestand de volgende regel toe:

   azure-functions==1.18.0b3
   

3. Installeer de Python-bibliotheek in de terminal.

   pip install -r .\requirements.txt
   

4. Wijzig uw local.setting.json bestand met de volgende configuratie:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

Voor het Python v1-model zijn geen aanvullende wijzigingen vereist, afgezien van het instellen van het statusarchief.

Volgende stappen

Meer informatie over Statusbeheer van Dapr.