mm_os 3.3.0 → 4.0.0

package/server.js

@@ -0,0 +1,598 @@
+require('mm_expand');
+const {
+  Log
+} = require('mm_logs');
+const {
+  cacheAdmin
+} = require('mm_cache');
+const {
+  sqlAdmin
+} = require('mm_sql');
+const {
+  Config
+} = require('mm_config');
+const {
+  Manager,
+  Drive
+} = require('mm_machine');
+
+const {
+  App
+} = require('./core/app/index.js');
+const {
+  Game
+} = require('./core/game/index.js');
+// const {
+//   Zone
+// } = require('./core/zone/index.js');
+const {
+  Mod
+} = require('./core/mod/index.js');
+const {
+  Middleware
+} = require('./core/middleware/index.js');
+const {
+  Notifier
+} = require('./core/notifier/index.js');
+const {
+  Pusher
+} = require('./core/pusher/index.js');
+const {
+  Sender
+} = require('./core/sender/index.js');
+const {
+  Web
+} = require('./adapter/web.js');
+const {
+  Mqtt
+} = require('./adapter/mqtt.js');
+const {
+  Socket
+} = require('./adapter/socket.js');
+const {
+  WebSocket
+} = require('./adapter/websocket.js');
+const {
+  Com
+} = require('./com.js');
+
+/**
+ * 服务器类
+ * 负责管理整个应用的服务端架构
+ */
+class Server extends Drive {
+  static config = {
+    name: 'mos',
+    title: 'mm服务端系统',
+    log: {
+      level: 'debug',
+      file: false
+    },
+    mqtt: {
+      host: '127.0.0.1',
+      port: 1883,
+      state: 0
+    },
+    socket: {
+      host: '0.0.0.0',
+      port: 8200,
+      state: 0
+    },
+    sql: {
+      // mysql、sqlite
+      way: 'mysql'
+    },
+    sqlite: {
+      dir: './db/'.fullname(),
+      user: 'root',
+      password: '',
+      database: 'mm',
+      charset: 'utf8mb4',
+      connect_timeout: 20000,
+      connection_limit: 500
+    },
+    mysql: {
+      host: '127.0.0.1',
+      port: 3306,
+      user: 'root',
+      password: 'Asd159357',
+      database: '',
+      charset: 'utf8mb4',
+      timezone: '+08:00',
+      connect_timeout: 20000,
+      connection_limit: 500
+    },
+    cache: {
+      // 缓存方式memory、redis、mongodb
+      way: 'redis'
+    },
+    // 缓存基础配置
+    cachebase: {
+      dir: './cache/'.fullname(),
+      expire: 0,
+      max: 0,
+      persist: false, // 是否启用持久化
+      saveInterval: 60000 // 保存间隔（毫秒）
+    },
+    // 缓存配置
+    redis: {
+      // 服务器地址
+      host: 'localhost',
+      // 端口号
+      port: 6379,
+      // 密码
+      password: 'asd159357',
+      // 数据库
+      database: 0,
+      // 前缀
+      prefix: "mm_",
+      // 连接超时时间(ms)
+      connect_timeout: 10000,
+      // 重试次数
+      retry_count: 3,
+      // 重试间隔(ms)
+      retry_delay: 1000
+    },
+    // 数据库配置
+    mongodb: {
+      // 服务器地址
+      host: 'localhost',
+      // 端口号
+      port: 27017,
+      // 数据库名
+      database: "mm",
+      // 用户名
+      user: '',
+      // 密码
+      password: '',
+      // 连接选项 (MongoDB驱动7.x版本支持的参数)
+      min_pool_size: 10,
+      max_pool_size: 100,
+      connect_timeout_ms: 10000,
+      server_selection_timeout_ms: 5000,
+      retry_writes: true
+    },
+    web: {
+      state: 1,
+      // 访问地址
+      host: '127.0.0.1',
+      // 访问端口号
+      port: 8000,
+      // 是否启用websocket
+      socket: false,
+      // 是否启用压缩
+      compress: false,
+      // 是否启用事件
+      event: true,
+      // 是否启用事件
+      log: true,
+      // 跨域
+      cos: {
+        status: true,
+        origin: '*',
+        // "headers": "Content-Type,Content-Length,Authorization,Accept,X-Requested-With,x-auth-token,token,client_id,appid,apikey,user_id,x-forwarded-for,x-real-ip,User-Agent,cache-control,pragma,accept-encoding,connection,host"
+      },
+      // 代理转发
+      proxy: {},
+      // static 配置
+      static: {
+        // 是否开启静态文件处理
+        state: 1,
+        // 前端缓存时间，单位秒
+        max_age: 7200,
+        // 是否开启缓存
+        cache: true,
+        // 后端缓存时间，单位秒
+        cache_age: 0,
+        // 是否开启immutable缓存
+        immutable: true,
+        // 是否开启隐藏文件处理
+        hidden: false,
+        // 是否格式化文件
+        format: true,
+        // 是否指定文件扩展名
+        extensions: false,
+        // 是否开启brotli压缩
+        brotli: false,
+        // 是否开启gzip压缩
+        gzip: false,
+        // 静态文件根目录
+        root: "./static",
+        // 编译vue文件，启动后会将vue转为js，可让前端通过 import xxx from './xxx.vue' 引入
+        compile_vue: true,
+        // 编译markdown文件，启动后会将markdown转为html
+        compile_md: true,
+        // 是否将files中的文件的js转换为amd格式
+        convert_amd: false,
+        // 指定路径文件需要转换
+        src_path: '/src',
+        // 需要转换的文件扩展名
+        files: [
+          '.js',
+          '.vue',
+          '.html'
+        ],
+        // 是否启用文件修改监听（实时检测文件修改）
+        watch: true
+      }
+    }
+  };
+
+  /**
+   * 构造函数
+   * @param {object} config 配置参数
+   */
+  constructor(config) {
+    super({ ...Server.config, ...config });
+    /** == 管理层 == */
+    // 管理器
+    this.manager = {};
+    // 通知器
+    this.notifier = {};
+    // 消息发送器
+    this.sender = {};
+    // 广播器
+    this.pusher = {};
+
+    /** == 应用层 == */
+    // 中间件
+    this.middleware = {};
+    // 应用
+    this.app = {};
+    // 模组，用于功能/玩法扩展
+    this.mod = {};
+    // 游戏
+    this.game = {};
+    // 事件总线
+    this.eventer = $.eventer;
+  }
+}
+
+/**
+ * 预置
+ */
+Server.prototype._preset = function () {
+  // 适配器
+  this.adapter = {};
+
+  /** == 基础设施 == */
+  // 日志
+  this.setLogger($.log || console);
+  // 数据库
+  this.sql = null;
+  // 缓存
+  this.cache = null;
+  // 文件管理
+  this.filer = null;
+};
+
+/**
+ * 深度合并对象
+ * @param {object} target 目标对象
+ * @param {object} source 源对象
+ * @returns {object} 合并后的对象
+ */
+Server.prototype.deepMerge = function (target, source) {
+  for (let key of Object.keys(source)) {
+    if (source[key] instanceof Object && key in target) {
+      Object.assign(source[key], this.deepMerge(target[key], source[key]));
+    }
+  }
+  return {
+    ...target,
+    ...source
+  };
+};
+
+/**
+ * 设置配置
+ * @param {object} config 配置参数
+ */
+Server.prototype.setConfig = function (config) {
+  if (config) {
+    this.config = this.deepMerge(this.config, config);
+    this._preset();
+  }
+};
+
+/**
+ * 初始化基础设施
+ */
+Server.prototype._initModules = function () {
+  // 模板引擎
+  require('mm_tpl');
+  const Http = require('mm_https').Http;
+  $.Http = Http;
+};
+
+/**
+ * 初始化基础设施
+ */
+Server.prototype._initBase = function () {
+  // 获取数据库配置
+  var sql = { type: 'mysql', ...this.config.sql };
+  if (this.config.mysql) {
+    sql.mysql = this.config.mysql;
+  }
+  if (this.config.sqlite) {
+    sql.sqlite = this.config.sqlite;
+  }
+  $.sqlAdmin = sqlAdmin;
+  this.sql = sqlAdmin('sys', sql);
+  $.sql = this.sql;
+
+  // 获取缓存配置
+  var cache = { type: 'memory', ...this.config.cache };
+  if (this.config.cachebase) {
+    cache.cachebase = this.config.cachebase;
+  }
+  if (this.config.redis) {
+    cache = { ...cache, ...this.config.redis };
+  }
+  if (this.config.mongodb) {
+    cache.mongodb = this.config.mongodb;
+  }
+  this.cache = cacheAdmin('sys', cache);
+  $.cache = this.cache;
+
+  this.filer = $.file;
+};
+
+/**
+ * 初始化工具
+ */
+Server.prototype._initTool = function () {
+  this.logger = new Log(this.config.log);
+  $.log = this.logger;
+  $.config = new Config({
+    file: '/config.json'.fullname()
+  });
+  $.config.load();
+  $.config.setOptions(this.config);
+  $.config.saveAsync();
+  $.com = new Com();
+  $.com.loads();
+};
+
+/**
+ * 初始化适配器
+ */
+Server.prototype._initAdapter = async function () {
+  // http服务器
+  var web = new Web(this.config.web);
+  web.init(this);
+  this.adapter.web = web;
+  if (this.config.web.socket) {
+    // websocket服务器 - 与web服务器共享同一个端口
+    this.adapter.ws = await new WebSocket(this.config.web).init(web);
+  }
+  if (this.config.mqtt && this.config.mqtt.state) {
+    // mqtt服务器
+    this.adapter.mqtt = await new Mqtt(this.config.mqtt).init(this.cache);
+  }
+  if (this.config.socket && this.config.socket.state) {
+    // socket服务器
+    this.adapter.socket = await new Socket(this.config.socket || {}).init();
+  }
+};
+
+
+/**
+ * 创建管理器实例
+ * @param {string} name 管理器名称
+ * @param {string} title 管理器标题
+ * @param {Function} cls 管理器类
+ * @returns {object} 管理器实例
+ */
+Server.prototype._createManager = function (name, title, cls) {
+  var manager = new Manager(
+    {
+      name: name,
+      title: title,
+      filename: name + '.json',
+      tpl_dir: `./core/${name}/`.fullname(__dirname),
+      base_dir: `./common/${name}/`.fullname(__dirname),
+      dir: `./${name}`.fullname()
+    },
+    this,
+    this[name],
+    cls
+  );
+  // 设置到对应的管理器属性
+  this.manager[name] = manager;
+  return manager;
+}
+
+/**
+ * 初始化管理
+ */
+Server.prototype._initManager = async function () {
+  // 管理器配置列表
+  var mgrConfigs = [
+    { name: 'game', title: '游戏', Module: Game },
+    // { name: 'zone', title: '分区', Module: Zone },
+    { name: 'app', title: '应用', Module: App },
+    { name: 'mod', title: '模组', Module: Mod },
+    { name: 'middleware', title: '中间件', Module: Middleware },
+    { name: 'notifier', title: '通知器', Module: Notifier },
+    { name: 'sender', title: '消息发送器', Module: Sender },
+    { name: 'pusher', title: '广播器', Module: Pusher }
+  ];
+
+  // 管理器实例集合
+  var managers = [];
+
+  // 使用for循环初始化所有管理器
+  for (var i = 0; i < mgrConfigs.length; i++) {
+    var config = mgrConfigs[i];
+    var manager = this._createManager(config.name, config.title, config.Module);
+    managers.push(manager);
+  }
+
+  // 并行执行所有管理器的初始化操作
+  var init_promises = [];
+  for (var j = 0; j < managers.length; j++) {
+    init_promises.push(managers[j].do('init'));
+  }
+
+  await Promise.all(init_promises);
+};
+
+/**
+ * 初始化模块
+ */
+Server.prototype._initAsyncMod = async function () {
+  await Promise.all([
+    this.manager.notifier.runAll('init', this.adapter, this.eventer, this.logger),
+    this.manager.sender.runAll('init', this.adapter, this.eventer, this.logger),
+    this.manager.pusher.runAll('init', this.adapter, this.eventer, this.logger)
+  ]);
+  this.manager.middleware.runWait('init', this.adapter, this.eventer, this.logger);
+};
+
+/**
+ * 初始化资源
+ */
+Server.prototype._initSources = async function () {
+  // 初始化顺序 game > app > mod > middleware > notifier > sender > pusher，根据依赖关系自下而上初始化，内部并行执行
+  await this.manager.game.runAll('init', this, this.eventer, this.logger);
+  await this.manager.app.runAll('init', this, this.eventer, this.logger);
+  await this.manager.mod.runAll('init', this, this.eventer, this.logger);
+  await this._initAsyncMod();
+};
+
+/**
+ * 初始化
+ * @private
+ */
+Server.prototype._init = async function () {
+  try {
+    // 初始化工具
+    this._initTool();
+    // 初始化模块
+    this._initModules();
+    // 初始化基础设施
+    this._initBase();
+    // 初始化适配器
+    this._initAdapter();
+    // 初始化管理器
+    await this._initManager();
+    // 加载资源
+    await this._loadSources();
+    // 初始化资源
+    await this._initSources();
+    // 统一处理错误
+    this._initErrorRun();
+  } catch (error) {
+    this.log('error', '初始化过程失败:', error);
+    throw error;
+  }
+};
+
+/**
+ * 启动资源
+ */
+Server.prototype._startSources = async function () {
+  // 启动无顺序，但需要等待所有启动完成，内部依次执行
+  await Promise.all([
+    this.manager.middleware.runAll('start'),
+    this.manager.game.runAll('start'),
+    // this.manager.zone.runAll('start'),
+    this.manager.app.runAll('start'),
+    this.manager.mod.runAll('start')
+  ]);
+};
+
+/**
+ * 启动适配器
+ */
+Server.prototype._startAdapter = async function () {
+  for (var k in this.adapter) {
+    try {
+      await this.adapter[k].start();
+    } catch (error) {
+      this.log('error', '启动适配器失败:', error);
+    }
+  }
+};
+
+/**
+ * 停止适配器
+ */
+Server.prototype._stopAdapter = async function () {
+  for (var k in this.adapter) {
+    try {
+      await this.adapter[k].stop();
+    } catch (error) {
+      this.log('error', '停止适配器失败:', error);
+    }
+  }
+};
+
+/**
+ * 停止
+ */
+Server.prototype._stop = async function () {
+  await this._stopAdapter();
+};
+
+/**
+ * 启动
+ */
+Server.prototype._start = async function () {
+  $.sql.open();
+  $.cache.connect();
+  
+  // 启动资源
+  await this._startSources();
+
+  // 启动适配器
+  await this._startAdapter();
+};
+
+/**
+ * 加载资源
+ */
+Server.prototype._loadSources = async function () {
+  // 加载无需依赖关系，所以可以同时加载，内部并行执行
+  await Promise.all([
+    this.manager.game.runAll('load'),
+    // this.manager.zone.runAll('load'),
+    this.manager.app.runAll('load'),
+    this.manager.middleware.runAll('load'),
+    this.manager.mod.runAll('load')
+  ]);
+};
+
+/**
+ * 启动服务器
+ */
+Server.prototype.start = async function () {
+  try {
+    if (this.status === 'created') {
+      await this.init();
+    }
+    await this._start();
+    this.log('info', '服务器启动成功');
+  } catch (error) {
+    this.log('error', '服务器启动失败:', error);
+    throw error;
+  }
+};
+
+/**
+ * 初始化全局错误处理机制
+ */
+Server.prototype._initErrorRun = function () {
+  // 全局未捕获异常处理
+  process.on('uncaughtException', (error) => {
+    this.log('error', '全局未捕获异常:', error);
+  });
+
+  // 全局未处理Promise拒绝处理
+  process.on('unhandledRejection', (reason) => {
+    this.log('error', '全局未处理Promise拒绝:', reason);
+  });
+};
+
+exports.Server = Server;

package/README.en.md

@@ -1,36 +0,0 @@
-# 服务端框架
-
-#### Description
-这是服务端框架，网站、游戏、小程序服务端可基于该框架进行二次开发
-
-#### Software Architecture
-Software architecture description
-
-#### Installation
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Instructions
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Contribution
-
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
-
-
-#### Gitee Feature
-
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)

package/conf.json

@@ -1,3 +0,0 @@
-{
-    "runPath": "E:\\gitee\\1_doing\\mm\\mm_os"
-}