经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » C# » 查看文章
深入解析C#中的第三方库NPOI:Excel和Word文件处理的利器
来源:cnblogs  作者:承蒙_关照  时间:2024/3/18 15:02:51  对本文有异议

一、引言
在.NET开发中,操作Office文档(特别是Excel和Word)是一项常见的需求。然而,在服务器端或无Microsoft Office环境的场景下,直接使用Office Interop可能会面临挑战。为了解决这个问题,开源库NPOI应运而生,它提供了无需安装Office即可创建、读取和修改Excel (.xls, .xlsx) 和 Word (.doc) 文件的能力。
二、NPOI简介
NPOI是一个基于.NET的API,用于读写微软的OLE 2 Compound Document formats,如Microsoft Office Excel和Word。它是Apache POI项目的.NET移植版本,允许开发者在没有安装Office的情况下处理这些格式的文件。
三、主要组件与方法
1. 安装与引用
Install-Package NPOI
或者在Visual Studio中右键项目 -> 管理NuGet程序包 -> 搜索并安装NPOI。
2. 引用命名空间

  1. using NPOI.SS.UserModel; // Excel相关的接口和类
  2. using NPOI.XSSF.UserModel; // 处理.xlsx文件
  3. using NPOI.HSSF.UserModel; // 处理.xls文件
  4. using System.IO; // 文件操作

3. 创建/打开工作簿

  • 创建一个新的Excel工作簿(.xlsx):
    var workbook = new XSSFWorkbook();
  • 打开一个现有的Excel文件(.xlsx或.xls):
  1. FileStream file = new FileStream("path_to_your_file.xlsx", FileMode.Open, FileAccess.Read);
  2. var workbook = new XSSFWorkbook(file); // .xlsx格式
  3. var workbook = new HSSFWorkbook(file); // .xls格式

4. 创建/获取工作表

  • 创建新的工作表:
    ISheet sheet = workbook.CreateSheet("Sheet1");
  • 获取已存在的工作表:
    ISheet sheet = workbook.GetSheetAt(0); // 获取索引为0的工作表
    5. 写入单元格数据
  • 创建行与单元格:
  1. IRow row = sheet.CreateRow(rowIndex);
  2. ICell cell = row.CreateCell(columnIndex);
  • 设置单元格值:
  1. cell.SetCellValue("文本内容"); // 文本
  2. cell.SetCellValue(12345); // 数字

6. 合并单元格

  1. var region = new CellRangeAddress(startRow, endRow, startColumn, endColumn);
  2. sheet.AddMergedRegion(region);

7. 设置单元格样式

  • 创建样式对象:
    var style = workbook.CreateCellStyle();
  • 设置样式属性(如字体、颜色、对齐方式等):
  1. style.Alignment = HorizontalAlignment.Center;
  2. IFont font = workbook.CreateFont();
  3. font.Boldweight = (short)FontBoldWeight.Bold;
  4. style.SetFont(font);
  • 应用到单元格:
    cell.CellStyle = style;
    8. 保存文件
  1. FileStream outputStream = new FileStream("output.xlsx", FileMode.Create);
  2. workbook.Write(outputStream);
  3. outputStream.Close();

9. 关闭资源

  • 确保关闭Workbook以及相关的文件流以释放资源:
  1. workbook.Close();
  2. file.Close();

四、高级功能

  • 读取现有文件:通过FileStream打开并读取Excel文件内容。

  • 读取公式结果:通过ICell.CachedFormulaResultType或ICell.CellFormula属性获取公式计算结果。

  • 操作图表和图片:NPOI支持插入、更新和删除Excel中的图表和图片。

  • 处理Word文档:通过XWPFDocument类来创建、读取和修改Word(.doc)文件。

五、总结

NPOI库凭借其强大的功能和轻量级设计,已成为.NET环境下处理Office文档的标准工具之一。无论是在Web应用程序后台处理用户上传的Excel文件,还是在批处理任务中生成报表,NPOI都能提供高效且易于使用的解决方案。通过深入理解和熟练运用NPOI的各种方法,开发者可以轻松应对各种复杂的文档处理任务。

六、完整的读取数据例子

  1. using NPOI.HSSF.UserModel;
  2. using NPOI.SS.UserModel;
  3. using System.IO;
  4. public void ReadExcelFile(string filePath)
  5. {
  6. // 创建一个FileStream对象来打开Excel文件
  7. using (FileStream file = new FileStream(filePath, FileMode.Open, FileAccess.Read))
  8. {
  9. // 根据文件扩展名选择合适的Workbook实现
  10. IWorkbook workbook;
  11. if (Path.GetExtension(filePath).ToLower() == ".xlsx")
  12. {
  13. workbook = new XSSFWorkbook(file);
  14. }
  15. else
  16. {
  17. workbook = new HSSFWorkbook(file); // 适用于.xls文件
  18. }
  19. // 获取第一个工作表(索引从0开始)
  20. ISheet sheet = workbook.GetSheetAt(0);
  21. // 遍历所有行
  22. for (int rowIndex = 0; rowIndex <= sheet.LastRowNum; rowIndex++)
  23. {
  24. IRow row = sheet.GetRow(rowIndex);
  25. // 如果当前行不为空,则遍历所有单元格
  26. if (row != null)
  27. {
  28. for (int cellIndex = 0; cellIndex < row.LastCellNum; cellIndex++)
  29. {
  30. ICell cell = row.GetCell(cellIndex);
  31. // 检查单元格是否存在并获取其数据类型和值
  32. if (cell != null)
  33. {
  34. switch (cell.CellType)
  35. {
  36. case CellType.Numeric:
  37. double numericValue = cell.NumericCellValue;
  38. Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:{numericValue}");
  39. break;
  40. case CellType.String:
  41. string stringValue = cell.StringCellValue;
  42. Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:{stringValue}");
  43. break;
  44. case CellType.Formula:
  45. // 如果需要显示公式计算结果,使用CachedFormulaResultType
  46. if (cell.CachedFormulaResultType == CellType.Numeric)
  47. {
  48. double formulaValue = cell.NumericCellValue;
  49. Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列(公式结果):{formulaValue}");
  50. }
  51. else if (cell.CachedFormulaResultType == CellType.String)
  52. {
  53. string formulaValue = cell.StringCellValue;
  54. Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列(公式结果):{formulaValue}");
  55. }
  56. // 其他类型的公式处理...
  57. break;
  58. default:
  59. // 对于日期、布尔值等其他类型,做相应处理
  60. break;
  61. }
  62. }
  63. else
  64. {
  65. Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:空单元格");
  66. }
  67. }
  68. }
  69. }
  70. // 关闭workbook以释放资源
  71. workbook.Close();
  72. }
  73. }

在这个例子中,我们首先打开了指定路径下的Excel文件,并根据文件类型创建了相应的HSSFWorkbook或XSSFWorkbook对象。然后,我们循环遍历每一行和每一列,获取每个单元格的内容,并根据单元格类型输出对应的值。

请确保已安装NPOI NuGet包并在项目中引用了必要的命名空间。

七、保存数据例子

  1. using NPOI.HSSF.UserModel;
  2. using NPOI.SS.UserModel;
  3. using System.IO;
  4. public void SaveDataToExcel(string filePath)
  5. {
  6. // 创建一个新的HSSFWorkbook(适用于.xls格式)或XSSFWorkbook(适用于.xlsx格式)
  7. IWorkbook workbook = new XSSFWorkbook(); // 使用.xlsx格式
  8. // 创建新的工作表并设置名称
  9. ISheet sheet = workbook.CreateSheet("Sheet1");
  10. // 创建第一行数据
  11. IRow headerRow = sheet.CreateRow(0);
  12. headerRow.CreateCell(0).SetCellValue("Name");
  13. headerRow.CreateCell(1).SetCellValue("Age");
  14. headerRow.CreateCell(2).SetCellValue("City");
  15. // 添加三行数据
  16. for (int i = 1; i <= 3; i++)
  17. {
  18. IRow dataRow = sheet.CreateRow(i);
  19. dataRow.CreateCell(0).SetCellValue($"Person {i}");
  20. dataRow.CreateCell(1).SetCellValue(i * 10); // 年龄假设为i*10
  21. dataRow.CreateCell(2).SetCellValue($"City{i}");
  22. // 设置单元格样式(可选,例如设置字体加粗和居中)
  23. ICellStyle style = workbook.CreateCellStyle();
  24. style.Alignment = HorizontalAlignment.Center;
  25. IFont font = workbook.CreateFont();
  26. font.Boldweight = (short)FontBoldWeight.Bold;
  27. style.SetFont(font);
  28. dataRow.Cells[0].CellStyle = style;
  29. }
  30. // 保存到文件
  31. using (FileStream fileStream = new FileStream(filePath, FileMode.Create, FileAccess.Write))
  32. {
  33. workbook.Write(fileStream);
  34. }
  35. // 关闭workbook以释放资源
  36. workbook.Close();
  37. }

在这个例子中,我们首先创建了一个新的XSSFWorkbook对象,并在其中创建了一个名为"Sheet1"的工作表。接着,我们在表头添加了列名,并插入了三行示例数据。为了演示单元格样式的设置,我们将第一列的数据设置为了加粗和居中的样式。最后,将整个工作簿内容写入指定路径的Excel文件。

请注意,根据实际需求选择创建HSSFWorkbook或XSSFWorkbook,以及调整保存的数据和样式。确保已安装NPOI NuGet包并在项目中引用了必要的命名空间。

原文链接:https://www.cnblogs.com/Z1000W/p/18080019

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号