mm_cache 1.5.5 → 1.8.0

package/example/index.js

@@ -0,0 +1,57 @@
+/**
+ * mm_cache 模块最小可运行示例
+ * @description 演示 Cache 统一缓存框架（cachebase 内存方式），
+ *              无需连接 Redis / MongoDB 等外部缓存服务
+ */
+// 独立运行时补充全局 $ 对象（mm_os 宿主环境已提供，npm 包运行需自备）
+if (!global.$) {
+  global.$ = {
+    log: {
+      debug: console.debug ? console.debug.bind(console) : console.log.bind(console),
+      info: console.info ? console.info.bind(console) : console.log.bind(console),
+      warn: console.warn ? console.warn.bind(console) : console.log.bind(console),
+      error: console.error ? console.error.bind(console) : console.log.bind(console),
+      success: console.log.bind(console)
+    }
+  };
+}
+
+const { Cache } = require('../index.js');
+
+/**
+ * 主演示流程
+ */
+async function main() {
+  // 使用 cachebase 内存缓存方式，不连接任何外部缓存服务
+  const cache = new Cache({
+    way: 'cachebase',
+    scope: 'demo',
+    cachebase: { persist: false }
+  });
+  const connected = await cache.connect();
+  console.log('缓存方式:', cache.getCacheWay(), '| 连接结果:', connected);
+
+  // 基础键值操作
+  await cache.set('name', 'mm_cache');
+  console.log('set/get:', await cache.get('name'));
+
+  // 原子自增操作
+  await cache.set('counter', 10);
+  console.log('incr:', await cache.incr('counter'));
+
+  // 哈希表操作
+  await cache.hset('user', 'id', '001');
+  console.log('hset/hget:', await cache.hget('user', 'id'));
+
+  // 删除键
+  await cache.del('name');
+  console.log('del 后 has:', await cache.has('name'));
+
+  await cache.dispose();
+  console.log('示例运行完成');
+}
+
+main().catch((err) => {
+  console.error('示例运行失败:', err);
+  process.exit(1);
+});

package/index.js

@@ -1,8 +1,8 @@
 
 const Cache = require('./lib/cache');
-const Admin = require('mm_corejs').Admin;
+const { reg } = require('mm_admin');
 
-let admin = new Admin();
+const admin = reg('mm_cache');
 admin.setClass(Cache);
 
 /**
@@ -12,12 +12,12 @@ module.exports = {
 	Cache,
 	admin,
 	cacheAdmin(scope, config = {}) {
-		if (!scope) {
-			scope = 'os';
-		}
-		return admin.get(scope, { name: scope, ...config });
+		return admin.get(scope || 'os', config);
 	},
 	getCache() {
 		return admin.get('os');
 	}
-};
+};
+/* mm-tool-logic-export 工具能力层：其它模块可 require("<pkg>").tools.<name> 直接引用 */
+Object.defineProperty(module.exports, 'tools', { enumerable: true, configurable: true,
+  get: function () { return require('./lib/tools'); } });

package/lib/cache.js

@@ -3,7 +3,7 @@
  * @author <a href="http://qww.elins.cn">邱文武</a>
  * @version 1.2
  */
-const { Base } = require('mm_corejs');
+const { Base } = require('mm_mod');
 const { fullname } = require('mm_helper');
 
 /** 

package/lib/tools/cache/index.js

@@ -0,0 +1,70 @@
+/**
+ * 缓存管理器
+ * 直接依赖 mm_config 读取配置、mm_cache 的 os 作用域实例读写缓存，支持 TTL
+ * @param {object} params 步骤参数
+ * @param {object} ctx 上下文对象
+ * @param {object} options 模块配置
+ * @returns {object} 处理结果
+ */
+const { configAdmin } = require('mm_config');
+const mm_cache = require('../../../index.js');
+
+/**
+ * 从配置存储组装缓存实例配置
+ * @returns {Promise<object>} 缓存配置
+ */
+async function _getCacheConfig() {
+  var cfg_store = configAdmin('os');
+  var config = (await cfg_store.get('cache')) || {};
+  config.way = config.way || 'memory';
+  config.cachebase = (await cfg_store.get('cachebase')) || {};
+  config.redis = (await cfg_store.get('redis')) || {};
+  config.mongodb = (await cfg_store.get('mongodb')) || {};
+  return config;
+}
+
+async function main(params, ctx, options) {
+  var action = params.action || 'get';
+  var key = params.key;
+  var value = params.value;
+  var ttl = params.ttl || 0;
+
+  if (!mm_cache.admin.has('os')) {
+    var config = await _getCacheConfig();
+    mm_cache.cacheAdmin('os', config);
+  }
+  var cache = mm_cache.getCache();
+  switch (action) {
+    case 'get': {
+      var result_value = await cache.get(key);
+      ctx.output = { obj: result_value };
+      break;
+    }
+    case 'set': {
+      var ok = await cache.set(key, value, ttl);
+      ctx.output = { msg: ok ? '缓存设置成功' : '缓存设置失败' };
+      break;
+    }
+    case 'del': {
+      var ok2 = await cache.del(key);
+      ctx.output = { msg: ok2 ? '缓存删除成功' : '缓存删除失败' };
+      break;
+    }
+    case 'has': {
+      var exists = await cache.has(key);
+      ctx.output = { obj: exists };
+      break;
+    }
+    case 'clear': {
+      var ok3 = await cache.clear();
+      ctx.output = { msg: ok3 ? '缓存已清空' : '缓存清空失败' };
+      break;
+    }
+    default:
+      ctx.output = { error: { code: 'MGR_UNKNOWN_ACTION', message: '不支持的操作: ' + action } };
+  }
+
+  return ctx.output;
+}
+
+module.exports = { main };

package/lib/tools/index.js

@@ -0,0 +1,16 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+/** 模块能力层：懒加载工具实现，避免模块入口被 require 时加载全部实现 */
+module.exports = new Proxy({}, {
+  get(_t, key) {
+    if (typeof key !== 'string') return undefined;
+    if (!fs.existsSync(path.join(__dirname, key, 'index.js'))) return undefined;
+    return require('./' + key);
+  },
+  has(_t, key) {
+    return typeof key === 'string' && fs.existsSync(path.join(__dirname, key, 'index.js'));
+  },
+  ownKeys() { return fs.readdirSync(__dirname, { withFileTypes: true }).filter(e => e.isDirectory()).map(e => e.name); },
+  getOwnPropertyDescriptor(_t, key) { return this.has(_t, key) ? { enumerable: true, configurable: true } : undefined; }
+});

package/package.json

@@ -1,44 +1,50 @@
 {
-    "name": "mm_cache",
-    "version": "1.5.5",
-    "description": "一个统一的缓存操作框架，为多种缓存方式（Redis、MongoDB、CacheBase、Memory）提供统一的API接口，实现无缝切换和兼容",
-    "main": "index.js",
-    "scripts": {
-        "test": "node test.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://gitee.com/qiuwenwu/mm_cache.git"
-    },
-    "keywords": [
-        "mm_mod",
-        "mm_port",
-        "mm_cache",
-        "cache",
-        "async",
-        "await",
-        "promise",
-        "add",
-        "del",
-        "set",
-        "get",
-        "query",
-        "run",
-        "exec"
-    ],
-    "layer": "port",
-    "group": "cache",
-    "author": "邱文武",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://gitee.com/qiuwenwu/mm_cache/issues"
-    },
-    "homepage": "https://gitee.com/qiuwenwu/mm_cache#readme",
-    "dependencies": {
-        "mm_cachebase": "^2.0.4",
-        "mm_mongodb": "^2.0.3",
-        "mm_redis": "^2.1.7",
-        "mm_corejs": "^1.1.4",
-        "mm_helper": "^1.0.0"
-    }
-}
+  "name": "mm_cache",
+  "version": "1.8.0",
+  "description": "一个统一的缓存操作框架，为多种缓存方式（Redis、MongoDB、CacheBase、Memory）提供统一的API接口，实现无缝切换和兼容",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_cache.git"
+  },
+  "keywords": [
+    "mm_mod",
+    "mm_port",
+    "mm_cache",
+    "cache",
+    "async",
+    "await",
+    "promise",
+    "add",
+    "del",
+    "set",
+    "get",
+    "query",
+    "run",
+    "exec"
+  ],
+  "layer": "infrastructure",
+  "group": "cache",
+  "author": "邱文武",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitee.com/qiuwenwu91/mm_cache/issues"
+  },
+  "homepage": "https://gitee.com/qiuwenwu91/mm_cache#readme",
+  "dependencies": {
+    "mm_admin": "^1.1.0",
+    "mm_cachebase": "^2.0.4",
+    "mm_config": "^2.6.0",
+    "mm_eslint": "^1.0.0",
+    "mm_helper": "^1.0.0",
+    "mm_mod": "^1.0.1",
+    "mm_mongodb": "^2.0.3",
+    "mm_redis": "^2.1.7"
+  },
+  "devDependencies": {
+    "mm_eslint": "^1.7.7"
+  }
+}

package/tool/cache/index.js

@@ -0,0 +1,7 @@
+'use strict';
+/**
+ * cache —— 工具契约适配层
+ * 业务实现归位于模块 lib/tools/cache/，本文件只把模块能力暴露给加载器。
+ * 其它模块可直接 require('mm_cache').tools.cache 复用。
+ */
+module.exports = require('../../lib/tools/cache');

package/tool/cache/tool.json

@@ -0,0 +1,73 @@
+{
+  "name": "cache",
+  "handler": "manager",
+  "title": "缓存管理器",
+  "description": "读写全局缓存，支持 get/set/del/has/clear 五种操作与 TTL 过期。适用场景：需要临时缓存计算结果、会话数据或高频读取数据时。工作流提示：action 与 key 必填，set 时 value 必填、ttl 设过期秒数（0 为不过期），读结果在 obj、写结果在 msg。",
+  "type": "function",
+  "params": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "type": "string",
+        "description": "操作类型: get/set/del/has/clear",
+        "enum": [
+          "get",
+          "set",
+          "del",
+          "has",
+          "clear"
+        ]
+      },
+      "key": {
+        "type": "string",
+        "description": "缓存键"
+      },
+      "value": {
+        "description": "缓存值(set时必填)"
+      },
+      "ttl": {
+        "type": "number",
+        "description": "过期时间(秒)",
+        "min": 0,
+        "max": 31536000
+      }
+    },
+    "required": [
+      "action",
+      "key"
+    ]
+  },
+  "returns": {
+    "description": "管理操作结果，读操作返回 obj，写操作返回 msg，异常时返回 error",
+    "type": "object",
+    "properties": {
+      "obj": {
+        "description": "读取操作的结果值（get/has 操作）"
+      },
+      "msg": {
+        "type": "string",
+        "description": "写操作的结果描述（set/del/clear 操作）"
+      }
+    }
+  },
+  "options": {
+    "way": {
+      "type": "string",
+      "description": "缓存后端: memory/redis/mongodb",
+      "default": "memory"
+    },
+    "prefix": {
+      "type": "string",
+      "description": "缓存键前缀",
+      "default": "cache:"
+    },
+    "default_ttl": {
+      "type": "number",
+      "description": "默认过期时间(秒)",
+      "default": 3600,
+      "min": 0,
+      "max": 31536000
+    }
+  },
+  "group": "storage"
+}