SysFileService.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using Aliyun.OSS.Util;
  7. using Furion.AspNetCore;
  8. using Microsoft.AspNetCore.Mvc.ModelBinding;
  9. namespace Admin.NET.Core.Service;
  10. /// <summary>
  11. /// 系统文件服务 🧩
  12. /// </summary>
  13. [ApiDescriptionSettings(Order = 410, Description = "系统文件")]
  14. public class SysFileService : IDynamicApiController, ITransient
  15. {
  16. private readonly UserManager _userManager;
  17. private readonly SqlSugarRepository<SysFile> _sysFileRep;
  18. private readonly OSSProviderOptions _OSSProviderOptions;
  19. private readonly UploadOptions _uploadOptions;
  20. private readonly IConfiguration _configuration;
  21. private readonly string _imageType = ".jpeg.jpg.png.bmp.gif.tif";
  22. private readonly INamedServiceProvider<ICustomFileProvider> _namedServiceProvider;
  23. private readonly ICustomFileProvider _customFileProvider;
  24. public SysFileService(UserManager userManager,
  25. SqlSugarRepository<SysFile> sysFileRep,
  26. IOptions<OSSProviderOptions> oSSProviderOptions,
  27. IOptions<UploadOptions> uploadOptions,
  28. INamedServiceProvider<ICustomFileProvider> namedServiceProvider,
  29. IConfiguration configuration)
  30. {
  31. _namedServiceProvider = namedServiceProvider;
  32. _userManager = userManager;
  33. _sysFileRep = sysFileRep;
  34. _OSSProviderOptions = oSSProviderOptions.Value;
  35. _uploadOptions = uploadOptions.Value;
  36. _configuration = configuration;
  37. // 简化提供者选择逻辑
  38. if (_OSSProviderOptions.Enabled || _configuration["MultiOSS:Enabled"].ToBoolean())
  39. {
  40. // 统一使用MultiOSSFileProvider处理所有OSS情况
  41. _customFileProvider = _namedServiceProvider.GetService<ITransient>(nameof(MultiOSSFileProvider));
  42. }
  43. else if (_configuration["SSHProvider:Enabled"].ToBoolean())
  44. {
  45. _customFileProvider = _namedServiceProvider.GetService<ITransient>(nameof(SSHFileProvider));
  46. }
  47. else
  48. {
  49. _customFileProvider = _namedServiceProvider.GetService<ITransient>(nameof(DefaultFileProvider));
  50. }
  51. }
  52. /// <summary>
  53. /// 获取文件分页列表 🔖
  54. /// </summary>
  55. /// <param name="input"></param>
  56. /// <returns></returns>
  57. [DisplayName("获取文件分页列表")]
  58. public async Task<SqlSugarPagedList<SysFile>> Page(PageFileInput input)
  59. {
  60. // 获取所有公开附件
  61. var publicList = _sysFileRep.AsQueryable().ClearFilter().Where(u => u.IsPublic == true);
  62. // 获取私有附件
  63. var privateList = _sysFileRep.AsQueryable().Where(u => u.IsPublic == false);
  64. // 合并公开和私有附件并分页
  65. return await _sysFileRep.Context.UnionAll(publicList, privateList)
  66. .WhereIF(!string.IsNullOrWhiteSpace(input.FileName), u => u.FileName.Contains(input.FileName.Trim()))
  67. .WhereIF(!string.IsNullOrWhiteSpace(input.FilePath), u => u.FilePath.Contains(input.FilePath.Trim()))
  68. .WhereIF(!string.IsNullOrWhiteSpace(input.StartTime.ToString()) && !string.IsNullOrWhiteSpace(input.EndTime.ToString()),
  69. u => u.CreateTime >= input.StartTime && u.CreateTime <= input.EndTime)
  70. .OrderBy(u => u.CreateTime, OrderByType.Desc)
  71. .ToPagedListAsync(input.Page, input.PageSize);
  72. }
  73. /// <summary>
  74. /// 上传文件Base64 🔖
  75. /// </summary>
  76. /// <param name="input"></param>
  77. /// <returns></returns>
  78. [DisplayName("上传文件Base64")]
  79. public async Task<SysFile> UploadFileFromBase64(UploadFileFromBase64Input input)
  80. {
  81. var pattern = @"data:(?<type>.+?);base64,(?<data>[^""]+)";
  82. var regex = new Regex(pattern, RegexOptions.Compiled);
  83. var match = regex.Match(input.FileDataBase64);
  84. byte[] fileData = Convert.FromBase64String(match.Groups["data"].Value);
  85. var contentType = match.Groups["type"].Value;
  86. if (string.IsNullOrEmpty(input.FileName))
  87. input.FileName = $"{YitIdHelper.NextId()}.{contentType.AsSpan(contentType.LastIndexOf('/') + 1)}";
  88. using var ms = new MemoryStream();
  89. ms.Write(fileData);
  90. ms.Seek(0, SeekOrigin.Begin);
  91. IFormFile formFile = new FormFile(ms, 0, fileData.Length, "file", input.FileName)
  92. {
  93. Headers = new HeaderDictionary(),
  94. ContentType = contentType
  95. };
  96. var uploadFileInput = input.Adapt<UploadFileInput>();
  97. uploadFileInput.File = formFile;
  98. return await UploadFile(uploadFileInput);
  99. }
  100. /// <summary>
  101. /// 上传多文件 🔖
  102. /// </summary>
  103. /// <param name="files"></param>
  104. /// <returns></returns>
  105. [DisplayName("上传多文件")]
  106. public async Task<List<SysFile>> UploadFiles([Required] List<IFormFile> files)
  107. {
  108. var fileList = new List<SysFile>();
  109. foreach (var file in files)
  110. {
  111. var uploadedFile = await UploadFile(new UploadFileInput { File = file });
  112. fileList.Add(uploadedFile);
  113. }
  114. return fileList;
  115. }
  116. /// <summary>
  117. /// 根据文件Id或Url下载 🔖
  118. /// </summary>
  119. /// <param name="input"></param>
  120. /// <returns></returns>
  121. [DisplayName("根据文件Id或Url下载")]
  122. public async Task<IActionResult> DownloadFile(SysFile input)
  123. {
  124. var file = input.Id > 0 ? await GetFile(input.Id) : await _sysFileRep.CopyNew().GetFirstAsync(u => u.Url == input.Url);
  125. var fileName = HttpUtility.UrlEncode(file.FileName, Encoding.GetEncoding("UTF-8"));
  126. return await GetFileStreamResult(file, fileName);
  127. }
  128. /// <summary>
  129. /// 文件预览 🔖
  130. /// </summary>
  131. /// <param name="id"></param>
  132. /// <returns></returns>
  133. [DisplayName("文件预览")]
  134. public async Task<IActionResult> GetPreview([FromRoute] long id)
  135. {
  136. var file = await GetFile(id);
  137. //var fileName = HttpUtility.UrlEncode(file.FileName, Encoding.GetEncoding("UTF-8"));
  138. return await GetFileStreamResult(file, file.Id + "");
  139. }
  140. /// <summary>
  141. /// 获取文件流
  142. /// </summary>
  143. /// <param name="file"></param>
  144. /// <param name="fileName"></param>
  145. /// <returns></returns>
  146. private async Task<IActionResult> GetFileStreamResult(SysFile file, string fileName)
  147. {
  148. return await _customFileProvider.GetFileStreamResultAsync(file, fileName);
  149. }
  150. /// <summary>
  151. /// 获取文件流
  152. /// </summary>
  153. [NonAction]
  154. public async Task<Stream> GetFileStream(SysFile file)
  155. {
  156. var fileName = HttpUtility.UrlEncode(file.FileName, Encoding.GetEncoding("UTF-8"));
  157. var result = await _customFileProvider.GetFileStreamResultAsync(file, fileName);
  158. return result.FileStream;
  159. }
  160. /// <summary>
  161. /// 下载指定文件Base64格式 🔖
  162. /// </summary>
  163. /// <param name="url"></param>
  164. /// <returns></returns>
  165. [DisplayName("下载指定文件Base64格式")]
  166. public async Task<string> DownloadFileBase64([FromBody] string url)
  167. {
  168. var sysFile = await _sysFileRep.CopyNew().GetFirstAsync(u => u.Url == url) ?? throw Oops.Oh($"文件不存在");
  169. return await _customFileProvider.DownloadFileBase64Async(sysFile);
  170. }
  171. /// <summary>
  172. /// 删除文件 🔖
  173. /// </summary>
  174. /// <param name="input"></param>
  175. /// <returns></returns>
  176. [ApiDescriptionSettings(Name = "Delete"), HttpPost]
  177. [DisplayName("删除文件")]
  178. public async Task DeleteFile(BaseIdInput input)
  179. {
  180. var file = await _sysFileRep.GetByIdAsync(input.Id) ?? throw Oops.Oh($"文件不存在");
  181. await _sysFileRep.DeleteAsync(file);
  182. await _customFileProvider.DeleteFileAsync(file);
  183. }
  184. /// <summary>
  185. /// 更新文件 🔖
  186. /// </summary>
  187. /// <param name="input"></param>
  188. /// <returns></returns>
  189. [ApiDescriptionSettings(Name = "Update"), HttpPost]
  190. [DisplayName("更新文件")]
  191. public async Task UpdateFile(SysFile input)
  192. {
  193. var isExist = await _sysFileRep.IsAnyAsync(u => u.Id == input.Id);
  194. if (!isExist) throw Oops.Oh(ErrorCodeEnum.D8000);
  195. await _sysFileRep.UpdateAsync(input);
  196. }
  197. /// <summary>
  198. /// 获取文件 🔖
  199. /// </summary>
  200. /// <param name="id"></param>
  201. /// <returns></returns>
  202. [DisplayName("获取文件")]
  203. public async Task<SysFile> GetFile([FromQuery] long id)
  204. {
  205. var file = await _sysFileRep.CopyNew().GetByIdAsync(id);
  206. return file ?? throw Oops.Oh(ErrorCodeEnum.D8000);
  207. }
  208. /// <summary>
  209. /// 根据文件Id集合获取文件 🔖
  210. /// </summary>
  211. /// <param name="ids"></param>
  212. /// <returns></returns>
  213. [DisplayName("根据文件Id集合获取文件")]
  214. public async Task<List<SysFile>> GetFileByIds([FromQuery][FlexibleArray<long>] List<long> ids)
  215. {
  216. return await _sysFileRep.AsQueryable().Where(u => ids.Contains(u.Id)).ToListAsync();
  217. }
  218. /// <summary>
  219. /// 获取文件路径 🔖
  220. /// </summary>
  221. /// <returns></returns>
  222. [DisplayName("获取文件路径")]
  223. public async Task<List<TreeNode>> GetFolder()
  224. {
  225. // 优化:直接在数据库层面获取不重复的文件路径
  226. var folders = await _sysFileRep.AsQueryable()
  227. .Select(u => u.FilePath)
  228. .Distinct()
  229. .ToListAsync();
  230. var pathTreeBuilder = new PathTreeBuilder();
  231. var tree = pathTreeBuilder.BuildTree(folders);
  232. return tree.Children;
  233. }
  234. /// <summary>
  235. /// 上传文件 🔖
  236. /// </summary>
  237. /// <param name="input"></param>
  238. /// <param name="targetPath">存储目标路径</param>
  239. /// <returns></returns>
  240. [DisplayName("上传文件")]
  241. public async Task<SysFile> UploadFile([FromForm] UploadFileInput input, [BindNever] string targetPath = "")
  242. {
  243. if (input.File == null || input.File.Length <= 0) throw Oops.Oh(ErrorCodeEnum.D8000);
  244. if (input.File.FileName.IndexOfAny(Path.GetInvalidFileNameChars()) >= 0) throw Oops.Oh(ErrorCodeEnum.D8005);
  245. // 判断是否重复上传的文件
  246. var sizeKb = input.File.Length / 1024; // 大小KB
  247. var fileMd5 = string.Empty;
  248. if (_uploadOptions.EnableMd5)
  249. {
  250. await using (var fileStream = input.File.OpenReadStream())
  251. {
  252. fileMd5 = OssUtils.ComputeContentMd5(fileStream, fileStream.Length);
  253. }
  254. // Mysql8 中如果使用了 utf8mb4_general_ci 之外的编码会出错,尽量避免在条件里使用.ToString()
  255. // 因为 Squsugar 并不是把变量转换为字符串来构造SQL语句,而是构造了CAST(123 AS CHAR)这样的语句,这样这个返回值是utf8mb4_general_ci,所以容易出错。
  256. var sysFile = await _sysFileRep.GetFirstAsync(u => u.FileMd5 == fileMd5 && u.SizeKb == sizeKb);
  257. if (sysFile != null) return sysFile;
  258. }
  259. // 验证文件类型
  260. if (!_uploadOptions.ContentType.Contains(input.File.ContentType)) throw Oops.Oh($"{ErrorCodeEnum.D8001}:{input.File.ContentType}");
  261. // 验证文件大小
  262. if (sizeKb > _uploadOptions.MaxSize) throw Oops.Oh($"{ErrorCodeEnum.D8002},允许最大:{_uploadOptions.MaxSize}KB");
  263. // 获取文件后缀
  264. var suffix = Path.GetExtension(input.File.FileName).ToLower(); // 后缀
  265. if (string.IsNullOrWhiteSpace(suffix))
  266. suffix = string.Concat(".", input.File.ContentType.AsSpan(input.File.ContentType.LastIndexOf('/') + 1));
  267. if (!string.IsNullOrWhiteSpace(suffix))
  268. {
  269. //var contentTypeProvider = FS.GetFileExtensionContentTypeProvider();
  270. //suffix = contentTypeProvider.Mappings.FirstOrDefault(u => u.Value == file.ContentType).Key;
  271. // 修改 image/jpeg 类型返回的 .jpeg、jpe 后缀
  272. if (suffix == ".jpeg" || suffix == ".jpe")
  273. suffix = ".jpg";
  274. }
  275. if (string.IsNullOrWhiteSpace(suffix)) throw Oops.Oh(ErrorCodeEnum.D8003);
  276. // 防止客户端伪造文件类型
  277. if (!string.IsNullOrWhiteSpace(input.AllowSuffix) && !input.AllowSuffix.Contains(suffix)) throw Oops.Oh(ErrorCodeEnum.D8003);
  278. //if (!VerifyFileExtensionName.IsSameType(file.OpenReadStream(), suffix)) throw Oops.Oh(ErrorCodeEnum.D8001);
  279. // 文件存储位置
  280. var path = string.IsNullOrWhiteSpace(targetPath) ? _uploadOptions.Path : targetPath;
  281. path = path.ParseToDateTimeForRep();
  282. var newFile = input.Adapt<SysFile>();
  283. newFile.Id = YitIdHelper.NextId();
  284. // 优先使用用户指定的存储桶名称,如果没有指定则使用默认配置
  285. if (!string.IsNullOrEmpty(input.BucketName))
  286. {
  287. newFile.BucketName = input.BucketName;
  288. }
  289. else
  290. {
  291. // MultiOSSFileProvider会自动使用默认配置
  292. newFile.BucketName = _OSSProviderOptions.Enabled ? _OSSProviderOptions.Bucket : "Local";
  293. }
  294. newFile.FileName = Path.GetFileNameWithoutExtension(input.File.FileName);
  295. newFile.Suffix = suffix;
  296. newFile.SizeKb = sizeKb;
  297. newFile.FilePath = path;
  298. newFile.FileMd5 = fileMd5;
  299. newFile.DataId = input.DataId;
  300. var finalName = newFile.Id + suffix; // 文件最终名称
  301. newFile = await _customFileProvider.UploadFileAsync(input.File, newFile, path, finalName);
  302. await _sysFileRep.AsInsertable(newFile).ExecuteCommandAsync();
  303. return newFile;
  304. }
  305. /// <summary>
  306. /// 上传头像 🔖
  307. /// </summary>
  308. /// <param name="file"></param>
  309. /// <returns></returns>
  310. [DisplayName("上传头像")]
  311. public async Task<SysFile> UploadAvatar([Required] IFormFile file)
  312. {
  313. var sysFile = await UploadFile(new UploadFileInput { File = file, AllowSuffix = _imageType }, "upload/avatar");
  314. var sysUserRep = _sysFileRep.ChangeRepository<SqlSugarRepository<SysUser>>();
  315. var user = await sysUserRep.GetByIdAsync(_userManager.UserId);
  316. await sysUserRep.UpdateAsync(u => new SysUser() { Avatar = sysFile.Url }, u => u.Id == user.Id);
  317. // 删除已有头像文件
  318. if (!string.IsNullOrWhiteSpace(user.Avatar))
  319. {
  320. var fileId = Path.GetFileNameWithoutExtension(user.Avatar);
  321. if (long.TryParse(fileId, out var id))
  322. {
  323. try
  324. {
  325. await DeleteFile(new BaseIdInput { Id = id });
  326. }
  327. catch
  328. {
  329. // 忽略删除旧头像文件的错误,不影响新头像上传
  330. }
  331. }
  332. }
  333. return sysFile;
  334. }
  335. /// <summary>
  336. /// 上传电子签名 🔖
  337. /// </summary>
  338. /// <param name="file"></param>
  339. /// <returns></returns>
  340. [DisplayName("上传电子签名")]
  341. public async Task<SysFile> UploadSignature([Required] IFormFile file)
  342. {
  343. var sysFile = await UploadFile(new UploadFileInput { File = file, AllowSuffix = _imageType }, "upload/signature");
  344. var sysUserRep = _sysFileRep.ChangeRepository<SqlSugarRepository<SysUser>>();
  345. var user = await sysUserRep.GetByIdAsync(_userManager.UserId);
  346. // 删除已有电子签名文件
  347. if (!string.IsNullOrWhiteSpace(user.Signature) && user.Signature.EndsWith(".png"))
  348. {
  349. var fileId = Path.GetFileNameWithoutExtension(user.Signature);
  350. if (long.TryParse(fileId, out var id))
  351. {
  352. try
  353. {
  354. await DeleteFile(new BaseIdInput { Id = id });
  355. }
  356. catch
  357. {
  358. // 忽略删除旧签名文件的错误,不影响新签名上传
  359. }
  360. }
  361. }
  362. await sysUserRep.UpdateAsync(u => new SysUser() { Signature = sysFile.Url }, u => u.Id == user.Id);
  363. return sysFile;
  364. }
  365. #region 统一实体与文件关联时,业务应用实体只需要定义一个SysFile集合导航属性,业务增加和更新、删除分别调用即可
  366. /// <summary>
  367. /// 更新文件的业务数据Id
  368. /// </summary>
  369. /// <param name="dataId"></param>
  370. /// <param name="sysFiles"></param>
  371. /// <returns></returns>
  372. [NonAction]
  373. public async Task UpdateFileByDataId(long dataId, List<SysFile> sysFiles)
  374. {
  375. var newFileIds = sysFiles.Select(u => u.Id).ToList();
  376. // 求文件Id差集并删除(无效文件)
  377. var tmpFiles = await _sysFileRep.GetListAsync(u => u.DataId == dataId);
  378. var tmpFileIds = tmpFiles.Select(u => u.Id).ToList();
  379. var deleteFileIds = tmpFileIds.Except(newFileIds);
  380. foreach (var fileId in deleteFileIds)
  381. await DeleteFile(new BaseIdInput() { Id = fileId });
  382. await _sysFileRep.UpdateAsync(u => new SysFile() { DataId = dataId }, u => newFileIds.Contains(u.Id));
  383. }
  384. /// <summary>
  385. /// 删除业务数据对应的文件
  386. /// </summary>
  387. /// <param name="dataId"></param>
  388. /// <returns></returns>
  389. [NonAction]
  390. public async Task DeleteFileByDataId(long dataId)
  391. {
  392. // 删除冗余无效的物理文件
  393. var tmpFiles = await _sysFileRep.GetListAsync(u => u.DataId == dataId);
  394. foreach (var file in tmpFiles)
  395. await _customFileProvider.DeleteFileAsync(file);
  396. await _sysFileRep.AsDeleteable().Where(u => u.DataId == dataId).ExecuteCommandAsync();
  397. }
  398. #endregion 统一实体与文件关联时,业务应用实体只需要定义一个SysFile集合导航属性,业务增加和更新、删除分别调用即可
  399. }