mm_os 3.3.1 → 4.0.1

package/core/logic/script.tpl.js

@@ -0,0 +1,19 @@
+/**
+ * 游戏逻辑
+ */
+module.exports = {
+  /**
+   * 初始化
+   */
+  async _init() {
+    // this.log('debug', '初始化');
+  },
+  /**
+   * 主要逻辑
+   * @param {...any} args 参数列表
+   */
+  async main(...args) {
+    this.log('debug', 'logic main 被调用', { args });
+    // 主要代码写在这
+  }
+};

package/core/middleware/config.tpl.json

@@ -0,0 +1,16 @@
+{
+  // 名称
+	"name": "${name}",
+  // 标题
+	"title": "${title || '示例中间件'}",
+  // 描述
+	"description": "${description || '用于中间件演示'}",
+	// 主文件
+	"main": "${main || 'index.js'}",
+  // 类型
+	"type": "${type || 'web'}",
+  // 排序，越小越靠前
+	"sort": 100,
+  // 状态 0：禁用 1：启用
+	"state": 1
+}

package/core/middleware/index.js

@@ -0,0 +1,125 @@
+const {
+  Drive
+} = require('mm_machine');
+
+/**
+ * Koa中间件基类
+ */
+class Middleware extends Drive {
+  static config = {
+    // 中间件名称
+    name: 'default',
+    // 状态 0：禁用 1：启用
+    state: 1,
+    // 排序，越小越靠前
+    sort: 100
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父对象
+   */
+  constructor(config, parent) {
+    super({ ...Middleware.config, ...config || {} }, parent);
+  }
+}
+
+/**
+ * 获取模板目录
+ * @returns {string} 模板目录
+ */
+Middleware.prototype.getTplDir = function () {
+  return __dirname;
+};
+
+/**
+ * 初始化核心
+ * @param {object} apapter 适配器
+ * @param {object} eventer 事件总线
+ * @param {object} logger 日志管理器
+ * @returns {Promise<void>}
+ */
+Middleware.prototype._initCore = async function (apapter, eventer, logger) {
+  // 初始化依赖项
+  if (logger) {
+    this.setLogger(logger);
+  }
+  if (eventer) {
+    this.getEventer = function () {
+      return eventer;
+    };
+  }
+  if (apapter) {
+    this.getAdapter = function () {
+      return apapter[this.config.type];
+    };
+  }
+  this._register();
+};
+
+/**
+ * 注册中间件
+ * @private
+ * @returns {Promise<void>}
+ */
+Middleware.prototype._register = async function () {
+  // 注册中间件到Koa应用
+  this.getAdapter().use(this.create());
+};
+
+/**
+ * 注册中间件
+ * @returns {Promise<void>}
+ */
+Middleware.prototype.register = async function () {
+  await this._register();
+};
+
+/**
+ * 创建中间件函数
+ * @returns {Function} Koa中间件函数
+ */
+Middleware.prototype.create = function () {
+  var self = this;
+  if (!this.config.state) {
+    return async function (ctx, next) {
+      return await next();
+    };
+  }
+  return async (ctx, next) => {
+    await self.before(ctx);
+    await self.main(ctx, next);
+    await self.after(ctx);
+  };
+};
+
+/**
+ * 中间件前置处理
+ * @returns {Promise<void>}
+ */
+Middleware.prototype.before = async function () {
+};
+
+/**
+ * 中间件主逻辑处理
+ * @param {object} ctx Koa上下文
+ * @param {Function} next 下一个中间件
+ * @returns {Promise<void>}
+ */
+Middleware.prototype.main = async function (ctx, next) {
+  await next();
+};
+
+/**
+ * 中间件后置处理
+ * @returns {Promise<void>}
+ */
+Middleware.prototype.after = async function () {
+  // 默认空实现，由子类重写
+  // this.log('debug', 'middleware after 被调用', { ctx });
+};
+
+// 模块导出
+module.exports = {
+  Middleware
+};

package/core/middleware/script.tpl.js

@@ -0,0 +1,37 @@
+/**
+ * 中间件
+ */
+module.exports = {
+  /**
+   * 中间件初始化
+   * @param {object} apapter 适配器
+   * @param {object} eventer 事件处理器
+   */
+  async _init(apapter, eventer) {
+    this.log('debug', 'middleware _init 被调用', { apapter, eventer });
+    // 初始化代码写在这
+    // 可在这里注入其他中间件
+  },
+  /**
+   * 中间件执行前，可用于触发事件
+   */
+  async before() {
+
+  },
+  /**
+   * 中间件执行后，可用于触发事件
+   */
+  async after() {
+
+  },
+  /**
+   * 主要逻辑
+   * @param {object} ctx Koa上下文
+   * @param {Function} next 下一个中间件
+   */
+  async main(ctx, next) {
+    this.log('debug', 'middleware main 被调用', { ctx });
+    // 主要代码写在这
+    await next();
+  }
+};

package/core/mod/config.tpl.json

@@ -0,0 +1,22 @@
+{
+	// 名称
+	"name": "${name}",
+	// 标题
+	"title": "${title || '示例模块'}",
+	// 描述
+	"description": "${description || '介绍该模块有什么用'}",
+	// 版本号
+	"version": "${version || '1.0.0'}",
+	// 作者
+	"author": "${author || 'mos'}",
+	// 作用域，决定加载到什么区域
+	"scope": "${scope || 'server'}",
+	// 主文件
+	"main": "${main || 'index.js'}",
+	// 状态 0：禁用 1：启用
+	"state": 1,
+	// 排序，越小越靠前
+	"sort": 100,
+	// 依赖的npm module
+	"dependencies": []
+}

package/core/mod/index.js

@@ -0,0 +1,130 @@
+const {
+  Drive
+} = require('mm_machine');
+
+/**
+ * 模组基类
+ * 扩展插件功能，用于管理和协调多个应用和插件
+ */
+class Mod extends Drive {
+  static config = {
+    // 模组名称
+    name: 'default',
+    // 模组版本
+    version: '1.0.0',
+    // 依赖的npm模块
+    dependencies: [],
+    // 作者
+    author: 'qww',
+    // 模组目录
+    dir: './mod'
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   * @param {object} parent 父对象
+   */
+  constructor(config, parent) {
+    super({ ...Mod.config, ...config || {} }, parent);
+  }
+}
+
+/**
+ * 预设
+ */
+Mod.prototype._preset = function () {
+  // 服务器实例
+  this.getServer = function () {
+    return $.server;
+  };
+};
+
+/**
+ * 获取模板目录
+ * @returns {string} 模板目录
+ */
+Mod.prototype.getTplDir = function () {
+  return __dirname;
+};
+
+/**
+ * 初始化核心
+ * @param {object} server 服务
+ * @param {object} eventer 事件总线
+ * @param {object} logger 日志管理器
+ * @private
+ */
+Mod.prototype._initCore = async function (server, eventer, logger) {
+  // 初始化依赖项
+  if (logger) {
+    this.setLogger(logger);
+  }
+  if (eventer) {
+    this.getEventer = function () {
+      return eventer;
+    };
+  }
+  if (server) {
+    this.getServer = function () {
+      return server;
+    };
+  }
+
+
+  // 初始化管理
+  await this._initManager();
+  // 加载资源
+  await this._loadSources();
+  // 初始化资源
+  await this._initSources();
+};
+
+/**
+ * 初始化管理器
+ * @private
+ */
+Mod.prototype._initManager = async function () {
+  this.log('debug', 'mod _initManager 被调用');
+};
+
+/**
+ * 加载资源
+ * @private
+ */
+Mod.prototype._loadSources = async function () {
+  this.log('debug', 'mod _loadSources 被调用');
+};
+
+/**
+ * 初始化资源
+ * @private
+ */
+Mod.prototype._initSources = async function () {
+  this.log('debug', 'mod _initSources 被调用');
+};
+
+/**
+ * 启动模组
+ */
+Mod.prototype._start = async function () {
+  try {
+    this.log('info', 'started');
+  } catch (error) {
+    this.log('error', 'start error:', error);
+  }
+};
+
+/**
+ * 停止模组
+ */
+Mod.prototype._stop = async function () {
+
+};
+
+/**
+ * 清理模组资源
+ */
+Mod.prototype._cleanup = async function () {
+};
+
+exports.Mod = Mod;

package/core/mod/script.tpl.js

@@ -0,0 +1,34 @@
+/**
+ * 模组，用于拓展游戏玩法
+ */
+module.exports = {
+  /**
+   * 安装
+   */
+  async _install() {
+    this.log('info', `应用安装`);
+  },
+  /**
+   * 卸载
+   */
+  async _uninstall() {
+    this.log('info', `应用卸载`);
+  },
+  /**
+   * 初始化
+   * @param {object} server 服务器对象
+   * @param {object} eventer 事件处理器
+   * @returns {Promise<void>}
+   */
+  async _init(server, eventer) {
+    // this.log('debug', `初始化！`);
+  },
+  /**
+   * 主要逻辑
+   * @param {...any} args 参数列表
+   */
+  async main(...args) {
+    this.log('debug', `main 被调用`, { args });
+    // 主要代码写在这
+  }
+};

package/core/model/config.tpl.json

@@ -0,0 +1,219 @@
+{
+  // 名称
+  "name": "${name}",
+  // 标题
+  "title": "${title || '用户账户模型'}",
+  // 描述
+  "description": "${description || '定于用户账户模型的组件'}",
+  // 主文件
+  "main": "${main || ''}",
+  // 状态 0：禁用 1：启用
+  "state": 1,
+  // 排序，越小越靠前
+  "sort": 100,
+  // 模型包含字段
+  "fields": {
+    "user_id": {
+      // 值类型
+      "type": "number",
+      // 数据类型
+      "data_type": "int",
+      // 标题
+      "title": "用户ID",
+      // 描述
+      "description": "用户的唯一标识符",
+      // 最小值
+      "min": 1,
+      // 最大值
+      "max": 10000000,
+      // 默认值
+      "default": 0,
+      // 是否主键
+      "primary_key": true,
+      // 是否自动增长
+      "auto": true
+    },
+    "username": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "用户名",
+      "description": "用户的显示名称",
+      // 最小长度
+      "min": 1,
+      // 最大长度
+      "max": 24,
+      "default": ""
+    },
+    "password": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "密码",
+      "description": "用户的密码",
+      "min": 1,
+      "max": 32,
+      "default": "123456"
+    },
+    "salt": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "盐值",
+      "description": "用户密码的盐值",
+      "min": 1,
+      "max": 32,
+      "default": "mm2025"
+    },
+    "state": {
+      "type": "number",
+      "data_type": "int",
+      "title": "状态",
+      "description": "账户的状态",
+      "min": 1,
+      "max": 10000000,
+      "default": 1,
+      "enum": [
+        {
+          "value": 1,
+          "label": "可用"
+        },
+        {
+          "value": 2,
+          "label": "异常"
+        },
+        {
+          "value": 3,
+          "label": "已冻结"
+        },
+        {
+          "value": 4,
+          "label": "已注销"
+        }
+      ]
+    },
+    "avatar": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "头像",
+      "description": "用户的头像",
+      "min": 1,
+      "max": 255,
+      "default": "/avatar.jpg"
+    },
+    "nickname": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "昵称",
+      "description": "用户的昵称",
+      "min": 1,
+      "max": 24,
+      "default": ""
+    },
+    "vip": {
+      "type": "number",
+      "data_type": "int",
+      "title": "会员等级",
+      "description": "用户的会员等级",
+      "min": 0,
+      "max": 10000000,
+      "default": 0
+    },
+    "gm": {
+      "type": "number",
+      "data_type": "int",
+      "title": "管理员等级",
+      "description": "用户的管理员等级",
+      "min": 0,
+      "max": 10000000,
+      "default": 0
+    },
+    "mc": {
+      "type": "number",
+      "data_type": "int",
+      "title": "商家等级",
+      "description": "用户的商家等级",
+      "min": 0,
+      "max": 10000000,
+      "default": 0
+    },
+    "email": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "邮箱",
+      "description": "用户的邮箱",
+      "min": 1,
+      "max": 255,
+      "default": ""
+    },
+    "phone": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "手机号",
+      "description": "用户的手机号",
+      "min": 1,
+      "max": 11,
+      "default": ""
+    },
+    "admin_group": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "管理员组",
+      "description": "用户所属的管理员组集合",
+      "min": 0,
+      "max": 255,
+      "default": ""
+    },
+    "user_group": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "用户组",
+      "description": "用户所属的用户组集合",
+      "min": 0,
+      "max": 255,
+      "default": "default"
+    },
+    "referee_id": {
+      "type": "number",
+      "data_type": "int",
+      "title": "推荐人ID",
+      "description": "用户的推荐人ID",
+      "min": 1,
+      "max": 10000000,
+      "default": 0
+    },
+    "login_ip": {
+      "type": "string",
+      "data_type": "varchar",
+      "title": "登录IP",
+      "description": "用户最近一次登录的IP地址",
+      "min": 0,
+      "max": 255,
+      "default": "127.0.0.1"
+    },
+    "login_time": {
+      "type": "string",
+      "data_type": "datetime",
+      "title": "登录时间",
+      "description": "用户最近一次登录的时间",
+      "min": 1,
+      "max": 20,
+      "default": "1970-01-01 00:00:00"
+    },
+    "time_create": {
+      "type": "string",
+      "data_type": "datetime",
+      "title": "创建时间",
+      "description": "用户账户的创建时间",
+      "min": 1,
+      "max": 20,
+      "default": "now()"
+    },
+    "time_update": {
+      "type": "string",
+      "data_type": "datetime",
+      "title": "更新时间",
+      "description": "用户账户的更新时间",
+      "min": 1,
+      "max": 20,
+      "default": "1970-01-01 00:00:00"
+    }
+  }
+}