Add interface IWebClientService

src/BootstrapBlazor.Server/Components/Pages/Online.razor.cs

@@ -18,7 +18,7 @@ public partial class Online : IDisposable
 
     [Inject]
     [NotNull]
-    private WebClientService? WebClientService { get; set; }
+    private IWebClientService? WebClientService { get; set; }
 
     private DynamicObjectContext? DataTableDynamicContext { get; set; }
 

src/BootstrapBlazor.Server/Components/Samples/Client.razor

@@ -30,7 +30,7 @@
         <p class="code-label">@((MarkupString)Localizer["BasicUsageP3"].Value)</p>
         <Pre>[Inject]
 [NotNull]
-private WebClientService? ClientService { get; set; }
+private IWebClientService? ClientService { get; set; }
 
 private ClientInfo? ClientInfo { get; set; }
 

src/BootstrapBlazor.Server/Components/Samples/Client.razor.cs

@@ -12,7 +12,7 @@ public partial class Client
 {
     [Inject]
     [NotNull]
-    private WebClientService? ClientService { get; set; }
+    private IWebClientService? ClientService { get; set; }
 
     private ClientInfo _clientInfo = new();
 

src/BootstrapBlazor.Server/Components/Samples/Dispatches.razor.cs

@@ -14,7 +14,7 @@ public partial class Dispatches
 {
     [Inject]
     [NotNull]
-    private WebClientService? ClientService { get; set; }
+    private IWebClientService? ClientService { get; set; }
 
     [Inject]
     [NotNull]

src/BootstrapBlazor.Server/Components/Samples/Locators.razor.cs

@@ -16,7 +16,7 @@ public partial class Locators
 
     [Inject]
     [NotNull]
-    WebClientService? ClientService { get; set; }
+    IWebClientService? ClientService { get; set; }
 
     [Inject]
     [NotNull]

src/BootstrapBlazor.Server/Locales/en-US.json

@@ -3808,7 +3808,7 @@
     "BasicUsageP1": "Introduction to usage",
     "BasicUsageP2": "1. The <code>UseBootstrapBlazor</code> middleware in the <b>Startup.cs</b> file that client information collection is performed.",
     "BasicUsageTips": "<code>app.UseBootstrapBlazor</code> Middleware is located assembly <code>BootstrapBlazor.Middleware</code>, please refer to this package yourself for proper use",
-    "BasicUsageP3": "2. The component uses the injection service <code>WebClientService</code> to call the <code>GetClientInfo</code> method.",
+    "BasicUsageP3": "2. The component uses the injection service <code>IWebClientService</code> to call the <code>GetClientInfo</code> method.",
     "BasicUsageP4": "3. Turn on IP geolocation",
     "LocatorsProviderOptions": "<code>BootstrapBlazorOptions</code> section <code>WebClientOptions</code> By default it is <code>false</code>, which means the IP address location function is not enabled. Please change it to <code>true</code> in the configuration file or code.",
     "LocatorsProviderDesc1": "Update the <code>appsetting.json</code> project configuration file",

src/BootstrapBlazor.Server/Locales/zh-CN.json

@@ -3808,7 +3808,7 @@
     "BasicUsageP1": "用法介绍",
     "BasicUsageP2": "1. <b>Startup.cs</b> 文件中使用 <code>UseBootstrapBlazor</code> 中间件进行客户端信息收集",
     "BasicUsageTips": "<code>app.UseBootstrapBlazor</code> 中间件位于程序集 <code>BootstrapBlazor.Middleware</code>，请自行引用此包才能正常使用",
-    "BasicUsageP3": "2. 组件中使用注入服务 <code>WebClientService</code> 调用 <code>GetClientInfo</code> 方法",
+    "BasicUsageP3": "2. 组件中使用注入服务 <code>IWebClientService</code> 调用 <code>GetClientInfo</code> 方法",
     "BasicUsageP4": "3. 开启 IP 地理位置定位功能",
     "LocatorsProviderOptions": "全局配置定位器选项 <code>WebClientOptions</code> 默认 <code>false</code> 没有启用 IP 地址定位功能，请在配置文件中或者代码中更改为 <code>true</code>",
     "LocatorsProviderDesc1": "更新 <code>appsetting.json</code> 项目配置文件",

src/BootstrapBlazor/Extensions/BootstrapBlazorServiceCollectionExtensions.cs

@@ -105,7 +105,7 @@ public static IServiceCollection AddBootstrapBlazor(this IServiceCollection serv
         services.AddScoped<PrintService>();
         services.AddScoped<TitleService>();
         services.AddScoped<DownloadService>();
-        services.AddScoped<WebClientService>();
+        services.AddScoped<IWebClientService, WebClientService>();
         services.AddScoped<AjaxService>();
         services.AddScoped(typeof(DragDropService<>));
         services.AddScoped<ClipboardService>();

src/BootstrapBlazor/Services/IWebClientService.cs

@@ -0,0 +1,23 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License
+// See the LICENSE file in the project root for more information.
+// Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
+
+namespace BootstrapBlazor.Components;
+
+/// <summary>
+/// WebClient 服务类
+/// </summary>
+public interface IWebClientService : IAsyncDisposable
+{
+    /// <summary>
+    /// 获得 ClientInfo 实例方法
+    /// </summary>
+    /// <returns></returns>
+    Task<ClientInfo> GetClientInfo();
+    /// <summary>
+    /// SetData 方法由 JS 调用
+    /// </summary>
+    /// <param name="client"></param> 
+    void SetData(ClientInfo client);
+}

src/BootstrapBlazor/Services/WebClientService.cs

@@ -4,6 +4,7 @@
 // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
 
 using Microsoft.Extensions.Logging;
+
 using System.Text.Json.Serialization;
 
 namespace BootstrapBlazor.Components;
@@ -20,7 +21,7 @@ public class WebClientService(IIpLocatorFactory ipLocatorFactory,
     IOptionsMonitor<BootstrapBlazorOptions> options,
     IJSRuntime runtime,
     NavigationManager navigation,
-    ILogger<WebClientService> logger) : IAsyncDisposable
+    ILogger<WebClientService> logger) : IAsyncDisposable, IWebClientService
 {
     private TaskCompletionSource? _taskCompletionSource;
     private JSModule? _jsModule;

test/UnitTest/Services/ConnectionHubTest.cs

@@ -26,7 +26,7 @@ public async Task Callback_Ok()
             BeatInterval = TimeSpan.FromMilliseconds(200)
         };
 
-        var client = context.Services.GetRequiredService<WebClientService>();
+        var client = context.Services.GetRequiredService<IWebClientService>();
         var service = context.Services.GetRequiredService<IConnectionService>();
         var cut = context.RenderComponent<ConnectionHub>();
         await cut.InvokeAsync(async () =>
@@ -60,7 +60,7 @@ await cut.InvokeAsync(async () =>
 
         // 触发内部 ClientInfo 为空情况 覆盖 _clientInfo ??= new();
         options.Value.ConnectionHubOptions.Enable = false;
-        client = context.Services.GetRequiredService<WebClientService>();
+        client = context.Services.GetRequiredService<IWebClientService>();
         cut = context.RenderComponent<ConnectionHub>();
         await cut.InvokeAsync(async () =>
         {
@@ -71,7 +71,7 @@ await cut.InvokeAsync(async () =>
         // 设置 EnableIpLocator 为 false
         options.Value.ConnectionHubOptions.Enable = true;
         options.Value.ConnectionHubOptions.EnableIpLocator = false;
-        client = context.Services.GetRequiredService<WebClientService>();
+        client = context.Services.GetRequiredService<IWebClientService>();
         cut = context.RenderComponent<ConnectionHub>();
         await cut.InvokeAsync(async () =>
         {

test/UnitTest/Services/WebClientServiceTest.cs

@@ -24,7 +24,7 @@ public async Task WebClientService_Ok()
             Engine = "engine",
             UserAgent = "test_agent"
         };
-        var service = Context.Services.GetRequiredService<WebClientService>();
+        var service = Context.Services.GetRequiredService<IWebClientService>();
         service.SetData(mockData);
         ClientInfo? client = null;
         _ = Task.Run(async () => client = await service.GetClientInfo());
@@ -53,15 +53,15 @@ public async Task WebClientOptions_Ok()
         var options = Context.Services.GetRequiredService<IOptionsMonitor<BootstrapBlazorOptions>>();
         options.CurrentValue.WebClientOptions.EnableIpLocator = true;
 
-        var service = Context.Services.GetRequiredService<WebClientService>();
+        var service = Context.Services.GetRequiredService<IWebClientService>();
         var client = await service.GetClientInfo();
         Assert.Null(client.Ip);
     }
 
     [Fact]
     public async Task GetClientInfo_Error()
     {
-        var service = Context.Services.GetRequiredService<WebClientService>();
+        var service = Context.Services.GetRequiredService<IWebClientService>();
         var client = await service.GetClientInfo();
 
         // TimeoutException
@@ -75,7 +75,7 @@ public async Task GetClientInfo_Error()
     [Fact]
     public async Task SetData_Ok()
     {
-        var service = Context.Services.GetRequiredService<WebClientService>();
+        var service = Context.Services.GetRequiredService<IWebClientService>();
 
         // 内部 ReturnTask 为空
         var fieldInfo = service.GetType().GetField("_taskCompletionSource", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance);
@@ -94,6 +94,6 @@ public async Task SetData_Ok()
     [Fact]
     public async Task WebClientService_Dispose()
     {
-        await (Context.Services.GetRequiredService<WebClientService>() as IAsyncDisposable).DisposeAsync();
+        await (Context.Services.GetRequiredService<IWebClientService>() as IAsyncDisposable).DisposeAsync();
     }
 }