使用NPOI导入导出标准Excel

最新推荐文章于 2024-06-17 23:31:56 发布

CodingSir

最新推荐文章于 2024-06-17 23:31:56 发布

阅读量1.8k

点赞数

文章标签： stream office excel 工作 microsoft null

尝试过很多Excel导入导出方法，都不太理想，无意中逛到oschina时，发现了NPOI，无需Office COM组件且不依赖Office，顿时惊为天人，怀着无比激动的心情写下此文。

曾使用过的方法

直接导出html，修改后缀名为.xls，这个方法有点像骗人的把戏，而且不能再导入
使用Jet OLEDB引擎来进行导入导出，完全使用sql语句来进行操作，缺点能控制的东西非常有限，比如格式就难以控制
使用Office COM组件进行导入导出，对环境依赖性太强(如“检索 COM 类工厂…”错误)；且需要通过打开Excel.exe进程进行操作；虽然可以通过关闭工作表以及Marshal.ReleaseComObject方法来释放资源，但依然避免不了性能差。

关于NPOI

NPOI是POI项目的.NET版本，是由@Tony Qu(http://tonyqus.cnblogs.com/)等大侠基于POI开发的，可以从http://npoi.codeplex.com/下载到它的最新版本。它不使用Office COM组件(Microsoft.Office.Interop.XXX.dll)，不需要安装Microsoft Office，支持对Office 97-2003的文件格式，功能比较强大。更详细的说明请看作者的博客或官方网站。

它的以下一些特性让我相当喜欢：

支持对标准的Excel读写
支持对流(Stream)的读写 (而Jet OLEDB和Office COM都只能针对文件)
支持大部分Office COM组件的常用功能
性能优异 (相对于前面的方法)
使用简单，易上手

使用NPOI

本文使用的是它当前的最新版本1.2.4，此版本的程序集缩减至2个：NPOI.dll、Ionic.Zip.dll，直接引用到项目中即可。

对于我们开发者使用的对象主要位于NPOI.HSSF.UserModel空间下，主要有HSSFWorkbook、HSSFSheet、HSSFRow、HSSFCell，对应的接口为位于NPOI.SS.UserModel空间下的IWorkbook、ISheet、IRow、ICell，分别对应Excel文件、工作表、行、列。

简单演示一下创建一个Workbook对象，添加一个工作表，在工作表中添加一行一列：

 
     01using  NPOI.HSSF.UserModel; 
 
     02using  NPOI.SS.UserModel; 
 
     03
 
     04public  class NPOIWrite 
 
     05{ 
 
     06void CreateSheet() 
 
     07{  
 
     08IWorkbook workbook = new HSSFWorkbook();//创建Workbook对象 
 
     09ISheet sheet = workbook.CreateSheet("Sheet1");//创建工作表 
 
     10IRow row = sheet.CreateRow(0);//在工作表中添加一行 
 
     11ICell cell = row.CreateCell(0);//在行中添加一列 
 
     12cell.SetCellValue("test");//设置列的内容 
 
     13}  
 
     14}

相应的读取代码：

 
     01using  System.IO; 
 
     02using  NPOI.HSSF.UserModel; 
 
     03using  NPOI.SS.UserModel; 
 
     04
 
     05public  class NPOIRead 
 
     06{ 
 
     07void GetSheet(Stream stream) 
 
     08{  
 
     09IWorkbook workbook = new HSSFWorkbook(stream);//从流内容创建Workbook对象 
 
     10ISheet sheet = workbook.GetSheetAt(0);//获取第一个工作表 
 
     11IRow row = sheet.GetRow(0);//获取工作表第一行 
 
     12ICell cell = row.GetCell(0);//获取行的第一列 
 
     13string value = cell.ToString();//获取列的值 
 
     14}  
 
     15}

使用NPOI导出

从DataTable读取内容来创建Workbook对象：

 
     01public  static MemoryStream RenderToExcel(DataTable table) 
 
     02{ 
 
     03MemoryStream ms = new MemoryStream(); 
 
     04 
 
     05using (table) 
 
     06{  
 
     07using (IWorkbook workbook = new HSSFWorkbook()) 
 
     08{  
 
     09using (ISheet sheet = workbook.CreateSheet()) 
 
     10{  
 
     11IRow headerRow = sheet.CreateRow(0); 
 
     12 
 
     13// handling header. 
 
     14foreach (DataColumn column in table.Columns) 
 
     15headerRow.CreateCell(column.Ordinal).SetCellValue(column.Caption);//If Caption not set, returns the ColumnName value 
 
     16 
 
     17// handling value. 
 
     18int rowIndex = 1; 
 
     19 
 
     20foreach (DataRow row in table.Rows) 
 
     21{  
 
     22IRow dataRow = sheet.CreateRow(rowIndex); 
 
     23 
 
     24foreach (DataColumn column in table.Columns) 
 
     25{  
 
     26dataRow.CreateCell(column.Ordinal).SetCellValue(row[column].ToString()); 
 
     27}  
 
     28 
 
     29rowIndex++; 
 
     30}  
 
     31 
 
     32workbook.Write(ms); 
 
     33ms.Flush(); 
 
     34ms.Position = 0; 
 
     35}  
 
     36}  
 
     37}  
 
     38return ms; 
 
     39}

如果看不惯DataTable，那么DataReader也行：

 
     01public  static MemoryStream RenderToExcel(IDataReader reader) 
 
     02{ 
 
     03MemoryStream ms = new MemoryStream(); 
 
     04 
 
     05using (reader) 
 
     06{  
 
     07using (IWorkbook workbook = new HSSFWorkbook()) 
 
     08{  
 
     09using (ISheet sheet = workbook.CreateSheet()) 
 
     10{  
 
     11IRow headerRow = sheet.CreateRow(0); 
 
     12int cellCount = reader.FieldCount; 
 
     13 
 
     14// handling header. 
 
     15for (int  i = 0; i < cellCount; i++) 
 
     16{  
 
     17headerRow.CreateCell(i).SetCellValue(reader.GetName(i)); 
 
     18}  
 
     19 
 
     20// handling value. 
 
     21int rowIndex = 1; 
 
     22while (reader.Read()) 
 
     23{  
 
     24IRow dataRow = sheet.CreateRow(rowIndex); 
 
     25 
 
     26for (int  i = 0; i < cellCount; i++) 
 
     27{  
 
     28dataRow.CreateCell(i).SetCellValue(reader[i].ToString()); 
 
     29}  
 
     30 
 
     31rowIndex++; 
 
     32}  
 
     33 
 
     34workbook.Write(ms); 
 
     35ms.Flush(); 
 
     36ms.Position = 0; 
 
     37}  
 
     38}  
 
     39}  
 
     40return ms; 
 
     41}

以上代码把创建的Workbook对象保存到流中，可以通过以下方法输出到浏览器，或是保存到硬盘中：

 
     01static  void SaveToFile(MemoryStream ms, string fileName) 
 
     02{ 
 
     03using (FileStream fs = new FileStream(fileName, FileMode.Create, FileAccess.Write)) 
 
     04{  
 
     05byte[] data = ms.ToArray(); 
 
     06 
 
     07fs.Write(data, 0, data.Length); 
 
     08fs.Flush(); 
 
     09 
 
     10data = null;  
 
     11}  
 
     12} 
 
     13 
 
     14static  void RenderToBrowser(MemoryStream ms, HttpContext context, string fileName) 
 
     15{ 
 
     16if (context.Request.Browser.Browser == "IE") 
 
     17fileName = HttpUtility.UrlEncode(fileName); 
 
     18context.Response.AddHeader("Content-Disposition", "attachment;fileName="  + fileName); 
 
     19context.Response.BinaryWrite(ms.ToArray()); 
 
     20}

使用NPOI导入

需要注意的是，sheet.LastRowNum = sheet.PhysicalNumberOfRows - 1，这里可能存在BUG：当没有数据或只有一行数据时sheet.LastRowNum为0，PhysicalNumberOfRows 表现正常。

这里读取流中的Excel来创建Workbook对象，并转换成DataTable：

 
     01static  DataTable RenderFromExcel(Stream excelFileStream) 
 
     02{ 
 
     03using (excelFileStream) 
 
     04{  
 
     05using (IWorkbook workbook = new HSSFWorkbook(excelFileStream)) 
 
     06{  
 
     07using (ISheet sheet = workbook.GetSheetAt(0))//取第一个表 
 
     08{  
 
     09DataTable table = new DataTable(); 
 
     10 
 
     11IRow headerRow = sheet.GetRow(0);//第一行为标题行 
 
     12int cellCount = headerRow.LastCellNum;//LastCellNum = PhysicalNumberOfCells 
 
     13int rowCount = sheet.LastRowNum;//LastRowNum = PhysicalNumberOfRows - 1 
 
     14 
 
     15//handling header. 
 
     16for (int  i = headerRow.FirstCellNum; i < cellCount; i++) 
 
     17{  
 
     18DataColumn column = new DataColumn(headerRow.GetCell(i).StringCellValue); 
 
     19table.Columns.Add(column); 
 
     20}  
 
     21 
 
     22for (int  i = (sheet.FirstRowNum + 1); i <= rowCount; i++) 
 
     23{  
 
     24IRow row = sheet.GetRow(i); 
 
     25DataRow dataRow = table.NewRow(); 
 
     26 
 
     27if (row != null) 
 
     28{  
 
     29for (int  j = row.FirstCellNum; j < cellCount; j++) 
 
     30{  
 
     31if (row.GetCell(j) != null) 
 
     32dataRow[j] = GetCellValue(row.GetCell(j)); 
 
     33}  
 
     34}  
 
     35 
 
     36table.Rows.Add(dataRow); 
 
     37}  
 
     38return table; 
 
     39 
 
     40}  
 
     41}  
 
     42}  
 
     43}

或者是直接生成SQL语句来插入到数据库：

 
     01public  static int  RenderToDb(Stream excelFileStream, string insertSql, DBAction dbAction) 
 
     02{ 
 
     03int rowAffected = 0; 
 
     04using (excelFileStream) 
 
     05{  
 
     06using (IWorkbook workbook = new HSSFWorkbook(excelFileStream)) 
 
     07{  
 
     08using (ISheet sheet = workbook.GetSheetAt(0))//取第一个工作表 
 
     09{  
 
     10StringBuilder builder = new StringBuilder(); 
 
     11 
 
     12IRow headerRow = sheet.GetRow(0);//第一行为标题行 
 
     13int cellCount = headerRow.LastCellNum;//LastCellNum = PhysicalNumberOfCells 
 
     14int rowCount = sheet.LastRowNum;//LastRowNum = PhysicalNumberOfRows - 1 
 
     15 
 
     16for (int  i = (sheet.FirstRowNum + 1); i <= rowCount; i++) 
 
     17{  
 
     18IRow row = sheet.GetRow(i); 
 
     19if (row != null) 
 
     20{  
 
     21builder.Append(insertSql); 
 
     22builder.Append(" values ("); 
 
     23for (int  j = row.FirstCellNum; j < cellCount; j++) 
 
     24{  
 
     25builder.AppendFormat("'{0}',", GetCellValue(row.GetCell(j)).Replace("'", "''"));  
 
     26}  
 
     27builder.Length = builder.Length - 1; 
 
     28builder.Append(");"); 
 
     29}  
 
     30 
 
     31if ((i % 50 == 0 || i == rowCount) && builder.Length > 0) 
 
     32{  
 
     33//每50条记录一次批量插入到数据库 
 
     34rowAffected += dbAction(builder.ToString()); 
 
     35builder.Length = 0; 
 
     36}  
 
     37}  
 
     38}  
 
     39}  
 
     40}  
 
     41return rowAffected; 
 
     42}

这里的Excel可能没有数据，所以可以加一个方法来检测：

 
     01public  static bool  HasData(Stream excelFileStream) 
 
     02{ 
 
     03using (excelFileStream) 
 
     04{  
 
     05using (IWorkbook workbook = new HSSFWorkbook(excelFileStream)) 
 
     06{  
 
     07if (workbook.NumberOfSheets > 0) 
 
     08{  
 
     09using (ISheet sheet = workbook.GetSheetAt(0)) 
 
     10{  
 
     11return sheet.PhysicalNumberOfRows > 0; 
 
     12}  
 
     13}  
 
     14}  
 
     15}  
 
     16return false; 
 
     17}