monSQLize

    🚀 分布式部署快速参考

    📑 目录

    最简配置（只需3行）

    distributed: {
  enabled: true  // 只需这一行！其他都是可选的
}

    完整配置（推荐）

    const Redis = require('ioredis');
const redis = new Redis('redis://localhost:6379');

const msq = new MonSQLize({
  type: 'mongodb',
  databaseName: 'mydb',
  config: { uri: 'mongodb://...' },
  cache: {
    multiLevel: true,
    local: { maxSize: 1000 },
    remote: MonSQLize.createRedisCacheAdapter(redis),  // ① Redis 缓存
    distributed: {
      enabled: true,                              // ② 启用分布式失效
      instanceId: process.env.INSTANCE_ID         // ③ 实例ID（建议设置）
    }
  }
});

    参数速查表

    distributed（分布式缓存失效）

    参数必需？默认值
    enabled✅ 是-
    redis❌ 否自动从 remote 提取
    instanceId❌ 否instance-${timestamp}-${random}
    channel❌ 否'monsqlize:cache:invalidate'

    transaction.distributedLock（事务锁）

    参数必需？默认值
    redis✅ 是-
    keyPrefix❌ 否'monsqlize:cache:lock:'

    常见场景

    场景1: 一般Web应用（推荐）

    distributed: {
  enabled: true,
  instanceId: process.env.INSTANCE_ID  // 使用环境变量
}

    场景2: 金融/支付系统

    distributed: {
  enabled: true,
  instanceId: process.env.INSTANCE_ID
},
transaction: {
  distributedLock: {
    redis  // 必须显式配置（ES6 简写）
  }
}

    场景3: Kubernetes部署

    distributed: {
  enabled: true,
  instanceId: process.env.HOSTNAME  // 使用Pod名称
}

    环境变量设置

    Docker

    docker run -e INSTANCE_ID=server-1 myapp

    Kubernetes

    env:
  - name: INSTANCE_ID
    valueFrom:
      fieldRef:
        fieldPath: metadata.name  # 使用Pod名称

    PM2

    {
  "apps": [{
    "name": "app-1",
    "script": "server.js",
    "env": {
      "INSTANCE_ID": "app-1"
    }
  }]
}

    关键点记忆

    1. enabled: true - 唯一必需的配置
    2. redis - 自动从 remote 复用，无需重复配置
    3. instanceId - 可选但建议设置，便于调试
    4. 事务锁的 redis - 必须显式配置

    验证配置

    // 启动后检查
const stats = msq._cacheInvalidator?.getStats();
console.log('分布式失效器状态:', stats);
// 输出: { messagesSent: 0, messagesReceived: 0, instanceId: 'xxx', ... }

    文档: 完整说明
    更新: 2025-11-25