@zenweb/cache 4.0.1 → 4.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.1.1] - 2023-8-18
+增加 normalKey number 参数
+
+## [4.1.0] - 2023-8-18
+增加 normalKey 方法
+
 ## [4.0.1] - 2023-8-17
 cached 中间件增加 type 参数
 

package/dist/global.js

@@ -7,7 +7,7 @@ const core_1 = require("@zenweb/core");
  */
 function getCache() {
     const ins = (0, core_1.getCore)();
-    return ins.cache;
+    return ins.cache2;
 }
 exports.getCache = getCache;
 /**

package/dist/index.d.ts

@@ -18,10 +18,10 @@ declare module '@zenweb/core' {
         /**
          * Redis 实例
          */
-        redis: Redis;
+        redis2: Redis;
         /**
          * 缓存实例
          */
-        cache: Cache;
+        cache2: Cache;
     }
 }

package/dist/index.js

@@ -48,8 +48,8 @@ function setup(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');
-        setup.defineCoreProperty('redis', { value: redis });
-        setup.defineCoreProperty('cache', { value: new cache_1.Cache(redis, opt) });
+        setup.defineCoreProperty('redis2', { value: redis });
+        setup.defineCoreProperty('cache2', { value: new cache_1.Cache(redis, opt) });
         setup.destroy(async () => {
             setup.debug('quit redis...');
             await redis.quit();

package/dist/middleware.js

@@ -15,7 +15,7 @@ function cached(key, opt) {
             parse: false,
             decompress,
         });
-        const result = await ctx.core.cache.lockGet(_key, async function () {
+        const result = await ctx.core.cache2.lockGet(_key, async function () {
             await next();
             return ctx.body;
         }, _opt);

package/dist/utils.d.ts

@@ -17,3 +17,8 @@ export declare function sleep(ms: number): Promise<void>;
  * @returns 执行结果
  */
 export declare function runRedisScript(redis: Redis, hash: string, script: string, keys: RedisKey[], values?: RedisValue[]): Promise<unknown>;
+/**
+ * 生成一个参数缓存key
+ * - 多个元素用 : 连接
+ */
+export declare function normalKey(...key: (string | number | object)[]): string;

package/dist/utils.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runRedisScript = exports.sleep = exports.debug = void 0;
+exports.normalKey = exports.runRedisScript = exports.sleep = exports.debug = void 0;
 const debug_1 = require("debug");
+const crypto = require("crypto");
 exports.debug = (0, debug_1.default)('zenweb:cache');
 /**
  * Promise 等待
@@ -39,3 +40,40 @@ async function runRedisScript(redis, hash, script, keys, values = []) {
     }
 }
 exports.runRedisScript = runRedisScript;
+/**
+ * 将一个嵌套对象转换为平面字符串结构
+ */
+function plainify(obj) {
+    if (Array.isArray(obj)) {
+        return obj.map(plainify).sort().join(',');
+    }
+    if (obj && typeof obj === 'object') {
+        return Object.keys(obj).sort().map(k => `${k}=${plainify(obj[k])}`).join('&');
+    }
+    return String(obj);
+}
+/**
+ * 对象使用 `plainify` 处理，如果对象过长则使用摘要
+ * @param obj
+ * @returns
+ */
+function plainifyOrHash(obj) {
+    let p = plainify(obj);
+    if (Buffer.byteLength(p, 'utf8') > 16) {
+        // 参数太长只取摘要
+        p = crypto.createHash('sha1').update(p, 'utf8').digest().subarray(0, 10).toString('base64url');
+    }
+    return p;
+}
+/**
+ * 生成一个参数缓存key
+ * - 多个元素用 : 连接
+ */
+function normalKey(...key) {
+    return key.map(i => {
+        if (typeof i === 'string')
+            return i;
+        return plainifyOrHash(i);
+    }).join(':');
+}
+exports.normalKey = normalKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenweb/cache",
-  "version": "4.0.1",
+  "version": "4.1.1",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",