xlsx插件简介

news2024/10/6 22:34:12

1. xlsx插件
- 1.1. 常用属性和方法
  - 1.1.1. 创建新的工作簿
  - 1.1.2. 从数组生成工作表
  - 1.1.3. 添加工作表到工作簿
  - 1.1.4. 从HTML表格创建工作表
  - 1.1.5. 读取Excel文件
  - 1.1.6. 导出Excel文件
  - 1.1.7. 设置单元格样式
2. vue中如何使用xlsx
- 2.1. vue-xlsx的特点
- 2.2. 常用属性和方法
  - 2.2.1. 安装 vue-xlsx
  - 2.2.2. 导入 vue-xlsx
  - 2.2.3. 读取Excel文件
  - 2.2.4. 导出Excel文件

1. xlsx插件

xlsx插件（通常指的是SheetJS/js-xlsx）是一个强大的JavaScript库，它允许你在浏览器或Node.js环境中读取、创建、编辑和导出Excel文件（.xls, .xlsx, .csv, .ods等多种格式）。

这个库是纯JavaScript编写的，不依赖于任何外部库，非常适合在前端应用中处理Excel数据，也适用于服务器端处理。

1.1. 常用属性和方法

以下是xlsx插件中一些核心的属性和方法及其使用示例：

1.1.1. 创建新的工作簿

var XLSX = require('xlsx');
var workbook = XLSX.utils.book_new();

这段代码会创建一个新的Excel工作簿对象。

1.1.2. 从数组生成工作表

var ws_data = [
  ["姓名", "年龄", "城市"],
  ["张三", 28, "北京"],
  ["李四", 32, "上海"]
];
var ws = XLSX.utils.aoa_to_sheet(ws_data);

aoa_to_sheet方法将二维数组(Array of Arrays)转换为工作表对象。

1.1.3. 添加工作表到工作簿

XLSX.utils.book_append_sheet(workbook, ws, "Sheet1");

这里将之前创建的工作表ws添加到工作簿中，并命名为"Sheet1"。

1.1.4. 从HTML表格创建工作表

假设你有一个DOM元素引用一个HTML表格：

var table = document.getElementById('myTable');
var ws = XLSX.utils.table_to_sheet(table);

这段代码会把指定的HTML表格转换为工作表对象。

1.1.5. 读取Excel文件

在浏览器环境下，可以通过FileReader读取文件内容，然后使用read方法：

var reader = new FileReader();
reader.onload = function(e) {
  var data = e.target.result;
  var workbook = XLSX.read(data, {type: 'binary'});
  // 处理工作簿...
};
reader.readAsBinaryString(file);

这里file是你通过文件输入控件获取到的文件对象。

1.1.6. 导出Excel文件

你可以将工作簿转换为Blob对象，然后下载：

var wbout = XLSX.write(workbook, {bookType:'xlsx', bookSST:true, type: 'binary'});
saveAs(new Blob([s2ab(wbout)], {type:"application/octet-stream"}), "example.xlsx");
// 注意：s2ab是一个辅助函数，用于将字符串转换为ArrayBuffer
function s2ab(s) {
  var buf = new ArrayBuffer(s.length);
  var view = new Uint8Array(buf);
  for (var i=0; i<s.length; i++) view[i] = s.charCodeAt(i) & 0xFF;
  return buf;
}

上述代码展示了如何将工作簿对象转换并下载为一个名为"example.xlsx"的Excel文件。

1.1.7. 设置单元格样式

虽然xlsx的核心库主要关注数据处理，但其扩展库xlsx-style可以用来设置单元格样式，例如字体、颜色等。不过需要注意的是，样式功能可能在最新的SheetJS版本中有所变化，推荐查阅最新的文档。

这些只是xlsx库的基础用法，实际上它提供了更多高级功能，包括处理公式、图表、样式等。为了获取更详细的使用方法和最新特性，建议直接参考SheetJS/js-xlsx的官方GitHub仓库和文档。

更多详细内容，请微信搜索“前端爱好者“， 戳我查看 。

2. vue中如何使用xlsx

在Vue中，vue-xlsx是一个专门为Vue框架设计的轻量级封装库，它基于SheetJS/js-xlsx，目的是使得在Vue应用中处理Excel文件变得更加简单和直接。

尽管直接使用SheetJS/js-xlsx已经足够强大，但vue-xlsx通过提供Vue组件和更加Vue友好的API，使得集成和使用过程对Vue开发者更为友好。

2.1. vue-xlsx的特点

易用性：为Vue开发者量身定制，简化了与Vue应用的集成过程。
模块化：支持按需引入，仅使用你需要的功能，保持应用体积小。
文档友好：提供了详尽的文档和示例，帮助开发者快速上手。

2.2. 常用属性和方法

由于具体实现细节可能随库的更新而变化，以下是一些基于SheetJS/js-xlsx的核心概念和方法在Vue中的应用示例：

2.2.1. 安装 vue-xlsx

首先，你需要通过npm或yarn安装vue-xlsx库：

npm install vue-xlsx

2.2.2. 导入 vue-xlsx

在Vue组件中导入vue-xlsx：

import { Xlsx } from 'vue-xlsx';

2.2.3. 读取Excel文件

使用FileReader API读取用户选择的Excel文件，并通过Xlsx提供的方法解析数据：

methods: {
  handleFileUpload(event) {
    const file = event.target.files[0];
    const reader = new FileReader();
    reader.onload = (e) => {
      const data = e.target.result;
      const workbook = Xlsx.read(data, { type: 'binary' });
      const sheetName = workbook.SheetNames[0];
      const sheetData = Xlsx.utils.sheet_to_json(workbook.Sheets[sheetName], { header: 1 });
      console.log(sheetData); // 打印解析后的数据
    };
    reader.readAsBinaryString(file);
  },
},

上面的例子中，handleFileUpload方法处理文件上传事件，读取文件内容并将其解析为JSON格式。

2.2.4. 导出Excel文件

可以使用Xlsx.utils.json_to_sheet和Xlsx.writeFile方法将数据导出到Excel文件：

methods: {
  exportToExcel() {
    const ws = Xlsx.utils.json_to_sheet([{ name: "John Doe", age: 30 }, { name: "Jane Doe", age: 25 }]);
    const wb = Xlsx.utils.book_new();
    Xlsx.utils.book_append_sheet(wb, ws, "Sheet1");
    Xlsx.writeFile(wb, "output.xlsx");
  },
},