associazione di trigger Servizio SignalR per Funzioni di Azure

Usare l'associazione di trigger SignalR per rispondere ai messaggi inviati da Servizio Azure SignalR. Quando viene attivata la funzione, i messaggi passati alla funzione vengono analizzati come oggetto json.

In Servizio SignalR modalità serverless, Servizio SignalR usa la funzionalità Upstream per inviare messaggi dal client all'app per le funzioni. E l'app per le funzioni usa Servizio SignalR'associazione di trigger per gestire questi messaggi. L'architettura generale è illustrata di seguito:

Per informazioni sui dettagli di impostazione e configurazione, vedere la panoramica.

Esempio

[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']))

Per esempi completi, vedere la sezione di esempio.

Utilizzo

Payload

Il tipo di input del trigger viene dichiarato come InvocationContext o come tipo personalizzato. Se si sceglie InvocationContext, si ottiene l'accesso completo al contenuto della richiesta. Per un tipo personalizzato, il runtime cerca di analizzare il corpo della richiesta JSON per impostare le proprietà dell'oggetto.

InvocationContext

InvocationContext contiene tutto il contenuto del messaggio inviato da un servizio SignalR, che include le proprietà seguenti:

uso di ParameterNames

La proprietà ParameterNames in SignalRTrigger consente di associare argomenti di messaggi di chiamata ai parametri delle funzioni. È possibile usare il nome definito come parte delle espressioni di associazione in altre associazioni o come parametri nel codice. In questo modo è possibile accedere agli argomenti di InvocationContext.

Si supponga di avere un client JavaScript SignalR che tenta di richiamare il metodo broadcast nella funzione di Azure con due argomenti message1, message2.

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

Dopo aver impostato parameterNames, i nomi definiti corrispondono agli argomenti inviati sul lato client.

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

Contiene quindi arg1 il contenuto di message1e arg2 contiene il contenuto di message2.

ParameterNames Considerazioni

Per l'associazione di parametri, l'ordine è importante. Se si usa ParameterNames, l'ordine in ParameterNames corrisponde all'ordine degli argomenti richiamati nel client. Se si usa l'attributo [SignalRParameter] in C#, l'ordine degli argomenti nei metodi di Funzione di Azure corrisponde all'ordine degli argomenti nei client.

ParameterNamesNon è possibile usare l'attributo [SignalRParameter] e contemporaneamente oppure si otterrà un'eccezione.

integrazione di Servizio SignalR

Servizio SignalR richiede un URL per accedere all'app per le funzioni quando si usa Servizio SignalR'associazione di trigger. L'URL deve essere configurato in Impostazioni upstream sul lato Servizio SignalR.

Quando si usa Servizio SignalR trigger, l'URL può essere semplice e formattato come segue:

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

L'elemento Function_App_URL è disponibile nella pagina Panoramica dell'app per le funzioni e viene API_KEY generato dalla funzione di Azure. È possibile ottenere da API_KEY signalr_extension nel pannello Chiavi app dell'app per le funzioni.

Se si vuole usare più app per le funzioni insieme a una Servizio SignalR, upstream può supportare anche regole di routing complesse. Per altre informazioni, vedere Impostazioni Upstream.

Esempio dettagliato

È possibile seguire l'esempio in GitHub per distribuire una chat room nell'app per le funzioni con Servizio SignalR l'associazione di trigger e la funzionalità upstream: Esempio di chat room bidirezionale

Passaggi successivi

• Sviluppo e configurazione di Funzioni di Azure e con il Servizio Azure SignalR
• Esempio di associazione trigger Servizio SignalR
• Servizio SignalR esempio di associazione trigger nel processo di lavoro isolato