Vue3-Antdv-Admin项目中导出Excel功能实现与跨域问题解决

前言

在Vue3-Antdv-Admin项目中实现Excel导出功能是许多开发者常见的需求。本文将详细介绍如何在该项目中实现Excel导出功能，并解决可能遇到的跨域问题。

Excel导出功能实现

在Vue3-Antdv-Admin项目中，Excel导出功能通常分为前端请求和后端处理两部分。

前端实现

前端主要使用axios发起请求，并处理返回的Excel文件流：

// 示例代码
const exportExcel = async () => {
  try {
    const response = await axios.get('/api/export-xlsx', {
      responseType: 'blob'
    });
    const url = window.URL.createObjectURL(new Blob([response.data]));
    const link = document.createElement('a');
    link.href = url;
    link.setAttribute('download', 'data.xlsx');
    document.body.appendChild(link);
    link.click();
    document.body.removeChild(link);
  } catch (error) {
    console.error('导出失败:', error);
  }
};

后端实现

后端使用ExcelJS库生成Excel文件并返回给前端。在NestJS框架中，实现如下：

import { Controller, Get, Res, Query, Header } from '@nestjs/common';
import { FastifyReply } from 'fastify';
import * as ExcelJS from 'exceljs';

@Controller('api')
export class ExcelController {
  @Get('export-xlsx')
  @Header('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
  @Header('Content-Disposition', 'attachment; filename=data.xlsx')
  async exportExcel(@Res() res: FastifyReply) {
    const workbook = new ExcelJS.Workbook();
    const worksheet = workbook.addWorksheet('Sheet1');
    
    // 添加表头
    worksheet.columns = [
      { header: 'ID', key: 'id', width: 10 },
      { header: '名称', key: 'name', width: 20 }
    ];
    
    // 添加数据
    worksheet.addRow({ id: 1, name: '示例数据' });
    
    await workbook.xlsx.write(res.raw);
    res.send();
  }
}

跨域问题解决方案

在实际开发中，导出Excel功能常会遇到跨域问题。以下是几种解决方案：

1. 使用@Header装饰器

在NestJS中，可以直接使用@Header装饰器设置CORS相关头信息：

@Get('export-xlsx')
@Header('Access-Control-Allow-Origin', '*')
@Header('Access-Control-Allow-Methods', 'GET,POST')
@Header('Access-Control-Allow-Headers', 'Content-Type, Authorization')
async exportExcel(@Res() res: FastifyReply) {
  // 导出逻辑
}

2. 全局CORS配置

在NestJS应用的main.ts中配置全局CORS：

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  
  app.enableCors({
    origin: true,
    methods: 'GET,HEAD,PUT,PATCH,POST,DELETE',
    allowedHeaders: 'Content-Type,Authorization',
    exposedHeaders: 'Content-Disposition'
  });
  
  await app.listen(3000);
}

3. 前端代理方案

如果前端使用Vue CLI开发，可以在vue.config.js中配置代理：

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'http://localhost:3000',
        changeOrigin: true
      }
    }
  }
};

常见问题排查

1. 响应头未正确设置：确保设置了正确的Content-Type和Content-Disposition头
2. 响应类型不匹配：前端axios请求需要设置responseType: 'blob'
3. Fastify特殊处理：使用Fastify时需要通过res.raw操作原生响应流
4. 文件损坏：确保后端正确完成了文件写入和响应发送

最佳实践建议

1. 对于生产环境，应限制Access-Control-Allow-Origin为特定域名而非*
2. 考虑添加权限验证，防止未授权导出
3. 大数据量导出时考虑分页或流式处理
4. 前端添加加载状态和错误提示，提升用户体验

结语

在Vue3-Antdv-Admin项目中实现Excel导出功能并不复杂，关键在于前后端的正确配合和跨域问题的妥善处理。通过本文介绍的方法，开发者可以快速实现这一功能并解决常见问题。