ASP.NET Core常用工具之NPOI（入门篇）-导出数据到Excel文件

阅读本文你的收获

在项目开发中，常需要将某一个列表的的数据导出到Excel中，比如说学校考试系统中导出学员的成绩列表、在MES系统中导出物料信息到Excel中、电商系统中导出订单等等，应对这一类的开发需求，市面上有很多导入导出的工具，在实际开发中我经常会用到NPOI来实现导入和导出。本篇我们先来入门一下NPOI导出数据到Excel表中。

一. NPOI是什么

NPOI是一个开源的C#读写Excel、WORD等微软OLE2组件文档的项目。NPOI常用来做数据的导入、导出。

NPOI工具中操作Excel表格有以下核心对象：

1. 工作簿 - Workbook
2. 工作表单- Sheet
3. 行- Row
4. 列- Column
5. 单元格- Cell

二. 用NPOI实现用户信息导出

开发环境：

平台版本是：.NET6
开发框架：ASP.NET Core WebApi
前端框架：Vue2+ElementUI
开发工具：Visual Studio 2022、Visual Studio Code

效果图：

2.1 安装NPOI

安装NPOI，在Nuget包管理器里安装，也可以在控制台窗口执行以下命令：

install-package npoi

或者也可以通过NuGet包管理器进行安装：

2.2 编写导出功能的Api接口

以下接口演示根据模板导出，并将导出的文件用文件流返回给客户端

using NPOI.SS.UserModel; //引用命名空间
using Microsoft.AspNetCore.Hosting;
using System.IO;
using System.Net;
using System.Web;
using System.Net.Http.Headers;

/// <summary>
/// 导出到Excel表格并返回文件流
/// </summary>
/// <returns></returns>
[HttpGet]
public IActionResult ExportToExcel(/*各种查询条件*/[FromServices] IWebHostEnvironment hostEnvironment)
{
    //1.条件查询需要的数据
    int totalCount;
    //为了演示，我只取第一页10条
    List<UserViewModel> users = _bll.GetUsers(1, 10, "", out totalCount);

    //2. 用excel四大对象，保存到Excel中（循环处理）
    //2.1 工作簿对象
    //读取Files/用户导出模板.xlsx，来创建一个Workbook对象
    string templatePath = hostEnvironment.WebRootPath + @"/Files/用户导出模板.xlsx";         
    IWorkbook workbook = WorkbookFactory.Create(templatePath);

    //2.2 工作表对象
    ISheet sheet = workbook.GetSheetAt(0); //索引0代表获取第一个Sheet

    //2.3 循环数据
    for (int i = 0; i < users.Count; i++)
    {
        IRow row = sheet.CreateRow(i + 1);  //创建了一行
        //创建单元格
        for (int j = 0; j < 4; j++)
        {
        	row.CreateCell(j);  //在行里面创建4个单元格
        }
        //导数据字段
        row.Cells[0].SetCellValue(i);
        row.Cells[1].SetCellValue(users[i].UserName);   //用户名
        row.Cells[2].SetCellValue(users[i].DepName);    //部门名
        row.Cells[3].SetCellValue(users[i].Telephone);  //电话
    }

    //3. 返回文件（下载）(把以上内存中的信息，导出到文件）
    //MemoryStream 内存流
    using MemoryStream stream = new MemoryStream();
    workbook.Write(stream, true);

    //向客户端暴露响应头
    Response.Headers.Add("Access-Control-Expose-Headers", "Content-Disposition");
 	string newFileName = $"导出数据{DateTime.Now.ToString("yyyyMMddHHmmss")}.xlsx";
    
    return File(stream.ToArray(), "application/octet-stream", newFileName);
}

2.3 前端VUE-实现下载功能

“导出”按钮点击事件绑定以下download()方法，代码实现如下：

download(){
    //方法一 适用于浏览器无法识别文件，如果是html、jpg、pdf等会直接解析展示，而不会下载
    // var url = "http://localhost:50845/api/User/ExportToExcel";
    // window.location.href = url;

    //方法二 文件流下载
    this.$axios({
        method:'get',
        url:'http://localhost:50845/api/User/ExportToExcel',
        params: this.queryParams, //查询参数
        headers:{
            "Authorization" : "Bearer " + store.getters.token //加认证头，如果有，则加。
        },
        responseType: 'blob'
    }).then((response)=>{
        //获取文件名
        var content = response.headers['content-disposition'];
        var name = content && content.split(';')[2].split("filename*=UTF-8''")[1];;
        var fileName = decodeURIComponent(name)
        //获取文件流
        let blob = new Blob([response.data], {type: 'application/octet-stream'})
        let url = window.URL.createObjectURL(blob)
        console.log(url, fileName)
        //动态创建a标签
        let link = document.createElement('a')
        link.href = url;
        link.style.display = 'none';
        link.setAttribute('download',fileName)
        document.body.appendChild(link)
        link.click() //点击a标签

        window.URL.revokeObjectURL(url)
        document.body.removeChild(link)
    })
}

2.4 测试效果

效果图：

---

参考连接：

前端下载文件的几种方式
vue项目中下载/导出文件

---

今天我们分享了NPOI的数据导出功能，是对Excel的操作，NPOI也可以导出到Word文档，将在后续进行更新。欢迎点赞+关注+评论。