深入理解memfs项目中的crudfs文件系统抽象层-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00632/article/details/148942910

深入理解memfs项目中的crudfs文件系统抽象层

memfs JavaScript file system utilities 项目地址: https://gitcode.com/gh_mirrors/me/memfs

什么是crudfs

crudfs是memfs项目中提供的一个CRUD风格的文件系统抽象层。它作为真实文件系统的一个轻量级封装，允许开发者以CRUD（创建、读取、更新、删除）的方式操作文件和文件夹。这种设计理念特别适合现代Web应用开发场景，因为它：

保持轻量级设计，可以高效地打包用于浏览器环境
提供精简的API接口，同时覆盖大多数常见文件操作场景
采用集合(Collections)和资源(Resources)的概念来组织文件系统结构

在crudfs的术语中，文件夹被称为"集合"(collections)或"类型"(types)，而文件则被称为"资源"(resources)。

核心使用场景

基于File System Access API的使用

现代浏览器提供的File System Access API为Web应用提供了访问本地文件系统的能力。crudfs可以很好地与这个API集成：

import { FsaCrud } from 'memfs/lib/fsa-to-crud';

// 假设dirHandle是通过window.showDirectoryPicker()获取的目录句柄
const crud = new FsaCrud(dirHandle);

创建这个实例后，你就可以使用简洁的CRUD接口来操作文件系统了。下面是一些典型操作示例：

创建资源：

// 在/user/files集合下创建两个二进制文件
await crud.put(['user', 'files'], 'file1.bin', new Uint8Array([1, 2, 3]));
await crud.put(['user', 'files'], 'file2.bin', new Uint8Array([4, 5, 6]));

列出集合内容：

const files = await crud.list(['user', 'files']);
// files将包含['file1.bin', 'file2.bin']

读取资源内容：

const fileContent = await crud.get(['user', 'files'], 'file1.bin');

删除资源：

await crud.delete(['user', 'files'], 'file1.bin');

清空集合：

await crud.drop(['user', 'files']);

基于Node.js文件系统的使用

crudfs同样可以运行在Node.js环境中，使用标准的fs模块作为底层实现：

import * as fs from 'fs';
import { NodeCrud } from 'memfs/lib/node-to-crud';

const crud = new NodeCrud({ 
  fs: fs.promises,  // 使用Promise版本的fs API
  dir: '/path/to/folder'  // 指定操作的基础目录
});

通过FSA适配器间接使用

memfs还提供了一种间接使用方式，通过File System Access API适配器来包装Node.js的fs模块：

import * as fs from 'fs';
import { nodeToFsa } from 'memfs/lib/node-to-fsa';
import { FsaCrud } from 'memfs/lib/fsa-to-crud';

// 将Node.js文件系统转换为FSA接口
const dir = nodeToFsa(fs, '/path/to/folder', { mode: 'readwrite' });
// 然后使用FSA接口创建crud实例
const crud = new FsaCrud(dir);

这种方式特别适合需要在不同环境间保持代码一致性的场景。