!1460 增强Excel数据导入、模板导出功能

Merge pull request !1460 from 喵你个汪/jasondom-next

Admin.NET/Admin.NET.Core/Utils/BaseImportInput.cs

@@ -0,0 +1,27 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+//
+// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+//
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
+
+namespace Admin.NET.Core;
+
+/// <summary>
+/// 数据导入输入参数基类
+/// </summary>
+public class BaseImportInput
+{
+    /// <summary>
+    /// 记录Id
+    /// </summary>
+    [ImporterHeader(IsIgnore = true)]
+    [ExporterHeader(IsIgnore = true)]
+    public virtual long Id { get; set; }
+
+    /// <summary>
+    /// 错误信息
+    /// </summary>
+    [ImporterHeader(IsIgnore = true)]
+    [ExporterHeader("错误信息", ColumnIndex = 9999, IsBold = true, IsAutoFit = true)]
+    public virtual string Error { get; set; }
+}

Admin.NET/Admin.NET.Core/Utils/CommonUtil.cs

@@ -247,6 +247,34 @@ public static class CommonUtil
         }
         return res.Data;
     }
+    
+    /// <summary>
+    /// 导入数据Excel
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="file"></param>
+    /// <returns></returns>
+    public static async Task<List<T>> ImportExcelDataAsync<T>([Required] IFormFile file) where T : class, new()
+    {
+        var sysFileService = App.GetRequiredService<SysFileService>();
+        var newFile = await sysFileService.UploadFile(new FileUploadInput { File = file });
+        var filePath = Path.Combine(App.WebHostEnvironment.WebRootPath, newFile.FilePath!, newFile.Id + newFile.Suffix);
+
+        IImporter importer = new ExcelImporter();
+        var res = await importer.Import<T>(filePath);
+
+        // 删除文件
+        _ = sysFileService.DeleteFile(new DeleteFileInput { Id = newFile.Id });
+
+        if (res == null)
+            throw Oops.Oh("导入数据为空");
+        if (res.Exception != null)
+            throw Oops.Oh("导入异常:" + res.Exception);
+        if (res.TemplateErrors?.Count > 0)
+            throw Oops.Oh("模板异常:" + res.TemplateErrors.Select(x => $"[{x.RequireColumnName}]{x.Message}").Join("\n"));
+
+        return res.Data.ToList();
+    }
 
     // 例：List<Dm_ApplyDemo> ls = CommonUtil.ParseList<Dm_ApplyDemoInport, Dm_ApplyDemo>(importResult.Data);
     /// <summary>

Admin.NET/Admin.NET.Core/Utils/ExcelHelper.cs

@@ -0,0 +1,120 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+//
+// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+//
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
+
+using OfficeOpenXml;
+
+namespace Admin.NET.Core;
+
+public class ExcelHelper
+{
+    /// <summary>
+    /// 数据导入
+    /// </summary>
+    /// <param name="file"></param>
+    /// <param name="action"></param>
+    /// <returns></returns>
+    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()
+    {
+        try
+        {
+            var result = CommonUtil.ImportExcelDataAsync<IN>(file).Result ?? throw Oops.Oh("有效数据为空");
+
+            var tasks = new List<Task>();
+            action.Invoke(result, (storageable, pageItems, rows) =>
+            {
+                // 标记校验信息
+                tasks.Add(Task.Run(() =>
+                {
+                    if (storageable.TotalList.Any())
+                    {
+                        for (int i = 0; i < rows.Count; i++) pageItems[i].Id = rows[i].Id;
+
+                        for (int i = 0; i < storageable.TotalList.Count; i++)
+                            pageItems[i].Error = storageable.TotalList[i].StorageMessage;
+                    }
+                }));
+            });
+            
+            // 等待所有标记验证信息任务完成
+            Task.WhenAll(tasks).GetAwaiter().GetResult();
+
+            return ExportData(result);
+        }
+        catch (Exception ex)
+        {
+            App.HttpContext.Response.Headers["Content-Type"] = "application/json; charset=utf-8";
+            throw Oops.Oh(new AdminResult<object>
+            {
+                Code = 500,
+                Message = ex.Message,
+                Result = null,
+                Type = "error",
+                Extras = UnifyContext.Take(),
+                Time = DateTime.Now
+            }.ToJson());
+        }
+    }
+
+    /// <summary>
+    /// 导出Xlsx数据
+    /// </summary>
+    /// <param name="list"></param>
+    /// <param name="fileName"></param>
+    /// <returns></returns>
+    public static IActionResult ExportData(dynamic list, string fileName = "导入记录")
+    {
+        var exporter = new ExcelExporter();
+        var fs = new MemoryStream(exporter.ExportAsByteArray(list).GetAwaiter().GetResult());
+        return new XlsxFileResult(stream: fs, fileDownloadName: $"{fileName}-{DateTime.Now:yyyy-MM-dd_HHmmss}");
+    }
+
+    /// <summary>
+    /// 根据类型导出Xlsx模板
+    /// </summary>
+    /// <param name="list"></param>
+    /// <param name="filename"></param>
+    /// <param name="addListValidationFun"></param>
+    /// <returns></returns>
+    public static IActionResult ExportTemplate<T>(List<T> list, string filename = "导入模板", Func<ExcelWorksheet, PropertyInfo, IEnumerable<string>> addListValidationFun = null)
+    {
+        using var package = new ExcelPackage((ExportData(list, filename) as XlsxFileResult)!.Stream);
+        var worksheet = package.Workbook.Worksheets[0];
+        
+        foreach (var prop in typeof(T).GetProperties())
+        {
+            var propType = prop.PropertyType;
+            
+            var headerAttr = prop.GetCustomAttribute<ExporterHeaderAttribute>();
+            var isNullableEnum = propType.IsGenericType && propType.GetGenericTypeDefinition() == typeof(Nullable<>) && Nullable.GetUnderlyingType(propType).IsEnum();
+            if (isNullableEnum) propType = Nullable.GetUnderlyingType(propType);
+            if (headerAttr == null) continue;
+
+            // 获取列序号
+            var columnIndex = 0;
+            foreach (var item in worksheet.Cells[1, 1, 1, worksheet.Dimension.End.Column])
+                if (++columnIndex > 0 && item.Text.Equals(headerAttr.DisplayName)) break;
+            if (columnIndex <= 0) continue;
+            
+            // 优先从代理函数中获取下列列表，若为空且字段为枚举型，则填充枚举项为下列列表，否则不设置下列列表
+            var dataList = addListValidationFun?.Invoke(worksheet, prop)?.ToList();
+            if (dataList == null && propType.IsEnum()) dataList = propType.EnumToList()?.Select(it => it.Describe).ToList();
+            if (dataList != null) AddListValidation(columnIndex, dataList);
+        }
+
+        void AddListValidation(int columnIndex, List<string> dataList)
+        {
+            var validation = worksheet.DataValidations.AddListValidation(worksheet.Cells[2, columnIndex, 99999, columnIndex].Address);
+            dataList.ForEach(e => validation!.Formula.Values.Add(e));
+            validation.ShowErrorMessage = true;
+            validation.ErrorTitle = "无效输入";
+            validation.Error = "请从列表中选择一个有效的选项";
+        }
+        
+        package.Save();
+        package.Stream.Position = 0;
+        return new XlsxFileResult(stream: package.Stream, fileDownloadName: $"{filename}-{DateTime.Now:yyyy-MM-dd_HHmmss}");
+    }
+}

Admin.NET/Admin.NET.Core/Utils/XlsxFileResult.cs

@@ -0,0 +1,107 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+//
+// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+//
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
+
+namespace Admin.NET.Core;
+
+/// <summary>
+/// Excel文件ActionResult
+/// </summary>
+/// <typeparam name="T"></typeparam>
+public class XlsxFileResult<T> : XlsxFileResultBase where T : class, new()
+{
+    /// <summary>
+    ///
+    /// </summary>
+    /// <param name="data"></param>
+    /// <param name="fileDownloadName"></param>
+    public XlsxFileResult(ICollection<T> data, string fileDownloadName = null)
+    {
+        FileDownloadName = fileDownloadName;
+        Data = data;
+    }
+
+    public string FileDownloadName { get; }
+    public ICollection<T> Data { get; }
+
+    public override async Task ExecuteResultAsync(ActionContext context)
+    {
+        var exporter = new ExcelExporter();
+        var bytes = await exporter.ExportAsByteArray(Data);
+        var fs = new MemoryStream(bytes);
+        await DownloadExcelFileAsync(context, fs, FileDownloadName);
+    }
+}
+
+/// <summary>
+///
+/// </summary>
+public class XlsxFileResult : XlsxFileResultBase
+{
+    /// <summary>
+    ///
+    /// </summary>
+    /// <param name="stream"></param>
+    /// <param name="fileDownloadName"></param>
+    public XlsxFileResult(Stream stream, string fileDownloadName = null)
+    {
+        Stream = stream;
+        FileDownloadName = fileDownloadName;
+    }
+
+    /// <summary>
+    ///
+    /// </summary>
+    /// <param name="bytes"></param>
+    /// <param name="fileDownloadName"></param>
+
+    public XlsxFileResult(byte[] bytes, string fileDownloadName = null)
+    {
+        Stream = new MemoryStream(bytes);
+        FileDownloadName = fileDownloadName;
+    }
+
+
+    public Stream Stream { get; protected set; }
+    public string FileDownloadName { get; protected set; }
+
+
+    public async override Task ExecuteResultAsync(ActionContext context)
+    {
+        await DownloadExcelFileAsync(context, Stream, FileDownloadName);
+    }
+}
+
+/// <summary>
+/// 基类
+/// </summary>
+public class XlsxFileResultBase : ActionResult
+{
+    /// <summary>
+    /// 下载Excel文件
+    /// </summary>
+    /// <param name="context"></param>
+    /// <param name="stream"></param>
+    /// <param name="downloadFileName"></param>
+    /// <returns></returns>
+    protected virtual async Task DownloadExcelFileAsync(ActionContext context, Stream stream, string downloadFileName)
+    {
+        var response = context.HttpContext.Response;
+        response.ContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+
+        if (downloadFileName == null)
+        {
+            downloadFileName = Guid.NewGuid().ToString("N") + ".xlsx";
+        }
+
+        if (string.IsNullOrEmpty(Path.GetExtension(downloadFileName)))
+        {
+            downloadFileName += ".xlsx";
+        }
+
+        context.HttpContext.Response.Headers.Append("Content-Disposition", new[] { "attachment; filename=" +HttpUtility.UrlEncode(downloadFileName) });
+        await stream.CopyToAsync(context.HttpContext.Response.Body);
+    }
+}