Выходная привязка состояния Dapr для Функции Azure
Выходная привязка состояния Dapr позволяет сохранять значение в состоянии Dapr во время выполнения функции.
Сведения о настройке и настройке расширения Dapr см. в обзоре расширения Dapr.
Пример
Функцию C# можно создать с помощью одного из следующих режимов C#:
Модель выполнения | Description |
---|---|
Изолированная рабочая модель | Код функции выполняется в отдельном рабочем процессе .NET. Используйте поддерживаемые версии .NET и платформа .NET Framework. Дополнительные сведения см. в статье "Разработка изолированных рабочих процессов .NET". |
Модель внутрипроцессного процесса | Код функции выполняется в том же процессе, что и хост-процесс Функций. Поддерживает только долгосрочные версии .NET. Дополнительные сведения см. в статье "Разработка функций библиотеки классов .NET". |
В следующем примере показано использование выходной привязки состояния Dapr для сохранения нового состояния в хранилище состояний.
[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();
}
В следующем примере создается "CreateNewOrderHttpTrigger"
функция с помощью привязки DaprStateOutput
с :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.");
}
В следующем примере выходная привязка состояния Dapr связана с триггером HTTP, зарегистрированным app
объектом:
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 };
}
});
В следующих примерах показаны триггеры Dapr в файле function.json и коде PowerShell, использующем эти привязки.
Ниже приведен файл function.json для daprState
выходных данных:
{
"bindings":
{
"type": "daprState",
"stateStore": "%StateStoreName%",
"direction": "out",
"name": "order",
"key": "order"
}
}
Дополнительные сведения о свойствах файла function.json см. в разделе "Конфигурация ".
В коде:
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"]
В следующем примере показана выходная привязка состояния Dapr, которая использует модель программирования Python версии 2. Чтобы использовать код приложения-функции Python, выполните следующие действия daprState
.
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'
Атрибуты
В модели в процессе используйте DaprState
для определения выходной привязки состояния Dapr, которая поддерживает следующие параметры:
Параметр | Описание | Можно отправлять с помощью атрибута | Может отправляться через RequestBody |
---|---|---|---|
StateStore | Имя хранилища состояний для сохранения состояния. | ✔️ | ❌ |
Ключ | Имя ключа для сохранения состояния в хранилище состояний. | ✔️ | ✔️ |
Value | Обязательный. Хранимое значение. | ❌ | ✔️ |
Заметки
Заметка DaprStateOutput
позволяет работать с хранилищем состояний.
Элемент | Description | Можно отправлять с помощью атрибута | Может отправляться через RequestBody |
---|---|---|---|
stateStore | Имя хранилища состояний для сохранения состояния. | ✔️ | ❌ |
key | Имя ключа для сохранения состояния в хранилище состояний. | ✔️ | ✔️ |
значение | Обязательный. Хранимое значение. | ❌ | ✔️ |
Настройка
В следующей таблице описываются свойства конфигурации привязки, заданные в коде.
Свойство | Description | Можно отправлять с помощью атрибута | Может отправляться через RequestBody |
---|---|---|---|
stateStore | Имя хранилища состояний для сохранения состояния. | ✔️ | ❌ |
key | Имя ключа для сохранения состояния в хранилище состояний. | ✔️ | ✔️ |
значение | Обязательный. Хранимое значение. | ❌ | ✔️ |
В следующей таблице описываются свойства конфигурации привязки, которые задаются в файле function.json.
Свойство в function.json | Description | Можно отправлять с помощью атрибута | Может отправляться через RequestBody |
---|---|---|---|
stateStore | Имя хранилища состояний для сохранения состояния. | ✔️ | ❌ |
key | Имя ключа для сохранения состояния в хранилище состояний. | ✔️ | ✔️ |
значение | Обязательный. Хранимое значение. | ❌ | ✔️ |
В следующей таблице описываются свойства конфигурации привязки, заданные @dapp.dapr_state_output
в коде Python.
Свойство | Description | Можно отправлять с помощью атрибута | Может отправляться через RequestBody |
---|---|---|---|
stateStore | Имя хранилища состояний для сохранения состояния. | ✔️ | ❌ |
key | Имя ключа для сохранения состояния в хранилище состояний. | ✔️ | ✔️ |
значение | Обязательный. Хранимое значение. | ❌ | ✔️ |
Если свойства определены как в атрибутах, так и RequestBody
приоритет присваивается данным, предоставленным в RequestBody
.
Подробные примеры см. в разделе Примеры.
Использование
Чтобы использовать выходную привязку состояния Dapr, начните с настройки компонента хранилища состояний Dapr. Дополнительные сведения о том, какой компонент следует использовать и как настроить его в официальной документации dapr.
Чтобы использовать daprState
Python версии 2, настройте проект с правильными зависимостями.
requirements.text
В файле добавьте следующую строку:azure-functions==1.18.0b3
В терминале установите библиотеку Python.
pip install -r .\requirements.txt
Измените
local.setting.json
файл со следующей конфигурацией:"PYTHON_ISOLATE_WORKER_DEPENDENCIES":1