什么是exceljs
exceljs是一个用于处理excel文件的javascript库。它可以让你使用javascript创建、读取和修改excel文件。
以下是exceljs的一些主要特点:
- 支持xlsx、xlsm、xlsb、xls格式的excel文件。
- 可以创建和修改工作表、单元格、行和列。
- 可以设置单元格样式、字体、背景颜色等。
- 可以设置工作表的打印选项。
- 可以将excel文件保存到本地或者下载到浏览器中。
- 支持流式写入大型excel文件,以避免内存限制问题。
我们使用exceljs可以轻松地将数据转换为excel文件,并且可以通过代码自动化地创建和修改excel文件。
exceljs的基本使用
安装exceljs
在命令行中使用命令来安装excel.js
npm install exceljs
创建工作簿
excel.js库提供了创建新的工作簿、打开已有的工作簿以及保存工作簿的方法。
首先我们需要引入excel.js库:
const exceljs = require('exceljs');
接着,我们可以使用以下代码创建一个新的工作簿:
const workbook = new exceljs.workbook();
这个代码将会创建一个空的工作簿。我们可以通过以下代码添加一个新的工作表:
const worksheet = workbook.addworksheet('sheet1');
这个代码将会在工作簿中添加一个名为’sheet1’的新工作表。我们也可以使用以下代码获取已有的工作表:
const worksheet = workbook.getworksheet('sheet1');
这个代码将会获取名为’sheet1’的工作表。如果工作簿中不存在这个工作表,那么这个代码将会返回undefined。
在创建新的工作表时,我们可以指定一些选项来控制新工作表的行数、列数、列宽和行高等,例如:
const options = { pagesetup: {papersize: 9, orientation: 'landscape'}, properties: {tabcolor: {argb:'ffc0000'}} }; const worksheet = workbook.addworksheet('sheet1', options);
这个代码将会创建一个名为’sheet1’的新工作表,并设置纸张大小为’a4’、方向为’横向’,以及选项卡颜色为橙色。
除此之外,我们还可以使用以下代码删除一个已有的工作表:
workbook.removeworksheet(worksheet);
这个代码将会删除名为’sheet1’的工作表。需要注意的是,如果工作簿中只剩下一个工作表,那么这个工作表是不能被删除的。
最后我们需要使用以下代码保存工作簿:
workbook.xlsx.writefile('example.xlsx') .then(function() { console.log('文件已保存'); });
这个代码将会把工作簿保存为’example.xlsx’文件。需要注意的是,excel.js库支持保存为多种格式,包括.xlsx、.xls、.csv等。
操作单元格
excel.js库提供了一系列方法来操作单元格,例如获取单元格、设置单元格值、合并单元格和设置单元格样式等
首先我们可以使用以下代码创建一个新的工作簿和工作表:
const workbook = new exceljs.workbook(); const worksheet = workbook.addworksheet('sheet1');
获取单元格
我们可以使用以下代码获取一个单元格:
const cell = worksheet.getcell('a1');
这个代码将会获取’sheet1’工作表中的a1单元格。我们也可以使用以下代码获取一个单元格的行和列:
const cell = worksheet.getrow(1).getcell(1);
这个代码将会获取’sheet1’工作表中的a1单元格。
设置单元格值
然后我们可以使用以下代码设置一个单元格的值:
worksheet.getcell('a1').value = 'hello, world!';
这个代码将会在’sheet1’工作表中的a1单元格设置值为’hello, world!’
excel.js库支持各种数据类型,包括字符串、数字、日期和布尔值等。
合并单元格
我们可以使用以下代码合并一个区域内的单元格:
worksheet.mergecells('b2:c3');
这个代码将会合并’sheet1’工作表中b2到c3区域内的所有单元格。
需要注意的是,合并单元格时,只有左上角的单元格保留了原有的值,其他单元格的值都被清空了。
设置单元格样式
我们可以使用以下代码设置一个单元格的样式:
worksheet.getcell('a1').font = {bold: true}; worksheet.getcell('a1').fill = {type: 'pattern', pattern: 'solid', fgcolor: {argb: 'ffff0000'}}; worksheet.getcell('a1').border = {top: {style: 'thin'}, left: {style: 'thin'}, bottom: {style: 'thin'}, right: {style: 'thin'}}; worksheet.getcell('a1').alignment = {horizontal: 'center', vertical: 'middle'};
这个代码将会设置’sheet1’工作表中的a1单元格的字体加粗、背景颜色为红色、边框为实线细边框、水平居中和垂直居中。
读取和写入数据
读取工作表中的数据
我们可以使用以下代码读取工作表中的数据:
worksheet.eachrow({ includeempty: false }, function(row, rownumber) { console.log('row ' + rownumber + ' = ' + json.stringify(row.values)); });
上述代码将会遍历’sheet1’工作表中的每一行并打印出每一行的值,这里我们使用了includeempty选项来忽略空行。
除此之外,我们还可以使用以下代码获取’sheet1’工作表中的a1单元格的值:
const data = [ { name: 'john', age: 30 }, { name: 'jane', age: 25 }, { name: 'jim', age: 40 } ]; worksheet.addrows(data);
写入数据到工作表中
我们可以使用以下代码将数据写入到工作表中:
worksheet.getcolumn('a').values = [1, 2, 3, 4, 5];
这个代码将会在’sheet1’工作表中的a列写入1到5这五个数字。
除此之外,我们还可以使用以下代码将一个对象数组写入到工作表中:
const data = [ { name: 'john', age: 30 }, { name: 'jane', age: 25 }, { name: 'jim', age: 40 } ]; worksheet.addrows(data);
这个代码将会在’sheet1’工作表中添加三行数据,每一行包括’name’和’age’两个字段
处理行和列
获取行和列
我们可以使用以下代码获取工作表中的行和列:
const row = worksheet.getrow(1); const column = worksheet.getcolumn('a');
这个代码将会获取’sheet1’工作表中的第一行和第一列。
我们也可以使用以下代码获取指定区域内的行和列:
const rows = worksheet.getrows(1, 5); const columns = worksheet.getcolumns('a', 'c');
这个代码将会获取’sheet1’工作表中第1到5行和a到c列。
添加行和列
我们可以使用以下代码添加新的行和列:
const row = worksheet.addrow([1, 2, 3, 4, 5]); const column = worksheet.addcolumn(['a', 'b', 'c', 'd', 'e']);
这个代码将会在’sheet1’工作表中添加一行和一列,并分别设置它们的值为1到5和a到e。
删除行和列
我们可以使用以下代码删除指定的行和列:
worksheet.splicerows(1, 5); worksheet.splicecolumns('a', 2);
这个代码将会删除’sheet1’工作表中第1到5行和a到b列。
设置行高和列宽
我们可以使用以下代码设置指定行的高度和指定列的宽度:
worksheet.getrow(1).height = 30; worksheet.getcolumn('a').width = 20;
这个代码将会设置’sheet1’工作表中第一行的高度为30像素,第一列的宽度为20字符。
隐藏行和列
我们可以使用以下代码隐藏工作表中的行和列:
worksheet.getrow(1).hidden = true; worksheet.getcolumn('a').hidden = true;
这个代码将会隐藏’sheet1’工作表中第一行和第一列。
冻结窗格
我们可以使用以下代码冻结工作表中的窗格:
worksheet.views = [ {state: 'frozen', xsplit: 1, ysplit: 1} ];
这个代码将会冻结’sheet1’工作表中第一行和第一列。
需要注意的是,xsplit和ysplit选项指定了冻结窗格的位置,它们的值从1开始。
导入和导出数据
excel.js库提供了一系列方法来导入和导出excel文件中的数据,例如从文件读取excel数据、将数据写入到excel文件中以及将excel文件转换为其他格式等。
从文件读取excel数据
const workbook = new exceljs.workbook(); workbook.xlsx.readfile('path/to/file.xlsx') .then(function() { const worksheet = workbook.getworksheet('sheet1'); worksheet.eachrow({ includeempty: false }, function(row, rownumber) { console.log('row ' + rownumber + ' = ' + json.stringify(row.values)); }); });
这个代码将会从’path/to/file.xlsx’文件中读取数据,并打印出’sheet1’工作表中每一行的值。
将数据写入到excel文件中
const workbook = new exceljs.workbook(); const worksheet = workbook.addworksheet('sheet1'); worksheet.addrow([1, 2, 3, 4, 5]); worksheet.addrow(['a', 'b', 'c', 'd', 'e']); workbook.xlsx.writefile('path/to/file.xlsx') .then(function() { console.log('file is written successfully!'); });
这个代码将会创建一个新的工作簿和工作表,然后向’sheet1’工作表中添加两行数据,最后它将会将这个工作簿写入到’path/to/file.xlsx’文件中。
将excel文件转换为其他格式
const workbook = new exceljs.workbook(); workbook.xlsx.readfile('path/to/file.xlsx') .then(function() { workbook.csv.writefile('path/to/file.csv') .then(function() { console.log('csv file is written successfully!'); }); });
这个代码将会从’path/to/file.xlsx’文件中读取数据,并将其转换为csv格式,然后它将会将这个csv文件写入到’path/to/file.csv’文件中。除此之外,excel.js库还支持将excel文件转换为json、html、pdf等各种格式。
exceljs实战
我们之前曾经爬过掘金小册的所有数据并且存到了本地的json文件里
没有学过的同学可以看一下这一篇nodejs中使用puppeteer控制浏览器中视频播放功能
这里我们直接来看生成的json文件:
我们这里就来把这些数据全部写入 excel 表并导出文件
相信大家有了前面对exceljs的了解,这里的代码就非常简单了
首先我们新建一个 excel 工作簿,然后创建一个新的工作表,我们给这个工作表添加自定义表头,接下来就是把数据写入excel表并且设置一些单元格的样式,最后我们将工作簿保存然后导出excel文件
具体实现请看下面的代码:
const exceljs = require('exceljs'); const bookdata = require('../juejin/xiaoce.json') // 新建一个 excel 工作簿 const workbook = new exceljs.workbook(); // 创建一个新的工作表 const worksheet = workbook.addworksheet('sheet1'); // 添加表头 worksheet.columns = [ { header: '小册名称', key: 'title', width: 45 }, // 设置列宽 { header: '小册简介', key: 'desc', width: 120 }, // 设置列宽 { header: '小册作者', key: 'author', width: 16 }, // 设置列宽 { header: '小册价格', key: 'price', width: 18 }, // 设置列宽 ]; // 添加数据 worksheet.addrows(bookdata); // 第一行字体加粗加大 worksheet.getrow(1).font = { bold: true, size: 14 }; // 第一行单元格居中 worksheet.getrow(1).alignment = { vertical: 'middle', horizontal: 'center' }; // 第一列单元格居中 worksheet.getcolumn(1).alignment = { vertical: 'middle', horizontal: 'center' }; // 第三列单元格居中 worksheet.getcolumn(3).alignment = { vertical: 'middle', horizontal: 'center' }; // 第四列单元格居中 worksheet.getcolumn(4).alignment = { vertical: 'middle', horizontal: 'center' }; // 将工作簿保存到文件 workbook.xlsx.writefile('juejinbook.xlsx') .then(() => { console.log('excel文件已保存'); }) .catch((error) => { console.log('保存excel文件时出错:', error); });
运行程序,不出意外的话控制台会出现“excel文件已保存”,我们发现目录下确实多了一个excel文件:
然后我们来打开生成的excel文件,看看里面是不是我们要的json文件里爬取到的数据:
没有问题!所有的小册数据全部写入了excel文件,并且单元格的样式也是我们想要的。
总结
excel.js是一个强大的javascript库,它提供了一系列方法来处理excel文件,例如创建和编辑工作簿、读取和写入数据、处理行和列、设置样式、导入和导出数据等。
使用excel.js,我们可以轻松地创建和编辑excel文件,以及从excel文件中读取和写入数据。
在使用excel.js时,我们需要注意以下几点:
- excel.js库需要安装并引入到我们的项目中。
- 我们需要创建一个新的工作簿和工作表来存储数据。
- 我们可以使用一系列方法来读取和写入工作表中的数据,例如eachrow()、getcell()、addrow()、addcolumn()等。
- 我们可以使用一系列方法来处理工作表中的行和列,例如getrow()、getcolumn()、addrow()、addcolumn()、splicerows()、splicecolumns()等。
- 我们可以使用一系列方法来设置工作表中的行和列的样式,例如设置行高和列宽、设置单元格边框和背景色等。
- 我们可以使用一系列方法来导入和导出excel文件中的数据,例如从文件读取excel数据、将数据写入到excel文件中以及将excel文件转换为其他格式等。
最后我们还带大家写了一个excel.js的实战项目来生成了爬取到的掘金小册excel文件
如果想深入了解exceljs,请查看官方文档:https://github.com/exceljs/exceljs/blob/master/readme_zh.md
发表评论