【亲测免费】 Node-xlsx 使用教程

1. 项目介绍

Node-xlsx 是一个基于 Node.js 的 Excel 文件解析器和构建器。它依赖于 SheetJS 的 xlsx 模块来解析和构建 Excel 工作表。此项目使用 TypeScript 进行静态类型检查，并导出了类型定义，以提高开发效率。

2. 项目快速启动

在开始使用 node-xlsx 前，确保你的环境中已经安装了 Node.js。

安装

通过 npm 或 pnpm 安装 node-xlsx：

npm install node-xlsx
# 或者
pnpm add node-xlsx

解析 Excel 文件

以下是一个解析 Excel 文件的示例：

const xlsx = require('node-xlsx').default;

// 解析一个文件
const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);

// 解析一个缓冲区
const workSheetsFromBuffer = xlsx.parse(fs.readFileSync(`${__dirname}/myFile.xlsx`));

构建 Excel 文件

以下是一个构建 Excel 文件的示例：

const xlsx = require('node-xlsx').default;

const data = [
    [1, 2, 3],
    [true, false, null, 'sheetjs'],
    ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
    ['baz', null, 'qux'],
];

var buffer = xlsx.build([
    {
        name: 'mySheetName',
        data: data
    }
]);

3. 应用案例和最佳实践

自定义列宽

你可以通过 sheetOptions 来设置自定义列宽：

const xlsx = require('node-xlsx').default;

const data = [
    [1, 2, 3],
    [true, false, null, 'sheetjs'],
    ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
    ['baz', null, 'qux'],
];

const sheetOptions = {
    '!cols': [
        { wch: 6 },
        { wch: 7 },
        { wch: 10 },
        { wch: 20 }
    ]
};

var buffer = xlsx.build([
    {
        name: 'mySheetName',
        data: data,
        options: sheetOptions
    }
]);

跨行合并

你可以通过 !merges 选项来设置跨行合并：

const xlsx = require('node-xlsx').default;

const data = [
    [1, 2, 3],
    [true, false, null, 'sheetjs'],
    ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
    ['baz', null, 'qux'],
];

const range = {
    s: { c: 0, r: 0 },
    e: { c: 0, r: 3 }
};

const sheetOptions = {
    '!merges': [range]
};

var buffer = xlsx.build([
    {
        name: 'mySheetName',
        data: data,
        options: sheetOptions
    }
]);

4. 典型生态项目

目前，Node-xlsx 在生态中有着广泛的应用，许多项目都基于它来处理 Excel 文件。以下是一些典型的生态项目：

• exceljs: 一个基于 Node.js 的 Excel 文件处理库，支持读写 Excel 文件。
• ** formulajs**: 一个实现 Excel 公式计算功能的 Node.js 库。

这些项目可以帮助开发者更方便地在 Node.js 环境中处理 Excel 文件。