ExcelHelper.cs 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using OfficeOpenXml;
  7. namespace Admin.NET.Core;
  8. public class ExcelHelper
  9. {
  10. /// <summary>
  11. /// 数据导入
  12. /// </summary>
  13. /// <param name="file"></param>
  14. /// <param name="action"></param>
  15. /// <returns></returns>
  16. public static IActionResult ImportData<IN, T>(IFormFile file, Action<List<IN>, Action<StorageableResult<T>, List<IN>, List<T>>> action) where IN : BaseImportInput, new() where T : EntityBaseId, new()
  17. {
  18. try
  19. {
  20. var result = CommonUtil.ImportExcelDataAsync<IN>(file).Result ?? throw Oops.Oh("有效数据为空");
  21. var tasks = new List<Task>();
  22. action.Invoke(result, (storageable, pageItems, rows) =>
  23. {
  24. // 标记校验信息
  25. tasks.Add(Task.Run(() =>
  26. {
  27. if (storageable.TotalList.Any())
  28. {
  29. for (int i = 0; i < rows.Count; i++) pageItems[i].Id = rows[i].Id;
  30. for (int i = 0; i < storageable.TotalList.Count; i++)
  31. pageItems[i].Error ??= storageable.TotalList[i].StorageMessage;
  32. }
  33. }));
  34. });
  35. // 等待所有标记验证信息任务完成
  36. Task.WhenAll(tasks).GetAwaiter().GetResult();
  37. return ExportData(result);
  38. }
  39. catch (Exception ex)
  40. {
  41. App.HttpContext.Response.Headers["Content-Type"] = "application/json; charset=utf-8";
  42. throw Oops.Oh(new AdminResult<object>
  43. {
  44. Code = 500,
  45. Message = ex.Message,
  46. Result = null,
  47. Type = "error",
  48. Extras = UnifyContext.Take(),
  49. Time = DateTime.Now
  50. }.ToJson());
  51. }
  52. }
  53. /// <summary>
  54. /// 导出Xlsx数据
  55. /// </summary>
  56. /// <param name="list"></param>
  57. /// <param name="fileName"></param>
  58. /// <returns></returns>
  59. public static IActionResult ExportData(dynamic list, string fileName = "导入记录")
  60. {
  61. var exporter = new ExcelExporter();
  62. var fs = new MemoryStream(exporter.ExportAsByteArray(list).GetAwaiter().GetResult());
  63. return new XlsxFileResult(stream: fs, fileDownloadName: $"{fileName}-{DateTime.Now:yyyy-MM-dd_HHmmss}");
  64. }
  65. /// <summary>
  66. /// 根据类型导出Xlsx模板
  67. /// </summary>
  68. /// <param name="list"></param>
  69. /// <param name="filename"></param>
  70. /// <param name="addListValidationFun"></param>
  71. /// <returns></returns>
  72. public static IActionResult ExportTemplate<T>(IEnumerable<T> list, string filename = "导入模板", Func<ExcelWorksheet, PropertyInfo, IEnumerable<string>> addListValidationFun = null)
  73. {
  74. using var package = new ExcelPackage((ExportData(list, filename) as XlsxFileResult)!.Stream);
  75. var worksheet = package.Workbook.Worksheets[0];
  76. foreach (var prop in typeof(T).GetProperties())
  77. {
  78. var propType = prop.PropertyType;
  79. var headerAttr = prop.GetCustomAttribute<ExporterHeaderAttribute>();
  80. var isNullableEnum = propType.IsGenericType && propType.GetGenericTypeDefinition() == typeof(Nullable<>) && Nullable.GetUnderlyingType(propType).IsEnum();
  81. if (isNullableEnum) propType = Nullable.GetUnderlyingType(propType);
  82. if (headerAttr == null) continue;
  83. // 获取列序号
  84. var columnIndex = 0;
  85. foreach (var item in worksheet.Cells[1, 1, 1, worksheet.Dimension.End.Column])
  86. if (++columnIndex > 0 && item.Text.Equals(headerAttr.DisplayName)) break;
  87. if (columnIndex <= 0) continue;
  88. // 优先从代理函数中获取下列列表,若为空且字段为枚举型,则填充枚举项为下列列表,若为字典字段,则填充字典值value列表为下列列表
  89. var dataList = addListValidationFun?.Invoke(worksheet, prop)?.ToList();
  90. if (dataList == null)
  91. {
  92. if (propType.IsEnum())
  93. {// 填充枚举项为下列列表
  94. dataList = propType.EnumToList()?.Select(it => it.Describe).ToList();
  95. }
  96. else
  97. {// 获取字段上的字典特性
  98. var dict = prop.GetCustomAttribute<DictAttribute>();
  99. if (dict != null)
  100. {// 填充字典值value为下列列表
  101. dataList = App.GetService<SysDictTypeService>().GetDataList(new GetDataDictTypeInput
  102. { Code = dict.DictTypeCode }).Result?.Select(x => x.Label).ToList();
  103. }
  104. }
  105. }
  106. if (dataList != null) AddListValidation(columnIndex, dataList);
  107. }
  108. void AddListValidation(int columnIndex, List<string> dataList)
  109. {
  110. var validation = worksheet.DataValidations.AddListValidation(worksheet.Cells[2, columnIndex, 99999, columnIndex].Address);
  111. dataList.ForEach(e => validation!.Formula.Values.Add(e));
  112. validation.ShowErrorMessage = true;
  113. validation.ErrorTitle = "无效输入";
  114. validation.Error = "请从列表中选择一个有效的选项";
  115. }
  116. package.Save();
  117. package.Stream.Position = 0;
  118. return new XlsxFileResult(stream: package.Stream, fileDownloadName: $"{filename}-{DateTime.Now:yyyy-MM-dd_HHmmss}");
  119. }
  120. }