SignalR Service-Auslöserbindung für Azure Functions

Verwenden Sie die SignalR-Auslöserbindung, um auf Nachrichten zu antworten, die von Azure SignalR Service gesendet werden. Beim Auslösen der Funktion werden die an die Funktion übergebenen Nachrichten als JSON-Objekt analysiert.

Im serverlosen Modus des SignalR Service verwendet SignalR Service das Feature Upstream, um Nachrichten vom Client an die Funktions-App zu senden. Und die Funktions-App verwendet die SignalR Service-Triggerbindung, um diese Nachrichten zu verarbeiten. Die allgemeine Architektur wird unten dargestellt:

Informationen zu Setup- und Konfigurationsdetails finden Sie in der Übersicht.

Beispiel

[Function(nameof(OnClientMessage))]
public static void OnClientMessage(
    [SignalRTrigger("Hub", "messages", "sendMessage", "content", ConnectionStringSetting = "SignalRConnection")]
        SignalRInvocationContext invocationContext, string content, FunctionContext functionContext)
{
    var logger = functionContext.GetLogger(nameof(OnClientMessage));
    logger.LogInformation("Connection {connectionId} sent a message. Message content: {content}", invocationContext.ConnectionId, content);
}

public class HubName1 : ServerlessHub
{
    [FunctionName("SignalRTest")]
    public Task SendMessage([SignalRTrigger]InvocationContext invocationContext, string message, ILogger logger)
    {
        logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
    }
}

[FunctionName("SignalRTest")]
public static Task Run([SignalRTrigger("SignalRTest", "messages", "SendMessage", parameterNames: new string[] {"message"})]InvocationContext invocationContext, string message, ILogger logger)
{
    logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
}

[FunctionName("SignalRTest")]
public static Task Run([SignalRTrigger("SignalRTest", "messages", "SendMessage")]InvocationContext invocationContext, [SignalRParameter]string message, ILogger logger)
{
    logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
}

{
    "type": "signalRTrigger",
    "name": "invocation",
    "hubName": "hubName1",
    "category": "messages",
    "event": "SendMessage",
    "parameterNames": [
        "message"
    ],
    "direction": "in"
}

app.generic("function1",
    {
        trigger: { "type": "signalRTrigger", "name": "invocation", "direction": "in", "hubName": "hubName1", "event": "SendMessage", "category": "messages" },
        handler: (triggerInput, context) => {
            context.log(`Receive ${context.Arguments[0]} from ${triggerInput.ConnectionId}.`)
        }
    })

{
    "type": "signalRTrigger",
    "name": "invocation",
    "hubName": "hubName1",
    "category": "messages",
    "event": "SendMessage",
    "parameterNames": [
        "message"
    ],
    "direction": "in"
}

module.exports = function (context, invocation) {
    context.log(`Receive ${context.bindingData.message} from ${invocation.ConnectionId}.`)
};

import logging
import json
import azure.functions as func

def main(invocation) -> None:
    invocation_json = json.loads(invocation)
    logging.info("Receive {0} from {1}".format(invocation_json['Arguments'][0], invocation_json['ConnectionId']))

Vollständige Beispiele finden Sie im Abschnitt „Beispiele“.

Verwendung

Payloads

Der Triggereingabetyp wird entweder als InvocationContext oder als benutzerdefinierter Typ deklariert. Wenn Sie dies auswählen InvocationContext, erhalten Sie vollzugriff auf den Anforderungsinhalt. Bei einem benutzerdefinierten Typ versucht die Laufzeit, den JSON-Anforderungstext zu analysieren, um die Objekteigenschaften festzulegen.

InvocationContext

InvocationContext enthält den gesamten Inhalt der Nachricht, die von einem SignalR-Dienst gesendet wird – einschließlich folgender Eigenschaften:

Verwenden von ParameterNames

Mit der Eigenschaft ParameterNames in SignalRTrigger können Argumente von Aufrufnachrichten an die Parameter von Funktionen gebunden werden. Der von Ihnen definierte Name kann als Teil der Bindungsausdrücke in anderen Bindungen oder als Parameter im Code verwendet werden. Dadurch erhalten Sie einen bequemeren Zugriff auf die Argumente von InvocationContext.

Angenommen, Sie haben einen JavaScript-SignalR-Client, der versucht, die Methode broadcast in Azure Functions mit zwei Argumenten (message1, message2) aufzurufen.

await connection.invoke("broadcast", message1, message2);

Nachdem Sie parameterNames festgelegt haben, entsprechen die von Ihnen definierte Name den Argumenten, die auf der Clientseite gesendet werden.

[SignalRTrigger(parameterNames: new string[] {"arg1, arg2"})]

Enthält dann arg1 den Inhalt von message1, und arg2 enthält den Inhalt von message2.

Überlegungen im Zusammenhang mit ParameterNames

Für die Parameterbindung ist die Reihenfolge wichtig. Wenn Sie ParameterNames verwenden, entspricht die Reihenfolge in ParameterNames der Reihenfolge der Argumente, die Sie im Client aufrufen. Wenn Sie das Attribut [SignalRParameter] in C# verwenden, entspricht die Reihenfolge der Argumente in Azure Functions-Methoden der Reihenfolge der Argumente in Clients.

ParameterNames und das Attribut [SignalRParameter] kann nicht gleichzeitig verwendet werden, oder Sie erhalten eine Ausnahme.

SignalR Service-Integration

Der signalr-Dienst benötigt eine URL für den Zugriff auf die Funktions-App, wenn Sie die SignalR Service-Triggerbindung verwenden. Die URL sollte in Upstreameinstellungen auf der SignalR Service-Seite konfiguriert werden.

Bei Verwendung des SignalR-Diensttriggers kann die URL wie folgt einfach und formatiert werden:

<Function_App_URL>/runtime/webhooks/signalr?code=<API_KEY>

Die Function_App_URL Finden Sie auf der Seite "Übersicht" der Funktions-App, und die API_KEY wird von Azure Function generiert. Sie können den API_KEY von signalr_extension auf dem Blatt API_KEY der Funktions-App abrufen.

Wenn Sie mehrere Funktions-Apps in Verbindung mit einem SignalR Service verwenden möchten, kann der Upstream auch komplexe Routingregeln unterstützen. Weitere Informationen finden Sie unter Upstreameinstellungen.

Beispiel mit allen Einzelschritten

Sie können das Beispiel in GitHub befolgen, um einen Chatraum für die Funktions-App mit der SignalR Service-Triggerbindung und der Upstreamfunktion bereitzustellen: Beispiel für bidirektionalen Chatraum

Nächste Schritte

• Azure Functions-Entwicklung und -Konfiguration mit Azure SignalR Service
• Beispiel einer SignalR Service-Auslöserbindung
• Beispiel für eine SignalR Service-Triggerbindung im isolierten Workerprozess