mm_os 2.7.8 → 2.7.9

package/README.md

@@ -1,37 +1,59 @@
 # 服务端框架
 
 #### 介绍
-这是服务端框架，网站、游戏、小程序服务端可基于该框架进行二次开发
+这是一个服务端框架，用于快速构建网站、游戏、小程序服务端。
 
 #### 软件架构
-软件架构说明
-
+由koa网站框架 + art-template模板引擎 + mm(热拔插)插件机制 + mysql数据库 + redis缓存 + jwt鉴权 + 等等组成。
 
 #### 安装教程
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
+新建一个目录，然后在当前打开命令提示符，输入以下命令进行初始化
+``` command
+npm init
+```
+然后根据提示进行配置，配置完成后，输入以下指令进行安装
+``` command
+npm i mm_os
+```
 
 #### 使用说明
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
+安装完成后，目录下新建一个index.js文件，在命令行输入以下代码，然后运行即可
+```javascript
+require("mm_expand");
+const OS = require("mm_os");
+$.runPath = __dirname + $.slash;
+var os = new OS(config);
+os.run();
+```
+
+#### 特色说明
+1.  独特的json配置文件 + js脚本的开发模式，让开发更加灵活，更加高效。
+2.  内置http请求模块、mysql、redis、mongodb模块，让请求数据和操作数据库更加简单。
+3.  适合分布式部署，支持多进程，支持负载均衡，支持集群部署。
+4.  适合微服务架构，支持服务注册与发现，支持服务调用，支持服务熔断，支持服务降级。
+5.  mm(热拔插)插件机制，可以快速扩展功能，并且支持热拔插，无需重启服务。
+6.  jwt鉴权，支持单点登录，支持多用户登录，支持多角色权限控制。
+7.  mysql数据库，支持多数据库连接，支持事务，支持分库分表。
+8.  redis缓存，支持多缓存连接，支持缓存穿透，支持缓存雪崩。
+9.  art-template模板引擎，支持多模板引擎，支持模板继承，支持模板缓存。
+10. 支持多语言，采用I18n多语言模式。
+11. 支持多协议，支持http，支持https，支持websocket，支持grpc。
+12. 支持多平台，支持windows，支持linux，支持mac。
 
 #### 参与贡献
-
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
-
-
-#### 特技
-
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+1.  qiuwenwu（mm_os框架创始人）
+2.  自由人网络（mm_os框架核心开发团队）
+
+#### 特点
+1.  简单易用，快速上手
+2.  高效开发，快速迭代
+3.  灵活扩展，快速定制
+4.  稳定可靠，长期维护
+5.  开源免费，社区支持
+6.  适合个人开发者，适合企业级应用
+8.  适合初创企业，中小型企业，仅需几人即可快速搭建大型网站、游戏服务端或智能物联网(AIOT)平台
+
+#### 附言
+1.  mm_os 官方网站 [www.fman.top](https://www.fman.top)
+2.  你可以访问 [https://www.fman.top/source/market](https://www.fman.top/source/market) 来了解 mm_os 上的优秀开源项目
+3.  [mm_os_server](https://www.fman.top/download) 是极为有价值开源项目，是综合评定出的优秀开源项目，具有丰富的插件、模板、挂件可用

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_os",
-  "version": "2.7.8",
+  "version": "2.7.9",
   "description": "这是超级美眉服务端框架，用于快速构建应用程序。",
   "main": "index.js",
   "scripts": {
@@ -30,7 +30,7 @@
   "author": "邱文武",
   "license": "ISC",
   "dependencies": {
-    "koa": "^2.15.3",
+    "koa": "^2.15.4",
     "koa-body": "^6.0.1",
     "koa-compress": "^5.1.1",
     "koa-send": "^5.0.1",
@@ -41,7 +41,7 @@
     "mm_html": "^1.1.6",
     "mm_koa_proxy": "^1.0.0",
     "mm_logs": "^1.1.6",
-    "mm_machine": "^1.8.1",
+    "mm_machine": "^1.8.2",
     "mm_mongodb": "^1.4.2",
     "mm_mqtt": "^1.0.6",
     "mm_mysql": "^1.8.9",

package/demo/app/test/app.js

@@ -1,145 +0,0 @@
-/**
- * @fileOverview dev
- * @author <a href="作者主页地址">插件作者</a>
- * @version 1.0
- */
-
-/**
- * @description 插件对象
- */
-module.exports = {
-	/**
-	 * @description 初始化
-	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null, 否则返回错误提示
-	 */
-	init(option) {
-		var msg = null;
-		console.log("示例应用-初始化");
-		return msg;
-	},
-
-	/**
-	 * @description 安装
-	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
-	 */
-	install(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 卸载
-	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
-	 */
-	uninstall(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 更新
-	 * @param {Object} option 配置参数
-	 * @return {String} 成功返回null, 否则返回错误提示
-	 */
-	update(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 启动
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
-	 */
-	start(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 暂停
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
-	 */
-	stop(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 结束
-	 * @param {Object} opiton 配置参数
-	 * @return {String} 成功返回null,否则返回错误提示
-	 */
-	end(option) {
-		var msg = null;
-		return msg;
-	},
-
-	/**
-	 * @description 插件
-	 * @param {String} item 插件项
-	 * @return {Object} 旗下插件和信息
-	 */
-	help(item) {
-		var tip = "";
-		switch (item) {
-			case "run":
-				break;
-			default:
-				break;
-		}
-		return tip;
-	},
-
-	/**
-	 * @description 主程序
-	 * @param {Object} param1 参数1
-	 * @param {Object} param2 参数2
-	 * @return {Object} 返回执行结果
-	 */
-	main(param1, param2) {
-		var ret = null;
-		return ret;
-	},
-
-	/**
-	 * @description 指令（类似命令提示符）
-	 * @param {String} content 指令内容
-	 * @return {String} 执行结果
-	 */
-	cmd(content) {
-		var ret = "";
-		return ret;
-	},
-
-	/**
-	 * @description API接口（用于其他插件调用该插件时）
-	 * @param {Object} ctx HTTP上下文
-	 * @param {Object} db 数据库管理器
-	 * @return {Object} 执行结果
-	 */
-	api(ctx, db) {
-		var ret = "";
-		return ret;
-	},
-
-	/**
-	 * @description 聊天（通过聊天的方式驱动插件, 用于机器人开发）
-	 * @param {String} from_user 发送消息人
-	 * @param {String} to_user 接收消息人
-	 * @param {String} content 内容
-	 * @param {String} group 群组 如果是个人，群组为空
-	 * @param {Number} type 群类型, 1永久会话/群、2临时会话/群
-	 * @param {String} msg_type 消息类型, event事件型、message消息型。默认消息型
-	 * @param {Object} 数据管理器
-	 * @return {String} 回复内容
-	 */
-	async chat(from_user, to_user, group, content, type, msg_type, db) {
-		var ret = "";
-		return ret;
-	}
-};

package/demo/app/test/app.json

@@ -1,12 +0,0 @@
-{
-    "name": "demo",
-    "title": "这是示例应用",
-    "description": "用于调试开发",
-    "version": "1.0",
-    "lang_path": "./lang/",
-    "icon": "/demo/img/logo.png",
-    "cmd": "demo",
-    "script": "./app.js",
-    "sort": 10,
-    "state": 1
-}

package/demo/app/test/event_api/client/event.json

@@ -1,20 +0,0 @@
-[{
-	// 目标对象
-	"target": "/api/test*",
-	// 事件名称, 用于动态增删改
-	"name": "test_client",
-	// 标题, 用于开发者查看事件
-	"title": "示例事件",
-	// 描述, 用于介绍该事件是做什么用的
-	"description": "描述事件使用方法",
-	// 阶段, 分执行前before、验证check、主要main、渲染render、执行后after阶段
-	"stage": "main",
-	// 响应方法 GET请求、POST请求、ALL所有请求，如果非API事件可自定义
-	"method": "ALL",
-	// 函数文件, 当事件触发时执行指定的脚本
-	"func_file": "./main.js",
-	// 执行顺序, 数值越小越优先执行
-	"sort": 100,
-	// 状态
-	"state": 1
-}]

package/demo/app/test/event_api/client/main.js

@@ -1,21 +0,0 @@
-// 使用api管理器
-var api = $.api_admin('demo_client', 'demo_client');
-// 首次启动更新api接口;
-api.update();
-// 使用mysql数据库管理器
-var sql = $.mysql_admin('sys', __dirname);
-sql.setConfig($.config.mysql);
-sql.open();
-
-/**
- * @description 接口主函数
- * @param {Object} ctx HTTP上下文
- * @param {Object} db 数据管理器,如: { next: async function{}, ret: {} }
- * @return {Object} 执行结果
- */
-async function main(ctx, db) {
-	$.push(db, sql.db(), true);
-	return await api.run(ctx, db);
-};
-
-exports.main = main;