您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

教程:使用 Azure Functions 和 Azure Web PubSub 服务创建无服务器实时聊天应用

Azure Web PubSub 服务可帮助你轻松地使用 Websocket 和发布-订阅模式生成实时消息传递 Web 应用程序。 Azure Functions 是一个无服务器平台,可让你在不管理任何基础结构的情况下运行代码。 本教程介绍如何使用 Azure Web PubSub 服务和 Azure Functions 来生成具有实时消息传递和发布-订阅模式的无服务器应用程序。

在本教程中,你将了解如何:

  • 构建无服务器实时聊天应用
  • 使用 Web PubSub 函数触发器绑定和输出绑定
  • 将函数部署到 Azure 函数应用
  • 配置 Azure 身份验证
  • 配置 Web PubSub 事件处理程序以将事件和消息路由到应用程序

先决条件

如果还没有 Azure 订阅,可以在开始前创建一个免费帐户

登录 Azure

使用 Azure 帐户登录到 Azure 门户 (https://portal.azure.com/)。

创建 Azure Web PubSub 服务实例

你的应用程序将连接到 Azure 中的 Web PubSub 服务实例。

  1. 选择 Azure 门户左上角的“新建”按钮。 在“新建”屏幕中,在搜索框中键入“Web PubSub”,然后按 Enter。 (还可以从 Web 类别中搜索 Azure Web PubSub。)

    屏幕截图显示在门户中搜索 Azure Web PubSub。

  2. 在搜索结果中选择“Web PubSub”,然后选择“创建” 。

  3. 输入以下设置。

    设置 建议的值 说明
    资源名称 全局唯一名称 标识新 Web PubSub 服务实例的全局唯一名称。 有效字符为 a-z0-9-
    订阅 你的订阅 在其下创建此新的 Web PubSub 服务实例的 Azure 订阅。
    资源组 myResourceGroup 要在其中创建 Web PubSub 服务实例的新资源组的名称。
    位置 美国西部 选择你附近的区域
    定价层 免费 可以先免费试用 Azure Web PubSub 服务。 了解有关 Azure Web PubSub 服务定价层的更多详细信息
    单位计数 - 单位计数指定 Web PubSub 服务实例可接受的连接数。 每个单位最多支持 1000 个并发连接。 它只能在标准层中配置。

    屏幕截图显示在门户中创建 Azure Web PubSub 实例。

  4. 选择“创建”,开始部署 Web PubSub 服务实例。

创建函数

  1. 确保已安装 Azure Functions Core Tools。 然后为项目创建一个空目录。 在此工作目录下运行命令。

    func init --worker-runtime javascript
    
  2. *安装 Microsoft.Azure.WebJobs.Extensions.WebPubSub 函数扩展包。

    备注

    支持扩展捆绑时,此步骤是可选的。

    a. 删除 extensionBundle 中的 host.json 节,以便在下一步中安装特定扩展包。 或者让 host json 变得像下面这样简单。

    {
        "version": "2.0"
    }
    

    b. 运行命令以安装特定函数扩展包。

    func extensions install --package Microsoft.Azure.WebJobs.Extensions.WebPubSub --version 1.0.0
    
  3. 创建 index 函数,为客户端读取和托管静态网页。

    func new -n index -t HttpTrigger
    
    • 更新 index/function.json 并复制以下 json 代码。
      {
          "bindings": [
              {
                  "authLevel": "anonymous",
                  "type": "httpTrigger",
                  "direction": "in",
                  "name": "req",
                  "methods": [
                    "get",
                    "post"
                  ]
              },
              {
                  "type": "http",
                  "direction": "out",
                  "name": "res"
              }
          ]
      }
      
    • 更新 index/index.js 并复制以下代码。
      var fs = require('fs');
      var path = require('path');
      
      module.exports = function (context, req) {
          var index = 'index.html';
          if (process.env["HOME"] != null)
          {
              index = path.join(process.env["HOME"], "site", "wwwroot", index);
          }
          context.log("index.html path: " + index);
          fs.readFile(index, 'utf8', function (err, data) {
              if (err) {
              console.log(err);
              context.done(err);
              }
              context.res = {
              status: 200,
              headers: {
                  'Content-Type': 'text/html'
              },
              body: data
              };
              context.done();
          });
      }
      
  4. 创建 negotiate 函数,以帮助客户端使用访问令牌获取服务连接 URL。

    func new -n negotiate -t HttpTrigger
    

    备注

    本示例使用 AAD 用户标识标头 x-ms-client-principal-name 来检索 userId。 这在本地函数中不起作用。 在本地运行时,可以将其清空或改为使用其他方式获取或生成 userId。 例如,让客户端键入用户名,并在调用 negotiate 函数以获取服务连接 URL 时将其传递到 ?user={$username} 之类的查询中。 在 negotiate 函数中,将 userId 设置为值 {query.user}

    • 更新 negotiate/function.json 并复制以下 json 代码。
      {
          "bindings": [
              {
                  "authLevel": "anonymous",
                  "type": "httpTrigger",
                  "direction": "in",
                  "name": "req"
              },
              {
                  "type": "http",
                  "direction": "out",
                  "name": "res"
              },
              {
                  "type": "webPubSubConnection",
                  "name": "connection",
                  "hub": "simplechat",
                  "userId": "{headers.x-ms-client-principal-name}",
                  "direction": "in"
              }
          ]
      }
      
    • 更新 negotiate/index.js 并复制以下代码。
      module.exports = function (context, req, connection) {
          context.res = { body: connection };
          context.done();
      };
      
  5. 创建 message 函数以通过服务广播客户端消息。

    func new -n message -t HttpTrigger
    

    备注

    此函数实际上是使用 WebPubSubTrigger。 但是,WebPubSubTrigger 未集成在函数的模块中。 我们使用 HttpTrigger 来初始化函数模板并在代码中更改触发器类型。

    • 更新 message/function.json 并复制以下 json 代码。
      {
          "bindings": [
              {
                  "type": "webPubSubTrigger",
                  "direction": "in",
                  "name": "data",
                  "hub": "simplechat",
                  "eventName": "message",
                  "eventType": "user"
              },
              {
                  "type": "webPubSub",
                  "name": "actions",
                  "hub": "simplechat",
                  "direction": "out"
              }
          ]
      }
      
    • 更新 message/index.js 并复制以下代码。
      module.exports = async function (context, data) {
          context.bindings.actions = {
              "actionName": "sendToAll",
              "data": `[${context.bindingData.request.connectionContext.userId}] ${data}`,
              "dataType": context.bindingData.dataType
          };
          // UserEventResponse directly return to caller
          var response = { 
              "data": '[SYSTEM] ack.',
              "dataType" : "text"
          };
          return response;
      };
      
  6. 在项目根文件夹中添加客户端单页 index.html,并复制如下所示的内容。

    <html>
        <body>
            <h1>Azure Web PubSub Serverless Chat App</h1>
            <div id="login"></div>
            <p></p>
            <input id="message" placeholder="Type to chat...">
            <div id="messages"></div>
            <script>
                (async function () {
                    let authenticated = window.location.href.includes('?authenticated=true');
                    if (!authenticated) {
                        // auth
                        let login = document.querySelector("#login");
                        let link = document.createElement('a');
                        link.href = `${window.location.origin}/.auth/login/aad?post_login_redirect_url=/api/index?authenticated=true`;
                        link.text = "login";
                        login.appendChild(link);
                    }
                    else {
                        // negotiate
                        let messages = document.querySelector('#messages');
                        let res = await fetch(`${window.location.origin}/api/negotiate`, {
                            credentials: "include"
                        });
                        let url = await res.json();
                        // connect
                        let ws = new WebSocket(url.url);
                        ws.onopen = () => console.log('connected');
                        ws.onmessage = event => {
                            let m = document.createElement('p');
                            m.innerText = event.data;
                            messages.appendChild(m);
                        };
                        let message = document.querySelector('#message');
                        message.addEventListener('keypress', e => {
                            if (e.charCode !== 13) return;
                            ws.send(message.value);
                            message.value = '';
                        });
                    }
                })();
            </script>
        </body>
    </html>
    

Create and Deploy the Azure Function App

Before you can deploy your function code to Azure, you need to create 3 resources:

  • A resource group, which is a logical container for related resources.
  • A storage account, which is used to maintain state and other information about your functions.
  • A function app, which provides the environment for executing your function code. A function app maps to your local function project and lets you group functions as a logical unit for easier management, deployment and sharing of resources.

Use the following commands to create these items.

  1. If you haven't done so already, sign in to Azure:

    az login
    
  2. 创建资源组,或者可以通过重用某个 Azure Web PubSub 服务来跳过此步骤:

    az group create -n WebPubSubFunction -l <REGION>
    
  3. 在资源组和区域中创建常规用途存储帐户:

    az storage account create -n <STORAGE_NAME> -l <REGION> -g WebPubSubFunction
    
  4. 在 Azure 中创建函数应用:

    az functionapp create --resource-group WebPubSubFunction --consumption-plan-location <REGION> --runtime node --runtime-version 12 --functions-version 3 --name <FUNCIONAPP_NAME> --storage-account <STORAGE_NAME>
    
  5. 将函数项目部署到 Azure:

    在 Azure 中成功创建函数应用后,便可以使用 func azure functionapp publish 命令部署本地函数项目。

    func azure functionapp publish <FUNCIONAPP_NAME>
    
  6. 配置函数应用的 WebPubSubConnectionString

    首先,从“Azure 门户”中找到你的 Web PubSub 资源,并复制出“密钥”下的连接字符串 。 然后,导航到“Azure 门户” -> “设置” -> “配置”中的函数应用设置 。 并在“应用程序设置”下添加一个新项目,其名称等于 WebPubSubConnectionString,值为你的 Web PubSub 资源连接字符串。

配置 Web PubSub 服务 Event Handler

本示例使用 WebPubSubTrigger 侦听服务上游请求。 因此 Web PubSub 需要知道函数的终结点信息才能发送目标客户端请求。 并且 Azure 函数应用需要一个系统密钥,以确保有关特定于扩展的 Webhook 方法的安全性。 在上一步中,使用 message 函数部署函数应用后,我们可以获取系统密钥。

转到“Azure 门户”-> 找到你的函数应用资源 ->“应用密钥” -> “系统密钥” -> “webpubsub_extension” 。 将该值复制为 <APP_KEY>

获取函数系统密钥的屏幕截图。

在 Azure Web PubSub 服务中设置 Event Handler。 转到“Azure 门户”>“查找 Web PubSub 资源”>“设置” 。 将新的中心设置映射添加到使用中的一个函数,如下所示。 将 <FUNCTIONAPP_NAME><APP_KEY> 替换为你自己的值。

  • 中心名称:simplechat
  • URL 模板: https://<FUNCTIONAPP_NAME>.azurewebsites.net/runtime/webhooks/webpubsub?code=<APP_KEY>
  • 用户事件模式:*
  • 系统事件:-(本示例中无需配置)

设置事件处理程序的屏幕截图。

备注

如果在本地运行函数: 可以在函数启动后通过命令 ngrok http 7071 使用 ngrok 公开函数 URL。 并使用 URL https://<NGROK_ID>.ngrok.io/runtime/webhooks/webpubsub 配置 Web PubSub 服务 Event Handler

配置以启用客户端身份验证

转到“Azure 门户”-> 找到你的函数应用资源 ->“身份验证” 。 单击“Add identity provider” 。 将“应用服务身份验证设置”设置为“允许未经身份验证的访问”,以便匿名用户可以在重定向以进行身份验证之前访问你的客户端索引页 。 然后“保存”。

此处选择 Microsoft 作为标识提供者,它将在 negotiate 函数中使用 x-ms-client-principal-name 作为 userId。 此外,可以按照以下链接配置其他标识提供者,并且不要忘记相应地更新 negotiate 函数中的 userId 值。

尝试运行应用程序

现在,可以从你的函数应用测试页面:https://<FUNCTIONAPP_NAME>.azurewebsites.net/api/index。 请参阅下面的快照。

  1. 单击 login 进行身份验证。
  2. 在输入框中键入消息进行聊天。

在消息函数中,我们会将调用方的消息广播给所有客户端,并向调用方返回消息 [SYSTEM] ack。 我们可以在下面的示例聊天快照中了解,前 4 条消息来自当前客户端,后 2 条消息来自其他客户端。

聊天示例的屏幕截图。

清理资源

如果不打算继续使用此应用,请按照以下步骤删除本文档中创建的所有资源,以免产生任何费用:

  1. 在 Azure 门户的最左侧选择“资源组”,,然后选择创建的资源组。 可以改用搜索框按名称查找资源组。

  2. 在打开的窗口中选择资源组,然后选择“删除资源组”。

  3. 在新窗口中键入要删除的资源组的名称,然后选择“删除”。

后续步骤

本快速入门介绍了如何运行无服务器聊天应用程序。 现在,可以开始构建自己的应用程序。