SysFileProviderService.cs 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using OnceMi.AspNetCore.OSS;
  7. using Newtonsoft.Json;
  8. using Microsoft.Extensions.DependencyInjection;
  9. namespace Admin.NET.Core.Service;
  10. /// <summary>
  11. /// 系统文件存储提供者服务 🧩
  12. /// </summary>
  13. [ApiDescriptionSettings(Order = 411, Description = "文件存储提供者")]
  14. public class SysFileProviderService : IDynamicApiController, ITransient
  15. {
  16. private readonly UserManager _userManager;
  17. private readonly SqlSugarRepository<SysFileProvider> _sysFileProviderRep;
  18. private readonly SysCacheService _sysCacheService;
  19. private readonly IOSSServiceFactory _ossServiceFactory;
  20. private readonly IOSSServiceManager _ossServiceManager;
  21. private static readonly string CacheKey = "sys_file_provider";
  22. public SysFileProviderService(UserManager userManager,
  23. SqlSugarRepository<SysFileProvider> sysFileProviderRep,
  24. SysCacheService sysCacheService,
  25. IOSSServiceFactory ossServiceFactory,
  26. IOSSServiceManager ossServiceManager)
  27. {
  28. _userManager = userManager;
  29. _sysFileProviderRep = sysFileProviderRep;
  30. _sysCacheService = sysCacheService;
  31. _ossServiceFactory = ossServiceFactory;
  32. _ossServiceManager = ossServiceManager;
  33. }
  34. /// <summary>
  35. /// 获取文件存储提供者分页列表 🔖
  36. /// </summary>
  37. /// <param name="input"></param>
  38. /// <returns></returns>
  39. [DisplayName("获取文件存储提供者分页列表")]
  40. [NonAction]
  41. public async Task<SqlSugarPagedList<SysFileProvider>> GetFileProviderPage(PageFileProviderInput input)
  42. {
  43. return await _sysFileProviderRep.AsQueryable()
  44. .WhereIF(!string.IsNullOrWhiteSpace(input.Provider), u => u.Provider.Contains(input.Provider!))
  45. .WhereIF(!string.IsNullOrWhiteSpace(input.BucketName), u => u.BucketName.Contains(input.BucketName!))
  46. .WhereIF(input.IsEnable.HasValue, u => u.IsEnable == input.IsEnable)
  47. .OrderBy(u => u.OrderNo)
  48. .OrderBy(u => u.Id)
  49. .ToPagedListAsync(input.Page, input.PageSize);
  50. }
  51. /// <summary>
  52. /// 获取文件存储提供者列表 🔖
  53. /// </summary>
  54. /// <returns></returns>
  55. [DisplayName("获取文件存储提供者列表")]
  56. [NonAction]
  57. public async Task<List<SysFileProvider>> GetFileProviderList()
  58. {
  59. return await _sysFileProviderRep.AsQueryable()
  60. .Where(u => u.IsEnable == true)
  61. .OrderBy(u => u.OrderNo)
  62. .OrderBy(u => u.Id)
  63. .ToListAsync();
  64. }
  65. /// <summary>
  66. /// 增加文件存储提供者 🔖
  67. /// </summary>
  68. /// <param name="input"></param>
  69. /// <returns></returns>
  70. [ApiDescriptionSettings(Name = "Add"), HttpPost]
  71. [DisplayName("增加文件存储提供者")]
  72. [NonAction]
  73. public async Task AddFileProvider(AddFileProviderInput input)
  74. {
  75. // 验证输入参数
  76. if (input == null)
  77. throw Oops.Oh("输入参数不能为空").StatusCode(400);
  78. if (string.IsNullOrWhiteSpace(input.Provider))
  79. throw Oops.Oh("存储提供者不能为空").StatusCode(400);
  80. if (string.IsNullOrWhiteSpace(input.BucketName))
  81. throw Oops.Oh("存储桶名称不能为空").StatusCode(400);
  82. // 验证提供者类型
  83. if (!Enum.TryParse<OSSProvider>(input.Provider, true, out _))
  84. throw Oops.Oh($"不支持的存储提供者类型: {input.Provider}").StatusCode(400);
  85. var isExist = await _sysFileProviderRep.AsQueryable()
  86. .AnyAsync(u => u.Provider == input.Provider && u.BucketName == input.BucketName);
  87. if (isExist)
  88. throw Oops.Oh(ErrorCodeEnum.D1006).StatusCode(400);
  89. var fileProvider = input.Adapt<SysFileProvider>();
  90. // 验证配置完整性
  91. await ValidateProviderConfiguration(fileProvider);
  92. // 处理默认提供者逻辑
  93. await HandleDefaultProviderLogic(fileProvider);
  94. await _sysFileProviderRep.InsertAsync(fileProvider);
  95. // 清除缓存
  96. await ClearCache();
  97. // 清除OSS服务缓存
  98. _ossServiceManager?.ClearCache();
  99. }
  100. /// <summary>
  101. /// 更新文件存储提供者 🔖
  102. /// </summary>
  103. /// <param name="input"></param>
  104. /// <returns></returns>
  105. [ApiDescriptionSettings(Name = "Update"), HttpPost]
  106. [DisplayName("更新文件存储提供者")]
  107. [NonAction]
  108. public async Task UpdateFileProvider(UpdateFileProviderInput input)
  109. {
  110. // 验证输入参数
  111. if (input == null)
  112. throw Oops.Oh("输入参数不能为空").StatusCode(400);
  113. var isExist = await _sysFileProviderRep.AsQueryable()
  114. .AnyAsync(u => u.Provider == input.Provider && u.BucketName == input.BucketName && u.Id != input.Id);
  115. if (isExist)
  116. throw Oops.Oh(ErrorCodeEnum.D1006).StatusCode(400);
  117. var fileProvider = input.Adapt<SysFileProvider>();
  118. // 验证配置完整性
  119. await ValidateProviderConfiguration(fileProvider);
  120. // 处理默认提供者逻辑
  121. await HandleDefaultProviderLogic(fileProvider);
  122. await _sysFileProviderRep.AsUpdateable(fileProvider).IgnoreColumns(ignoreAllNullColumns: true).ExecuteCommandAsync();
  123. // 清除缓存
  124. await ClearCache();
  125. // 清除OSS服务缓存
  126. _ossServiceManager?.ClearCache();
  127. }
  128. /// <summary>
  129. /// 删除文件存储提供者 🔖
  130. /// </summary>
  131. /// <param name="input"></param>
  132. /// <returns></returns>
  133. [ApiDescriptionSettings(Name = "Delete"), HttpPost]
  134. [DisplayName("删除文件存储提供者")]
  135. [NonAction]
  136. public async Task DeleteFileProvider(DeleteFileProviderInput input)
  137. {
  138. // 检查是否为默认提供者
  139. var provider = await _sysFileProviderRep.GetByIdAsync(input.Id) ?? throw Oops.Oh("存储提供者不存在").StatusCode(400);
  140. var isDefault = provider.IsDefault == true;
  141. await _sysFileProviderRep.DeleteByIdAsync(input.Id);
  142. // 如果删除的是默认提供者,自动设置第一个启用的提供者为默认
  143. if (isDefault)
  144. {
  145. var firstEnabledProvider = await _sysFileProviderRep.AsQueryable()
  146. .Where(p => p.IsEnable == true)
  147. .OrderBy(p => p.OrderNo)
  148. .OrderBy(p => p.Id)
  149. .FirstAsync();
  150. if (firstEnabledProvider != null)
  151. {
  152. await _sysFileProviderRep.AsUpdateable()
  153. .SetColumns(p => p.IsDefault == true)
  154. .Where(p => p.Id == firstEnabledProvider.Id)
  155. .ExecuteCommandAsync();
  156. Debug.WriteLine($"自动设置新的默认提供者: {firstEnabledProvider.DisplayName}");
  157. }
  158. }
  159. // 清除缓存
  160. await ClearCache();
  161. // 清除OSS服务缓存
  162. _ossServiceManager?.ClearCache();
  163. }
  164. /// <summary>
  165. /// 获取文件存储提供者详情 🔖
  166. /// </summary>
  167. /// <param name="input"></param>
  168. /// <returns></returns>
  169. [DisplayName("获取文件存储提供者详情")]
  170. [NonAction]
  171. public async Task<SysFileProvider> GetFileProvider([FromQuery] QueryFileProviderInput input)
  172. {
  173. return await _sysFileProviderRep.GetFirstAsync(u => u.Id == input.Id);
  174. }
  175. /// <summary>
  176. /// 根据提供者和存储桶获取配置
  177. /// </summary>
  178. /// <param name="provider"></param>
  179. /// <param name="bucketName"></param>
  180. /// <returns></returns>
  181. [NonAction]
  182. public async Task<SysFileProvider?> GetFileProviderByBucket(string provider, string bucketName)
  183. {
  184. var providers = await GetCachedFileProviders();
  185. return providers.FirstOrDefault(x => x.Provider == provider && x.BucketName == bucketName && x.IsEnable == true);
  186. }
  187. /// <summary>
  188. /// 根据ID获取配置
  189. /// </summary>
  190. /// <param name="id"></param>
  191. /// <returns></returns>
  192. [NonAction]
  193. public async Task<SysFileProvider?> GetFileProviderById(long id)
  194. {
  195. var providers = await GetCachedFileProviders();
  196. return providers.FirstOrDefault(x => x.Id == id && x.IsEnable == true);
  197. }
  198. /// <summary>
  199. /// 根据存储桶名称获取存储提供者
  200. /// </summary>
  201. /// <param name="bucketName">存储桶名称</param>
  202. /// <returns></returns>
  203. [NonAction]
  204. public async Task<SysFileProvider?> GetProviderByBucketName(string bucketName)
  205. {
  206. if (string.IsNullOrWhiteSpace(bucketName))
  207. return null;
  208. var providers = await GetCachedFileProviders();
  209. return providers.FirstOrDefault(p => p.BucketName == bucketName);
  210. }
  211. /// <summary>
  212. /// 获取默认存储提供者
  213. /// </summary>
  214. /// <returns></returns>
  215. [NonAction]
  216. public async Task<SysFileProvider?> GetDefaultProvider()
  217. {
  218. var providers = await GetCachedFileProviders();
  219. // 优先返回标记为默认的提供者
  220. var defaultProvider = providers.FirstOrDefault(p => p.IsDefault == true);
  221. if (defaultProvider != null)
  222. return defaultProvider;
  223. // 如果没有标记为默认的,返回第一个启用的提供者(兼容旧逻辑)
  224. return providers.FirstOrDefault();
  225. }
  226. /// <summary>
  227. /// 获取默认存储提供者信息 🔖
  228. /// </summary>
  229. /// <returns></returns>
  230. [DisplayName("获取默认存储提供者信息")]
  231. [NonAction]
  232. public async Task<SysFileProvider?> GetDefaultProviderInfo()
  233. {
  234. return await GetDefaultProvider();
  235. }
  236. /// <summary>
  237. /// 设置默认存储提供者 🔖
  238. /// </summary>
  239. /// <param name="input"></param>
  240. /// <returns></returns>
  241. [ApiDescriptionSettings(Name = "SetDefault"), HttpPost]
  242. [DisplayName("设置默认存储提供者")]
  243. [NonAction]
  244. public async Task SetDefaultProvider(SetDefaultProviderInput input)
  245. {
  246. // 验证提供者是否存在且启用
  247. var provider = await _sysFileProviderRep.GetByIdAsync(input.Id) ?? throw Oops.Oh("存储提供者不存在").StatusCode(400);
  248. if (provider.IsEnable != true)
  249. throw Oops.Oh("只能设置启用状态的存储提供者为默认").StatusCode(400);
  250. // 开启事务,确保数据一致性
  251. await _sysFileProviderRep.AsTenant().BeginTranAsync();
  252. try
  253. {
  254. // 先将所有提供者的默认标识设为false
  255. await _sysFileProviderRep.AsUpdateable()
  256. .SetColumns(p => p.IsDefault == false)
  257. .Where(p => p.IsDefault == true)
  258. .ExecuteCommandAsync();
  259. // 设置指定提供者为默认
  260. await _sysFileProviderRep.AsUpdateable()
  261. .SetColumns(p => p.IsDefault == true)
  262. .Where(p => p.Id == input.Id)
  263. .ExecuteCommandAsync();
  264. await _sysFileProviderRep.AsTenant().CommitTranAsync();
  265. // 清除缓存
  266. await ClearCache();
  267. // 清除OSS服务缓存
  268. _ossServiceManager?.ClearCache();
  269. Debug.WriteLine($"已设置默认存储提供者: {provider.DisplayName}");
  270. }
  271. catch (Exception)
  272. {
  273. await _sysFileProviderRep.AsTenant().RollbackTranAsync();
  274. throw;
  275. }
  276. }
  277. /// <summary>
  278. /// 获取缓存的文件提供者列表
  279. /// </summary>
  280. /// <returns></returns>
  281. [NonAction]
  282. public async Task<List<SysFileProvider>> GetCachedFileProviders()
  283. {
  284. return await _sysCacheService.AdGetAsync(CacheKey, async () =>
  285. {
  286. return await _sysFileProviderRep.AsQueryable()
  287. .Where(u => u.IsEnable == true)
  288. .OrderBy(u => u.OrderNo)
  289. .OrderBy(u => u.Id)
  290. .ToListAsync();
  291. }, TimeSpan.FromMinutes(30));
  292. }
  293. /// <summary>
  294. /// 清除缓存
  295. /// </summary>
  296. /// <returns></returns>
  297. [NonAction]
  298. public async Task ClearCache()
  299. {
  300. _sysCacheService.Remove(CacheKey);
  301. await Task.CompletedTask;
  302. }
  303. /// <summary>
  304. /// 获取所有可用的存储桶列表
  305. /// </summary>
  306. /// <returns></returns>
  307. [NonAction]
  308. public async Task<List<string>> GetAvailableBuckets()
  309. {
  310. var providers = await GetCachedFileProviders();
  311. return providers.Select(p => p.BucketName).Distinct().OrderBy(b => b).ToList();
  312. }
  313. /// <summary>
  314. /// 获取存储桶和提供者的映射关系
  315. /// </summary>
  316. /// <returns></returns>
  317. [NonAction]
  318. public async Task<Dictionary<string, List<SysFileProvider>>> GetBucketProviderMapping()
  319. {
  320. var providers = await GetCachedFileProviders();
  321. var mapping = new Dictionary<string, List<SysFileProvider>>();
  322. foreach (var provider in providers)
  323. {
  324. if (!mapping.TryGetValue(provider.BucketName, out List<SysFileProvider> value))
  325. {
  326. value = new List<SysFileProvider>();
  327. mapping[provider.BucketName] = value;
  328. }
  329. value.Add(provider);
  330. }
  331. return mapping;
  332. }
  333. /// <summary>
  334. /// 验证存储提供者配置
  335. /// </summary>
  336. /// <param name="provider">存储提供者配置</param>
  337. /// <returns></returns>
  338. [NonAction]
  339. private async Task ValidateProviderConfiguration(SysFileProvider provider)
  340. {
  341. if (provider == null)
  342. throw Oops.Oh("存储提供者配置不能为空").StatusCode(400);
  343. // 基础字段验证
  344. if (string.IsNullOrWhiteSpace(provider.Provider))
  345. throw Oops.Oh("存储提供者类型不能为空").StatusCode(400);
  346. if (string.IsNullOrWhiteSpace(provider.BucketName))
  347. throw Oops.Oh("存储桶名称不能为空").StatusCode(400);
  348. if (string.IsNullOrWhiteSpace(provider.Endpoint))
  349. throw Oops.Oh("端点地址不能为空").StatusCode(400);
  350. // 所有提供者都需要AccessKey和SecretKey
  351. if (string.IsNullOrWhiteSpace(provider.AccessKey))
  352. throw Oops.Oh($"{provider.Provider} AccessKey不能为空").StatusCode(400);
  353. if (string.IsNullOrWhiteSpace(provider.SecretKey))
  354. throw Oops.Oh($"{provider.Provider} SecretKey不能为空").StatusCode(400);
  355. // 根据不同提供者验证特定字段
  356. switch (provider.Provider.ToUpper())
  357. {
  358. case "ALIYUN":
  359. if (string.IsNullOrWhiteSpace(provider.Region))
  360. throw Oops.Oh("阿里云Region不能为空").StatusCode(400);
  361. break;
  362. case "QCLOUD":
  363. if (string.IsNullOrWhiteSpace(provider.Endpoint))
  364. throw Oops.Oh("腾讯云Endpoint(AppId)不能为空").StatusCode(400);
  365. if (string.IsNullOrWhiteSpace(provider.Region))
  366. throw Oops.Oh("腾讯云Region不能为空").StatusCode(400);
  367. break;
  368. case "MINIO":
  369. // Minio只需要AccessKey和SecretKey,已在上面验证
  370. break;
  371. default:
  372. throw Oops.Oh($"不支持的存储提供者类型: {provider.Provider}").StatusCode(400);
  373. }
  374. // 验证存储桶名称格式
  375. await ValidateBucketName(provider.Provider, provider.BucketName);
  376. }
  377. /// <summary>
  378. /// 验证存储桶名称格式
  379. /// </summary>
  380. /// <param name="provider">存储提供者类型</param>
  381. /// <param name="bucketName">存储桶名称</param>
  382. /// <returns></returns>
  383. [NonAction]
  384. private async Task ValidateBucketName(string provider, string bucketName)
  385. {
  386. if (string.IsNullOrWhiteSpace(bucketName))
  387. return;
  388. switch (provider.ToUpper())
  389. {
  390. case "ALIYUN":
  391. // 阿里云存储桶命名规则
  392. if (bucketName.Length < 3 || bucketName.Length > 63)
  393. throw Oops.Oh("阿里云存储桶名称长度必须在3-63字符之间").StatusCode(400);
  394. if (!Regex.IsMatch(bucketName, @"^[a-z0-9][a-z0-9\-]*[a-z0-9]$"))
  395. throw Oops.Oh("阿里云存储桶名称只能包含小写字母、数字和短横线,且必须以字母或数字开头和结尾").StatusCode(400);
  396. break;
  397. case "QCLOUD":
  398. // 腾讯云存储桶命名规则
  399. if (bucketName.Length < 1 || bucketName.Length > 40)
  400. throw Oops.Oh("腾讯云存储桶名称长度必须在1-40字符之间").StatusCode(400);
  401. if (!Regex.IsMatch(bucketName, @"^[a-z0-9][a-z0-9\-]*[a-z0-9]$"))
  402. throw Oops.Oh("腾讯云存储桶名称只能包含小写字母、数字和短横线,且必须以字母或数字开头和结尾").StatusCode(400);
  403. break;
  404. case "MINIO":
  405. // Minio存储桶命名规则
  406. if (bucketName.Length < 3 || bucketName.Length > 63)
  407. throw Oops.Oh("Minio存储桶名称长度必须在3-63字符之间").StatusCode(400);
  408. if (!Regex.IsMatch(bucketName, @"^[a-z0-9][a-z0-9\-\.]*[a-z0-9]$"))
  409. throw Oops.Oh("Minio存储桶名称只能包含小写字母、数字、短横线和点,且必须以字母或数字开头和结尾").StatusCode(400);
  410. break;
  411. }
  412. await Task.CompletedTask;
  413. }
  414. /// <summary>
  415. /// 处理默认提供者逻辑
  416. /// </summary>
  417. /// <param name="provider">存储提供者配置</param>
  418. /// <returns></returns>
  419. [NonAction]
  420. private async Task HandleDefaultProviderLogic(SysFileProvider provider)
  421. {
  422. // 如果设置为默认提供者
  423. if (provider.IsDefault == true)
  424. {
  425. // 确保只有一个默认提供者,将其他提供者的默认标识设为false
  426. await _sysFileProviderRep.AsUpdateable()
  427. .SetColumns(p => p.IsDefault == false)
  428. .Where(p => p.IsDefault == true && p.Id != provider.Id)
  429. .ExecuteCommandAsync();
  430. }
  431. else
  432. // 如果没有设置IsDefault值,默认为false
  433. {
  434. provider.IsDefault ??= false;
  435. }
  436. // 检查是否还有其他默认提供者,如果没有且当前提供者启用,则设为默认
  437. var hasDefaultProvider = await _sysFileProviderRep.AsQueryable()
  438. .Where(p => p.IsDefault == true && p.IsEnable == true && p.Id != provider.Id)
  439. .AnyAsync();
  440. if (!hasDefaultProvider && provider.IsEnable == true && provider.IsDefault != true)
  441. {
  442. // 如果没有其他默认提供者且当前提供者启用,则设为默认
  443. provider.IsDefault = true;
  444. }
  445. }
  446. }