node-karin 0.0.3

package/lib/db/level.d.ts

@@ -0,0 +1,20 @@
+import { Level } from 'level';
+/**
+ * @type {Level}
+ */
+declare class LevelDB extends Level {
+    id: string;
+    constructor();
+    /**
+     * 对get方法进行重写 找不到数据时返回null
+     */
+    get(key: string): Promise<string>;
+    /**
+     * 增加set方法
+     * @param {string} key 键
+     * @param {object|string} value 值
+     */
+    set(key: string, value: string): Promise<void>;
+}
+declare const level: LevelDB;
+export default level;

package/lib/db/level.js

@@ -0,0 +1,38 @@
+import { Level } from 'level'
+const path = process.cwd() + '/data/db/Level'
+/**
+ * @type {Level}
+ */
+class LevelDB extends Level {
+  id
+  constructor () {
+    super(path, { valueEncoding: 'json' })
+    /**
+         * @type {'Level'} 唯一标识符 用于区分不同的数据库
+         */
+    this.id = 'Level'
+  }
+
+  /**
+     * 对get方法进行重写 找不到数据时返回null
+     */
+  async get (key) {
+    try {
+      const res = await super.get(key)
+      return res
+    } catch {
+      return ''
+    }
+  }
+
+  /**
+     * 增加set方法
+     * @param {string} key 键
+     * @param {object|string} value 值
+     */
+  async set (key, value) {
+    return await super.put(key, value)
+  }
+}
+const level = new LevelDB()
+export default level

package/lib/db/redis.d.ts

@@ -0,0 +1,41 @@
+import RedisLevel from './redis_level.js';
+import redis from 'redis';
+export default class Redis {
+    id: 'redis';
+    RunCmd: string;
+    constructor();
+    /**
+     * redis实例化
+     */
+    start(): Promise<(redis.RedisClientType | string) | RedisLevel | false>;
+    /**
+     * 降级为 LevelDB
+     */
+    LevelDB(): Promise<false | RedisLevel>;
+    /**
+     * 连接 Redis 单例
+     * @param {import("redis").RedisClientOptions} options
+     * @return {Promise<{status: 'ok', data: import("redis").RedisClientType} | {status: 'error', data: Error}>}
+     */
+    connect(options: redis.RedisClientOptions): Promise<{
+        status: 'ok';
+        data: redis.RedisClientType;
+    } | {
+        status: 'error';
+        data: string;
+    }>;
+    /**
+     * 连接 Redis 集群
+     */
+    connectCluster(rootNodes: {
+        url: string;
+    }[]): Promise<{
+        status: string;
+        data: unknown;
+    }>;
+    /**
+     * 判断是否为 ARM64 并返回参数
+     */
+    aarch64(): Promise<string>;
+    execSync(cmd: string): Promise<string>;
+}

package/lib/db/redis.js

@@ -0,0 +1,137 @@
+import { exec } from 'child_process'
+import RedisLevel from './redis_level.js'
+import logger from '../utils/logger.js'
+import config from '../utils/config.js'
+import { createClient, createCluster } from 'redis'
+export default class Redis {
+  id
+  RunCmd
+  constructor () {
+    this.id = 'redis'
+    this.RunCmd = ''
+  }
+
+  /**
+     * redis实例化
+     */
+  async start () {
+    const { host, port, username, password, db: database, cluster } = config.redis
+    /** 集群模式 */
+    if (cluster && cluster.enable) {
+      const rootNodes = cluster.rootNodes.map((node) => ({ url: node }))
+      logger.info('正在连接 Redis 集群...')
+      const { status, data } = await this.connectCluster(rootNodes)
+      if (status === 'ok') {
+        logger.info('Redis 集群连接成功')
+        return data
+      }
+      logger.error(`Redis 集群建立连接失败：${logger.red(data)}`)
+      return false
+    }
+    logger.info(`正在连接 ${logger.green(`Redis://${host}:${port}/${database}`)}`)
+    const options = { socket: { host, port }, username, password, database }
+    /** 第一次连接 */
+    const { status, data } = await this.connect(options)
+    if (status === 'ok') {
+      logger.info('Redis 连接成功')
+      return data
+    }
+    /** 第一次连接失败尝试拉起 windows直接降级 */
+    if (process.platform === 'win32') {
+      logger.error(`Redis 建立连接失败：${logger.red(data)}`)
+      return await this.LevelDB()
+    }
+    this.RunCmd = 'redis-server --save 900 1 --save 300 10 --daemonize yes' + (await this.aarch64())
+    logger.info('正在尝试启动 Redis...')
+    try {
+      await this.execSync(this.RunCmd)
+      /** 启动成功再次重试 */
+      const { status, data } = await this.connect(options)
+      if (status === 'ok') {
+        logger.info('Redis 连接成功')
+        return data
+      }
+      logger.error(`Redis 二次建立连接失败：${logger.red(data)}`)
+      return false
+    } catch (error) {
+      logger.error(`Redis 启动失败：${logger.red(data)}`)
+      return await this.LevelDB()
+    }
+  }
+
+  /**
+     * 降级为 LevelDB
+     */
+  async LevelDB () {
+    try {
+      logger.mark(logger.red('正在降级为 LevelDB 代替 Redis 只能使用基础功能'))
+      const redis = new RedisLevel()
+      logger.info('LevelDB 降级成功')
+      return redis
+    } catch (error) {
+      logger.error('降级为 LevelDB 失败')
+      logger.error(error)
+      return false
+    }
+  }
+
+  /**
+     * 连接 Redis 单例
+     * @param {import("redis").RedisClientOptions} options
+     * @return {Promise<{status: 'ok', data: import("redis").RedisClientType} | {status: 'error', data: Error}>}
+     */
+  async connect (options) {
+    const client = createClient(options)
+    try {
+      await client.connect()
+      return { status: 'ok', data: client }
+    } catch (error) {
+      return { status: 'error', data: error }
+    }
+  }
+
+  /**
+     * 连接 Redis 集群
+     */
+  async connectCluster (rootNodes) {
+    const client = createCluster({ rootNodes })
+    try {
+      await client.connect()
+      return { status: 'ok', data: client }
+    } catch (error) {
+      return { status: 'error', data: error }
+    }
+  }
+
+  /**
+     * 判断是否为 ARM64 并返回参数
+     */
+  async aarch64 () {
+    try {
+      /** 判断arch */
+      const arch = await this.execSync('uname -m')
+      if (arch && arch.includes('aarch64')) {
+        /** 提取 Redis 版本 */
+        const version = await this.execSync('redis-server -v')
+        if (version) {
+          /** 提取版本号 */
+          const RedisVersion = version.match(/v=(\d)./)
+          /** 如果>=6版本则忽略警告 */
+          if (RedisVersion && Number(RedisVersion[1]) >= 6) { return ' --ignore-warnings ARM64-COW-BUG' }
+        }
+      }
+      return ''
+    } catch {
+      return ''
+    }
+  }
+
+  execSync (cmd) {
+    return new Promise((resolve, reject) => {
+      exec(cmd, (error, stdout) => {
+        if (error) { return reject(error) }
+        resolve(stdout)
+      })
+    })
+  }
+}

package/lib/db/redis_level.d.ts

@@ -0,0 +1,113 @@
+export default class RedisLevel {
+    #private;
+    id: string;
+    constructor();
+    /**
+     * get 获取数据
+     * @param {string} key 键
+     * @returns {Promise<string>|Error} 数据
+     */
+    get(key: string): Promise<string | null>;
+    /**
+     * set 设置数据
+     * @param {string} key 键
+     * @param {string} value 值
+     * @param {object} [options] 选项
+     * @param [options.EX] 过期时间 单位秒
+     * @returns {Promise<void>|Error}
+     */
+    set(key: string, value: string, options?: {
+        EX: number;
+    } | undefined): Promise<void>;
+    /**
+     * del 删除数据
+     * @param {string} key 键
+     * @returns {Promise<void>|Error}
+     */
+    del(key: string): Promise<void>;
+    /**
+     * keys 获取所有键
+     * @param {string} [prefix] 前缀
+     * @returns {Promise<string[]>|Error} 键列表
+     */
+    keys(prefix?: string): Promise<string[]>;
+    /**
+     * incr 递增数据
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+    incr(key: string): Promise<number>;
+    /**
+     * decr 递减数据
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+    decr(key: string): Promise<number>;
+    /**
+     * expire 设置过期时间
+     * @param {string} key 键
+     * @param seconds 过期时间 单位秒
+     * @returns {Promise<number>|Error}
+     */
+    expire(key: string, seconds: number): Promise<number>;
+    /**
+     * ttl 获取过期时间
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+    ttl(key: string): Promise<number>;
+    /**
+     * setEx 设置数据并设置过期时间
+     * @param {string} key 键
+     * @param seconds 过期时间 单位秒
+     * @param {string} value 值
+     * @returns {Promise<void>|Error}
+     */
+    setEx(key: string, seconds: number, value: string): Promise<void>;
+    /**
+     * exists 判断键是否存在
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+    exists(key: string): Promise<number>;
+    /**
+     * zAdd 有序集合添加元素
+     * @param {string} key 键
+     * @param {object} data 数据
+     * @param data.score 分数
+     * @param {string} data.value 值
+     */
+    zAdd(key: string, { score, value }: {
+        score: number;
+        value: string;
+    }): Promise<void>;
+    /**
+     * zRem 有序集合删除元素
+     * @param {string} key 键
+     * @param {string} value 值
+     */
+    zRem(key: string, value: string): Promise<void>;
+    /**
+     * zIncrBy 有序集合分数递增
+     * @param {string} key 键
+     * @param increment 递增值
+     * @param {string} value 值
+     * @returns {Promise<number>|Error}
+     */
+    zIncrBy(key: string, increment: number, value: string): Promise<number>;
+    /**
+     * zRangeByScore 有序集合根据分数范围获取元素
+     * @param {string} key 键
+     * @param min 最小分数
+     * @param max 最大分数
+     * @returns {Promise<string[]>|Error}
+     */
+    zRangeByScore(key: string, min: number, max: number): Promise<any[]>;
+    /**
+     * zScore 有序集合获取元素分数
+     * @param {string} key 键
+     * @param {string} value 值
+     * @returns {Promise<number>|Error}
+     */
+    zScore(key: string, value: string): Promise<number | null>;
+}

package/lib/db/redis_level.js

@@ -0,0 +1,290 @@
+import { Level } from 'level'
+export default class RedisLevel {
+  #level
+  #expireMap
+  id
+  constructor () {
+    const path = process.cwd() + '/data/db/RedisLevel'
+    this.#level = new Level(path, { valueEncoding: 'json' })
+    /**
+         * @type {'RedisLevel'} 唯一标识符 用于区分不同的数据库
+         */
+    this.id = 'RedisLevel'
+    /**
+         * 过期时间映射表
+         * @type {Map<string, number>} 键: 值 (过期时间)
+         */
+    this.#expireMap = new Map()
+    /**
+         * 开启过期时间处理
+         */
+    this.#expireHandle()
+  }
+
+  /**
+     * 过期时间处理 每分钟检查一次
+     */
+  async #expireHandle () {
+    setInterval(async () => {
+      const now = Date.now()
+      // 获取代理对象的键值对数组
+      const entries = Array.from(this.#expireMap.entries())
+      for (const [key, expire] of entries) {
+        if (expire < now) {
+          await this.#level.del(key)
+          this.#expireMap.delete(key) // 通过代理的方式删除键值对
+        }
+      }
+    }, 60000)
+    /**
+         * 对expireMap进行代理 实现持久化 每次触发都保存到数据库
+         */
+    const handler = {
+      get: function (target, prop, receiver) {
+        if (prop === 'get' || prop === 'entries') {
+          return function (...args) {
+            const reflect = Reflect.get(target, prop).apply(target, args)
+            return typeof reflect === 'function' ? reflect.bind(target) : reflect
+          }
+        }
+        const reflect = Reflect.get(target, prop, receiver)
+        return typeof reflect === 'function' ? reflect.bind(target) : reflect
+      },
+      set: function (target, key, value) {
+        target.set(key, value)
+        // 修改后持久化到数据库
+        const reflect = Reflect.set(target, key, value)
+        return typeof reflect === 'function' ? reflect.bind(target) : reflect
+      },
+      deleteProperty: function (target, key) {
+        Reflect.deleteProperty(target, key)
+        // 删除后持久化到数据库
+        const reflect = Reflect.deleteProperty(target, key)
+        return typeof reflect === 'function' ? reflect.bind(target) : reflect
+      },
+    }
+    this.#expireMap = new Proxy(this.#expireMap, handler)
+  }
+
+  /**
+     * get 获取数据
+     * @param {string} key 键
+     * @returns {Promise<string>|Error} 数据
+     */
+  async get (key) {
+    try {
+      /** 先查过期时间 */
+      const expire = this.#expireMap.get(key)
+      if (expire && expire < Date.now()) {
+        await this.#level.del(key)
+        this.#expireMap.delete(key)
+        return null
+      }
+      return await this.#level.get(key)
+    } catch (error) {
+      if (error.notFound) { return null }
+      throw error
+    }
+  }
+
+  /**
+     * set 设置数据
+     * @param {string} key 键
+     * @param {string} value 值
+     * @param {object} [options] 选项
+     * @param [options.EX] 过期时间 单位秒
+     * @returns {Promise<void>|Error}
+     */
+  async set (key, value, options) {
+    if (options && options.EX) {
+      this.#expireMap.set(key, Date.now() + options.EX * 1000)
+    }
+    return await this.#level.put(key, value)
+  }
+
+  /**
+     * del 删除数据
+     * @param {string} key 键
+     * @returns {Promise<void>|Error}
+     */
+  async del (key) {
+    this.#expireMap.delete(key)
+    return await this.#level.del(key)
+  }
+
+  /**
+     * keys 获取所有键
+     * @param {string} [prefix] 前缀
+     * @returns {Promise<string[]>|Error} 键列表
+     */
+  async keys (prefix = '') {
+    const keys = []
+    for await (const key of this.#level.keys({ gte: prefix, lt: prefix + '\xFF' })) {
+      // Check if the key has expired
+      const expire = this.#expireMap.get(key)
+      if (expire && expire < Date.now()) {
+        await this.#level.del(key)
+        this.#expireMap.delete(key)
+      } else {
+        keys.push(key)
+      }
+    }
+    return keys
+  }
+
+  /**
+     * incr 递增数据
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+  async incr (key) {
+    let value = Number(await this.get(key))
+    if (value === null) {
+      value = 0
+    } else {
+      value = Number(value)
+      if (isNaN(value)) { throw new Error('Value is not a number') }
+    }
+    value += 1
+    await this.set(key, value.toString())
+    return value
+  }
+
+  /**
+     * decr 递减数据
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+  async decr (key) {
+    let value = Number(await this.get(key))
+    if (value === null) {
+      value = 0
+    } else {
+      value = Number(value)
+      if (isNaN(value)) { throw new Error('Value is not a number') }
+    }
+    value -= 1
+    await this.set(key, value.toString())
+    return value
+  }
+
+  /**
+     * expire 设置过期时间
+     * @param {string} key 键
+     * @param seconds 过期时间 单位秒
+     * @returns {Promise<number>|Error}
+     */
+  async expire (key, seconds) {
+    this.#expireMap.set(key, Date.now() + seconds * 1000)
+    return seconds
+  }
+
+  /**
+     * ttl 获取过期时间
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+  async ttl (key) {
+    const expire = this.#expireMap.get(key)
+    if (expire) {
+      return Math.ceil((expire - Date.now()) / 1000)
+    }
+    return -2
+  }
+
+  /**
+     * setEx 设置数据并设置过期时间
+     * @param {string} key 键
+     * @param seconds 过期时间 单位秒
+     * @param {string} value 值
+     * @returns {Promise<void>|Error}
+     */
+  async setEx (key, seconds, value) {
+    this.#expireMap.set(key, Date.now() + seconds * 1000)
+    return await this.#level.put(key, value)
+  }
+
+  /**
+     * exists 判断键是否存在
+     * @param {string} key 键
+     * @returns {Promise<number>|Error}
+     */
+  async exists (key) {
+    const value = await this.get(key)
+    return value === null ? 0 : 1
+  }
+
+  /**
+     * zAdd 有序集合添加元素
+     * @param {string} key 键
+     * @param {object} data 数据
+     * @param data.score 分数
+     * @param {string} data.value 值
+     */
+  async zAdd (key, { score, value }) {
+    const set = await this.get(key)
+    const arr = (set ? JSON.parse(set) : [])
+    arr.push({ score, value })
+    arr.sort((a, b) => a.score - b.score)
+    await this.set(key, JSON.stringify(arr))
+  }
+
+  /**
+     * zRem 有序集合删除元素
+     * @param {string} key 键
+     * @param {string} value 值
+     */
+  async zRem (key, value) {
+    const set = await this.get(key)
+    if (set === null) { return }
+    let arr = JSON.parse(set)
+    arr = arr.filter((item) => item.value !== value)
+    await this.set(key, JSON.stringify(arr))
+  }
+
+  /**
+     * zIncrBy 有序集合分数递增
+     * @param {string} key 键
+     * @param increment 递增值
+     * @param {string} value 值
+     * @returns {Promise<number>|Error}
+     */
+  async zIncrBy (key, increment, value) {
+    const set = await this.get(key)
+    if (set === null) { throw new Error('Set does not exist') }
+    const arr = JSON.parse(set)
+    const item = arr.find((item) => item.value === value)
+    if (item) { item.score += increment }
+    arr.sort((a, b) => a.score - b.score)
+    await this.set(key, JSON.stringify(arr))
+    return item.score
+  }
+
+  /**
+     * zRangeByScore 有序集合根据分数范围获取元素
+     * @param {string} key 键
+     * @param min 最小分数
+     * @param max 最大分数
+     * @returns {Promise<string[]>|Error}
+     */
+  async zRangeByScore (key, min, max) {
+    const set = await this.get(key)
+    if (set === null) { return [] }
+    const arr = JSON.parse(set)
+    return arr.filter((item) => item.score >= min && item.score <= max).map((item) => item.value)
+  }
+
+  /**
+     * zScore 有序集合获取元素分数
+     * @param {string} key 键
+     * @param {string} value 值
+     * @returns {Promise<number>|Error}
+     */
+  async zScore (key, value) {
+    const set = await this.get(key)
+    if (set === null) { return null }
+    const arr = JSON.parse(set)
+    const item = arr.find((item) => item.value === value)
+    return item ? item.score : null
+  }
+}