根据数据源自定义字段实现动态导出Excel

前言

　　最近遇到了一个需求，需要导出各种订单数据，可能是因为懒吧，不想重新写查询然后导出数据；就有了下边的这些操作了。

具体实现方式

　　1），定义一个泛型类来接收我们要导出的数据源，（需要EPPlus包）代码如下：

　　　　  /// <summary>
        /// 传入数据，返回Excel流文件
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="TSources">数据源</param>
        /// <param name="sheetName">sheet名字</param>
        /// <returns></returns>
        private async Task<MemoryStream> GetExcelMemoryStreams<T>(List<T> TSources, string sheetName = "sheet1")
        {
            return await Task.Run(() =>
            {
                MemoryStream ms = new MemoryStream();
                if (TSources.Any())
                {
                    using (ExcelPackage package = new ExcelPackage())
                    {
                        ExcelWorksheet sheet = package.Workbook.Worksheets.Add(sheetName);


                        //获取传进来的类型
                        Type type = typeof(T);
                        var propertiesList = type.GetProperties();

                        for (int row = 1; row <= TSources.Count() + 1; row++)
                        {
                            var index = 0;
                            for (int cl = 1; cl <= propertiesList.Length; cl++)
                            {
                                //获取备注名字
                                var displayName = propertiesList[cl - 1].GetExportExcelDisplayName();
                                //判断字段是否有自定义属性（ExportExcelColumnAttribute）
                                if (displayName != "false")
                                {
                                    index++;
                                    if (row == 1) //设置表头
                                        sheet.Cells[row, index].Value = displayName;
                                    else
                                    {
                                        //获取字段名字
                                        var Name = propertiesList[cl - 1].Name;
                                        //获取对应的值
                                        var value = TSources[row - 2].GetType().GetProperty(Name)?.GetValue(TSources[row - 2])?.ToString();
                                        sheet.Cells[row, index].Value = value;
                                    }
                                }
                            }
                        }

                        //设置Excel列宽
                        sheet.Cells.AutoFitColumns(1.5);

                        package.SaveAs(ms);
                        ms.Position = 0;
                    }
                }
                else
                    throw new UserFriendlyException($"{sheetName}暂无数据！");

                return ms;
            });
        }

　　2），定义实体属性标识导出列，代码如下：

/// <summary>
    /// Excel导出用
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]//标记只能用在属性上面
    public class ExportExcelColumnAttribute : Attribute
    {
        private string _Name = null;

        /// <summary>
        /// 构造涵数传入值 
        /// </summary>
        /// <param name="Name"></param>
        public ExportExcelColumnAttribute(string Name)
        {
            this._Name = Name;
        }

        public string GetDisplayName()
        {
            return _Name;
        }
    }

　　3），定义获取该属性的备注名（Excel导出列名）方法，代码如下：

        /// <summary>
        /// 获取属性设置的导出备注
        /// </summary>
        /// <param name="prop"></param>
        /// <returns></returns>
        public static string GetExportExcelDisplayName(this PropertyInfo prop)
        {
            if (prop.IsDefined(typeof(ExportExcelColumnAttribute), true))
            {
                ExportExcelColumnAttribute attribute = (ExportExcelColumnAttribute)prop.GetCustomAttribute(typeof(ExportExcelColumnAttribute), true);
                return attribute.GetDisplayName();
            }
            else
            {
                return "false";
            }
        }

　　4），在实体上标注要导出的字段

public class GetServerOrderListDto : NullableIdDto<long>
    {
        /// <summary>
        /// 订单编号
        /// </summary> 
        [ExportExcelColumn("订单编号")]
        public string OrdernNumber { get; set; }

        /// <summary>
        /// 赠购单id
        /// </summary>
        public long? OrderID { get; set; }

        /// <summary>
        /// 赠送单号
        /// </summary>
        [ExportExcelColumn("赠送单号")]
        public string ComplimentaryOrderNumber { get; set; }
        /// <summary>
        /// 收费单号
        /// </summary>
        [ExportExcelColumn("收费单号")]
        public string AdditionalOrdernNumber { get; set; }

        /// <summary>
        /// 客户名称
        /// </summary>
        [ExportExcelColumn("客户名称")]
        public string CompanyName { get; set; }
}       

　　5），接口服务调用：

 　　6）.控制器需要将返回的内存流转化为文件流（FileStreamResult）返回到前端响应。

　　 7）.前端js代码

//点击导出按钮
            $("#export_excel").click(function () {
                var input = {
                   ....
                };
                
                const req = new XMLHttpRequest();
                req.open('Post', '你的请求地址', true);
                req.responseType = 'blob';
                req.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
                req.onload = function () {
                    const data = req.response;
                    const blob = new Blob([data]);
                    let blobUrl = window.URL.createObjectURL(blob);
                    download(blobUrl, "你要导出的文件名");
                };
                var str = "";
                var keys = Object.keys(input);
                $.each(keys, function (idx, val) {
                    str += `&${val}=${input[val]}`;
                });
                console.log(str.substring(1, str.length))
                req.send(str);
            });

            function download(blobUrl,fileName) {
                const a = document.createElement('a');
                a.style.display = 'none';
                a.download = fileName;
                a.href = blobUrl;
                a.click();
                document.body.removeChild(a);
            }    

　　

温馨提示

　　a），上述第34行 index 作用主要是防止出现空白列，（实体列中不标识某列导出时(如上述实体 赠送订单ID)，会显示空白列的问题：如下图情况：）；

　　b），导出列会比较窄，我们需要设置自适应宽度： sheet.Cells.AutoFitColumns(1.5); 调整列宽；

　　c），返回的内存流 MemoryStream 返回的时候需要将位置至为0（代码中：ms.Position = 0;）；因为Read()方法是从当前流的Position属性的位置开始读，这就是为什么很多人测试的时候，刚刚写入内存的数据，Read()方法无法读取到内容的原因，因为刚刚写入内存之后，位置恰好是在最后一位了。Read()方法当然读不到。此方法强大之处在于，你可以从一个内存流中读出你想要的一个片段。

　　d），using块的 ExcelPackage对象不需要手动释放，因为他继承了IDisposable，在使用完之后会自动释放；如下图：

　　e），MemoryStream 是一个特例，MemoryStream中没有任何非托管资源，所以它的Dispose不调用也没关系；托管资源.Net会自动回收；