Node.js 中的 tar 模块实用指南

Node.js 中的 tar 模块实用指南

node-tartar for node项目地址:https://gitcode.com/gh_mirrors/no/node-tar

项目介绍

node-tar 是一个为 Node.js 设计的快速且功能全面的 Tar 工具包。它旨在模拟 Unix 系统中 tar(1) 命令的行为。对 Unix 熟悉的开发者将会发现其接口直观易懂。该库不仅便于创建、替换、更新、列出和提取 tar 归档文件，而且通过简洁的 API 支持高级定制。

项目快速启动

要快速地在你的 Node.js 项目中集成并使用 node-tar，首先确保你已经安装了它。可以通过 npm 进行安装：

npm install tar

接下来，是一个基本示例，展示如何创建一个 tar 文件：

const tar = require('tar');
const fs = require('fs');

// 创建一个 tar 文件，这里将把当前目录下的所有文件打包。
tar.c(
    { gzip: true, file: 'backup.tar.gz' }, // 输出压缩后的 tar 文件
    ['./.'] // 需要打包的文件或目录路径，"./." 表示当前目录
)
.then(() => console.log('备份完成'))
.catch(err => console.error('备份过程中出错:', err));

反向操作，解压 tar 文件：

fs.createReadStream('backup.tar.gz')
.pipe(tar.x({ C: './extracted' })) // 解压到./extracted目录
.on('finish', () => console.log('解压完成'));

应用案例和最佳实践

动态调整归档属性

利用 onWriteEntry 钩子可以修改即将写入归档的文件属性，例如统一转换文件名为小写，并设置执行权限：

const filesProcessed = [];
tar.c({
    sync: true,
    file: 'modified-archive.tar',
    onWriteEntry(entry) {
        entry.path = entry.path.toLowerCase(); // 转换为小写
        entry.mode = 0o755; // 设置为可执行权限
        filesProcessed.push(`${entry.path} - ${octalToPermission(entry.mode)}`);
    }
}, ['./exampleFolder'])
.then(() => {
    console.log('处理完成，添加的文件列表:', filesProcessed);
});

function octalToPermission(mode) {
    return (mode & 0o777).toString(8);
}

典型生态项目

虽然本项目自身是 Node.js 生态中的基础工具，广泛应用于各种构建、部署流程中，直接与其他特定生态项目的互动不那么显眼。不过，它与npm, yarn等包管理器紧密相关，这些工具在管理依赖、发布包时都会用到 tar 来处理 .tgz 格式的包文件。因此，可以说任何依赖于Node.js进行版本控制或分发的软件项目都间接受益于 node-tar 的存在。

使用 node-tar 可以增强自定义构建脚本的能力，帮助你高效地管理和维护资源归档，尤其是在自动化部署、备份恢复场景中发挥着不可或缺的作用。

---

以上就是关于 node-tar 的简明教程，希望能帮助你更好地理解和运用这个强大的归档工具。

node-tartar for node项目地址:https://gitcode.com/gh_mirrors/no/node-tar