使用NPOI导入导出标准Excel

使用NPOI导入导出标准Excel

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

 

曾使用过的方法

1. 直接导出html，修改后缀名为.xls，这个方法有点像骗人的把戏，而且不能再导入
2. 使用Jet OLEDB引擎来进行导入导出，完全使用sql语句来进行操作，缺点能控制的东西非常有限，比如格式就难以控制
3. 使用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的文件格式，功能比较强大。更详细的说明请看作者的博客或官方网站。

 

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

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

 

使用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对象，添加一个工作表，在工作表中添加一行一列：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

using   NPOI.HSSF.UserModel; using   NPOI.SS.UserModel;   public   class   NPOIWrite {      void   CreateSheet()      {          IWorkbook workbook = new   HSSFWorkbook(); //创建Workbook对象          ISheet sheet = workbook.CreateSheet( "Sheet1" ); //创建工作表          IRow row = sheet.CreateRow(0); //在工作表中添加一行          ICell cell = row.CreateCell(0); //在行中添加一列          cell.SetCellValue( "test" ); //设置列的内容      } }

 

相应的读取代码：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

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

 

使用NPOI导出

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

public   static   MemoryStream RenderToExcel(DataTable table) {      MemoryStream ms = new   MemoryStream();        using   (table)      {          using   (IWorkbook workbook = new   HSSFWorkbook())          {              using   (ISheet sheet = workbook.CreateSheet())              {                  IRow headerRow = sheet.CreateRow(0);                    // handling header.                  foreach   (DataColumn column in   table.Columns)                      headerRow.CreateCell(column.Ordinal).SetCellValue(column.Caption); //If Caption not set, returns the ColumnName value                    // handling value.                  int   rowIndex = 1;                    foreach   (DataRow row in   table.Rows)                  {                      IRow dataRow = sheet.CreateRow(rowIndex);                        foreach   (DataColumn column in   table.Columns)                      {                          dataRow.CreateCell(column.Ordinal).SetCellValue(row[column].ToString());                      }                        rowIndex++;                  }                    workbook.Write(ms);                  ms.Flush();                  ms.Position = 0;              }          }      }      return   ms; }

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

public   static   MemoryStream RenderToExcel(IDataReader reader) {      MemoryStream ms = new   MemoryStream();        using   (reader)      {          using   (IWorkbook workbook = new   HSSFWorkbook())          {              using   (ISheet sheet = workbook.CreateSheet())              {                  IRow headerRow = sheet.CreateRow(0);                  int   cellCount = reader.FieldCount;                    // handling header.                  for   ( int   i = 0; i < cellCount; i++)                  {                      headerRow.CreateCell(i).SetCellValue(reader.GetName(i));                  }                    // handling value.                  int   rowIndex = 1;                  while   (reader.Read())                  {                      IRow dataRow = sheet.CreateRow(rowIndex);                        for   ( int   i = 0; i < cellCount; i++)                      {                          dataRow.CreateCell(i).SetCellValue(reader[i].ToString());                      }                        rowIndex++;                  }                    workbook.Write(ms);                  ms.Flush();                  ms.Position = 0;              }          }      }      return   ms; }

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

static   void   SaveToFile(MemoryStream ms, string   fileName) {      using   (FileStream fs = new   FileStream(fileName, FileMode.Create, FileAccess.Write))      {          byte [] data = ms.ToArray();            fs.Write(data, 0, data.Length);          fs.Flush();            data = null ;      } }   static   void   RenderToBrowser(MemoryStream ms, HttpContext context, string   fileName) {      if   (context.Request.Browser.Browser == "IE" )          fileName = HttpUtility.UrlEncode(fileName);      context.Response.AddHeader( "Content-Disposition" , "attachment;fileName="   + fileName);      context.Response.BinaryWrite(ms.ToArray()); }

 

使用NPOI导入

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

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

static   DataTable RenderFromExcel(Stream excelFileStream) {      using   (excelFileStream)      {          using   (IWorkbook workbook = new   HSSFWorkbook(excelFileStream))          {              using   (ISheet sheet = workbook.GetSheetAt(0)) //取第一个表              {                  DataTable table = new   DataTable();                    IRow headerRow = sheet.GetRow(0); //第一行为标题行                  int   cellCount = headerRow.LastCellNum; //LastCellNum = PhysicalNumberOfCells                  int   rowCount = sheet.LastRowNum; //LastRowNum = PhysicalNumberOfRows - 1                    //handling header.                  for   ( int   i = headerRow.FirstCellNum; i < cellCount; i++)                  {                      DataColumn column = new   DataColumn(headerRow.GetCell(i).StringCellValue);                      table.Columns.Add(column);                  }                    for   ( int   i = (sheet.FirstRowNum + 1); i <= rowCount; i++)                  {                      IRow row = sheet.GetRow(i);                      DataRow dataRow = table.NewRow();                        if   (row != null )                      {                          for   ( int   j = row.FirstCellNum; j < cellCount; j++)                          {                              if   (row.GetCell(j) != null )                                  dataRow[j] = GetCellValue(row.GetCell(j));                          }                      }                        table.Rows.Add(dataRow);                  }                  return   table;                }          }      } }

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

public   static   int   RenderToDb(Stream excelFileStream, string   insertSql, DBAction dbAction) {      int   rowAffected = 0;      using   (excelFileStream)      {          using   (IWorkbook workbook = new   HSSFWorkbook(excelFileStream))          {              using   (ISheet sheet = workbook.GetSheetAt(0)) //取第一个工作表              {                  StringBuilder builder = new   StringBuilder();                    IRow headerRow = sheet.GetRow(0); //第一行为标题行                  int   cellCount = headerRow.LastCellNum; //LastCellNum = PhysicalNumberOfCells                  int   rowCount = sheet.LastRowNum; //LastRowNum = PhysicalNumberOfRows - 1                    for   ( int   i = (sheet.FirstRowNum + 1); i <= rowCount; i++)                  {                      IRow row = sheet.GetRow(i);                      if   (row != null )                      {                          builder.Append(insertSql);                          builder.Append( " values (" );                          for   ( int   j = row.FirstCellNum; j < cellCount; j++)                          {                              builder.AppendFormat( "'{0}'," , GetCellValue(row.GetCell(j)).Replace( "'" , "''" ));                          }                          builder.Length = builder.Length - 1;                          builder.Append( ");" );                      }                        if   ((i % 50 == 0 || i == rowCount) && builder.Length > 0)                      {                          //每50条记录一次批量插入到数据库                          rowAffected += dbAction(builder.ToString());                          builder.Length = 0;                      }                  }              }          }      }      return   rowAffected; }

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

public   static   bool   HasData(Stream excelFileStream) {      using   (excelFileStream)      {          using   (IWorkbook workbook = new   HSSFWorkbook(excelFileStream))          {              if   (workbook.NumberOfSheets > 0)              {                  using   (ISheet sheet = workbook.GetSheetAt(0))                  {                      return   sheet.PhysicalNumberOfRows > 0;                  }              }          }      }      return   false ; }

 

1. 确实不错
2. NPOI还是有很多局限滴
3. 引用

   supperwu：NPOI还是有很多局限滴

   
   有得必有失，想听听你所说的局限性，我们将在以后的版本中改进
4. 顶一下，很不错。
5. Aspose Cells 也是一个选择。
6. 对 我也一直都是用的Aspose.Cells
7. 这里额外说一下，文章里面的部分代码是从 http://msdn.microsoft.com/zh-tw/ee818993.aspx更改而来的
   
   @萧冲
   @C#通用权限管理系统组件
   ^_^
   
   @supperwu
   比如呢？
   
   @Tony Qu
   不知LastRowNum是否bug？
   
   @木野狐(Neil Chen)
   好吧，忘了一点，NPOI是免费的，那个Aspose.Cells貌似要不少美刀啊。免费开源应该要优于破解吧？
8. 资料量大到一个程度的时候用NPOI导出EXCEL会发生OutOfMemory问题
9. EPPlus也很不错，支持xlsx格式，不过目前在用Aspose.Cells，很好，只可惜不是免费的。
10. 呵呵，不错。我也用了，不知现在支持office07不
     
11. 暂时不支持2007，很可惜。
12. 这些第三方类库读写大Excel文件都是个悲剧
    
    在内存中装入大量数据都会有这种问题吧~~NPOI我试过100列1w条数，生成的Excel有50多M了，话说现实应用中有这么bt的场景吗？应该考虑程序设计是否合理了吧
    
    @何苦丶
    @zsuxiong
    @Bēniaǒ
    NPOI是支持97-2003格式
    EPPlus是支持Office 2007/2010的Office Open XML格式，是还不错，不过从类库的易用性来说，我觉得还是NPOI好
     
     
13. 实际经验,真的有客户要求转出超大量的EXCEL导致Out Of Memory
    虽然我也知道不合理,但是客户需求最大
    
    我目前主要使用COM+的方法,虽然有各种缺点
    不过我比较过NPOI跟COM+法的性能面
    
    转EXCEL速度 COM+>NPOI
    到达Out Of Memory的笔数上限 COM+>NPOI
    
    COM+法的缺点很多前人讨论过,例如进程砍不掉,我是在程序中调用user32.dll去砍掉进程,外加一个Service在背景不断检查启动时间过久的EXCEL.EXE.
    
    这样的做法能负荷多少人同时使用我也不知道,只是在我的运用场景下还没出大问题而已
14. 有这种应用-_-
    或许直接用sql来导出或许会比COM组件好一点(比如insert into OPENROWSET......)
    这类方法就怕并发量大啊~~
    
    用COM组件，把sheet，workbook，application都关掉，再用Marshal.ReleaseComObject来释放一下，进程就没了吧~
     
15. 引用

    佳贛：
    实际经验,真的有客户要求转出超大量的EXCEL导致Out Of Memory
    虽然我也知道不合理,但是客户需求最大
    
    我目前主要使用COM+的方法,虽然有各种缺点
    不过我比较过NPOI跟COM+法的性能面
    
    转EXCEL速度 COM+>NPOI
    到达Out Of Memory的笔数上限 COM+>NPOI
    
    COM+法的缺点很多前人讨论过,例如进程砍不掉,我是在程序中调用user32.dll去砍掉进程,外加一个Service在背景不断检查启动时间过久的EXCEL.EXE.
    
    这样的做法能负荷多少人同时使用我也不知道,只是在我的运用场景下还没出大问题而已

    
    如果前一个进程杀不掉，很有可能导致阻塞
16. NPOI现在正召集有空闲的QQ群成员一起开发和测试新功能新版本，有兴趣和时间的同学可以加进来。QQ群号：116053476
17. 的确只要前有一个excel.exe的进程没有正常关闭,后面的进程就有可能呆呆的排队。
    
    一般在网络上找到的COM+写法也不能说它错了，但我测试过在使用到某些特定语法时会无法正常关闭进程，所以有些时候会产生能够关闭进程的错觉，即使用了Marshal.ReleaseComObject也无法释放进程，因为写范例程序的人可能没用到特定语法。
    
    至于有多少指令会造成进程无法关闭我没有去研究，因为研究出来也无法避免不去用它，最後我引用了user32.dll，抓取进程的ProcessID，在EXCEL转换之后再让进程自杀。
    
    第二道防线就是用一个Windows Service去监测启动过久的excel.exe进程,如果超时就杀掉它
    

    引用

    Tony Qu：
    

    引用

    supperwu：NPOI还是有很多局限滴

    
    有得必有失，想听听你所说的局限性，我们将在以后的版本中改进

    
    
    有些比较复杂的Excel，里面包含很多VLOOKUP函数，当一个Sheet里面的内容是从另外的Sheet引用过来的，NPOI好像没有办法搞定。
     
18. ?

    1 2 3 4 5 6 7 8 9 10 11

    /// <summary> /// Excel文档流转换成DataTable /// 第一行必须为标题行 /// </summary> /// <param name="excelFileStream">Excel文档流</param> /// <param name="sheetName">表名称</param> /// <returns></returns> public   static   DataTable RenderFromExcel(Stream excelFileStream, string   sheetName) {      return   RenderFromExcel(excelFileStream, sheetName); }