vue3中纯前端实现excel表格导出功能

675 阅读4分钟

前后端分离的项目中,导出功能通常是前端调用接口,由后端返回文件的二进制流,再由前端使用Blob的方式将文件字符流数据写入文件,下载下来。有时候场景比较特殊,后端无法提供导出接口,那么就需要前端自己去实现表格下载功能。

1、实现方法依赖两个插件

"dependencies": {
  "exceljs": "^4.3.0",
  "file-saver": "^2.0.5",
},

2、新建exportExcel.ts文件,封装文件导出相关方法。

import Excel from 'exceljs';
import * as FileSaver from 'file-saver';

export const exportExcel = function(luckysheet:any, value:any) {
  // 参数为luckysheet.getluckysheetfile()获取的对象
  // 1.创建工作簿,可以为工作簿添加属性
  const workbook = new Excel.Workbook();
  // 2.创建表格,第二个参数可以配置创建什么样的工作表
  if (Object.prototype.toString.call(luckysheet) === '[object Object]') {
    luckysheet = [luckysheet];
  }
  luckysheet.forEach(function(table:any) {
    if (table.data.length === 0) return true;
    // ws.getCell('B2').fill = fills.
    const worksheet = workbook.addWorksheet(table.name);
    const merge = (table.config && table.config.merge) || {};
    const borderInfo = (table.config && table.config.borderInfo) || {};
    // 3.设置单元格合并,设置单元格边框,设置单元格样式,设置值
    setStyleAndValue(table.data, worksheet);
    setMerge(merge, worksheet);
    setBorder(borderInfo, worksheet);
    return true;
  });

  // return
  // 4.写入 buffer
  return workbook.xlsx.writeBuffer().then(data => {
    // console.log('data', data)
    const blob = new Blob([data], {
      type: 'application/vnd.ms-excel;charset=utf-8'
    });
    // console.log("导出成功!");
    FileSaver.saveAs(blob, `${value}.xlsx`);
  });
};

const setMerge = function(luckyMerge = {}, worksheet:any) {
  const mergearr = Object.values(luckyMerge);
  mergearr.forEach(function(elem:any) {
    // elem格式:{r: 0, c: 0, rs: 1, cs: 2}
    // 按开始行,开始列,结束行,结束列合并(相当于 K10:M12)
    worksheet.mergeCells(
      elem.r + 1,
      elem.c + 1,
      elem.r + elem.rs,
      elem.c + elem.cs
    );
  });
};

const setBorder = function(luckyBorderInfo:any, worksheet:any) {
  if (!Array.isArray(luckyBorderInfo)) return;
  // console.log('luckyBorderInfo', luckyBorderInfo)
  luckyBorderInfo.forEach(function(elem) {
    // 现在只兼容到borderType 为range的情况
    // console.log('ele', elem)
    if (elem.rangeType === 'range') {
      const border = borderConvert(elem.borderType, elem.style, elem.color);
      const rang = elem.range[0];
      const row = rang.row;
      const column = rang.column;
      for (let i = row[0] + 1; i < row[1] + 2; i++) {
        for (let y = column[0] + 1; y < column[1] + 2; y++) {
          worksheet.getCell(i, y).border = border;
        }
      }
    }
    if (elem.rangeType === 'cell') {
      const { col_index, row_index } = elem.value;
      const borderData = Object.assign({}, elem.value);
      delete borderData.col_index;
      delete borderData.row_index;

      worksheet.getCell(row_index + 1, col_index + 1).border = addborderToCell(borderData, row_index, col_index);
    }
  });
};
const setStyleAndValue = function(cellArr:any, worksheet:any) {
  if (!Array.isArray(cellArr)) return;
  cellArr.forEach(function(row, rowid) {
    row.every(function(cell:any, columnid:any) {
      if (!cell) return true;
      const fill = fillConvert(cell.bg);

      const font = fontConvert(
        cell.ff,
        cell.fc,
        cell.bl,
        cell.it,
        cell.fs,
        cell.cl,
        cell.ul
      );
      const alignment = alignmentConvert(cell.vt, cell.ht, cell.tb, cell.tr);
      let value = {};

      if (cell.f) {
        value = { formula: cell.f, result: cell.v };
      } else if (!cell.v && cell.ct && cell.ct.s) {
        // xls转为xlsx之后,内部存在不同的格式,都会进到富文本里,即值不存在与cell.v,而是存在于cell.ct.s之后
        // value = cell.ct.s[0].v
        cell.ct.s.forEach((arr:any) => {
          value += arr.v;
        });
      } else {
        value = cell.v;
      }
      //  style 填入到_value中可以实现填充色
      const letter = createCellPos(columnid);
      const target = worksheet.getCell(letter + (rowid + 1));
      // console.log('1233', letter + (rowid + 1))
      for (const key in fill) {
        target.fill = fill;
        break;
      }
      target.font = font;
      target.alignment = alignment;
      target.value = value;

      return true;
    });
  });
};

const fillConvert = function(bg:any) {
  if (!bg) {
    return {};
  }
  // const bgc = bg.replace('#', '')
  const fill = {
    type: 'pattern',
    pattern: 'solid',
    fgColor: { argb: bg.replace('#', '') }
  };
  return fill;
};

const fontConvert = function(
  ff = 0,
  fc = '#000000',
  bl = 0,
  it = 0,
  fs = 10,
  cl = 0,
  ul = 0
) {
  // luckysheet:ff(样式), fc(颜色), bl(粗体), it(斜体), fs(大小), cl(删除线), ul(下划线)
  const luckyToExcel:any = {
    0: '微软雅黑',
    1: '宋体(Song)',
    2: '黑体(ST Heiti)',
    3: '楷体(ST Kaiti)',
    4: '仿宋(ST FangSong)',
    5: '新宋体(ST Song)',
    6: '华文新魏',
    7: '华文行楷',
    8: '华文隶书',
    9: 'Arial',
    10: 'Times New Roman ',
    11: 'Tahoma ',
    12: 'Verdana',
    num2bl: function(num:number) {
      return num === 0 ? false : true;
    }
  };
  // 出现Bug,导入的时候ff为luckyToExcel的val

  const font = {
    name: typeof ff === 'number' ? luckyToExcel[ff] : ff,
    family: 1,
    size: fs,
    color: { argb: fc.replace('#', '') },
    bold: luckyToExcel.num2bl(bl),
    italic: luckyToExcel.num2bl(it),
    underline: luckyToExcel.num2bl(ul),
    strike: luckyToExcel.num2bl(cl)
  };

  return font;
};

const alignmentConvert = function(
  vt = 'default',
  ht = 'default',
  tb = 'default',
  tr = 'default'
) {
  // luckysheet:vt(垂直), ht(水平), tb(换行), tr(旋转)
  const luckyToExcel:any = {
    vertical: {
      0: 'middle',
      1: 'top',
      2: 'bottom',
      default: 'top'
    },
    horizontal: {
      0: 'center',
      1: 'left',
      2: 'right',
      default: 'left'
    },
    wrapText: {
      0: false,
      1: false,
      2: true,
      default: false
    },
    textRotation: {
      0: 0,
      1: 45,
      2: -45,
      3: 'vertical',
      4: 90,
      5: -90,
      default: 0
    }
  };

  const alignment = {
    vertical: luckyToExcel.vertical[vt],
    horizontal: luckyToExcel.horizontal[ht],
    wrapText: luckyToExcel.wrapText[tb],
    textRotation: luckyToExcel.textRotation[tr]
  };
  return alignment;
};

const borderConvert = function(borderType:any, style = 1, color = '#000') {
  // 对应luckysheet的config中borderinfo的的参数
  if (!borderType) {
    return {};
  }
  const luckyToExcel:any = {
    type: {
      'border-all': 'all',
      'border-top': 'top',
      'border-right': 'right',
      'border-bottom': 'bottom',
      'border-left': 'left'
    },
    style: {
      0: 'none',
      1: 'thin',
      2: 'hair',
      3: 'dotted',
      4: 'dashDot', // 'Dashed',
      5: 'dashDot',
      6: 'dashDotDot',
      7: 'double',
      8: 'medium',
      9: 'mediumDashed',
      10: 'mediumDashDot',
      11: 'mediumDashDotDot',
      12: 'slantDashDot',
      13: 'thick'
    }
  };
  const template = {
    style: luckyToExcel.style[style],
    color: { argb: color.replace('#', '') }
  };
  const border:any = {};
  if (luckyToExcel.type[borderType] === 'all') {
    border['top'] = template;
    border['right'] = template;
    border['bottom'] = template;
    border['left'] = template;
  } else {
    border[luckyToExcel.type[borderType]] = template;
  }
  // console.log('border', border)
  return border;
};

function addborderToCell(borders:any, row_index:any, col_index:any) {
  const border:any = {};
  const luckyExcel:any = {
    type: {
      l: 'left',
      r: 'right',
      b: 'bottom',
      t: 'top'
    },
    style: {
      0: 'none',
      1: 'thin',
      2: 'hair',
      3: 'dotted',
      4: 'dashDot', // 'Dashed',
      5: 'dashDot',
      6: 'dashDotDot',
      7: 'double',
      8: 'medium',
      9: 'mediumDashed',
      10: 'mediumDashDot',
      11: 'mediumDashDotDot',
      12: 'slantDashDot',
      13: 'thick'
    }
  };
  // console.log('borders', borders)
  for (const bor in borders) {
    // console.log(bor)
    if (borders[bor].color.indexOf('rgb') === -1) {
      border[luckyExcel.type[bor]] = {
        style: luckyExcel.style[borders[bor].style],
        color: { argb: borders[bor].color.replace('#', '') }
      };
    } else {
      border[luckyExcel.type[bor]] = {
        style: luckyExcel.style[borders[bor].style],
        color: { argb: borders[bor].color }
      };
    }
  }

  return border;
}

function createCellPos(n:any) {
  const ordA = 'A'.charCodeAt(0);

  const ordZ = 'Z'.charCodeAt(0);
  const len = ordZ - ordA + 1;
  let s = '';
  while (n >= 0) {
    s = String.fromCharCode((n % len) + ordA) + s;

    n = Math.floor(n / len) - 1;
  }
  return s;
}

3、调用,在需要用到的地方引入改方法

import { exportExcel } from '@/utils/exportExcel';

// 导出方法
async function onExport() {
  if (multipleSelection.value.length === 0) {
    queryData.selectIds = '';
  } else {
    let selectIds:any = [];
    multipleSelection.value.forEach(el => {
      selectIds.push(el.uid);
    });
    queryData.selectIds = selectIds.toString();
  }
  const { data } = await api.hiddenDanger.getPageList(queryData);
  // 表头,加粗
  const header = [
    [
      { v: '所属区域', bl: 1 },
      { v: '隐患类型', bl: 1 },
      { v: '隐患子类型', bl: 1 },
      { v: '隐患级别', bl: 1 },
      { v: '隐患地址', bl: 1 },
      { v: '隐患描述', bl: 1 },
      { v: '处置状态', bl: 1 },
      { v: '隐患来源', bl: 1 },
      { v: '权属单位', bl: 1 },
      { v: '隐患检查日期', bl: 1 },
      { v: '隐患时长', bl: 1 },
    ]
  ];

  // 数据内容
  let content:any = [];
  data.forEach((el:any) => {
    const row = [
      { v: el._districtId },
      { v: el._subjectType },
      { v: el._dangerType },
      { v: el._level },
      { v: el.address },
      { v: el.remark },
      { v: el._state },
      { v: el._dangerSource },
      { v: el._orgId },
      { v: el.checkDate },
      { v: el.dangerDuration }
    ];
    content.push(row);
  });

  const sheet = [
    {
      name: 'Sheet1',
      data: [...header, ...content],
    }
  ];
  exportExcel(sheet, '隐患管理');
}

4、看一下实际效果

y1wgd-rocd5.gif