SysFileProviderService.cs 19 KB

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