jj.js 0.18.0 → 0.20.0

package/lib/{run.js → mvc.js}

@@ -1,16 +1,24 @@
 const path = require('path');
-const loader = require('./loader');
 const {readFile} = require('fs').promises;
 const {toHump} = require('./utils/str');
+const {validatePath} = require('./utils/validate');
 const config = require('./config');
 const {app: cfg_app, view: cfg_view} = config;
 const compose = require('koa-compose');
 const Logger = require('./logger');
 const storage = require('./storage');
 
-async function run(ctx, next, control_type=cfg_app.controller_folder) {
+/**
+ * MVC中间件
+ * @param {import('../types').KoaCtx} ctx 
+ * @param {import('../types').KoaMiddleware} next 
+ * @returns {Promise<void>}
+ */
+async function mvc(ctx, next) {
+    const controller_folder = ctx.FOLDER || cfg_app.controller_folder;
+
     if(cfg_app.app_debug) {
-        Logger.http({Router: control_type, APP: ctx.APP, CONTROLLER: ctx.CONTROLLER, ACTION: ctx.ACTION});
+        Logger.http({Router: controller_folder, APP: ctx.APP, CONTROLLER: ctx.CONTROLLER, ACTION: ctx.ACTION});
         Object.keys(ctx.params).length && Logger.http('Params:', ctx.params);
         Object.keys(ctx.query).length && Logger.http('Get:', ctx.query);
         Object.keys(ctx.request.body || {}).length && Logger.http('Post:', ctx.request.body);
@@ -22,9 +30,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
     store.CONTROLLER = ctx.CONTROLLER;
     store.ACTION = ctx.ACTION;
     store.COMMON = cfg_app.common_app;
-    // 设置根加载器
-    store.$ = loader('./', ctx);
-    store._ = loader(cfg_app.base_dir, ctx);
+
     // 配置特殊处理
     store._.config === undefined && (store._.config = {});
     Object.entries(config).forEach(([key, value]) => {
@@ -32,58 +38,58 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
     });
 
     // 应用、控制器、方法名字验证
-    if(~ctx.APP.indexOf('.') || ~ctx.CONTROLLER.indexOf('.') || ~ctx.ACTION.indexOf('.')) {
+    if(!validatePath(ctx.APP) || !validatePath(ctx.CONTROLLER) || !validatePath(ctx.ACTION)) {
         // throw new Error(`RunError: 应用、控制器或方法名字不合法！`);
-        return false;
+        return;
     }
 
     if(ctx.APP[0] == '_' || ctx.APP[0] == '$' || !store._[ctx.APP]) {
         if(cfg_app.app_debug) {
             throw new Error(`RunError: 应用:${ctx.APP}不存在！`);
         } else {
-            return false;
+            return;
         }
     }
 
-    if(!store._[ctx.APP][control_type]) {
+    if(!store._[ctx.APP][controller_folder]) {
         if(cfg_app.app_debug) {
-            throw new Error(`RunError: 目录:${ctx.APP}/${control_type}不存在！`);
+            throw new Error(`RunError: 目录:${ctx.APP}/${controller_folder}不存在！`);
         } else {
-            return false;
+            return;
         }
     }
 
     // 模版文件内容直接输出
-    if(control_type == cfg_view.view_folder) {
-        const content = await readFile(path.join(cfg_app.base_dir, `${ctx.APP}/${control_type}`, ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext));
+    if(controller_folder == cfg_view.view_folder) {
+        const content = await readFile(path.join(cfg_app.base_dir, `${ctx.APP}/${controller_folder}`, ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext));
         if(!content) {
-            throw new Error(`RunError: 模板文件:${ctx.APP}/${control_type}/${ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext}不存在！`);
+            throw new Error(`RunError: 模板文件:${ctx.APP}/${controller_folder}/${ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext}不存在！`);
         }
         ctx.body = content;
         return;
     }
 
     // 控制器
-    const Controller = store._[ctx.APP][control_type][ctx.CONTROLLER] || store._[ctx.APP][control_type]['_empty'];
+    const Controller = store._[ctx.APP][controller_folder][ctx.CONTROLLER] || store._[ctx.APP][controller_folder]['_empty'];
 
     if(ctx.CONTROLLER[0] == '_' || ctx.CONTROLLER[0] == '$' || typeof Controller != 'function') {
         if(cfg_app.app_debug) {
-            throw new Error(`RunError: class文件:${ctx.APP}/${control_type}/${ctx.CONTROLLER}不存在！`);
+            throw new Error(`RunError: class文件:${ctx.APP}/${controller_folder}/${ctx.CONTROLLER}不存在！`);
         } else {
-            return false;
+            return;
         }
     }
 
     // 控制器实例
     const $controller = new Controller(ctx, next);
     const humpAction = toHump(ctx.ACTION);
-    const action = typeof $controller[humpAction] == 'function' ? humpAction : '_empty';
+    const action = typeof $controller[humpAction] == 'function' && !$controller[humpAction].__ISCLASS__ ? humpAction : '_empty';
 
     if(ctx.ACTION[0] == '_' || ctx.ACTION[0] == '$' || typeof $controller[action] != 'function') {
         if(cfg_app.app_debug) {
-            throw new Error(`RunError: class方法:${ctx.APP}/${control_type}/${ctx.CONTROLLER}/${humpAction}不存在！`);
+            throw new Error(`RunError: class方法:${ctx.APP}/${controller_folder}/${ctx.CONTROLLER}/${humpAction}不存在！`);
         } else {
-            return false;
+            return;
         }
     }
 
@@ -98,6 +104,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
                 if(middle.accept && (Array.isArray(middle.accept) ? !~middle.accept.indexOf(action) : !~[middle.accept].indexOf(action))) {
                     return stack;
                 }
+                // @ts-ignore
                 return stack.concat(async (ctx, next) => {
                     const [METHOD = action, MIDDLEWARE = ctx.CONTROLLER, APP = ctx.APP] = middle.middleware.split('/').reverse();
                     if(!store._[APP]) {
@@ -130,4 +137,4 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
     });
 }
 
-module.exports = run;
+module.exports = mvc;

package/lib/pagination.js

@@ -1,15 +1,28 @@
 const {page: cfg_page} = require('./config');
 const Context = require('./context');
 
+/**
+ * @typedef {import('../types').KoaCtx} KoaCtx
+ * @typedef {import('../types').PageConfig} PageConfig
+ * @typedef {import('../types').UrlInstance} UrlInstance
+ */
+
 /**
  * @extends Context
  */
 class Pagination extends Context
 {
+    /**
+     * @type {PageConfig}
+     * @private
+     */
+    // @ts-ignore
+    options = null;
+
     /**
      * Initialize a new `Pagination`
      * @public
-     * @param {import('../types').KoaCtx} ctx
+     * @param {KoaCtx} ctx
      */
     constructor(ctx) {
         super(ctx);
@@ -23,17 +36,17 @@ class Pagination extends Context
     /**
      * 分页配置
      * @public
-     * @param {import('../types').PageConfig} [options]
+     * @param {PageConfig} [options]
      * @returns {this}
      */
     init(options) {
         /**
-         * @type {import('../types').PageConfig}
+         * @type {PageConfig}
          * @private
          */
         this.options = {...cfg_page, ...options};
-        this._pageKey = this.options.page_key;
-        this._keyOrigin = this.options.key_origin;
+        this._pageKey = this.options.page_key || 'page';
+        this._keyOrigin = this.options.key_origin || 'query';
         this._ctxPage = this.ctx
             && this.ctx[this._keyOrigin]
             && this.ctx[this._keyOrigin][this._pageKey]
@@ -103,6 +116,7 @@ class Pagination extends Context
         this._totalPage = Math.ceil(this._total / this._pageSize);
 
         return this._initRule().options['template'].replace(/\$\{(\w+)\}/g, (...args) => {
+            // @ts-ignore
             return this['_' + args[1]]();
         });
     }
@@ -158,29 +172,42 @@ class Pagination extends Context
         return list;
     }
 
-    // 解析模块
+    /**
+     * 解析模块
+     * @param {string} tpl_key 
+     * @param {*} num 
+     * @returns 
+     */
     _parseTpl(tpl_key, num) {
+        // @ts-ignore
         return this.options[tpl_key].replace(/\$\{(\w+)\}/g, (...args) => {
             return args[1] == 'url' ? this._parseUrl(num) : args[1] == 'page' ? num : args[1] == 'total' ? this._total : this._totalPage;
         });
     }
 
-    // 解析网址
+    /**
+     * 解析网址
+     * @param {number} page 
+     * @returns 
+     */
     _parseUrl(page) {
-        return (page == 1 ? this._urlIndex : this._urlPage).replace('${page}', page);
+        // @ts-ignore
+        return ((page == 1 ? this._urlIndex : this._urlPage) || '').replace('${page}', page);
     }
 
     // 初始网址规则
     _initRule() {
-        let url_index = this.options.url_index;
-        let url_page = this.options.url_page;
+        let url_index = this.options.url_index || '';
+        let url_page = this.options.url_page || '';
 
         if(url_index.slice(0, 1) == ':') {
-            url_index = this.$url.ruleUrl(url_index.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
+            // @ts-ignore
+            url_index = this._$url.ruleUrl(url_index.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
         }
 
         if(url_page.slice(0, 1) == ':') {
-            url_page = this.$url.ruleUrl(url_page.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
+            // @ts-ignore
+            url_page = this._$url.ruleUrl(url_page.substr(1), {[this._pageKey]: '__page__'}).replace('__page__', '${page}');
         }
 
         if(url_index == '' || url_page == '') {
@@ -212,11 +239,38 @@ class Pagination extends Context
             }
         }
 
-        this._urlIndex = url_index;
-        this._urlPage = url_page;
+        this._urlIndex = url_index || '';
+        this._urlPage = url_page || '';
 
         return this;
     }
+
+    /**
+     * @type {UrlInstance} Url实例
+     * @private
+     */
+    // @ts-ignore
+    __url = null;
+
+    /**
+     * @type {UrlInstance} Url实例
+     */
+    get _$url() {
+        if(this.__url === null) {
+            if(this.$url && this.$url.__ISCLASS__) {
+                this.__url = this.$url;
+            } else if(this.$ && this.$.url) {
+                this.__url = this.$.url;
+            } else {
+                this.__url = new (require('./url'))(this.ctx);
+            }
+        }
+        return this.__url;
+    }
+
+    set _$url(url) {
+        this.__url = url;
+    }
 }
 
 module.exports = Pagination;

package/lib/request.js

@@ -61,6 +61,9 @@ class Request extends Context
      * @returns {*}
      */
     post(key, default_value='') {
+        if(!this.$config.app.koa_body && key !== 'is_ajax') {
+            throw new Error('请先在app配置中开启koa_body');
+        }
         return this._post[key] || default_value;
     }
 
@@ -100,10 +103,10 @@ class Request extends Context
     /**
      * 获取上传file数据
      * @param {string} key
-     * @returns {import('formidable').File | import('formidable').File[]}
+     * @returns {import('formidable').File | import('formidable').File[] | undefined}
      */
     file(key) {
-        return this.ctx.request.files[key];
+        return this.ctx.request.files && this.ctx.request.files[key];
     }
 
     /**
@@ -111,7 +114,7 @@ class Request extends Context
      * @returns {import('formidable').Files}
      */
     fileAll() {
-        return this.ctx.request.files;
+        return this.ctx.request.files || {};
     }
 
     /**

package/lib/response.js

@@ -2,6 +2,12 @@ const {tpl: cfg_tpl} = require('./config');
 const {parseError} = require('./utils/error');
 const Context = require('./context');
 
+/**
+ * @typedef {import('../types').KoaCtx} KoaCtx
+ * @typedef {import('../types').RequestInstance} RequestInstance
+ * @typedef {import('../types').UrlInstance} UrlInstance
+ */
+
 /**
  * @extends Context
  */
@@ -10,7 +16,7 @@ class Response extends Context
     /**
      * Initialize a new `Response`
      * @public
-     * @param {import('../types').KoaCtx} ctx
+     * @param {KoaCtx} ctx
      */
     constructor(ctx) {
         super(ctx);
@@ -36,7 +42,7 @@ class Response extends Context
      */
     redirect(url, status=302) {
         this.ctx.status = status;
-        this.ctx.redirect(this.$url.build(url));
+        this.ctx.redirect(this._$url.build(url));
     }
 
     /**
@@ -47,7 +53,7 @@ class Response extends Context
      */
     success(msg='操作成功！', url) {
         typeof msg == 'object' && ([msg, url] = ['操作成功！', msg]);
-        url = typeof url == 'string' ? this.$url.build(url) : (url || this.ctx.header.referer);
+        url = typeof url == 'string' ? this._$url.build(url) : (url || this.ctx.header.referer || '');
         this.jump(msg, url, 1);
     }
 
@@ -59,7 +65,7 @@ class Response extends Context
      */
     error(msg='操作失败！', url) {
         typeof msg == 'object' && ([msg, url] = ['操作失败！', msg]);
-        url = typeof url == 'string' ? this.$url.build(url) : (url || 'javascript:history.back(-1);');
+        url = typeof url == 'string' ? this._$url.build(url) : (url || 'javascript:history.back(-1);');
         this.jump(msg, url, 0);
     }
 
@@ -72,7 +78,8 @@ class Response extends Context
      */
     jump(msg, url, state=1) {
         const tplData = {state, msg, url, wait: this._wait};
-        this.ctx.body = this.$request.isAjax() ? {state, msg, data: url} : this._tpl_jump.replace(/\{\$(\w+)\}/g, (...args) => {
+        this.ctx.body = this._$request.isAjax() ? {state, msg, data: url} : this._tpl_jump.replace(/\{\$(\w+)\}/g, (...args) => {
+            // @ts-ignore
             return tplData[args[1]];
         });
     }
@@ -97,12 +104,69 @@ class Response extends Context
         const escapeHtml = require('escape-html');
         const tplData = parseError(err);
         tplData.msg = escapeHtml(tplData.msg);
+        // @ts-ignore
         tplData.code = '<span class="line">' + tplData.code.map(str => escapeHtml(str)).join('</span><span class="line">') + '</span>';
+        // @ts-ignore
         tplData.stack = tplData.stack.map(str => escapeHtml(str)).join('<br>');
-        this.ctx.body = this.$request.isAjax() ? {state: 0, msg: tplData.msg} : this._tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
+        this.ctx.body = this._$request.isAjax() ? {state: 0, msg: tplData.msg, stack: tplData.stack} : this._tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
+            // @ts-ignore
             return tplData[args[1]];
         });
     }
+
+    /**
+     * @type {RequestInstance} Request实例
+     * @private
+     */
+    // @ts-ignore
+    __request = null;
+
+    /**
+     * @type {RequestInstance} Request实例
+     */
+    get _$request() {
+        if(this.__request === null) {
+            if(this.$request && this.$request.__ISCLASS__) {
+                this.__request = this.$request;
+            } else if(this.$ && this.$.request) {
+                this.__request = this.$.request;
+            } else {
+                this.__request = new (require('./request'))(this.ctx);
+            }
+        }
+        return this.__request;
+    }
+
+    set _$request(request) {
+        this.__request = request;
+    }
+
+    /**
+     * @type {UrlInstance} Url实例
+     * @private
+     */
+    // @ts-ignore
+    __url = null;
+
+    /**
+     * @type {UrlInstance} Url实例
+     */
+    get _$url() {
+        if(this.__url === null) {
+            if(this.$url && this.$url.__ISCLASS__) {
+                this.__url = this.$url;
+            } else if(this.$ && this.$.url) {
+                this.__url = this.$.url;
+            } else {
+                this.__url = new (require('./url'))(this.ctx);
+            }
+        }
+        return this.__url;
+    }
+
+    set _$url(url) {
+        this.__url = url;
+    }
 }
 
 module.exports = Response;

package/lib/router.js

@@ -1,7 +1,6 @@
 const router = new (require('@koa/router'));
 const {app: cfg_app, routes: cfg_routes} = require('./config');
 const {toLine} = require('./utils/str');
-const run = require('./run');
 
 // 注册用户路由
 if (cfg_routes) {
@@ -26,7 +25,8 @@ if (cfg_routes) {
             ctx.APP = paths[2] || cfg_app.default_app;
             ctx.CONTROLLER = paths[1] || cfg_app.default_controller;
             ctx.ACTION = paths[0] || cfg_app.default_action;
-            await run(ctx, next, item.type);
+            ctx.FOLDER = item.type || cfg_app.controller_folder;
+            await next();
         });
     }
 }
@@ -36,10 +36,11 @@ router.all(cfg_app.app_multi ? '/:APP?/:CONTROLLER?/:ACTION?' : '/:CONTROLLER?/:
     ctx.APP = ctx.params.APP || cfg_app.default_app;
     ctx.CONTROLLER = ctx.params.CONTROLLER || cfg_app.default_controller;
     ctx.ACTION = ctx.params.ACTION || cfg_app.default_action;
+    ctx.FOLDER = cfg_app.controller_folder;
     delete ctx.params.APP;
     delete ctx.params.CONTROLLER;
     delete ctx.params.ACTION;
-    await run(ctx, next);
+    await next();
 });
 
 module.exports = router;