深入解析C#中的第三方库NPOI:Excel和Word文件处理的利器

来自:博客园
时间:2024-03-18
阅读:

一、引言
在.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. 引用命名空间

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

3. 创建/打开工作簿

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

4. 创建/获取工作表

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

6. 合并单元格

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

7. 设置单元格样式

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

9. 关闭资源

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

四、高级功能

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

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

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

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

五、总结

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

六、完整的读取数据例子

using NPOI.HSSF.UserModel;
using NPOI.SS.UserModel;
using System.IO;
  public void ReadExcelFile(string filePath)
    {
        // 创建一个FileStream对象来打开Excel文件
        using (FileStream file = new FileStream(filePath, FileMode.Open, FileAccess.Read))
        {
            // 根据文件扩展名选择合适的Workbook实现
            IWorkbook workbook;
            if (Path.GetExtension(filePath).ToLower() == ".xlsx")
            {
                workbook = new XSSFWorkbook(file);
            }
            else
            {
                workbook = new HSSFWorkbook(file); // 适用于.xls文件
            }

            // 获取第一个工作表(索引从0开始)
            ISheet sheet = workbook.GetSheetAt(0);

            // 遍历所有行
            for (int rowIndex = 0; rowIndex <= sheet.LastRowNum; rowIndex++)
            {
                IRow row = sheet.GetRow(rowIndex);

                // 如果当前行不为空,则遍历所有单元格
                if (row != null)
                {
                    for (int cellIndex = 0; cellIndex < row.LastCellNum; cellIndex++)
                    {
                        ICell cell = row.GetCell(cellIndex);

                        // 检查单元格是否存在并获取其数据类型和值
                        if (cell != null)
                        {
                            Switch (cell.CellType)
                            {
                                case CellType.Numeric:
                                    double numericValue = cell.NumericCellValue;
                                    Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:{numericValue}");
                                    break;
                                case CellType.String:
                                    string stringValue = cell.StringCellValue;
                                    Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:{stringValue}");
                                    break;
                                case CellType.Formula:
                                    // 如果需要显示公式计算结果,使用CachedFormulaResultType
                                    if (cell.CachedFormulaResultType == CellType.Numeric)
                                    {
                                        double formulaValue = cell.NumericCellValue;
                                        Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列(公式结果):{formulaValue}");
                                    }
                                    else if (cell.CachedFormulaResultType == CellType.String)
                                    {
                                        string formulaValue = cell.StringCellValue;
                                        Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列(公式结果):{formulaValue}");
                                    }
                                    // 其他类型的公式处理...
                                    break;
                                default:
                                    // 对于日期、布尔值等其他类型,做相应处理
                                    break;
                            }
                        }
                        else
                        {
                            Console.WriteLine($"第{rowIndex + 1}行,第{cellIndex + 1}列:空单元格");
                        }
                    }
                }
            }

            // 关闭workbook以释放资源
            workbook.Close();
        }
    }

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

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

七、保存数据例子

using NPOI.HSSF.UserModel;
using NPOI.SS.UserModel;
using System.IO;
 public void SaveDataToExcel(string filePath)
    {
        // 创建一个新的HSSFWorkbook(适用于.xls格式)或XSSFWorkbook(适用于.xlsx格式)
        IWorkbook workbook = new XSSFWorkbook(); // 使用.xlsx格式

        // 创建新的工作表并设置名称
        ISheet sheet = workbook.CreateSheet("Sheet1");

        // 创建第一行数据
        IRow headerRow = sheet.CreateRow(0);
        headerRow.CreateCell(0).SetCellValue("Name");
        headerRow.CreateCell(1).SetCellValue("Age");
        headerRow.CreateCell(2).SetCellValue("City");

        // 添加三行数据
        for (int i = 1; i <= 3; i++)
        {
            IRow dataRow = sheet.CreateRow(i);

            dataRow.CreateCell(0).SetCellValue($"Person {i}");
            dataRow.CreateCell(1).SetCellValue(i * 10); // 年龄假设为i*10
            dataRow.CreateCell(2).SetCellValue($"City{i}");

            // 设置单元格样式(可选,例如设置字体加粗和居中)
            ICellStyle style = workbook.CreateCellStyle();
            style.Alignment = HorizontalAlignment.Center;
            IFont font = workbook.CreateFont();
            font.Boldweight = (short)FontBoldWeight.Bold;
            style.SetFont(font);
            dataRow.Cells[0].CellStyle = style;
        }

        // 保存到文件
        using (FileStream fileStream = new FileStream(filePath, FileMode.Create, FileAccess.Write))
        {
            workbook.Write(fileStream);
        }

        // 关闭workbook以释放资源
        workbook.Close();
    }

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

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

返回顶部
顶部