根據數據源自定義字段實現動態導出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會自動回收；