add hangfire

Attributes/OriginResponseAttribute.cs

@@ -0,0 +1,8 @@
+using System;
+
+namespace SimApi.Attributes;
+
+[AttributeUsage(AttributeTargets.Method)]
+public class OriginResponseAttribute : Attribute
+{
+}

Communications/SimApiBaseResponse.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using SimApi.Helpers;
 
 namespace SimApi.Communications;
 
@@ -36,15 +37,7 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
     /// <returns></returns>
     public override string ToString()
     {
-        return JsonSerializer.Serialize(this, new JsonSerializerOptions
-        {
-            IgnoreReadOnlyProperties = true,
-            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-            Converters =
-            {
-                new JsonStringEnumConverter()
-            }
-        });
+        return SimApiUtil.Json(this);
     }
 }
 

Configurations/SimApiJobOptions.cs

@@ -0,0 +1,22 @@
+namespace SimApi.Configurations;
+
+public class SimApiJobOptions
+{
+    /// <summary>
+    /// WebUi地址,设置为null表示不启用
+    /// </summary>
+    public string? DashboardUrl { get; set; } = "/jobs";
+
+    public string DashboardAuthUser { get; set; } = "admin";
+    public string DashboardAuthPass { get; set; } = "Admin@123!";
+    public string? RedisConfiguration { get; set; }
+
+    public int? Database { get; set; } = null;
+    public SimApiJobServerConfig[] Servers { get; set; } = [new()];
+}
+
+public class SimApiJobServerConfig()
+{
+    public string[] Queues { get; set; } = ["default"];
+    public int WorkerNum { get; set; } = 50;
+}

Configurations/SimApiOptions.cs

@@ -5,6 +5,13 @@ namespace SimApi.Configurations;
 
 public class SimApiOptions
 {
+    public string? RedisConfiguration { get; set; }
+
+    /// <summary>
+    /// 是否启用后台任务系统 *基于Hangfire
+    /// </summary>
+    public bool EnableJob { get; set; } = false;
+
     /// <summary>
     /// 启用全部Cors，对于开发前后分离的时候很有用。
     /// default: true
@@ -37,6 +44,11 @@ public class SimApiOptions
     /// </summary>
     public bool EnableSimApiException { get; set; } = true;
 
+    /// <summary>
+    /// 启用返回结果拦截
+    /// </summary>
+    public bool EnableSimApiResponseFilter { get; set; } = true;
+
     /// <summary>
     /// 开启S3兼容的存储系统。
     /// default: false
@@ -66,6 +78,10 @@ public class SimApiOptions
     /// </summary>
     public bool EnableSynapse { get; set; }
 
+    /// <summary>
+    /// 配置Job
+    /// </summary>
+    public SimApiJobOptions SimApiJobOptions { get; set; } = new();
 
     /// <summary>
     /// Swagger文档相关配置，需要启用 EnableSimApiDoc
@@ -98,4 +114,9 @@ public class SimApiOptions
     {
         options?.Invoke(SimApiStorageOptions);
     }
+
+    public void ConfigureSimApiJob(Action<SimApiJobOptions>? options = null)
+    {
+        options?.Invoke(SimApiJobOptions);
+    }
 }

Helpers/SimApiCache.cs

@@ -0,0 +1,32 @@
+using System.Text.Json;
+using Microsoft.Extensions.Caching.Distributed;
+
+namespace SimApi.Helpers;
+
+public class SimApiCache(IDistributedCache cache)
+{
+    private const string Prefix = "SimApi:Cache";
+
+    public void Set(string key, object value, DistributedCacheEntryOptions? options = null)
+    {
+        if (options is not null)
+        {
+            cache.SetString(Prefix + key, SimApiUtil.Json(value), options);
+        }
+        else
+        {
+            cache.SetString(Prefix + key, SimApiUtil.Json(value));
+        }
+    }
+
+    public string? Get(string key)
+    {
+        return cache.GetString(Prefix + key);
+    }
+
+    public T? Get<T>(string key)
+    {
+        var data = cache.GetString(Prefix + key);
+        return data == null ? default : JsonSerializer.Deserialize<T>(data);
+    }
+}

Helpers/SimApiJobWebAuth.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Linq;
+using System.Text;
+using Hangfire.Dashboard;
+using Microsoft.AspNetCore.Http;
+
+namespace SimApi.Helpers;
+
+public class SimApiJobWebAuth(string user, string pass) : IDashboardAuthorizationFilter
+{
+    public bool Authorize(DashboardContext context)
+    {
+        var httpContext = context.GetHttpContext();
+        var authHeader = httpContext.Request.Headers["Authorization"].FirstOrDefault();
+        if (authHeader != null && authHeader.StartsWith("Basic "))
+        {
+            var encodedUsernamePassword = authHeader.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries)[1]?.Trim();
+            var decodedUsernamePassword = Encoding.UTF8.GetString(Convert.FromBase64String(encodedUsernamePassword));
+            var username = decodedUsernamePassword.Split(':', 2)[0];
+            var password = decodedUsernamePassword.Split(':', 2)[1];
+
+            if (username == user && password == pass)
+            {
+                return true;
+            }
+        }
+
+        httpContext.Response.StatusCode = 401;
+        httpContext.Response.Headers.WWWAuthenticate = "Basic realm=\"SimApiBasicAuth\"";
+        httpContext.Response.WriteAsync("").Wait();
+        return false;
+    }
+}

Helpers/SimApiResponseFilter.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Linq;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Filters;
+using SimApi.Attributes;
+using SimApi.Communications;
+
+namespace SimApi.Helpers;
+
+public class SimApiResponseFilter : IResultFilter
+{
+    public void OnResultExecuting(ResultExecutingContext context)
+    {
+        if (context.ActionDescriptor.EndpointMetadata.Any(meta => meta is OriginResponseAttribute))
+        {
+            return;
+        }
+
+        context.Result = context.Result switch
+        {
+            // 检查结果是否为 null
+            null => new OkObjectResult(new SimApiBaseResponse()),
+            ObjectResult { Value: SimApiBaseResponse simApiBaseResponse } =>
+                new OkObjectResult(simApiBaseResponse),
+            ObjectResult objectResult => new OkObjectResult(new SimApiBaseResponse<object>(objectResult.Value!)),
+            EmptyResult => new OkObjectResult(new SimApiBaseResponse()),
+            _ => context.Result
+        };
+    }
+
+    public void OnResultExecuted(ResultExecutedContext context)
+    {
+    }
+}

Middlewares/SimApiExceptionMiddleware.cs

@@ -1,5 +1,5 @@
 using System;
-using System.Linq;
+using System.IO;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using SimApi.Communications;
@@ -27,12 +27,11 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
             switch (context.Response.StatusCode)
             {
                 case 200:
-                    break;
-                case 404:
-                    throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
                 case 301:
                 case 302:
                     break;
+                case 404:
+                    throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
                 default:
                     throw new SimApiException(context.Response.StatusCode);
             }
@@ -42,7 +41,6 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
             response = string.IsNullOrEmpty(ex.Message)
                 ? new SimApiBaseResponse(ex.Code)
                 : new SimApiBaseResponse(ex.Code, ex.Message);
-
             ErrorResponse(context, response);
         }
         catch (Exception ex)
@@ -61,9 +59,8 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
     /// <param name="response"></param>
     private static void ErrorResponse(HttpContext context, SimApiBaseResponse response)
     {
-        if (context.Response.HasStarted) return;
         context.Response.StatusCode = 200;
         context.Response.Headers.Append("Content-Type", "application/json");
-        context.Response.WriteAsync(response.ToString());
+        context.Response.WriteAsync(response.ToString()).Wait();
     }
 }

SimApi.csproj

@@ -19,16 +19,18 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <Folder Include="Helpers\"/>
         <Folder Include="Communications\"/>
-        <Folder Include="Middlewares\"/>
         <Folder Include="Exceptions\"/>
     </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="Minio" Version="6.0.3" />
-        <PackageReference Include="MQTTnet" Version="4.3.6.1152" />
-        <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.7.1" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.7.1" />
+        <PackageReference Include="Hangfire.AspNetCore" Version="1.8.17" />
+        <PackageReference Include="Hangfire.Console" Version="1.4.3" />
+        <PackageReference Include="Hangfire.Redis.StackExchange" Version="1.9.4" />
+        <PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.1" />
+        <PackageReference Include="Minio" Version="6.0.4" />
+        <PackageReference Include="MQTTnet" Version="5.0.1.1416" />
+        <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="7.2.0" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="7.2.0" />
     </ItemGroup>
     <ProjectExtensions>
         <MonoDevelop>

SimApiExtensions.cs

@@ -1,4 +1,11 @@
 using System;
+using System.Diagnostics;
+using System.Linq;
+using System.Reflection;
+using System.Text.Json;
+using Hangfire;
+using Hangfire.Console;
+using Hangfire.Redis.StackExchange;
 using SimApi.Helpers;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
@@ -7,6 +14,7 @@ using SimApi.Middlewares;
 using Microsoft.AspNetCore.HttpOverrides;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using SimApi.Attributes;
 using SimApi.CoceSdk;
 using SimApi.Configurations;
 using SimApi.Logger;
@@ -24,6 +32,12 @@ public static class SimApiExtensions
     {
         var simApiOptions = new SimApiOptions();
         options?.Invoke(simApiOptions);
+        if (simApiOptions.RedisConfiguration != null)
+        {
+            builder.AddStackExchangeRedisCache(x => x.Configuration = simApiOptions.RedisConfiguration);
+            builder.AddSingleton<SimApiCache>();
+        }
+
         if (simApiOptions.EnableLogger)
         {
             builder.AddLogging(logger =>
@@ -44,6 +58,30 @@ public static class SimApiExtensions
             builder.AddSingleton<CoceApp>();
         }
 
+        if (simApiOptions.EnableJob)
+        {
+            builder.AddHangfire(x =>
+            {
+                var redisOption = new RedisStorageOptions();
+                if (simApiOptions.SimApiJobOptions.Database.HasValue)
+                {
+                    redisOption.Db = simApiOptions.SimApiJobOptions.Database.Value;
+                }
+
+                x.UseRedisStorage(simApiOptions.SimApiJobOptions.RedisConfiguration ??
+                                  simApiOptions.RedisConfiguration, redisOption);
+                x.UseConsole();
+            });
+            foreach (var server in simApiOptions.SimApiJobOptions.Servers)
+            {
+                builder.AddHangfireServer(hfs =>
+                {
+                    hfs.Queues = server.Queues;
+                    hfs.WorkerCount = server.WorkerNum;
+                });
+            }
+        }
+
         if (simApiOptions.EnableCors)
         {
             builder.AddCors(cors => cors.AddPolicy("any",
@@ -53,6 +91,19 @@ public static class SimApiExtensions
         if (simApiOptions.EnableSynapse)
         {
             builder.AddSingleton<Synapse>();
+            //自动依赖注入
+            var stackTrace = new StackTrace();
+            var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1)?.GetMethod();
+            var assembly = callingMethod?.DeclaringType?.Assembly;
+            var types = assembly?.GetTypes() ?? [];
+            foreach (var type in types)
+            {
+                var methodsWithSynapse = type.GetMethods()
+                    .Where(m => m.GetCustomAttribute<SynapseRpcAttribute>() != null ||
+                                m.GetCustomAttribute<SynapseEventAttribute>() != null);
+                if (!methodsWithSynapse.Any()) continue;
+                builder.AddScoped(type);
+            }
         }
 
         // 使用SimApiDoc
@@ -192,6 +243,12 @@ public static class SimApiExtensions
             builder.AddSingleton<SimApiStorage>();
         }
 
+        if (simApiOptions.EnableSimApiResponseFilter)
+        {
+            builder.AddControllers(opt => opt.Filters.Add<SimApiResponseFilter>())
+                .AddJsonOptions(opt => opt.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase);
+        }
+
         builder.AddSingleton(simApiOptions);
         return builder;
     }
@@ -204,6 +261,11 @@ public static class SimApiExtensions
 
         logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
 
+        if (options.RedisConfiguration != null)
+        {
+            logger.LogInformation("开始配置 RedisCache ...");
+        }
+
         //请求一下检测存储错误
         if (options.EnableSimApiStorage)
         {
@@ -218,17 +280,17 @@ public static class SimApiExtensions
                 options.CoceSdkOptions.AppId);
         }
 
-        if (options.EnableLowerUrl)
-        {
-            logger.LogInformation("开始配置使用URL小写...");
-        }
-
         if (options.EnableSynapse)
         {
             var synapse = builder.Services.GetRequiredService<Synapse>();
             synapse.Init();
         }
 
+        if (options.EnableJob)
+        {
+            logger.LogInformation("开始配置 SimApiJob ...");
+        }
+
         return builder;
     }
 
@@ -240,10 +302,8 @@ public static class SimApiExtensions
     public static WebApplication UseSimApi(this WebApplication builder)
     {
         var options = builder.Services.GetRequiredService<SimApiOptions>();
-
         var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
-
-        logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
+        UseSimApi((IHost)builder);
         if (options.EnableForwardHeaders)
         {
             logger.LogInformation("开始配置ForwardedHeaders...");
@@ -256,6 +316,11 @@ public static class SimApiExtensions
             builder.UseCors("any");
         }
 
+        if (options.EnableSimApiResponseFilter)
+        {
+            logger.LogInformation("开始配置SimApiResponseFilter...");
+        }
+
         if (options.EnableSimApiAuth)
         {
             logger.LogInformation("开始配置SimApiAuth...");
@@ -304,22 +369,22 @@ public static class SimApiExtensions
             builder.UseMiddleware<SimApiExceptionMiddleware>();
         }
 
-        //请求一下检测存储错误
-        if (options.EnableSimApiStorage)
-        {
-            logger.LogInformation("开始配置SimApiStorage...");
-            builder.Services.GetService<SimApiStorage>();
-        }
-
         if (options.EnableLowerUrl)
         {
             logger.LogInformation("开始配置使用URL小写...");
         }
 
-        if (options.EnableSynapse)
+        if (options is { EnableJob: true, SimApiJobOptions.DashboardUrl: not null })
         {
-            var synapse = builder.Services.GetRequiredService<Synapse>();
-            synapse.Init();
+            logger.LogInformation("开始配置 SimApiJob Web控制台...");
+            builder.UseHangfireDashboard(options.SimApiJobOptions.DashboardUrl, new DashboardOptions
+            {
+                Authorization =
+                [
+                    new SimApiJobWebAuth(options.SimApiJobOptions.DashboardAuthUser,
+                        options.SimApiJobOptions.DashboardAuthPass)
+                ]
+            });
         }
 
         return builder;

Synapse/Synapse.cs

@@ -8,7 +8,6 @@ using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using MQTTnet;
-using MQTTnet.Client;
 using MQTTnet.Formatter;
 using SimApi.Attributes;
 using SimApi.Communications;
@@ -22,7 +21,7 @@ public partial class Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logge
 {
     private SimApiSynapseOptions Options { get; } = simApiOptions.SimApiSynapseOptions;
 
-    private MqttFactory MqttFactory { get; } = new();
+    private MqttClientFactory MqttFactory { get; } = new();
     public IMqttClient? Client { get; set; }
 
     private List<RegisterItem> EventRegistry { get; set; } = new();