mm_mongodb 2.0.3 → 2.0.5

package/README.md

@@ -33,6 +33,10 @@ npm install mm_mongodb
 
 ```javascript
 const { MongoDB, mongodbAdmin } = require('mm_mongodb');
+const { getLogger } = require('mm_logger');
+
+// 日志记录器实例
+const logger = getLogger();
 
 // 通过连接池管理器获取实例（推荐）
 const cache = mongodbAdmin('myapp');
@@ -46,11 +50,11 @@ async function example() {
 
     // 获取缓存
     const value = await cache.get("name");
-    $.log.debug(value); // 输出: 张三
+    logger.debug(value); // 输出: 张三
 
     // 删除缓存（返回删除数量）
     const deleted = await cache.del("name");
-    $.log.debug(deleted); // 输出: 1
+    logger.debug(deleted); // 输出: 1
 
     // 关闭连接
     await cache.close();
@@ -305,24 +309,30 @@ try {
 事件名采用**冒号风格**，与 mm_redis / mm_cachebase 完全一致。每个操作有 `:before`、`:after`、`:error` 三种事件。
 
 ```javascript
+const { mongodbAdmin } = require('mm_mongodb');
+const { getLogger } = require('mm_logger');
+
+// 日志记录器实例
+const logger = getLogger();
+
 const cache = mongodbAdmin('myapp');
 await cache.open();
 
 // 监听 set 前置事件，可修改参数或取消操作
 cache.on('set:before', (ctx) => {
-    $.log.debug('即将设置键:', ctx.key, '值:', ctx.value);
+    logger.debug('即将设置键:', ctx.key, '值:', ctx.value);
     // 可修改 ctx.key / ctx.value / ctx.seconds
     // 设置 ctx.cancel = true 可取消操作
 });
 
 // 监听 set 后置事件
 cache.on('set:after', (data) => {
-    $.log.debug('设置完成:', data.key, '成功:', data.success);
+    logger.debug('设置完成:', data.key, '成功:', data.success);
 });
 
 // 监听错误事件
 cache.on('set:error', (data) => {
-    $.log.error('设置出错:', data.key, data.error);
+    logger.error('设置出错:', data.key, data.error);
 });
 ```
 
@@ -387,7 +397,7 @@ async function zsetExample() {
 ```javascript
 async function pubsubExample() {
     await cache.subscribe('news', (message) => {
-        $.log.debug('收到消息:', message);
+        logger.debug('收到消息:', message);
     });
     await cache.publish('news', 'hello world'); // 接收者数量: 1
 }

package/example/index.js

@@ -0,0 +1,41 @@
+/**
+ * mm_mongodb 最小可运行示例
+ * @description 演示 MongoDB 类的实例化、工厂获取实例与核心方法存在性。
+ * 注意：不会真正连接 MongoDB 服务；host/port/database 为示例假值，实际使用时请替换为真实配置。
+ */
+const { MongoDB, mongodbAdmin } = require('../index.js');
+
+/** 示例假配置（实际使用时替换为真实 MongoDB 连接信息） */
+const CONFIG = {
+  host: 'localhost',
+  port: 27017,
+  user: '',
+  password: '',
+  database: 'example_db'
+};
+
+/**
+ * 主函数
+ */
+function main() {
+  console.log('== mm_mongodb 示例开始 ==');
+
+  // 实例化（构造函数会做连接参数校验，但不会建立真实连接）
+  const db = new MongoDB(CONFIG);
+  console.log('实例化 MongoDB 成功');
+  console.log('配置校验通过:', typeof db.config.host === 'string' && Number.isInteger(db.config.port));
+
+  // 通过工厂函数获取按作用域缓存的实例
+  const cache = mongodbAdmin('example', CONFIG);
+  console.log('mongodbAdmin 获取实例:', cache instanceof MongoDB);
+
+  // 核心方法存在性检查（不真正执行，避免连接外部服务）
+  const METHODS = ['open', 'close', 'set', 'get', 'del', 'exists', 'keys', 'hset', 'hget',
+    'mset', 'mget', 'incr', 'decr', 'sadd', 'smembers', 'zadd', 'zrange', 'subscribe', 'publish'];
+  const missing = METHODS.filter((name) => typeof cache[name] !== 'function');
+  console.log('核心方法检查:', missing.length === 0 ? '全部存在' : '缺失: ' + missing.join(','));
+
+  console.log('== mm_mongodb 示例结束 ==');
+}
+
+main();