1. 简介
ASP.NET Core SignalR 是一个用于构建实时 Web 应用程序的开源库。它允许服务器端与客户端之间进行双向通信,使得服务器能够主动推送消息到客户端。在本教程中,我们将从零开始,逐步搭建一个实时通信应用。
2. 准备工作
在开始之前,请确保您已安装以下软件:
- .NET Core SDK:从 dotnet.microsoft.com 下载并安装。
- Visual Studio:如果您是 Windows 用户,可以从 visualstudio.microsoft.com 下载并安装。
3. 创建项目
- 打开 Visual Studio,选择“创建新项目”。
- 在“创建新项目”窗口中,选择“ASP.NET Core Web 应用程序”模板。
- 在“配置你的新应用程序”窗口中,选择.NET 5.0 或更高版本,并选择“Web 应用程序”作为应用程序类型。
- 点击“创建”按钮,等待项目创建完成。
4. 安装 SignalR NuGet 包
在项目中,通过 NuGet 包管理器安装 SignalR NuGet 包:
dotnet add package Microsoft.AspNetCore.SignalR
5. 添加 SignalR 依赖
在 Startup.cs 文件中,添加 SignalR 依赖:
public void ConfigureServices(IServiceCollection services)
{
services.AddSignalR();
}
6. 创建 Hub
创建一个新的 Hub 类,例如 ChatHub.cs:
using Microsoft.AspNetCore.SignalR;
public class ChatHub : Hub
{
public async Task SendChatMessage(string message)
{
await Clients.All.SendAsync("ReceiveMessage", message);
}
}
在这个例子中,我们创建了一个名为 ChatHub 的 Hub 类,它有一个名为 SendChatMessage 的方法。该方法接收一个字符串参数 message,并将该消息发送给所有连接的客户端。
7. 配置路由
在 Startup.cs 文件中,配置路由来映射到我们的 Hub:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseEndpoints(endpoints =>
{
endpoints.MapHub<ChatHub>("/chat");
});
}
在这个例子中,我们使用 MapHub 方法将 /chat 路由映射到 ChatHub 类。
8. 创建客户端
在客户端,我们可以使用 SignalR JavaScript 客户端库来连接到我们的 Hub。以下是一个简单的示例:
<!DOCTYPE html>
<html>
<head>
<title>Chat Client</title>
<script src="https://cdn.jsdelivr.net/npm/@aspnet/signalr@3.1.6/dist/signalr.min.js"></script>
</head>
<body>
<input type="text" id="message" placeholder="Type a message...">
<button id="send">Send</button>
<div id="messages"></div>
<script>
var connection = new signalR.HubConnectionBuilder()
.withUrl("/chat")
.build();
connection.on("ReceiveMessage", function (message) {
var messages = document.getElementById("messages");
messages.innerHTML += message + "<br/>";
});
connection.start().catch(function (err) {
return console.error(err.toString());
});
document.getElementById("send").addEventListener("click", function () {
var message = document.getElementById("message").value;
connection.invoke("SendChatMessage", message).catch(function (err) {
return console.error(err.toString());
});
});
</script>
</body>
</html>
在这个例子中,我们创建了一个简单的 HTML 页面,其中包含一个文本输入框、一个按钮和一个用于显示消息的 <div> 元素。我们使用 SignalR JavaScript 客户端库连接到我们的 Hub,并监听 ReceiveMessage 事件来接收消息。我们还添加了一个事件监听器来处理按钮点击事件,并调用 SendChatMessage 方法将消息发送到服务器。
9. 运行应用程序
现在,我们可以运行应用程序,并通过客户端发送和接收消息。
- 在 Visual Studio 中,按 F5 键或选择“启动调试”。
- 打开浏览器,访问
http://localhost:5000。
您现在应该能够看到客户端页面,并能够发送和接收消息。
10. 总结
在本教程中,我们学习了如何使用 ASP.NET Core SignalR 搭建一个实时通信应用。通过创建一个简单的聊天应用,我们了解了如何使用 SignalR 进行双向通信。希望这个教程能帮助您开始使用 SignalR 进行实时通信开发。
