skybase 0.1.90 → 0.1.93

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+## [0.1.92](https://github.com/kongnet/skybase/compare/v0.1.91...v0.1.92) (2022-08-31)
+
+
+### :ambulance:
+
+* 非get/post/all打印出错 ([1573187](https://github.com/kongnet/skybase/commit/157318784828856e7a689c654ce23ba1953f65a5))
+
+
+
+## [0.1.91](https://github.com/kongnet/skybase/compare/v0.1.90...v0.1.91) (2022-05-16)
+
+
+### :memo:
+
+* 增加RTS例子 ([ed4d52c](https://github.com/kongnet/skybase/commit/ed4d52ceeb04bd8eaba839117588ff90e4c7aac3))
+
+
+
+## [0.1.90](https://github.com/kongnet/skybase/compare/v0.1.89...v0.1.90) (2022-05-01)
+
+
+
+
 ## [0.1.89](https://github.com/kongnet/skybase/compare/v0.1.88...v0.1.89) (2022-04-29)
 
 

package/README.md

@@ -1,39 +1,36 @@
 # skybase
-![jiatuiLogo](https://github.com/kongnet/skybase/raw/master/screenShot/logo.png)
 
 Sky web base suit
 
 ## 安装 Install
 
-
     npm i skybase
 
-
-## 开始你的web世界 Hello World
+## 开始你的 web 世界 Hello World
 
     const sky = require('skybase')
-    
+
     sky.start({}, async () => {
       console.log('Program running...')
     })
 
 ## start(config, afterStart)
 
-skybase只有一个方法
+skybase 只有一个方法
 
-* config 配置
-* afterStart 启动成功后执行的方法，可用async方法
+- config 配置
+- afterStart 启动成功后执行的方法，可用 async 方法
 
 ## 配置
 
     const path = require('path')
     module.exports = {
-    
+
       /**
        * 项目名称，启动时，会以3D字体的形式在控制台打印
        * */
       name: 'skybase',
-    
+
       /**
        * 中间件
        * ps. 填写中间件的文件名（如果不填文件后缀，则认为是.js），自定义的中间件一定要放在项目根目录的 middleware 文件夹里，不然找不到。
@@ -60,19 +57,19 @@ skybase只有一个方法
         'sky-output',
         'sky-api-register'
       ],
-    
+
       /**
        * token 保存key值
        * */
       tokenName: 'skybase',
-    
+
       /**
        * 入口文件的路径
        *
        * 如果不填，或者转为布尔值为false，则使用 path.dirname(process.mainModule.filename) ，即本node应用的入口文件所在目录
        * */
       rootDir: path.dirname(process.mainModule.filename),
-    
+
       /**
        * api定义所在目录
        *
@@ -81,7 +78,7 @@ skybase只有一个方法
        * 填写相对于 rootDir 的相对路径
        * */
       apiDir: './model/api',
-    
+
       /**
        * 控制器所在目录
        *
@@ -90,7 +87,7 @@ skybase只有一个方法
        * 填写相对于 rootDir 的相对路径
        * */
       routerDir: './router',
-    
+
       /**
        * service所在目录
        *
@@ -100,12 +97,12 @@ skybase只有一个方法
        * 填写相对于 rootDir 的相对路径
        * */
       serviceDir: '',
-    
+
       /**
        * 是否打印日志
        * */
       logger: true,
-    
+
       /**
        * 自定义中间件所在目录
        *
@@ -114,7 +111,7 @@ skybase只有一个方法
        * 填写相对于 rootDir 的相对路径
        * */
       middlewareDir: './middleware',
-    
+
       /**
        * 静态服务的路径
        *
@@ -123,7 +120,7 @@ skybase只有一个方法
        * 填写相对于 rootDir 的相对路径
        * */
       staticDir: './www',
-    
+
       /**
        * 限制post来的数据，这个配置将在 sky/middleware/bodyParse.js 中使用
        */
@@ -142,21 +139,25 @@ skybase只有一个方法
 
 ## api 定义
 
-skybase框架的api定义功能主要有以下几点：
+skybase 框架的 api 定义功能主要有以下几点：
 
-1. 指定api所需参数，会自动校验参数是否符合设定
-2. 输出api接口文档，前端同学可直观查看
+1. 指定 api 所需参数，会自动校验参数是否符合设定
+2. 输出 api 接口文档，前端同学可直观查看
 3. 指定接口的访问权限。如是否登录，是否签名，登录者是否拥有指定权限
-### param中的type类型说明
-* int 整形
-* positive/negative 正数/负数
-* string 字符型
-* datetime 可以被Date.parse的 'YYYY-MM-DD hh:mm:ss'
-* enum 数组，并要求提交的参数包含在，数组列表中
-* bool bool型
-* number 数值型
-* array 数组型，用得少，可以为它配置items的类型： arrayParam1:{type:'array',items:{type:'string'}}
+
+### param 中的 type 类型说明
+
+- int 整形
+- positive/negative 正数/负数
+- string 字符型
+- datetime 可以被 Date.parse 的 'YYYY-MM-DD hh:mm:ss'
+- enum 数组，并要求提交的参数包含在，数组列表中
+- bool bool 型
+- number 数值型
+- array 数组型，用得少，可以为它配置 items 的类型： arrayParam1:{type:'array',items:{type:'string'}}
+
 ### 案例
+
     module.exports = {
       __swagger__: { // 用于把此文件内的接口归为同一组的组名
         name: '文章库-文章管理',
@@ -197,19 +198,27 @@ skybase框架的api定义功能主要有以下几点：
       }
     }
 
+**接口地址**：
 
-**接口地址**： 
-
-* 如果以 / 开始，接口路径则完全等于所编写的地址
-* 否则接口路径的规则为：
+- 如果以 / 开始，接口路径则完全等于所编写的地址
+- 否则接口路径的规则为：
 
 ## 实操案例
-### mock服务器
-* 1. 运行 npm run demo5 //启动mock服务器，前提需要有nodemon全局安装 npm i -g nodemon
-* 2. 启动后 访问 http://127.0.0.1:8888/mock/first
-* 3. mock定义在 [您的项目]\node_modules\skybase\demo\5-mock-api\model\api\mock.js
-
-### mysql探针
-* 1. 运行 npm run demo9 //启动mysql探针服务器，前提需要有nodemon全局安装 npm i -g nodemon
-* 2. 启动后 访问 http://127.0.0.1:13000/skyapi/probe/mysql
-![demo9](https://github.com/kongnet/skybase/raw/master/screenShot/demo9.png)
+
+### mock 服务器
+
+- 1. 运行 npm run demo5 //启动 mock 服务器，前提需要有 nodemon 全局安装 npm i -g nodemon
+- 2. 启动后 访问 http://127.0.0.1:8888/mock/first
+- 3. mock 定义在 [您的项目]\node_modules\skybase\demo\5-mock-api\model\api\mock.js
+
+### mysql 探针
+
+- 1. 运行 npm run demo9 //启动 mysql 探针服务器，前提需要有 nodemon 全局安装 npm i -g nodemon
+- 2. 启动后 访问 http://127.0.0.1:13000/skyapi/probe/mysql
+     ![demo9](https://github.com/kongnet/skybase/raw/master/screenShot/demo9.png)
+
+### RTS 打点例子
+
+> RTS 是时序数据库 https://github.com/kongnet/skyrts
+
+![demo1](https://github.com/kongnet/skybase/raw/master/screenShot/demo1.png)

package/README_demo9.md

@@ -1,5 +1,4 @@
-
-# 加推全栈开发之mysql数据库探针
+# 加推全栈开发之 mysql 数据库探针
 
 ## 项目背景
 
@@ -9,109 +8,138 @@
 
 ## 项目实操
 
-  - 方式一
+- 方式一
+
+  1. 项目地址 [skybase](https://github.com/kongnet/skybase)
+  2. clone 后，安装全局 nodemon,npm i -g nodemon.
+  3. 运行 demo9,npm run demo9，启动数据库探针
+  4. 最终效果
+     ![最终效果](demo_img/treemap.gif)
+
+- 方式二（推荐方式）
+
+  - 1. 使用 skyjt 安装 skybase，项目地址： [skyjt](https://github.com/kongnet/sky)
+  - 2. 安装 npm i -g skyjt
+  - 3. 创建新的文件夹，cd 进入，执行
+  - 4. dn init -f // 强制初始化
 
-    1. 项目地址 [skybase](https://github.com/kongnet/skybase)
-    2. clone后，安装全局nodemon,npm i -g nodemon.
-    3. 运行demo9,npm run demo9，启动数据库探针
-    4. 最终效果
-        ![最终效果](demo_img/treemap.gif)
-  - 方式二（推荐方式）
-    * 1. 使用skyjt安装skybase，项目地址： [skyjt](https://github.com/kongnet/sky)
-    * 2. 安装 npm i -g skyjt
-    * 3. 创建新的文件夹，cd 进入，执行
-    * 4. jt init -f // 强制初始化
+  ![init](demo_img/init.gif)
 
-    ![init](demo_img/init.gif)
+  - 5. cd 进创建的目录，执行 **npm i** or **yarn** or **cnpm i**// 安装依赖包
+  - 6. 安装全局 nodemon, npm i -g nodemon.
+  - 7. 执行 **nodemon** or **npm start** or **node index**
+  - 8. 最终效果同方法一 // 数据库探针需要修改 **./config/config.default.js** 中 **mysql** 的配置
 
-    * 5. cd进创建的目录，执行 **npm i** or **yarn** or **cnpm i**// 安装依赖包
-    * 6. 安装全局nodemon, npm i -g nodemon.
-    * 7. 执行 **nodemon** or **npm start** or **node index**
-    * 8. 最终效果同方法一 // 数据库探针需要修改 **./config/config.default.js** 中 **mysql** 的配置
-  - 注意
+- 注意
 
-      请确认数据库链接正常，且有一定的数据.
+  请确认数据库链接正常，且有一定的数据.
 
-      推荐使用方法二
+  推荐使用方法二
 
 ## 项目运行流程
 
 1. 流程图
 
-    ![图](demo_img/process.png)
+   ![图](demo_img/process.png)
 
 2. 项目结构
 
-    ``` js
-    .
-    ├── README.md
-    ├── config                // 环境配置
-    │   ├── config.default.js // 默认环境数据库配置
-    │   ├── config.dev.js     // 开发环境数据库配置
-    │   ├── config.prod.js    // 生产环境数据库配置
-    │   ├── config.test.js    // 测试环境数据库配置
-    │   └── index.js          // 环境判断
-    ├── index.js              //项目执行文件
-    ├── model                 //API定义 抽象类所处位置
-    │   └── api
-    │       └── skyapi
-    │           └── probe.js
-    ├── package.json            // 项目配置文件
-    ├── router
-    │   └── mysqlProbe.js       //路由 渲染数据库数据渲染到模版
-    ├── service
-    │   └── mysqlProbe.js       //服务 提供处理数据库实际方法
-    ├── template
-         └── treemap-mysql.html // 输出模板
-    ```
+   ```js
+   .
+   ├── README.md
+   ├── config                // 环境配置
+   │   ├── config.default.js // 默认环境数据库配置
+   │   ├── config.dev.js     // 开发环境数据库配置
+   │   ├── config.prod.js    // 生产环境数据库配置
+   │   ├── config.test.js    // 测试环境数据库配置
+   │   └── index.js          // 环境判断
+   ├── index.js              //项目执行文件
+   ├── model                 //API定义 抽象类所处位置
+   │   └── api
+   │       └── skyapi
+   │           └── probe.js
+   ├── package.json            // 项目配置文件
+   ├── router
+   │   └── mysqlProbe.js       //路由 渲染数据库数据渲染到模版
+   ├── service
+   │   └── mysqlProbe.js       //服务 提供处理数据库实际方法
+   ├── template
+        └── treemap-mysql.html // 输出模板
+   ```
 
 3. 方法亮点详解
 
-    - service/mysqlProbe.js
-
-      ```js
-      async function getTableColumnSize () {
-        let sql = `select
-        table_schema as 'dbName',
-        table_name as 'tableName',
-        table_rows as 'rowCount',
-        truncate(data_length/1024/1024, 2) as 'dataSize',
-        truncate(index_length/1024/1024, 2) as 'idxSize',
-        table_comment as 'tableComment'
-        from information_schema.tables
-        order by data_length desc, index_length desc;` // 数据库查询语句
-        let r = await db.cmd(sql).run() // 异步执行，返回所有数据表的数据
-        let arr = []
-        let arrSize = []
-        let obj = {}
-        r.forEach(item => {
-          if (obj[item.dbName]) { // 如果存在节点就插入到children
-            arr[obj[item.dbName]].children.push({ name: item.tableComment + '\n' + item.tableName + '\n\n' + ((item.rowCount + '').toMoney(2)), value: item.rowCount || 0 })
-            arrSize[obj[item.dbName]].children.push({ name: item.tableComment + '\n' + item.tableName + '\n\n' + ((item.dataSize + '').toMoney(2)), value: item.dataSize || 0 })
-          } else { // 如果不存在节点就创建
-            if (!['performance_schema', 'mysql', 'information_schema', 'sys', 'happyminer_test'].includes(item.dbName)) { // 需要忽略的数据库
-              // es7方法: includes
-              // 如 [1, 2, 3].includes(2); // true
-              // 在es7之前使用indexOf来判断数组中是否包含某个值。
-              // 如果不确定是否支持，使用一下方法判断
-              // const isInList = (() => {
-              //  Array.prototype.includes
-              //   ? (arr, value) => arr.includes(value)
-              //   : (arr, value) => arr.some(el => el === value)
-              //  )();
-              //})
-              arr.push({ name: item.dbName, children: [] })
-              arrSize.push({ name: item.dbName, children: [] })
-              obj[item.dbName] = arr.length - 1
-            }
-          }
-        })
-        arr.shift()// 因为增加了两条一样的初始数据，所以删除第一条。
-        // console.log(arr)
-        return {
-          code: 0,
-          data: { tableRow: arr, tableSize: arrSize }
-        }
-      }
-
-      ```
+   - service/mysqlProbe.js
+
+     ```js
+     async function getTableColumnSize () {
+       let sql = `select
+       table_schema as 'dbName',
+       table_name as 'tableName',
+       table_rows as 'rowCount',
+       truncate(data_length/1024/1024, 2) as 'dataSize',
+       truncate(index_length/1024/1024, 2) as 'idxSize',
+       table_comment as 'tableComment'
+       from information_schema.tables
+       order by data_length desc, index_length desc;` // 数据库查询语句
+       let r = await db.cmd(sql).run() // 异步执行，返回所有数据表的数据
+       let arr = []
+       let arrSize = []
+       let obj = {}
+       r.forEach(item => {
+         if (obj[item.dbName]) {
+           // 如果存在节点就插入到children
+           arr[obj[item.dbName]].children.push({
+             name:
+               item.tableComment +
+               '\n' +
+               item.tableName +
+               '\n\n' +
+               (item.rowCount + '').toMoney(2),
+             value: item.rowCount || 0
+           })
+           arrSize[obj[item.dbName]].children.push({
+             name:
+               item.tableComment +
+               '\n' +
+               item.tableName +
+               '\n\n' +
+               (item.dataSize + '').toMoney(2),
+             value: item.dataSize || 0
+           })
+         } else {
+           // 如果不存在节点就创建
+           if (
+             ![
+               'performance_schema',
+               'mysql',
+               'information_schema',
+               'sys',
+               'happyminer_test'
+             ].includes(item.dbName)
+           ) {
+             // 需要忽略的数据库
+             // es7方法: includes
+             // 如 [1, 2, 3].includes(2); // true
+             // 在es7之前使用indexOf来判断数组中是否包含某个值。
+             // 如果不确定是否支持，使用一下方法判断
+             // const isInList = (() => {
+             //  Array.prototype.includes
+             //   ? (arr, value) => arr.includes(value)
+             //   : (arr, value) => arr.some(el => el === value)
+             //  )();
+             //})
+             arr.push({ name: item.dbName, children: [] })
+             arrSize.push({ name: item.dbName, children: [] })
+             obj[item.dbName] = arr.length - 1
+           }
+         }
+       })
+       arr.shift() // 因为增加了两条一样的初始数据，所以删除第一条。
+       // console.log(arr)
+       return {
+         code: 0,
+         data: { tableRow: arr, tableSize: arrSize }
+       }
+     }
+     ```

package/lib/middleware/sky-check-param.js

@@ -3,8 +3,8 @@
  * */
 
 const $ = require('meeko')
-const $G = global.$G = global.$G || {}
-const api = $G.api = $G.api || {}
+const $G = (global.$G = global.$G || {})
+const api = ($G.api = $G.api || {})
 
 const config = require('../../skyconfig')
 
@@ -12,9 +12,21 @@ const apiCheckLog = function (url, obj, method, oldParam, ctx) {
   if (config.logger) {
     let checkColor = 'c'
     obj = obj || {}
-    if (obj.code >= 400) { checkColor = 'y' }
+    if (obj.code >= 400) {
+      checkColor = 'y'
+    }
     let methodStr = method.toUpperCase()
-    $.log($.c[{ 'GET': 'dimg', 'POST': 'dimy' }[methodStr]](`[ ${methodStr} ]`) + $.c.dimy(url.join ? url.join('/') : url) + $.c[checkColor](JSON.stringify(obj || '{}')), '实际参数:', oldParam ? $.c.r(JSON.stringify(oldParam || '{}')) : '', 'header参数:', $.c.c(JSON.stringify(ctx.header || '{}')))
+    const fname =
+      methodStr === 'GET' ? 'dimg' : methodStr === 'POST' ? 'dimy' : 'r'
+    $.log(
+      $.c[fname](`[ ${methodStr} ]`) +
+        $.c.dimy(url.join ? url.join('/') : url) +
+        $.c[checkColor](JSON.stringify(obj || '{}')),
+      '实际参数:',
+      oldParam ? $.c.r(JSON.stringify(oldParam || '{}')) : '',
+      'header参数:',
+      $.c.c(JSON.stringify(ctx.header || '{}'))
+    )
   }
 }
 
@@ -22,7 +34,8 @@ const apiCheckLog = function (url, obj, method, oldParam, ctx) {
 const checkRedirect = (ctx, apiPath) => {
   if (config.redirect) {
     let url = config.redirect[apiPath] || null
-    if (url) { // 跳转
+    if (url) {
+      // 跳转
       if (ctx.request.header) {
         url = `${ctx.request.header['x-forwarded-prefix'] || ''}${url}`
       }
@@ -48,7 +61,7 @@ const checkCache = (ctx, method, url) => {
 // 快速检查是否可以不执行具体方法
 const preCheck = (ctx, method, url, apiPath) => {
   if (!['get', 'post'].includes(method)) {
-    ctx.throwCode(ctx.status, '只支持get/post方式')
+    ctx.throwCode(ctx.status, '只支持get/post/all方式')
     return { succ: false, continue: false }
   }
   if (checkRedirect(ctx, apiPath)) {
@@ -64,8 +77,16 @@ const preCheck = (ctx, method, url, apiPath) => {
   let apiSetting = api[apiPath]
   //NOTICE: 支持动态路由，但找不到的时候性能有点损失
   if (!apiSetting) {
-    apiSetting = api[Object.keys(api).find(x => x.includes(':')
-      && new RegExp(x.replace(/(:[0-9a-z]+)/g, '[0-9a-z]+'), 'g').test(apiPath))]
+    apiSetting =
+      api[
+        Object.keys(api).find(
+          x =>
+            x.includes(':') &&
+            new RegExp(x.replace(/(:[0-9a-z]+)/g, '[0-9a-z]+'), 'g').test(
+              apiPath
+            )
+        )
+      ]
   }
   if (!apiSetting) {
     ctx.throwCode(404, '接口不存在')
@@ -73,7 +94,8 @@ const preCheck = (ctx, method, url, apiPath) => {
   }
 
   const needMethod = apiSetting.method
-  if (method !== needMethod && needMethod !== 'all') { // 允许get和post都接入
+  if (method !== needMethod && needMethod !== 'all') {
+    // 允许get和post都接入
     $.err(`方法类型不对，应为${needMethod}，不能为${method}`)
     ctx.throwCode(405, '方法类型不对')
     return { succ: false, continue: false }
@@ -86,7 +108,12 @@ module.exports = async (ctx, next) => {
   const method = ctx.method.toLowerCase()
   const url = ctx.request.url
   const apiPath = url.split('?')[0]
-  const { continue: canContinue, succ, needMethod, apiSetting } = preCheck(ctx, method, url, apiPath)
+  const { continue: canContinue, succ, needMethod, apiSetting } = preCheck(
+    ctx,
+    method,
+    url,
+    apiPath
+  )
   if (!canContinue) {
     apiCheckLog(apiPath, ctx.body, method, null, ctx)
     return succ ? 1 : 0
@@ -94,7 +121,8 @@ module.exports = async (ctx, next) => {
 
   ctx.apiSetting = apiSetting
 
-  const params = method === 'get' ? ctx.query || {} : ctx.request.fields || ctx.body || {}
+  const params =
+    method === 'get' ? ctx.query || {} : ctx.request.fields || ctx.body || {}
 
   // 下面是原来有的逻辑，感觉不安全，所以去掉了
   // NOTICE 如果是上传文件不过滤参数 参数里有files的即为上传
@@ -106,7 +134,10 @@ module.exports = async (ctx, next) => {
   //   }
   // }
 
-  ctx.checkedData = $.tools.checkParam(params, needMethod === 'all' && apiSetting.param[method] || apiSetting.param)
+  ctx.checkedData = $.tools.checkParam(
+    params,
+    (needMethod === 'all' && apiSetting.param[method]) || apiSetting.param
+  )
   apiCheckLog(apiPath, ctx.checkedData, method, params, ctx)
   if (ctx.checkedData.code >= 400) {
     return ctx.throwCode(400, ctx.checkedData.msg)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skybase",
-  "version": "0.1.90",
+  "version": "0.1.93",
   "description": "sky框架",
   "main": "index.js",
   "directories": {