本文介绍 npm 包 cache-manager-fs-hash 的使用教程。cache-manager-fs-hash 是一个简单而又功能强大的缓存管理器，它能够把缓存文件保存在本地文件系统，并通过哈希值进行管理，以减少文件锁定和读写冲突。本文重点讲解 cache-manager-fs-hash 的安装、基本使用方法和相关注意事项。
安装
使用 npm 命令行工具即可完成安装：
npm install --save cache-manager-fs-hash
安装完成后，在你的项目中引入 cache-manager-fs-hash 模块即可开始使用。
基本用法
cache-manager-fs-hash 提供了一系列 API 以便于管理缓存文件。下面我们详细说明其每个 API 的使用场景和参数：
create
参数：
- options <Object> 创建缓存对象的选项。
- ttl <Number> 缓存的超时时间（秒）。
- max <Number> 缓存文件的最大数量。
- path <String> 缓存文件存储的路径，必须是一个存在的目录。
- useClones <Boolean> 是否使用克隆数据。默认为 false。
- hash <Object> 哈希算法函数的设置，可选参数，具体说明见下方。
返回值：
返回一个 CacheManager 对象，该对象包含了所有缓存管理操作方法。
示例代码：
-- -------------------- ---- -------
----- ------------ - -------------------------
----- ------ - ---------------------------------
----- ------- - -
---- ----
---- -----
----- ----------
---------- ------
----- -
---------- ---------
---- -----------------
------- ---
--
--
----- ----- - ----------------------
------ -------
-------- --------
---get
参数：
- key <String> 缓存键。
- callback <Function> 回调函数，它接收两个参数：err 和 value。
返回值：
无。函数通过回调函数返回 err 和 value 两个参数。
示例代码：
cache.get('my-key', (err, value) => {
if (err) {
console.log(err);
} else {
console.log(value);
}
});set
参数：
- key <String> 缓存键。
- value <String, Buffer, Object> 缓存值。
- options <Object> 缓存选项。
- ttl <Number> 缓存超时时间（秒），如果未设置，则使用创建缓存对象时设置的默认值。
- hash <String> 如要使用不同的哈希算法，则需要在此处指定。如不填则使用创建缓存对象时设置的默认值。
- hashOptions <Object> 如要使用不同的哈希算法参数，则需要在此处指定。如不填则使用创建缓存对象时设置的默认值。
返回值：
无。
示例代码：
cache.set('my-key', 'my-value');del
参数：
- key <String> 要删除的缓存键。
返回值：
无。
示例代码：
cache.del('my-key');wrap
参数：
- key <String> 缓存键。
- fn <Function> 要缓存的函数。
- [options] <Object> 缓存选项。
- ttl <Number> 缓存超时时间（秒），如果未设置，则使用创建缓存对象时设置的默认值。
- hash <String> 如要使用不同的哈希算法，则需要在此处指定。如不填则使用创建缓存对象时设置的默认值。
- hashOptions <Object> 如要使用不同的哈希算法参数，则需要在此处指定。如不填则使用创建缓存对象时设置的默认值。
返回值：
函数的执行结果。
示例代码：
const res = await cache.wrap('my-key', () => {
return 'my-value';
});hash 算法
cache-manager-fs-hash 支持不同的哈希算法，其中最常用的是 sha1, sha256 和 md5。如果需要使用其他哈希算法，则需要先使用 crypto 模块生成 hash 函数并调用 digest('hex') 方法获取到哈希值。
// crypto.js
const crypto = require('crypto');
const hash = crypto.createHash('md5');
module.exports = (str) => hash.update(str).digest('hex');使用时必须在创建缓存对象时指定 hash 定义，如下例所示：
-- -------------------- ---- -------
----- ------- - -
---- ----
---- -----
----- ----------
---------- ------
----- -
---------- ---------
---- -----------------
------- ---
--
--
----- ----- - ----------------------
------ -------
-------- --------
---
---------------- -------- - ----- --------------------- ---注意事项
- 缓存文件的最大数量应尽量控制额外开销，不宜设置过大。
- 请注意跨平台的路径兼容问题，如使用相对路径请确保在所有系统上均能正确访问存储目录。
- 使用 cache-manager-fs-hash 时不需要手动指定哈希值，它会在使用 get, set 等 API 时自动计算并校验哈希值。
- 如在多个进程或多个服务器之间共享缓存，则需要使用外部共享存储，如 Redis、Memcached 等。
总结
cache-manager-fs-hash 是一个良好的缓存管理器，可以方便管理文件缓存，避免因多个进程或多个服务器之间的冲突导致数据丢失或不一致。本文介绍了 cache-manager-fs-hash 的安装、基本使用方法和相关注意事项。希望它能够帮助您更好的管理文件缓存，并提升应用程序的性能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb4b7b5cbfe1ea061133c