共用方式為

Azure Functions 的 Dapr State 輸出繫結

  • 發行項

Dapr State 輸出繫結可讓您在函式執行期間，將值儲存至 Dapr 狀態。

如需 Dapr 延伸模組的安裝和設定詳細資料，請參閱 Dapr 延伸模組概觀。

範例

您可以使用下列其中一種 C# 模式來建立 C# 函式：

執行模型 描述
隔離式背景工作模型 您的函數程式碼在個別的 .NET 背景工作處理序中執行。 搭配支援的 .NET 和 .NET Framework 版本使用。 若要深入了解，請參閱開發 .NET 隔離式背景工作處理序函數。
同處理序模型 您的函數程式碼執行的處理序與 Functions 主機處理序相同。 僅支援長期支援 (LTS) 的 .NET 版本。 若要深入了解，請參閱開發 .NET 類別庫函數。

下列範例示範如何使用 Dapr State 輸出繫結，將新狀態保存至狀態存放區。

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

下列範例會使用 DaprStateOutput 繫結搭配 HttpTrigger 來建立 "CreateNewOrderHttpTrigger" 函式：

@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 State 輸出繫結會與 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 };
    }
});

下列範例顯示 function.json 檔案中的 Dapr 觸發程序，以及使用這些繫結的 PowerShell 程式碼。

以下是 daprState 輸出的 function.json 檔案：

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

下列範例示範使用 v2 Python 程式設計模型的 Dapr State 輸出繫結。 若要在您的 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 State 輸出繫結，其支援下列參數：

參數 描述 可透過屬性傳送 可透過 RequestBody 傳送
StateStore 要儲存狀態的狀態存放區名稱。 ✔️ ❌
索引鍵 將狀態儲存至狀態存放區的索引鍵名稱。 ✔️ ✔️
值 必要。 要儲存的值。 ❌ ✔️

註釋

DaprStateOutput 註釋可讓您透過函式存取狀態存放區。

元素 描述 可透過屬性傳送 可透過 RequestBody 傳送
stateStore 要儲存狀態的狀態存放區名稱。 ✔️ ❌
key 將狀態儲存至狀態存放區的索引鍵名稱。 ✔️ ✔️
value 必要。 要儲存的值。 ❌ ✔️

組態

下表說明您在程式碼中設定的繫結設定屬性。

屬性 說明 可透過屬性傳送 可透過 RequestBody 傳送
stateStore 要儲存狀態的狀態存放區名稱。 ✔️ ❌
key 將狀態儲存至狀態存放區的索引鍵名稱。 ✔️ ✔️
value 必要。 要儲存的值。 ❌ ✔️

下表說明您在 function.json 檔案中設定的繫結設定屬性。

function.json 屬性 描述 可透過屬性傳送 可透過 RequestBody 傳送
stateStore 要儲存狀態的狀態存放區名稱。 ✔️ ❌
key 將狀態儲存至狀態存放區的索引鍵名稱。 ✔️ ✔️
value 必要。 要儲存的值。 ❌ ✔️

下表說明您在 Python 程式碼中設定的 @dapp.dapr_state_output 繫結組態屬性。

屬性 說明 可透過屬性傳送 可透過 RequestBody 傳送
stateStore 要儲存狀態的狀態存放區名稱。 ✔️ ❌
key 將狀態儲存至狀態存放區的索引鍵名稱。 ✔️ ✔️
value 必要。 要儲存的值。 ❌ ✔️

如果屬性在 Attributes 和 RequestBody 中都有定義，則系統會優先考量 RequestBody 中提供的資料。

如需完整範例，請參閱範例一節。

使用方式

若要使用 Dapr State 輸出繫結，請先設定 Dapr State 存放區元件。 若想深入了解要使用的元件及其設定方式，請參閱官方 Dapr 文件。

若要在 Python v2 中使用 daprState，請設定您的專案使其具備正確的相依性。

  1. 建立並啟用虛擬環境。

  2. 在 requirements.text 檔案中新增以下這一行：

    azure-functions==1.18.0b3

  3. 在終端機中，安裝 Python 程式庫。

    pip install -r .\requirements.txt

  4. 使用下列組態修改您的 local.setting.json 檔案：

    "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1

下一步

深入了解 Dapr 狀態管理。