NPOI操作EXCEL（四）——反射机制批量导出excel文件

前面我们已经实现了反射机制进行excel表格数据的解析，既然有上传就得有下载，我们再来写一个通用的导出方法，利用反射机制实现对系统所有数据列表的筛选结果导出excel功能。

我们来构想一下这样一个画面，管理员筛选出北京的所有员工数据，想导出成excel表格；管理员筛选出北京所有欠费的企业数据，想导出成excel表格；管理员想导出本月的工单报表到excel表格；管理员想导出近3月北京各岗位的运营报表到excel表格......

系统客服真是个神奇的职业，神马都想导出到excel表格！

那么对于我们的程序来说，该怎么做呢！由于每个导出功能对应的数据源都不一样，简单的方法很难做到，只能每个业务单写一个导出功能。

所以，我们再次沿用导入时使用的xml文件配置做桥梁，通过反射技术做具体实现的方法，做一个通用的EXCEL导出工具：传入DTO数据集合与xml规则集，返回excel文件流。

1.我们创建一个xml文件，里面存放所有需要导出功能涉及字段的规则集（博主项目涉及到的导出功能也就10来个列表，约涉及100多个字段（这儿未全部列出），故未分开成多个xml规则文件）

 <?xml version="1.0" encoding="utf-8" ?>
 <module>
   <add ExportFieldName="姓名"                   PropertyName="Name"                                       DataType="System.String"/>
   <add ExportFieldName="手机号码"               PropertyName="PhoneNumber"                                DataType="System.String"/>
   <add ExportFieldName="性别"                   PropertyName="Sex"                                        DataType="System.String"/>
   <add ExportFieldName="民族"                   PropertyName="Nation"                                     DataType="System.String"/>
   <add ExportFieldName="出生日期"               PropertyName="Birthday"                                   DataType="System.String"/>
   <add ExportFieldName="身份证号码"             PropertyName="Cardid"                                     DataType="System.String"/>
 </module>

注：

1.导出的规则相对简单，所以我们创建一个简单的规则集类：

     /// <summary>
     /// 导出excel-中英文规则类
     /// </summary>
     public class ExportRegular
     {
         /// <summary>
         /// 属性名称（英文）
         /// </summary>
         public string PropertyName { get; set; }

         /// <summary>
         /// 数据类型
         /// </summary>
         public string DataType { get; set; }

         /// <summary>
         /// 导出名称（中文）
         /// </summary>
         public string ExportFieldName { get; set; }
     }

2.然后是解析XML规则集的方法

         /// <summary>
         /// 解析XML规则集文件
         /// </summary>
         /// <returns></returns>
         public static List<ExportRegular> GetExportRegulars()
         {
             var result = new List<ExportRegular>();

             var reader = new XmlTextReader(xmlpath);
             var doc = new XmlDocument();
             //从指定的XMLReader加载XML文档
             doc.Load(reader);

             foreach (XmlNode node in doc.DocumentElement.ChildNodes)
             {
                 var header = new ExportRegular();

                 if (node.Attributes["PropertyName"] != null)
                     header.PropertyName = node.Attributes["PropertyName"].Value;
                 if (node.Attributes["DataType"] != null)
                     header.DataType = node.Attributes["DataType"].Value;
                 if (node.Attributes["ExportFieldName"] != null)
                     header.ExportFieldName = node.Attributes["ExportFieldName"].Value;

                 result.Add(header);
             }

             return result;
         }

2.我们的excel导出工具对外暴露两个静态方法：

 public static MemoryStream CreateExcelStreamByDatas(List<object> objectDatas, KeyValuePair<string, string> excelHeader)

 public static MemoryStream CreateExcelStreamByDatas(List<KeyValuePair<List<object>, KeyValuePair<string, string>>> objectDatass)

一个是单sheet表单导出接口，一个是多表单导出接口（例：管理员导出东三省的员工数据，则导出excel含4个表单（1、东三省全部数据；2、辽宁省数据；3、吉林省数据；4、黑龙江省数据））

参数objectDatas是从库中筛选到的结果DTO数据集，excelHeader是一个键值对：key-表头名称，value-sheet表单名称

3.我们具体来看单表单方法的实现：

         /// <summary>
         /// 将数据转换成excel文件流输出  ->单表单导出接口
         /// </summary>
         /// <returns></returns>
         public static MemoryStream CreateExcelStreamByDatas(List<object> objectDatas, KeyValuePair<string, string> excelHeader)
         {
             // 返回对象
             var ms = new MemoryStream();

             // excel工作簿
             IWorkbook workbook = new HSSFWorkbook();
             //导入数据到sheet表单
             CreateExcelSheetByDatas(objectDatas, excelHeader.Key, excelHeader.Value, ref workbook);

             workbook.Write(ms);
             ms.Flush();
             ms.Position = ;

             return ms;
         }

我们将具体功能逻辑抽象到了方法CreateExcelSheetByDatas中，

那么多表单的实现只需要修改第13行为：

             foreach (KeyValuePair<List<object>, KeyValuePair<string, string>> keyValuePair in objectDatass)
             {
                 //导入数据到sheet表单
                 CreateExcelSheetByDatas(keyValuePair.Key, keyValuePair.Value.Key, keyValuePair.Value.Value, ref workbook);
             }

4.我们来实现最核心的方法CreateExcelSheetByDatas（博主还没来得及重构代码，所有逻辑都写在里面了，略长...）

         /// <summary>
         /// 根据传入数据新建sheet表单到指定workbook
         /// </summary>
         /// <param name="objectDatas"></param>
         /// <param name="excelHeader"></param>
         /// <param name="sheetName"></param>
         /// <param name="regulars"></param>
         /// <param name="workbook"></param>
         private static void CreateExcelSheetByDatas(List<object> objectDatas, string excelHeader, string sheetName, ref IWorkbook workbook)
         {
             var regulars = GetExportRegulars();

             // excel sheet表单
             ISheet sheet = workbook.CreateSheet(sheetName);
             // excel行数
             int rows = ;

             #region 单元格 -表头格式

             #region 表头字体

             IFont fontTitle = workbook.CreateFont();
             fontTitle.FontHeightInPoints = ;
             fontTitle.Boldweight = (short)FontBoldWeight.BOLD;

             #endregion

             ICellStyle styleTitle = workbook.CreateCellStyle();
             styleTitle.Alignment = NPOI.SS.UserModel.HorizontalAlignment.CENTER;
             styleTitle.SetFont(fontTitle);
             styleTitle.VerticalAlignment = NPOI.SS.UserModel.VerticalAlignment.CENTER;

             #endregion

             #region 单元格 -表体格式

             #region 表体字体

             IFont fontMessage = workbook.CreateFont();
             fontMessage.FontHeightInPoints = ;

             #endregion

             ICellStyle styleMessage = workbook.CreateCellStyle();
             styleMessage.Alignment = NPOI.SS.UserModel.HorizontalAlignment.CENTER;
             styleMessage.SetFont(fontMessage);
             styleMessage.VerticalAlignment = NPOI.SS.UserModel.VerticalAlignment.CENTER;

             #endregion

             // 创建表头并赋值
             int firstRowCellCount = GetAttributeCount(objectDatas.First());
             IRow headerRow = sheet.CreateRow(rows);
             headerRow.HeightInPoints = ;
             var headerCell = headerRow.CreateCell();
             headerCell.SetCellValue(excelHeader);

             // 合并表头
             var cellRangeAddress = new CellRangeAddress(rows, rows, , firstRowCellCount - );
             sheet.AddMergedRegion(cellRangeAddress);
             // 设置表头格式
             headerCell.CellStyle = styleTitle;

             //生成表头
             if (objectDatas.Any())
             {
                 rows++;
                 // excel列数
                 int cells = -;
                 // 创建数据行
                 var firstRow = sheet.CreateRow(rows);
                 firstRow.HeightInPoints = ;
                 var objectData = objectDatas.FirstOrDefault();
                 foreach (System.Reflection.PropertyInfo p in objectData.GetType().GetProperties())
                 {
                     cells++;
                     var regular = regulars.Find(t => t.PropertyName == p.Name);
                     if (regular == null)
                     {
                         throw new Exception("导出excel时，出现未配置字段。表：" + objectData.GetType().Name + ",字段：" + p.Name);
                     }
                     var firstRowCell = firstRow.CreateCell(cells);
                     firstRowCell.SetCellValue(regular.ExportFieldName);
                     sheet.SetColumnWidth(cells, regular.ExportFieldName.Length *  * );
                     firstRowCell.CellStyle = styleMessage;
                 }
             }

             // 反射object对象，遍历字段
             foreach (var objectData in objectDatas)
             {
                 rows++;
                 // excel列数
                 int cells = -;
                 // 创建数据行
                 var messageRow = sheet.CreateRow(rows);
                 messageRow.HeightInPoints = ;
                 foreach (System.Reflection.PropertyInfo p in objectData.GetType().GetProperties())
                 {
                     cells++;
                     var regular = regulars.Find(t => t.PropertyName == p.Name);
                     var messageCell = messageRow.CreateCell(cells);
                     var value = p.GetValue(objectData);
                     if (value == null)
                     {
                         messageCell.SetCellValue("");
                     }
                     else
                     {
                         switch (regular.DataType)
                         {
                             case "datetime":
                                 if (Convert.ToDateTime(value) == DateTime.MinValue)
                                 {
                                     messageCell.SetCellValue("");
                                 }
                                 else
                                 {
                                     messageCell.SetCellValue(
                                         Convert.ToDateTime(value).ToString("yyyy-MM-dd HH:mm:ss"));
                                 }
                                 break;
                             case "int":
                                 messageCell.SetCellValue(Convert.ToInt32(value));
                                 break;
                             case "double":
                                 messageCell.SetCellValue(Convert.ToDouble(value));
                                 break;
                             case "bool":
                                 var setValue = "是";
                                 if (!(bool)value)
                                 {
                                     setValue = "否";
                                 }
                                 messageCell.SetCellValue(setValue);
                                 break;
                             default:
                                 messageCell.SetCellValue(value.ToString());
                                 break;
                         }
                     }
                     messageCell.CellStyle = styleMessage;
                 }
             }
         }

注：

1.第18到62行均是对表体、表头字体格式的指定，并创建合并表头名称

2.第66行到88行是在遍历DTO属性，按规则集取出对应中文名称创建表头字段

此处特别说明：博主把所有导出DTO的所有属性字段都是做的简单类型字段，方便做反射。

3.第52行GetAttributeCount方法，是获取DTO对象所有属性个数

4.第91行到145行是按规则集规则将DTO中对应数据写进excel单元格

至此，我们就实现了将DTO集合按规则集导出到excel表格的方法。

我们只需要在各个导出服务中，先查库获取到需要的数据集合，再Map到DTO集合中，作为参数调用EXCEL导出方法即可返回需要的excel文件流。

到这儿，NPOI操作简单模板excel进行导入导出的相关代码就贴完了。如有什么地方写的不对或不好，欢迎指出，一定虚心请教~~~

上一篇博文说到的那些反人类的excel的导入，会在下一篇博文贴出具体实现的代码，敬请期待~~~

原创文章，代码都是从自己项目里贴出来的。转载请注明出处哦，亲~~~