Skip to content

Commit 0d9c72a

Browse files
committed
feat(WebSocket): 添加 WebSocket 启用开关配置
添加 IsEnableWebSocket 配置项用于控制是否启用 WebSocket 服务,并修改相关逻辑检查此开关状态
1 parent e8be8fa commit 0d9c72a

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

GameFrameX.StartUp/AppStartUpByServer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ private async Task StartServer(List<BaseHttpHandler> baseHandler, Func<string, B
244244
}
245245

246246
// 检查WebSocket端口是否可用
247-
if (Setting.WsPort is > 0 and < ushort.MaxValue && NetHelper.PortIsAvailable(Setting.WsPort))
247+
if (Setting.IsEnableWebSocket && Setting.WsPort is > 0 and < ushort.MaxValue && NetHelper.PortIsAvailable(Setting.WsPort))
248248
{
249249
LogHelper.InfoConsole("启动 [WebSocket] 服务器...");
250250

GameFrameX.StartUp/Options/LauncherOptions.cs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,20 @@ public sealed class LauncherOptions
318318
[Option(nameof(HttpsPort), Description = "HTTPS 端口")]
319319
public ushort HttpsPort { get; set; }
320320

321+
/// <summary>
322+
/// 是否启用 WebSocket 服务
323+
/// <para>开启后服务器将监听 WebSocket 端口,允许客户端通过 WebSocket 协议进行连接</para>
324+
/// <para>默认值为 false,即不启用</para>
325+
/// </summary>
326+
[Option(nameof(IsEnableWebSocket), Description = "是否启用 WebSocket 服务,默认值为 false")]
327+
[DefaultValue(false)]
328+
public bool IsEnableWebSocket { get; set; } = false;
329+
321330
/// <summary>
322331
/// WebSocket 端口
332+
/// <para>默认值为 8889,当 IsEnableWebSocket 为 true 时才会启用</para>
323333
/// </summary>
324-
[Option(nameof(WsPort), Description = "WebSocket 端口")]
334+
[Option(nameof(WsPort), DefaultValue = 8889, Description = "WebSocket 端口,默认值为 8889,当 IsEnableWebSocket 为 true 时才会启用")]
325335
public ushort WsPort { get; set; }
326336

327337
/// <summary>

GameFrameX.Utility/Setting/AppSetting.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,13 @@ public string ToFormatString()
314314
/// </summary>
315315
public ushort MetricsPort { get; set; }
316316

317+
/// <summary>
318+
/// 是否启用 WebSocket 服务
319+
/// <para>开启后服务器将监听 WebSocket 端口,允许客户端通过 WebSocket 协议进行连接</para>
320+
/// <para>默认值为 false,即不启用</para>
321+
/// </summary>
322+
public bool IsEnableWebSocket { get; set; } = false;
323+
317324
/// <summary>
318325
/// WebSocket端口
319326
/// </summary>

0 commit comments

Comments
 (0)