.net core 3.0 Signalr - 07 業務實現-服務端 自定義管理組、用戶、連接


Hub的管理

  • 重寫OnConnectedAsync
    從連接信息中獲取UserId、Groups,ConnectId,並實現這三者的關系,存放於redis中
    代碼請查看
    using CTS.Signalr.Server.Cores;
    using CTS.Signalr.Server.Dtos;
    using Microsoft.AspNetCore.Authorization;
    using Microsoft.AspNetCore.SignalR;
    using Microsoft.Extensions.Logging;
    using System;
    using System.Linq;
    using System.Threading.Tasks;
    
    namespace CTS.Signalr.Server.Hubs
    {
        /// <summary>
        /// 服務端接口
        /// </summary>
        public interface IServerNotifyHub
        {
    
        }
    
        /// <summary>
        /// 客戶端使用的接口
        /// </summary>
        public interface IClientNotifyHub
        {
            Task OnNotify(object data);
    
            Task OnLine(object data);
    
            Task OffLine(object data);
        }
    
    
        [Authorize]
        public class NotifyHub : Hub<IClientNotifyHub>,IServerNotifyHub
        {
            private readonly SignalrRedisHelper _signalrRedisHelper;
            private readonly ILogger _logger;
    
            public NotifyHub(SignalrRedisHelper signalrRedisHelper, ILogger<NotifyHub> logger)
            {
                _signalrRedisHelper = signalrRedisHelper;
                _logger = logger;
            }
    
            public override async Task OnConnectedAsync()
            {
                //await Clients.All.OnNotify(new { UserId= Context.User.Identity.Name, Name=Context.User.Identity.Name, ConnectId = Context.ConnectionId });
                var userId= Context.User.Identity.Name;
                var groups=Context.GetHttpContext().Request.Query["group"].FirstOrDefault();
                _logger.LogDebug($"OnConnectedAsync----userId:{userId},groups:{groups},connectionId:{ Context.ConnectionId}");
                if (!string.IsNullOrWhiteSpace(userId))
                {
                    await _signalrRedisHelper.AddConnectForUserAsync(userId, Context.ConnectionId);
                    await JoinToGroup(userId, Context.ConnectionId, groups?.Split(','));
                    await DealOnLineNotify(userId, Context.ConnectionId);
                }
                await base.OnConnectedAsync();
            }
    
            public override async Task OnDisconnectedAsync(Exception exception)
            {
                var userId = Context.User.Identity.Name;
                var groups = Context.GetHttpContext().Request.Query["group"].FirstOrDefault();
                _logger.LogDebug($"OnDisconnectedAsync----userId:{userId},groups:{groups},connectionId:{ Context.ConnectionId}");
                if (!string.IsNullOrWhiteSpace(userId))
                {
                    await _signalrRedisHelper.RemoveConnectForUserAsync(userId, Context.ConnectionId);
                    await DealOffLineNotify(userId,Context.ConnectionId);
                }
                await LeaveFromGroup(Context.ConnectionId, groups?.Split(','));
                await base.OnDisconnectedAsync(exception);
            }
    
            /// <summary>
            /// 加入組
            /// </summary>
            /// <param name="groupName"></param>
            /// <returns></returns>
            private async Task JoinToGroup(string userId,string connectionId,params string[] groups)
            {
                if (!string.IsNullOrWhiteSpace(userId)&& groups!=null&&groups.Length>0)
                {
                    foreach (var group in groups)
                    {
                        await Groups.AddToGroupAsync(connectionId, group);
                        await _signalrRedisHelper.AddUserForGroupAsync(group, connectionId, userId);
    
                        // await Clients.Group(group).OnJoinGroup(new { ConnectId = connectionId, UserId = userId, GroupName = group });
                    }
                }
            }
    
            /// <summary>
            /// 從組中移除
            /// </summary>
            /// <param name="groupName"></param>
            /// <returns></returns>
            private async Task LeaveFromGroup(string connectionId,params string[] groups)
            {
                if (groups != null && groups.Length > 0)
                {
                    foreach (var group in groups)
                    {
                        await Groups.RemoveFromGroupAsync(connectionId, group);
                        await _signalrRedisHelper.RemoveConnectFromGroupAsync(group,connectionId);
                        // await Clients.Group(group).OnLeaveGroup(new { ConnectId = connectionId, GroupName = group });
                    }
                }
            }
    
            /// <summary>
            /// 處理上線通知(只有用戶第一個連接才通知)
            /// </summary>
            /// <param name="userId"></param>
            /// <param name="connectionId"></param>
            /// <returns></returns>
            private async Task DealOnLineNotify(string userId,string connectionId) 
            {
                var userConnectCount = await _signalrRedisHelper.GetConnectsCountByUserAsync(userId);
                await Clients.All.OnLine(new OnLineData()
                {
                    UserId = userId,
                    ConnectionId = connectionId,
                    IsFirst = userConnectCount == 1
                });
            }
    
            /// <summary>
            /// 處理下線通知(只有當用戶一個連接都沒了 才算下線)
            /// </summary>
            /// <param name="userId"></param>
            /// <param name="connectionId"></param>
            /// <returns></returns>
            private async Task DealOffLineNotify(string userId,string connectionId)
            {
                var userConnectCount = await _signalrRedisHelper.GetConnectsCountByUserAsync(userId);
                await Clients.All.OffLine(new OffLineData()
                {
                    UserId = userId,
                    ConnectionId = connectionId,
                    IsLast = userConnectCount == 0
                });
            }
        }
    }
    
    

提供給業務系統調用的API

  • [POST] api/notify/post
    application/json形式 提交,數據格式如下

    {
      GroupIds:'', // [可空] 組id集合,多個用,隔開
      UserIds:'',// [可空] 用戶id集合,多個用,隔開
      ExcludeUsers:boolean, // 是否排除用戶列表中的用戶
      NotifyObj:Object // 通知的對象,任意類型(總大小不要超過36k)
    }
    
    • 有GroupIds

      • ExcludeUsers=true
        推送給指定的組中所有用戶(排除掉UserIds部分)

      • ExcludeUsers=false
        推送給組中指定(UserIds中指定的)的這些用戶

    • 無GroupIds

      • ExcludeUsers=true
        推送給當前所有連接(排除掉UserIds部分的用戶)

      • ExcludeUsers=false
        推送給指定用戶(UserIds中指定的用戶)

  • [POST] api/notify/postConnects
    application/json提交,數據格式如下

    {
      Connects:'', // 連接Id集合,多個用,隔開
      NotifyObj:Object // 通知的對象,任意類型(總大小不要超過36k)
    }
    
    • 有UserId
      • ExcludeConnectId=true
        給改用戶除指定的ConnectId外的所有連接端推送
      • ExcludeConnectId=false
        跟沒指定UserId一致
    • 無UserId
      給指定連接Id推送
  • [GET] api/users
    獲取在線用戶Id列表

  • [GET] api/groups
    獲取在線組列表

增加日志記錄

為了方便分析和定位問題,使用log4net來作為日志記錄器。

  • nuget 安裝log4net
    nuget 搜索 log4net,安裝
  • Config中配置
    在Config中注入ILoggerFactory,然后使用添加Log4Net,代碼如下所示
public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    app.UseHsts();

    loggerFactory.AddLog4Net();
    ...
}
  • 添加log4net配置文件
    更多配置請自行查找log4net官方配置文檔
<?xml version="1.0" encoding="utf-8" ?>
<!--LOG4日志級別 
    0:TRACE;記錄一些對程序員調試問題有幫助的信息, 其中可能包含一些敏感信息, 所以應該避免在生產環境中啟用Trace日志。
    1:DEBUG;記錄一些在開發和調試階段有用的短時變量(Short-term usefulness), 所以除非為了臨時排除生產環境的故障,開發人員應該盡量避免在生產環境中啟用Debug日志。
    2:INFO;信息日志,記錄應用程序的一些流程, 例如,記錄當前api請求的url,請求參數等。
    3:WARN;警告日志;記錄應用程序中發生的不正常或者未預期的事件信息。這些信息中可能包含錯誤消息或者錯誤產生的條件, 例如, 文件未找到,用戶不存在。
    4:ERROR;錯誤日志;記錄應用程序中某個操作產生的錯誤和異常信息,如對空值進行操作等。
    5:FATAL;毀滅性錯誤;記錄一些需要立刻修復的問題。例如數據丟失,磁盤空間不足。
trace<debug<info<warn<error<fatal -->
<log4net>
  <appender name="ErrorRollingFileAppender" type="log4net.Appender.RollingFileAppender">
    <file value="AppData\\logs\\" />
    <appendToFile value="true" />
    <rollingStyle value="Date"/>
    <datePattern value="yyyy-MM-dd-'error.log'"/>
    <maxSizeRollBackups value="100" />
    <staticLogFileName value="false" />
    <encoding value="utf-8" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%-5level %date [%-5.5thread] %-40.40logger - %message%newline" />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelMin value="ERROR" />
      <levelMax value="FATAL" />
    </filter>
  </appender>

  <root>
    <level value="All" />
    <appender-ref ref="ErrorRollingFileAppender" />
  </root>
</log4net>

至此,log4net配置完畢

更多內容請通過快速導航查看下一篇

快速導航

標題 內容
索引 .net core 3.0 Signalr - 實現一個業務推送系統
上一篇 .net core 3.0 Signalr - 06 業務實現-業務分析
下一篇 .net core 3.0 Signalr - 08 業務實現-客戶端demo
源碼地址 源碼
官方文檔 官方文檔

二維碼


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM