Azure İşlevi tetikleyicisini ve bağlamayı Socket.IO (Önizleme)

Bu makalede, Azure İşlevleri ile sunucusuz tümleştirme Socket.IO nasıl kullanılacağı açıklanmaktadır.

Eylem	Bağlama Türü
URL ve erişim belirteci de dahil olmak üzere istemci anlaşma sonucunu alma	Giriş bağlaması
Hizmetten gelen iletiler tarafından tetiklenen	Tetikleyici bağlaması
İleti göndermek veya istemcileri yönetmek için hizmeti çağırma	Çıkış bağlaması

Kaynak kodu | Paket | API'si başvuru belgeleri | Ürün belgeleri Örnekleri |

Önemli

Azure İşlev bağlamaları yalnızca Sunucusuz Modda Socket.IO için Web PubSub ile tümleşebilir.

Kimlik Doğrulaması ve Bağlantı Dizesi

Uzantının Socket.IO için Web PubSub ile çalışmasına izin vermek için, hizmette kimlik doğrulaması yapmak için erişim anahtarları veya kimlik tabanlı yapılandırma sağlamanız gerekir.

Erişim anahtarı tabanlı yapılandırma

Yapılandırma Adı	Açıklama
WebPubSubForSocketIOConnectionString	Gerekli. Hizmete yönelik anahtar tabanlı bağlantı dizesi

bağlantı dizesi, Azure portalında Socket.IO için Web PubSub'nizin Anahtarlar dikey penceresinde bulabilirsiniz.

Yerel geliştirme için dosyasını kullanarak bağlantı dizesi depolayınlocal.settings.json. Önceki adımdan kopyalanan bağlantı dizesi ayarlayınWebPubSubForSocketIOConnectionString:

{
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    `WebPubSubForSocketIOConnectionString`: "Endpoint=https://<webpubsub-name>.webpubsub.azure.com;AccessKey=<access-key>;Version=1.0;"
  }
}

Dağıtıldığında, bağlantı dizesi ayarlamak için uygulama ayarlarını kullanın.

Kimlik tabanlı yapılandırma

Yapılandırma Adı	Açıklama
WebPubSubForSocketIOConnectionString__endpoint	Gerekli. Hizmetin Uç Noktası. Örneğin https://mysocketio.webpubsub.azure.com
WebPubSubForSocketIOConnectionString__credential	Bağlantı için bir belirtecin nasıl alınması gerektiğini tanımlar. Dağıtılan Azure İşleviniz yönetilen kimlik kimlik doğrulamasını kullanmayı planlıyorsa bu ayar olarak ayarlanmalıdır managedidentity . Bu değer yalnızca barındırma ortamında yönetilen kimlik kullanılabilir olduğunda geçerlidir.
WebPubSubForSocketIOConnectionString__clientId	credential olarak ayarlandığındamanagedidentity, bu özellik belirteç alınırken kullanılacak kullanıcı tarafından atanan kimliği belirtmek üzere ayarlanabilir. özelliği, uygulamaya atanan kullanıcı tarafından atanan kimliğe karşılık gelen bir istemci kimliğini kabul eder. Belirtilmezse, sistem tarafından atanan kimlik kullanılır.

İşlev bağlaması, kimlik tabanlı yapılandırma için ortak özellikleri izler. Daha fazla bağımsız özellik için bkz . Kimlik tabanlı bağlantılar için ortak özellikler.

Yerel geliştirme için dosyasını kullanarak bağlantı dizesi depolayınlocal.settings.json. Önceki adımdan kopyalanan bağlantı dizesi ayarlayınWebPubSubForSocketIOConnectionString:

{
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "WebPubSubForSocketIOConnectionString__endpoint": "https://<webpubsub-name>.webpubsub.azure.com",
    "WebPubSubForSocketIOConnectionString__tenant": "<tenant id you're in>",
  }
}

Kimlik tabanlı yapılandırmayı kullanmak ve çevrimiçi çalışmak istiyorsanız, AzureWebJobsStorage kimlikle konak depolamaya bağlanma bölümüne bakın.

Giriş Bağlaması

Socket.IO Giriş bağlaması, istemci anlaşması isteğine bir SocketIONegotiationResult oluşturur. bir Socket.IO istemcisi hizmete bağlanmaya çalıştığında, kimlik doğrulaması için , pathve'yi access token bilmesi endpointgerekir. Bu verileri oluşturmak için bir sunucuya sahip olmak yaygın bir uygulamadır ve buna anlaşma adı verilir.

C#

[FunctionName("SocketIONegotiate")]
public static IActionResult Negotiate(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get")] HttpRequest req,
    [SocketIONegotiation(Hub = "hub", UserId = "userId")] SocketIONegotiationResult result)
{
    return new OkObjectResult(result);
}

Öznitelik

Giriş bağlama özniteliğidir [SocketIONegotiation].

Öznitelik özelliği	Açıklama
Hub	İstemcinin bağlanması gereken hub adı.
Connection	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).
Kullanıcı Kimliği	Bağlantının userId değeri. Bağlantıdaki tüm yuvalar için geçerlidir. Oluşturulan belirteçteki sub talep olur.

JavaScript Modeli v4

import { app, HttpRequest, HttpResponseInit, InvocationContext, input, } from "@azure/functions";

const socketIONegotiate = input.generic({
    type: 'socketionegotiation',
    direction: 'in',
    name: 'result',
    hub: 'hub',
});

export async function negotiate(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
    let result = context.extraInputs.get(socketIONegotiate);
    return { jsonBody: result };
};

// Negotiation
app.http('negotiate', {
    methods: ['GET'],
    authLevel: 'anonymous',
    extraInputs: [socketIONegotiate],
    handler: negotiate
});

Yapılandırma

Özellik	Açıklama
Tür	Olmalıdır socketionegotiation
yön	Olmalıdır in
Adı	Giriş bağlantısı bağlama nesnesi için işlev kodunda kullanılan değişken adı
göbek	İstemcinin bağlanması gereken hub adı.
bağlantı	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).
userId	Bağlantının userId değeri. Bağlantıdaki tüm yuvalar için geçerlidir. Oluşturulan belirteçteki sub talep olur.

Python Modeli v2

bir işlevin her zaman bir tetikleyici bağlaması gerekir. Kodlarda örnek olarak HttpTrigger kullanıyoruz.

import azure.functions as func
app = func.FunctionApp()

@app.function_name(name="negotiate")
@app.route(auth_level=func.AuthLevel.ANONYMOUS)
@app.generic_input_binding(arg_name="negotiate", type="socketionegotiation", hub="hub")
def negotiate(req: func.HttpRequest, negotiate) -> func.HttpResponse:
    return func.HttpResponse(negotiate)

Annotation

Özellik	Açıklama
arg_name	Giriş bağlamasını temsil eden işlevdeki bağımsız değişkenin değişken adı.
Tür	Olmalıdır socketionegotiation
göbek	İstemcinin bağlanması gereken hub adı.
bağlantı	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).
userId	Bağlantının userId değeri. Bağlantıdaki tüm yuvalar için geçerlidir. Oluşturulan belirteçteki sub talep olur.

Tetikleyici Bağlaması

Azure İşlevi, Socket.IO için Web PubSub'dan olayları işlemek üzere bir işlevi tetikleyen tetikleyici bağlamasını kullanır.

Tetikleyici bağlaması, Azure İşlevi uç noktasını izleyen belirli bir yolu kullanıma sunar. URL, hizmetin URL Şablonu olarak ayarlanmalıdır (Portal: ayarlar -> olay işleyicisi -> URL Şablonu). Uç nokta düzeninde, güvenlik nedeniyle Azure İşlev Uygulaması'nı kullanırken sorgu bölümü code=<API_KEY> GEREKLİ olur. Anahtar Azure portalında bulunabilir. İşlev uygulaması kaynağınızı bulun ve işlev uygulamasını Azure'a dağıttığınızda İşlevler ->Uygulama anahtarları ->Sistem anahtarları ->socketio_extension gidin. Ancak, yerel işlevlerle çalışırken bu anahtar gerekli değildir.

<Function_App_Endpoint>/runtime/webhooks/socketio?code=<API_KEY>

C#

Yuva bağlantısı olayı için işlev tetikleyicileri.

[FunctionName("SocketIOTriggerConnect")]
public static async Task<SocketIOEventHandlerResponse> Connect(
    [SocketIOTrigger("hub", "connect")] SocketIOConnectRequest request)
{
    return new SocketIOConnectResponse();
}

Yuvaya bağlı olay için işlev tetikleyicileri.

[FunctionName("SocketIOTriggerConnected")]
public static async Task Connected(
    [SocketIOTrigger("hub", "connected")] SocketIOConnectedRequest request)
{
}

Yuva bağlantısı kesme olayı için işlev tetikleyicileri.

[FunctionName("SocketIOTriggerDisconnected")]
public static async Task Disconnected(
    [SocketIOTrigger("hub", "disconnected")] SocketIODisconnectedRequest request)
{
}

İstemcilerden normal iletiler için işlev tetikleyicileri.

[FunctionName("SocketIOTriggerMessage")]
public static async Task NewMessage(
    [SocketIOTrigger("hub", "new message")] SocketIOMessageRequest request,
    [SocketIOParameter] string arg)
{
}

Özellikler

Tetikleyici bağlama özniteliğidir [SocketIOTrigger].

Öznitelik özelliği	Açıklama
Hub	İstemcinin bağlanması gereken hub adı.
Ad Alanı	Yuvanın ad alanı. Varsayılan: "/"
EventName	İşlevin tetiklediğini olay adı. Bazı olay adları önceden tanımlanmıştır: connect yuva bağlantısı olayı için. connected yuvaya bağlı olay için. disconnected yuva bağlantısı kesilmiş olay için. Ayrıca diğer olaylar kullanıcı tarafından tanımlanır ve istemci tarafından gönderilen olay adıyla eşleşmesi gerekir.
ParameterNames	Olayın parametre adı listesi. Listenin uzunluğu istemciden gönderilen olayla tutarlı olmalıdır. Ad, Bağlama ifadelerini kullanır ve aynı ad işlev parametresine göre erişim sağlar.

Veri Bağlama

[SocketIOTrigger] bazı değişkenleri bağlama verilerine bağlar. Bağlama ifade desenlerinden Azure İşlevleri hakkında daha fazla bilgi edinebilirsiniz

SocketIOAttribute

SocketIOAttribute , işlev tanımını basitleştiren bir alternatiftir ParameterNames. Örneğin, aşağıdaki iki tanım aynı etkiye sahiptir:

[FunctionName("SocketIOTriggerMessage")]
public static async Task NewMessage(
    [SocketIOTrigger("hub", "new message")] SocketIOMessageRequest request,
    [SocketIOParameter] string arg)
{
}

[FunctionName("SocketIOTriggerMessage")]
public static async Task NewMessage(
    [SocketIOTrigger("hub", "new message", ParameterNames = new[] {"arg"})] SocketIOMessageRequest request,
    string arg)
{
}

ve [SocketIOParameter] değerlerinin ParameterNames birlikte kullanılamadığını unutmayın.

JavaScript Modeli v4

Yuva bağlantısı olayı için işlev tetikleyicileri.

import { app, InvocationContext, input, trigger } from "@azure/functions";


export async function connect(request: any, context: InvocationContext): Promise<any> {
    return {};
}

// Trigger for connect
app.generic('connect', {
  trigger: trigger.generic({
    type: 'socketiotrigger',
    hub: 'hub',
    eventName: 'connect'
  }),
  handler: connect
});

Yuvaya bağlı olay için işlev tetikleyicileri.

import { app, InvocationContext, trigger } from "@azure/functions";

export async function connected(request: any, context: InvocationContext): Promise<void> {
}

// Trigger for connected
app.generic('connected', {
    trigger: trigger.generic({
        type: 'socketiotrigger',
        hub: 'hub',
        eventName: 'connected'
    }),
    handler: connected
});

Yuva bağlantısı kesilmiş olay için işlev tetikleyicileri.

import { app, InvocationContext, trigger } from "@azure/functions";

export async function disconnected(request: any, context: InvocationContext): Promise<void> {
}

// Trigger for connected
app.generic('disconnected', {
    trigger: trigger.generic({
        type: 'socketiotrigger',
        hub: 'hub',
        eventName: 'disconnected'
    }),
    handler: disconnected
});

İstemcilerden normal iletiler için işlev tetikleyicileri.

import { app, InvocationContext, trigger, output } from "@azure/functions";

export async function newMessage(request: any, context: InvocationContext): Promise<void> {
}

// Trigger for new message
app.generic('newMessage', {
    trigger: trigger.generic({
        type: 'socketiotrigger',
        hub: 'hub',
        eventName: 'new message'
    }),
    handler: newMessage
});

Yapılandırma

Özellik	Açıklama
Tür	Olmalıdır socketiotrigger
göbek	İstemcinin bağlanması gereken hub adı.
ad alanı	Yuvanın ad alanı. Varsayılan: "/"
eventName	İşlevin tetiklediğini olay adı. Bazı olay adları önceden tanımlanmıştır: connect yuva bağlantısı olayı için. connected yuvaya bağlı olay için. disconnected yuva bağlantısı kesilmiş olay için. Ayrıca diğer olaylar kullanıcı tarafından tanımlanır ve istemci tarafından gönderilen olay adıyla eşleşmesi gerekir.
ParameterNames	Olayın parametre adı listesi. Listenin uzunluğu istemciden gönderilen olayla tutarlı olmalıdır. Ve adı Bağlama ifadelerini kullanır ve tarafından context.bindings.<name>erişim sağlar.

Python Modeli v2

Yuva bağlantısı olayı için işlev tetikleyicileri.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json
app = func.FunctionApp()

@app.generic_trigger(arg_name="sio", type="socketiotrigger", data_type=DataType.STRING, hub="hub", eventName="connect")
def connect(sio: str) -> str:
    return json.dumps({'statusCode': 200})

Yuvaya bağlı olay için işlev tetikleyicileri.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json
app = func.FunctionApp()

@app.generic_trigger(arg_name="sio", type="socketiotrigger", data_type=DataType.STRING, hub="hub", eventName="connected")
def connected(sio: str) -> None:
    print("connected")

Yuva bağlantısı kesilmiş olay için işlev tetikleyicileri.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json
app = func.FunctionApp()

@app.generic_trigger(arg_name="sio", type="socketiotrigger", data_type=DataType.STRING, hub="hub", eventName="disconnected")
def connected(sio: str) -> None:
    print("disconnected")

İstemcilerden normal iletiler için işlev tetikleyicileri.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json
app = func.FunctionApp()

@app.generic_trigger(arg_name="sio", type="socketiotrigger", data_type=DataType.STRING, hub="hub", eventName="chat")
def chat(sio: str) -> None:
    # do something else

Geri çağırma ile normal iletiler için işlev tetikleyicisi.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json
app = func.FunctionApp()

@app.generic_trigger(arg_name="sio", type="socketiotrigger", data_type=DataType.STRING, hub="hub", eventName="chat")
def chat(sio: str) -> str:
    return json.dumps({'ack': ["param1"]})

Annotation

Özellik	Açıklama
arg_name	Tetikleyici bağlamasını temsil eden işlevdeki bağımsız değişkenin değişken adı.
Tür	Olmalıdır socketiotrigger
göbek	İstemcinin bağlanması gereken hub adı.
data_type	Olmalıdır DataType.STRING
ad alanı	Yuvanın ad alanı. Varsayılan: "/"
eventName	İşlevin tetiklediğini olay adı. Bazı olay adları önceden tanımlanmıştır: connect yuva bağlantısı olayı için. connected yuvaya bağlı olay için. disconnected yuva bağlantısı kesilmiş olay için. Ayrıca diğer olaylar kullanıcı tarafından tanımlanır ve istemci tarafından gönderilen olay adıyla eşleşmesi gerekir.

Giriş Bağlama İsteği

Giriş bağlama bağımsız değişkenlerinin veri yapısı ileti türüne bağlı olarak değişir.

Bağlan

{
    "namespace": "",
    "socketId": "",
    "claims": {
        "<claim-type>": [ "<claim-value>" ]
    },
    "query": {
        "<query-key>": [ "<query-value>" ]
    },
    "headers":{
        "<header-name>": [ "<header-value>" ]
    },
    "clientCertificates":{
        {
            "thumbprint": "",
            "content": ""
        }
    }
}

Özellik	Açıklama
ad alanı	Yuvanın ad alanı.
socketId	Yuvanın benzersiz kimliği.
talepler	İstemci bağlantısının JWT talebi. Hizmet işlevi istediğinde JWT değil, Engine.IO istemcisi hizmete bağlandığında JWT olduğunu unutmayın.
query	İstemci bağlantısının sorgusu. Hizmet işlevi istediğinde sorgu değil, Engine.IO istemcisi hizmete bağlandığında sorgu olduğunu unutmayın.
üst bilgiler	İstemci bağlantısının üst bilgileri. Hizmet işlevi istediğinde üst bilgiler değil, Engine.IO istemcisi hizmete bağlandığında üst bilgiler olduğunu unutmayın.
clientCertificates	Etkinleştirildiyse istemci sertifikası

Bağlandı

{
    "namespace": "",
    "socketId": "",
}

Özellik	Açıklama
ad alanı	Yuvanın ad alanı.
socketId	Yuvanın benzersiz kimliği.

Bağlantı kesildi

{
    "namespace": "",
    "socketId": "",
    "reason": ""
}

Özellik	Açıklama
ad alanı	Yuvanın ad alanı.
socketId	Yuvanın benzersiz kimliği.
reason	Bağlantı kapatma nedeni açıklaması.

Normal olaylar

{
    "namespace": "",
    "socketId": "",
    "payload": "",
    "eventName": "",
    "parameters": []
}

Özellik	Açıklama
ad alanı	Yuvanın ad alanı.
socketId	Yuvanın benzersiz kimliği.
yük	Engine.IO protokolündeki ileti yükü
eventName	İsteğin olay adı.
parametreler	İletinin parametrelerinin listesi.

Çıkış Bağlaması

Çıkış bağlaması şu anda aşağıdaki işlevleri destekler:

• Odaya yuva ekleme
• Odadan yuvayı kaldırma
• Yuvaya ileti gönderme
• Odaya ileti gönderme
• Ad alanına ileti gönderme
• Yuvaların bağlantısını kesme

C#

[FunctionName("SocketIOOutput")]
public static async Task<IActionResult> SocketIOOutput(
    [SocketIOTrigger("hub", "new message")] SocketIOMessageRequest request,
    [SocketIO(Hub = "hub")] IAsyncCollector<SocketIOAction> collector)
{
    await collector.AddAsync(SocketIOAction.CreateSendToNamespaceAction("new message", new[] { "arguments" }));
}

Öznitelik

Giriş bağlama özniteliğidir [SocketIO].

Öznitelik özelliği	Açıklama
Hub	İstemcinin bağlanması gereken hub adı.
Connection	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).

JavaScript Modeli v4

import { app, InvocationContext, trigger, output } from "@azure/functions";

const socketio = output.generic({
  type: 'socketio',
  hub: 'hub',
})

export async function newMessage(request: any, context: InvocationContext): Promise<void> {
    context.extraOutputs.set(socketio, {
      actionName: 'sendToNamespace',
      namespace: '/',
      eventName: 'new message',
      parameters: [
        "argument"
      ]
    });
}

// Trigger for new message
app.generic('newMessage', {
    trigger: trigger.generic({
        type: 'socketiotrigger',
        hub: 'hub',
        eventName: 'new message'
    }),
    extraOutputs: [socketio],
    handler: newMessage
});

Yapılandırma

Öznitelik özelliği	Açıklama
Tür	Olmalıdır socketio
göbek	İstemcinin bağlanması gereken hub adı.
bağlantı	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).

Python Modeli v2

bir işlevin her zaman bir tetikleyici bağlaması gerekir. TimerTrigger'i kodlarda örnek olarak kullanırız.

import azure.functions as func
from azure.functions.decorators.core import DataType
import json

app = func.FunctionApp()

@app.timer_trigger(schedule="* * * * * *", arg_name="myTimer", run_on_startup=False,
              use_monitor=False)
@app.generic_output_binding(arg_name="sio", type="socketio", data_type=DataType.STRING, hub="hub")
def new_message(myTimer: func.TimerRequest,
                 sio: func.Out[str]) -> None:
    sio.set(json.dumps({
        'actionName': 'sendToNamespace',
        'namespace': '/',
        'eventName': 'update',
        'parameters': [
            "message"
        ]
    }))

Annotation

Öznitelik özelliği	Açıklama
arg_name	Çıkış bağlamasını temsil eden işlevdeki bağımsız değişkenin değişken adı.
Tür	Olmalıdır socketio
data_type	DataType.STRING komutunu kullanma
göbek	İstemcinin bağlanması gereken hub adı.
bağlantı	Socket.IO bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak WebPubSubForSocketIOConnectionString).

Eylemler

Çıkış bağlama işlemleri gerçekleştirmek için eylemleri kullanır. Şu anda aşağıdaki eylemleri destekliyoruz:

AddSocketToRoomAction

{
    "type": "AddSocketToRoom",
    "socketId": "",
    "room": ""
}

RemoveSocketFromRoomAction

{
    "type": "RemoveSocketFromRoom",
    "socketId": "",
    "room": ""
}

SendToNamespaceAction

{
    "type": "SendToNamespace",
    "eventName": "",
    "parameters": [],
    "exceptRooms": []
}

SendToRoomsAction

{
    "type": "SendToRoom",
    "eventName": "",
    "parameters": [],
    "rooms": [],
    "exceptRooms": []
}

SendToSocketAction

{
    "type": "SendToSocket",
    "eventName": "",
    "parameters": [],
    "socketId": ""
}

DisconnectSocketsAction

{
    "type": "DisconnectSockets",
    "rooms": [],
    "closeUnderlyingConnection": false
}