library/simapi-net
1
0
Fork 0
Code Pull Requests Activity

add hangfire

Browse Source
This commit is contained in:
xrain
2025-01-16 22:05:59 +08:00
parent e53048a980
commit afea9c82bd
7 changed files with 172 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Configurations/SimApiJobOptions.cs
+22
View File
@@ -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
+16
View File
@@ -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
@@ -71,6 +78,10 @@ public class SimApiOptions
/// </summary>
public bool EnableSynapse { get; set; }
/// <summary>
/// 配置Job
/// </summary>
public SimApiJobOptions SimApiJobOptions { get; set; } = new();
/// <summary>
/// Swagger文档相关配置，需要启用 EnableSimApiDoc
@@ -103,4 +114,9 @@ public class SimApiOptions
{
options?.Invoke(SimApiStorageOptions);
}
public void ConfigureSimApiJob(Action<SimApiJobOptions>? options = null)
{
options?.Invoke(SimApiJobOptions);
}
}
Helpers/SimApiCache.cs
+32
View File
@@ -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
+33
View File
@@ -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;
}
}
SimApi.csproj
+8 -4
View File
@@ -23,10 +23,14 @@
<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
+59 -23
View File
@@ -3,6 +3,9 @@ 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;
@@ -29,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 =>
@@ -49,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",
@@ -228,6 +261,11 @@ public static class SimApiExtensions
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
if (options.RedisConfiguration != null)
{
logger.LogInformation("开始配置 RedisCache ...");
}
//请求一下检测存储错误
if (options.EnableSimApiStorage)
{
@@ -235,11 +273,6 @@ public static class SimApiExtensions
builder.Services.GetService<SimApiStorage>();
}
if (options.EnableSimApiResponseFilter)
{
logger.LogInformation("开始配置SimApiResponseFilter...");
}
if (options.EnableCoceSdk)
{
logger.LogInformation("开始配置CoceAppSdk...\nApi入口: {ApiUrl}\nAuth入口:{AuthUrl}n\nAppId: {AppId}",
@@ -247,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;
}
@@ -269,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...");
@@ -285,6 +316,11 @@ public static class SimApiExtensions
builder.UseCors("any");
}
if (options.EnableSimApiResponseFilter)
{
logger.LogInformation("开始配置SimApiResponseFilter...");
}
if (options.EnableSimApiAuth)
{
logger.LogInformation("开始配置SimApiAuth...");
@@ -333,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
+1 -2
View File
@@ -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();