欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Vue+axios+WebApi+NPOI导出Excel文件实例方法

程序员文章站 2022-07-05 20:49:21
一、前言 项目中前端采用的element ui 框架, 远程数据请求,使用的是axios,后端接口框架采用的asp.net webapi,数据导出成excel采用np...

一、前言

项目中前端采用的element ui 框架, 远程数据请求,使用的是axios,后端接口框架采用的asp.net webapi,数据导出成excel采用npoi组件。其业务场景,主要是列表页(如会员信息,订单信息等)表格数据导出,如表格数据进行了条件筛选,则需要将条件传至后端api,筛选数据后,导出成excel。

思考过前端导出的3种方案:

1.使用location.href 打开接口地址.缺点: 不能传token至后端api, 无法保证接口的安全性校验,并且接口只能是get方式请求.

2.采用axios请求接口,先在筛选后的数据服务端生成文件并保存,然后返回远程文件地址,再采用 location.href打开文件地址进行下载. 缺点: 实现复杂,并且每次导出会在服务端生成文件,但是又没有合适的时机再次触发删除文件,会在服务端形成垃圾数据。优点:每次导出都可以有记录。

3. 采用axios请求接口,服务端api返回文件流,前端接收到文件流后,采用blob对象存储,并创建成url, 使用a标签下载. 优点:前端可传token参数校验接口安全性,并支持get或post两种方式。

因其应用场景是导出excel文件之前,必须筛选数据,并需要对接口安全进行校验,所以第3种方案为最佳选择。在百度之后,发现目前使用最多的也是第3种方案。

二、vue + axios 前端处理

1.axios 需在response拦截器里进行相应的处理(这里不再介绍axios的使用, 关于axios的用法,具体请查看axios中文说明 ,我们在项目中对axios进行了统一的拦截定义). 需特别注意: response.headers['content-disposition'],默认是获取不到的,需要对服务端webapi进行配置,请查看第三点中webapi cors配置

// respone拦截器
service.interceptors.response.use(
 response => {
 // blob类型为文件下载对象,不论是什么请求方式,直接返回文件流数据
 if (response.config.responsetype === 'blob') {
  const filename = decodeuri(
  response.headers['content-disposition'].split('filename=')[1]
  )
// 返回文件流内容,以及获取文件名, response.headers['content-disposition']的获取, 默认是获取不到的,需要对服务端webapi进行配置
  return promise.resolve({ data: response.data, filename: filename })
 }
 // 依据后端逻辑实际情况,需要弹窗展示友好错误
 },
 error => {
 let resp = error.response
 if (resp.data) {
  console.log('err:' + decodeuricomponent(resp.data)) // for debug
 }
 // todo: 需要依据后端实际情况判断
 return promise.reject(error)
 }
)

2. 点击导出按钮,请求api. 需要注意的是接口请求配置的响应类型responsetype:'blob' (也可以是配置arraybuffer) ; 然ie9及以下浏览器不支持createobjecturl. 需要特别处理下ie浏览器将blob转换成文件。

exportexcel () {
  let params = {}
  let p = this.getqueryparams() // 获取相应的参数
  if (p) params = object({}, params, p)
  axios
  .get('接口地址', {
   params: params,
   responsetype: 'blob'
  })
  .then(res => {
   var blob = new blob([res.data], {
   type: 'application/vnd.ms-excel;charset=utf-8'
   })
   // 针对于ie浏览器的处理, 因部分ie浏览器不支持createobjecturl
   if (window.navigator && window.navigator.mssaveoropenblob) {
   window.navigator.mssaveoropenblob(blob, res.filename)
   } else {
   var downloadelement = document.createelement('a')
   var href = window.url.createobjecturl(blob) // 创建下载的链接
   downloadelement.href = href
   downloadelement.download = res.filename // 下载后文件名
   document.body.appendchild(downloadelement)
   downloadelement.click() // 点击下载
   document.body.removechild(downloadelement) // 下载完成移除元素
   window.url.revokeobjecturl(href) // 释放掉blob对象
   }
  })
 }

三、webapi + npoi 后端处理

1. 需要通过接口参数,查询数据

为了保持与分页组件查询接口一直的参数,采用了get请求方式,方便前端传参。webapi接口必须返回ihttpactionresult 类型

[httpget]
  public ihttpactionresult exportdata([fromuri]pagination pagination, [fromuri] orderreqdto dto)
  {
   //取出数据源
   datatable dt = this.service.getmemberpagelist(pagination, dto.converttofilter());
   if (dt.rows.count > 65535)
   {
    throw new exception("最大导出行数为65535行,请按条件筛选数据!");
   }
   foreach (datarow row in dt.rows)
   {
    var isrealname = row["isrealname"].tobool();
    row["isrealname"] = isrealname ? "是" : "否";
   }
   var model = new exportmodel();
   model.data = jsonconvert.serializeobject(dt);
   model.filename = "会员信息";
   model.title = model.filename;
   model.lstcol = new list<exportdatacolumn>();
   model.lstcol.add(new exportdatacolumn() { prop = "fullname", label = "会员名称" });
   model.lstcol.add(new exportdatacolumn() { prop = "realname", label = "真实姓名" });
   model.lstcol.add(new exportdatacolumn() { prop = "gradename", label = "会员等级" });
   model.lstcol.add(new exportdatacolumn() { prop = "telphone", label = "电话" });
   model.lstcol.add(new exportdatacolumn() { prop = "areaname", label = "区域" });
   model.lstcol.add(new exportdatacolumn() { prop = "gridname", label = "网格" });
   model.lstcol.add(new exportdatacolumn() { prop = "address", label = "门牌号" });
   model.lstcol.add(new exportdatacolumn() { prop = "regtime", label = "注册时间" });
   model.lstcol.add(new exportdatacolumn() { prop = "description", label = "备注" });
   return exportdatabyfore(model);
  }

2.关键导出函数 exportdatabyfore的实现

[httpget]
  public ihttpactionresult exportdatabyfore(exportmodel dto)
  {
   var dt = jsonconvert.deserializeobject<datatable>(dto.data);
   var filename = dto.filename + datetime.now.tostring("yymmddhhmmssfff") + ".xls";
   //设置导出格式
   excelconfig excelconfig = new excelconfig();
   excelconfig.title = dto.title;
   excelconfig.titlefont = "微软雅黑";
   excelconfig.titlepoint = 25;
   excelconfig.filename = filename;
   excelconfig.isallsizecolumn = true;
   //每一列的设置,没有设置的列信息,系统将按datatable中的列名导出
   excelconfig.columnentity = new list<columnentity>();
   //表头
   foreach (var col in dto.lstcol)
   {
    excelconfig.columnentity.add(new columnentity() { column = col.prop, excelcolumn = col.label });
   }
   //调用导出方法
   var stream = excelhelper.exportmemorystream(dt, excelconfig); // 通过npoi形成将数据绘制成excel文件并形成内存流
   var browser = string.empty;
   if (httpcontext.current.request.useragent != null)
   {
    browser = httpcontext.current.request.useragent.toupper();
   }
   httpresponsemessage httpresponsemessage = new httpresponsemessage(httpstatuscode.ok);
   httpresponsemessage.content = new streamcontent(stream);
   httpresponsemessage.content.headers.contenttype = new mediatypeheadervalue("application/octet-stream"); // 返回类型必须为文件流 application/octet-stream
   httpresponsemessage.content.headers.contentdisposition = new contentdispositionheadervalue("attachment") // 设置头部其他内容特性, 文件名
   {
    filename =
     browser.contains("firefox")
      ? filename
      : httputility.urlencode(filename)
   };
   return responsemessage(httpresponsemessage);
  }

3. web api 的cors配置

采用web api 构建后端接口服务的同学,都知道,接口要解决跨域问题,都需要进行api的 cors配置, 这里主要是针对于前端axios的响应response header中获取不到 content-disposition属性,进行以下配置

Vue+axios+WebApi+NPOI导出Excel文件实例方法

四、总结

以上就是我在实现axios导出excel文件功能时,遇到的一些问题,以及关键点进行总结。因为项目涉及到前后端其他业务以及公司架构的一些核心源码。要抽离一个完整的demo,比较耗时,所以没有完整demo展示. 但我已把npoi相关的操作函数源码,整理放至github上。https://github.com/yinboxie/blogexampledemo