در این آموزش به ساخت یک برنامه چت بصورت real-time با استفاده از SignalR در Asp.net core 2.1 خواهسم پرداخت.
مواردیکه که در این آموزش مورد بحث قرار خواهند گرفت شامل گزینه های زیر می باشد.
- نحوه ایجاد پروزه مبتنی بر SignalR در Asp.net Core 2.1
- ایجاد SignalR hub جهت ارتباط بین client و server
- پیکربندی کلاس sturtup.cs
قبل از شروع آموزش نیاز به نصب و بروزرسانی برنامه های مورد نیاز در این اموزش دارید که شامل موارد زیر می باشد.
برای شروع یک پروژه بنام SignalRChat با توجه به شکل زیر ایجاد نمایید.
در محیط visual studio کتابخانه های مورد نیاز سمت سرور با استفاده از Microsoft.AspNetCore.SignalR در قالب پروژه ای که بصورت
ASP.NET Core Web Application ایجاد کردیم موجود می باشد لذا برای نصب کتابخانه های جاوااسکریپت SignalR کلاینت از طریق npm عملیات نصب را انجام می دهیم.
بنا براین از قسمت Package Manager Console دستورات زیر را اجرا کنید.
npm init -y
npm install @aspnet/signalr
پوشه ای بنام signalr درون پوشه lib ایجاد نمایید سپس فایل signalr.js را از مسیر node_modules\@aspnet\signalr\dist\browser کپی نمایید و درون پوشه signalr قرار دهید.
اکنون یک پوشه بنام Hubs ایجاد میکنیم و درون آن کلاسی بنام CahtHub که از کلاس Microsoft.AspNetCore.SignalR.Hub ارث بری میکنید ، بصورت زیر ایجاد کنید.
using Microsoft.AspNetCore.SignalR;
using System.Threading.Tasks;
namespace SignalRChat.Hubs
{
public class ChatHub : Hub
{
public async Task SendMessage(string user, string message)
{
await Clients.All.SendAsync("ReceiveMessage", user,message);
}
}
}
در این برنامه هدفمان ارسال پیام بصورت بلادرنگ به تمامی کلاینتهای متصل به سرور می باشد.که این عمل توسط تابع SendMessage انجام میگیرد.
اکنون وقت آن رسیده است تا به پیکربندی کلاس startup.cs برای اتصالات به SignalR و مدیریت Rout آن در این کلاس بپردازیم.لذا محتویات توابع ConfigureServices و Configure را بصورت زیر ویرایش نمایید.
public void ConfigureServices(IServiceCollection services)
{
services.Configure<CookiePolicyOptions>(options =>
{
// This lambda determines whether user consent for non-essential cookies is needed for a given request.
options.CheckConsentNeeded = context => true;
options.MinimumSameSitePolicy = SameSiteMode.None;
});
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
services.AddCors(options => options.AddPolicy("CorsPolicy",
builder =>
{
builder.AllowAnyMethod().AllowAnyHeader()
.WithOrigins("http://localhost:55830")
.AllowCredentials();
}));
services.AddSignalR();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseCookiePolicy();
app.UseCors("CorsPolicy");
app.UseSignalR(routes =>
{
routes.MapHub<ChatHub>("/chathub");
});
app.UseMvc();
}
برای ایجاد کدهای جاوااسکریپت client یک فایل با نام chat.js درون مسیر wwwroot\js ایجاد نمایید و محتویات آنرا بصورت زیر ویرایش کنید.
// The following sample code uses modern ECMAScript 6 features
const connection = new signalR.HubConnectionBuilder()
.withUrl("/chatHub")
.build();
connection.on("ReceiveMessage", (user, message) => {
const msg = message.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
const encodedMsg = user + " says " + msg;
const li = document.createElement("li");
li.textContent = encodedMsg;
document.getElementById("messagesList").appendChild(li);
});
connection.start().catch(err => console.error(err.toString()));
document.getElementById("sendButton").addEventListener("click", event => {
const user = document.getElementById("userInput").value;
const message = document.getElementById("messageInput").value;
connection.invoke("SendMessage", user, message).catch(err => console.error(err.toString()));
event.preventDefault();
});
سپس فایل index.cshtml که درون پوشه pages قرار دارد را بصورت زیر ویرایش کنید.
@page
<div class="container">
<div class="row"> </div>
<div class="row">
<div class="col-6"> </div>
<div class="col-6">
User..........<input type="text" id="userInput" />
<br />
Message...<input type="text" id="messageInput" />
<input type="button" id="sendButton" value="Send Message" />
</div>
</div>
<div class="row">
<div class="col-12">
<hr />
</div>
</div>
<div class="row">
<div class="col-6"> </div>
<div class="col-6">
<ul id="messagesList"></ul>
</div>
</div>
</div>
<script src="~/lib/signalr/signalr.js"></script>
<script src="~/js/chat.js"></script>
@*<script src="~/js/es5-chat.js"></script>*@
اکنون برنامه را اجرا کنید و آنرا در دو مرورگر باز نمایید با ارسال پیام از یک کلاینت خروجی آن بصورت بلادرنگ (بدون refresh شدن صفحه ) در مرورگر دیگر نیز نمایش داده خواهد شد .