@zenweb/cache 4.3.1 → 4.5.0

package/dist/cache.d.ts

@@ -18,14 +18,14 @@ export declare class CacheResult {
  */
 export declare class Cache {
     private redis;
-    private option?;
-    constructor(redis: Redis, option?: SetupOption | undefined);
+    private option;
+    constructor(redis: Redis, option: Required<SetupOption>);
     /**
      * 删除缓存
      */
     del(key: string): Promise<number>;
     /**
-     * 直接设置缓存 - 不经过 JSON 序列化的数据
+     * 直接设置缓存 - 不经过序列化的数据
      * @param key
      * @param value
      * @param ttl  缓存有效时长 (秒)，不设置取默认设置
@@ -34,7 +34,7 @@ export declare class Cache {
     /**
      * 缓存对象
      * @param key 缓存key
-     * @param value 缓存值，除了 `Buffer` 以外的值会经过 JSON 序列化
+     * @param value 缓存值，除了 `Buffer` 以外的值会经过序列化
      * @param ttlopt 缓存有效时长 (秒)，不设置取默认设置 | 缓存选项
      */
     set(key: string, value: any, ttlopt?: number | SetOption): Promise<SetResult>;

package/dist/cache.js

@@ -40,7 +40,7 @@ class Cache {
         return this.redis.del(key);
     }
     /**
-     * 直接设置缓存 - 不经过 JSON 序列化的数据
+     * 直接设置缓存 - 不经过序列化的数据
      * @param key
      * @param value
      * @param ttl  缓存有效时长 (秒)，不设置取默认设置
@@ -54,19 +54,13 @@ class Cache {
     /**
      * 缓存对象
      * @param key 缓存key
-     * @param value 缓存值，除了 `Buffer` 以外的值会经过 JSON 序列化
+     * @param value 缓存值，除了 `Buffer` 以外的值会经过序列化
      * @param ttlopt 缓存有效时长 (秒)，不设置取默认设置 | 缓存选项
      */
     async set(key, value, ttlopt) {
-        var _a;
         let compressed;
-        let data = Buffer.isBuffer(value) ? value : JSON.stringify(value);
-        const opt = Object.assign({
-            ttl: 60,
-            compressMinLength: 1024,
-            compressStoreRatio: 0.95,
-            compressLevel: 1,
-        }, (_a = this.option) === null || _a === void 0 ? void 0 : _a.set, typeof ttlopt === 'object' ? ttlopt : undefined);
+        let data = Buffer.isBuffer(value) ? value : this.option.serializer.serialize(value);
+        const opt = Object.assign({}, this.option.set, typeof ttlopt === 'object' ? ttlopt : undefined);
         if (typeof ttlopt === 'number') {
             opt.ttl = ttlopt;
         }
@@ -107,17 +101,24 @@ class Cache {
             // 解析处理
             if (_opt.parse) {
                 _getDebug('[%s] parse', key);
-                return JSON.parse(data.toString());
+                return this.option.serializer.deserialize(data);
             }
             return new CacheResult(compressed, data);
         }
     }
     async lockGet(key, fetch, _opt) {
-        var _a, _b;
-        const opt = Object.assign({}, (_a = this.option) === null || _a === void 0 ? void 0 : _a.set, (_b = this.option) === null || _b === void 0 ? void 0 : _b.lockGet, _opt);
+        const opt = Object.assign({}, this.option.set, this.option.lockGet, _opt);
+        // 本地存储
+        if (opt.localStore && key in opt.localStore) {
+            return opt.localStore[key];
+        }
         // 获取数据并设置到缓存中
         const fetchAndSet = async () => {
             const obj = await fetch();
+            // 本地存储
+            if (opt.localStore) {
+                opt.localStore[key] = obj;
+            }
             const result = await this.set(key, obj, opt);
             if ((_opt === null || _opt === void 0 ? void 0 : _opt.parse) !== false) {
                 return obj;
@@ -147,6 +148,10 @@ class Cache {
                     if (!locker) {
                         preRefresh();
                     }
+                    // 本地存储
+                    if (opt.localStore) {
+                        opt.localStore[key] = data;
+                    }
                     return data;
                 }
             }

package/dist/index.js

@@ -18,6 +18,7 @@ exports.Cache = exports.cached = exports.Locker = exports.$cache = exports.getCa
 const cache_1 = require("./cache");
 Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return cache_1.Cache; } });
 const ioredis_1 = require("ioredis");
+const options_1 = require("./options");
 var global_1 = require("./global");
 Object.defineProperty(exports, "getCache", { enumerable: true, get: function () { return global_1.getCache; } });
 Object.defineProperty(exports, "$cache", { enumerable: true, get: function () { return global_1.$cache; } });
@@ -27,24 +28,13 @@ var locker_1 = require("./locker");
 Object.defineProperty(exports, "Locker", { enumerable: true, get: function () { return locker_1.Locker; } });
 var middleware_1 = require("./middleware");
 Object.defineProperty(exports, "cached", { enumerable: true, get: function () { return middleware_1.cached; } });
-/**
- * 默认选项
- */
-const defaultOption = {
-    redis: {
-        host: process.env.REDIS_HOST || '127.0.0.1',
-        port: parseInt(process.env.REDIS_PORT || '') || 6379,
-        password: process.env.REDIS_PASSWORD || '',
-        db: parseInt(process.env.REDIS_DB || '') || 0,
-    },
-};
 /**
  * 安装模块
  * @param option 配置
  */
 function setup(option) {
     return async function cache(setup) {
-        const opt = Object.assign({}, defaultOption, option);
+        const opt = Object.assign({}, options_1.defaultSetupOption, option);
         setup.debug('option: %o', opt);
         const redis = opt.redis instanceof ioredis_1.Redis ? opt.redis : new ioredis_1.Redis(opt.redis);
         await redis.ping('check');

package/dist/options.d.ts

@@ -0,0 +1,7 @@
+import type { RedisOptions } from "ioredis";
+import type { LockGetOption, ObjectSerializer, SetOption, SetupOption } from "./types";
+export declare const defaultRedisOption: RedisOptions;
+export declare const defaultSetOption: SetOption;
+export declare const defaultLockGetOption: LockGetOption;
+export declare const defaultSerializer: ObjectSerializer;
+export declare const defaultSetupOption: Required<SetupOption>;

package/dist/options.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultSetupOption = exports.defaultSerializer = exports.defaultLockGetOption = exports.defaultSetOption = exports.defaultRedisOption = void 0;
+exports.defaultRedisOption = {
+    host: process.env.REDIS_HOST || '127.0.0.1',
+    port: parseInt(process.env.REDIS_PORT || '') || 6379,
+    password: process.env.REDIS_PASSWORD || '',
+    db: parseInt(process.env.REDIS_DB || '') || 0,
+};
+exports.defaultSetOption = {
+    ttl: 60,
+    compressMinLength: 1024,
+    compressStoreRatio: 0.95,
+    compressLevel: 1,
+};
+exports.defaultLockGetOption = {
+    preRefresh: 0,
+    refresh: false,
+    localStore: undefined,
+};
+exports.defaultSerializer = {
+    serialize: (data) => {
+        return Buffer.from(JSON.stringify(data));
+    },
+    deserialize: (data) => {
+        return JSON.parse(data.toString());
+    },
+};
+exports.defaultSetupOption = {
+    redis: exports.defaultRedisOption,
+    set: exports.defaultSetOption,
+    lockGet: exports.defaultLockGetOption,
+    serializer: exports.defaultSerializer,
+};

package/dist/types.d.ts

@@ -34,6 +34,13 @@ export interface SetOption {
      */
     compressLevel?: number;
 }
+/**
+ * 对象序列化
+ */
+export interface ObjectSerializer {
+    serialize(data: object): Buffer;
+    deserialize(data: Buffer): object;
+}
 export interface SetupOption {
     /**
      * Redis 实例或 Redis 选项
@@ -47,13 +54,18 @@ export interface SetupOption {
      * 默认锁缓存选项
      */
     lockGet?: LockGetOption;
+    /**
+     * 自定义序列化器
+     * - 默认为 JSON 序列化
+     */
+    serializer?: ObjectSerializer;
 }
 /**
  * 取得缓存选项
  */
 export interface GetOption {
     /**
-     * 是否解析 JSON 数据
+     * 是否反序列化数据为对象
      * @default true
      */
     parse?: boolean;
@@ -117,4 +129,13 @@ export interface LockGetOption extends GetOption, SetOption, LockOption {
      * @default false
      */
     refresh?: boolean;
+    /**
+     * 本地存储
+     * - 如果指定一个对象，则尝试先从对象中存取
+     * - 防止在同一次请求中重复从 Redis 获取
+     * - 一般情况下在 Context 中设置一个空对象并指定
+     */
+    localStore?: {
+        [key: string]: any;
+    };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenweb/cache",
   "packageManager": "yarn@4.0.2",
-  "version": "4.3.1",
+  "version": "4.5.0",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,7 +11,7 @@
   "scripts": {
     "vscode": "yarn dlx @yarnpkg/sdks vscode",
     "build": "rimraf dist && tsc",
-    "prepublishOnly": "yarn run build",
+    "prepack": "yarn run build",
     "test": "ts-mocha -p tsconfig.json test/**/*.test.ts",
     "dev": "cd example && cross-env DEBUG=\\* NODE_ENV=development ts-node app"
   },