jj.js 0.12.0 → 0.14.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.14.0 / 2024-03-07
+1. 优化类型文件生成
+2. 修复优化url生成
+3. 自动加载功能，不缓存空文件
+4. 修复优化Resquest类请求方法判断
+5. 默认开启cookie签名机制
+
+# v0.13.0 / 2024-02-27
+1. 新增request系统类库
+2. response类isAjax方法迁移到request类
+3. 优化应用端types类型文件生成逻辑，启动服务时生成一次
+
 # v0.12.0 / 2024-02-26
 1. 添加依赖`watch`
 

package/jj.js

@@ -1,6 +1,6 @@
 /**
  * jj.js核心库<br/>
- * {App, Cache, Context, Controller, Cookie, Ctx, Db, Logger, Middleware, Model, Pagination, Response, Upload, Url, View, utils, config}
+ * {App, Cache, Context, Controller, Cookie, Ctx, Db, Logger, Middleware, Model, Pagination, Request, Response, Upload, Url, View, utils, config}
  * @module core
  * @type {import('./types').Core}
  */

package/jsconfig.json

@@ -5,5 +5,5 @@
         "resolveJsonModule": true,
         "checkJs": true
     },
-    "exclude": ["node_modules", "docs", "./lib/ctx.js"]
-  }
+    "exclude": ["node_modules", "docs"]
+}

package/lib/app.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const Koa = require('koa');
-const {app: cfg_app} = require('./config');
+const {app: cfg_app, cookie: cfg_cookie} = require('./config');
 const Logger = require('./logger');
 const Response = require('./response');
 const router = require('./router');
@@ -54,6 +54,9 @@ class App extends Koa
         // router
         this.use(router.routes()).use(router.allowedMethods());
 
+        // cookie
+        cfg_cookie.keys && (this.keys = cfg_app.app_debug ? ['jj.js'] : cfg_cookie.keys);
+
         // types
         if(cfg_app.app_debug) {
             const {isFileSync} = require('./utils/fs');

package/lib/config.js

@@ -49,6 +49,11 @@ const cache = {
     clear_time: undefined // (undefined: 清理一次, 0: 关闭自动清理, >0: 为自动清理周期)
 }
 
+const cookie = {
+    keys: [Math.random().toString(36).slice(-8)], // cookie密钥
+    signed: true // 默认开启签名
+}
+
 const page = {
     page_key    : 'page', // 默认分页标识
     key_origin    : 'query', // query 或 params
@@ -94,6 +99,6 @@ module.exports = {
     cache: {...cache, ...base_config.cache},
     page: {...page, ...base_config.page},
     routes: base_config.routes,
-    cookie: base_config.cookie,
+    cookie: {...cookie, ...base_config.cookie},
     tpl: {...tpl, ...base_config.tpl}
 };

package/lib/cookie.js

@@ -30,20 +30,21 @@ class Cookie extends Context
         if(key === undefined) {
             return this.all();
         }
-        return this.ctx.cookies.get(key, options);
+        return this.ctx.cookies.get(key, {signed: cfg_cookie.signed, ...options});
     }
 
     /**
      * 删除或清理cookie
      * @public
      * @param {*} [key] - 为空则清理所有cookie
+     * @param {import('cookies').GetOption} [options]
      * @returns {this}
      */
-    delete(key) {
+    delete(key, options) {
         if(key === undefined) {
             this.clear();
         } else {
-            this.ctx.cookies.set(key, '', {maxAge: 0});
+            this.ctx.cookies.set(key, '', {...cfg_cookie, ...options, maxAge: 0});
         }
         return this;
     }

package/lib/ctx.js

@@ -42,8 +42,8 @@ const Ctx = new Proxy(class {}, {
                         } else {
                             _[APP][$prop] = null;
                         }
-                        // lib调用，防止覆盖
-                        if(['logger', 'pagination', 'response', 'url', 'view'].includes(prop) && _[APP][$prop] && _[APP][$prop].__node && !_[APP][$prop].__node.isClass && $[prop]) {
+                        // lib内有调用，防止覆盖
+                        if(['logger', 'pagination', 'request', 'response', 'url', 'view'].includes(prop) && _[APP][$prop] && _[APP][$prop].__node && !_[APP][$prop].__node.isClass && $[prop]) {
                             _[APP][$prop] = $[prop];
                         }
                     }

package/lib/loader.js

@@ -43,8 +43,8 @@ function loader(dir='./', ...args) {
                         nodeType[_nodePath] = 'file';
                     } else if(isDirSync(_nodePath)) {
                         nodeType[_nodePath] = 'dir';
-                    } else{
-                        nodeType[_nodePath] = 'none';
+                    } else {
+                        // nodeType[_nodePath] = 'none';
                     }
                 }
                 if(nodeType[_nodePath] == 'file') {

package/lib/request.js

@@ -0,0 +1,204 @@
+const Context = require('./context');
+
+class Request extends Context
+{
+    /**
+     * Initialize a new `Request`
+     * @public
+     * @param {import('../types').KoaCtx} ctx
+     */
+    constructor(ctx) {
+        super(ctx);
+        /**
+         * @type {import('querystring').ParsedUrlQuery}
+         * @private
+         */
+        this._get = {...this.ctx.query};
+        /**
+         * @private
+         */
+        this._post = {...this.ctx.request.body};
+        /**
+         * @private
+         */
+        this._param = {...this.ctx.params};
+    }
+
+    /**
+     * 智能获取请求数据
+     * @param {string} key
+     * @param {*} [default_value='']
+     * @returns {*}
+     */
+    query(key, default_value='') {
+        return this.post(key) || this.get(key) || this.param(key) || default_value;
+    }
+
+    /**
+     * 获取param请求数据
+     * @param {string} key
+     * @param {*} default_value
+     * @returns {*}
+     */
+    param(key, default_value='') {
+        return this._param[key] || default_value;
+    }
+
+    /**
+     * 获取get请求数据
+     * @param {string} key
+     * @param {*} default_value
+     * @returns {*}
+     */
+    get(key, default_value='') {
+        return Array.isArray(this._get[key]) ? this._get[key][0] : this._get[key] || default_value;
+    }
+
+    /**
+     * 获取post请求数据
+     * @param {string} key
+     * @param {*} default_value
+     * @returns {*}
+     */
+    post(key, default_value='') {
+        return this._post[key] || default_value;
+    }
+
+
+    /**
+     * 获取所有请求数据
+     * @returns {Object}
+     */
+    queryAll() {
+        return {...this._param, ...this._get, ...this._post};
+    }
+
+    /**
+     * 获取所有param数据
+     * @returns {Object}
+     */
+    paramAll() {
+        return this._param;
+    }
+
+    /**
+     * 获取所有get数据
+     * @returns {Object}
+     */
+    getAll() {
+        return this._get;
+    }
+
+    /**
+     * 获取所有post数据
+     * @returns {Object}
+     */
+    postAll() {
+        return this._post;
+    }
+
+    /**
+     * 获取上传file数据
+     * @param {string} key
+     * @returns {import('formidable').File | import('formidable').File[]}
+     */
+    file(key) {
+        return this.ctx.request.files[key];
+    }
+
+    /**
+     * 获取上传file数据
+     * @returns {import('formidable').Files}
+     */
+    fileAll() {
+        return this.ctx.request.files;
+    }
+
+    /**
+     * 获取请求应用名
+     * @returns {string}
+     */
+    app() {
+        return this.ctx.APP;
+    }
+
+    /**
+     * 获取请求控制器名
+     * @returns {string}
+     */
+    controller() {
+        return this.ctx.CONTROLLER;
+    }
+
+    /**
+     * 获取请求方法名
+     * @returns {string}
+     */
+    action() {
+        return this.ctx.ACTION;
+    }
+
+    /**
+     * 获取请求url
+     * @returns {string}
+     */
+    url() {
+        return this.ctx.url;
+    }
+
+    /**
+     * 获取请求方式
+     * @returns {string}
+     */
+    method() {
+        return this.ctx.method.toLowerCase();
+    }
+
+    /**
+     * 判断是否get请求
+     * @returns {boolean}
+     */
+    isGet() {
+        return this.method() == 'get';
+    }
+
+    /**
+     * 判断是否post请求
+     * @returns {boolean}
+     */
+    isPost() {
+        return this.method() == 'post';
+    }
+
+    /**
+     * 判断是否ajax请求
+     * @public
+     * @returns {boolean}
+     */
+    isAjax() {
+        return this.ctx.headers['x-requested-with'] && String(this.ctx.headers['x-requested-with']).toLowerCase() == 'xmlhttprequest'
+            || this.ctx.request.type.toLowerCase() == 'application/json'
+            || this.query('is_ajax')
+            ? true : false;
+    }
+
+    /**
+     * 获取header请求数据
+     * @param {string} key
+     * @param {*} default_value
+     * @returns {*}
+     */
+    header(key, default_value='') {
+        return this.ctx.headers[key] || default_value;
+    }
+
+    /**
+     * 获取所有header请求数据
+     * @returns {Object}
+     */
+    headerAll() {
+        return this.ctx.headers;
+    }
+}
+
+module.exports = Request;

package/lib/response.js

@@ -72,7 +72,7 @@ class Response extends Context
      */
     jump(msg, url, state=1) {
         const tplData = {state, msg, url, wait: this._wait};
-        this.ctx.body = this.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) => {
             return tplData[args[1]];
         });
     }
@@ -99,23 +99,10 @@ class Response extends Context
         tplData.msg = escapeHtml(tplData.msg);
         tplData.code = '<span class="line">' + tplData.code.map(str => escapeHtml(str)).join('</span><span class="line">') + '</span>';
         tplData.stack = tplData.stack.map(str => escapeHtml(str)).join('<br>');
-        this.ctx.body = this.isAjax() ? {state: 0, msg: tplData.msg} : this._tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
+        this.ctx.body = this.$request.isAjax() ? {state: 0, msg: tplData.msg} : this._tpl_exception.replace(/\{\$(\w+)\}/g, (...args) => {
             return tplData[args[1]];
         });
     }
-
-    /**
-     * 判断是否ajax请求
-     * @public
-     * @returns {boolean}
-     */
-    isAjax() {
-        return this.ctx.headers['x-requested-with'] && String(this.ctx.headers['x-requested-with']).toLowerCase() == 'xmlhttprequest'
-            || this.ctx.request.type.toLowerCase() == 'application/json'
-            || this.ctx.query.is_ajax
-            || this.ctx.request.body && this.ctx.request.body.is_ajax
-            ? true : false;
-    }
 }
 
 module.exports = Response;

package/lib/run.js

@@ -10,7 +10,6 @@ const storage = require('./storage');
 
 async function run(ctx, next, control_type=cfg_app.controller_folder) {
     if(cfg_app.app_debug) {
-        Logger.http('Request:', ctx.request);
         Logger.http({Router: control_type, 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);

package/lib/types.js

@@ -21,6 +21,7 @@ function start() {
             Object.keys(f).forEach(file => {
                 Logger.system("wacth:", file);
             });
+            createFile();
         } else if(prev === null) {
             // f is a new file
             if(prevFile.file != f || prevFile.action != "created") {
@@ -55,18 +56,23 @@ function start() {
  * createTypesFile
  */
 async function createFile(f) {
-    if(this._f == f) {
-        return;
-    }
-    if(this._f) {
-        delete require.cache[require.resolve(this._f)];
-    }
-    this._f = f;
-
-    const f_info = f.replace(cfg_app.base_dir + path.sep, '').split(path.sep);
-    if(f_info[0] && f_info[0] != cfg_app.common_app && !~f_info[0].indexOf('.')) {
-        this._APP = f_info[0];
+    if(f) {
+        require.cache[f] && delete(require.cache[f])
+        if(f == this._f) {
+            return;
+        }
+        
+        this._f && require.cache[this._f] && delete(require.cache[this._f]);
+        this._f = f;
+    
+        const f_info = f.replace(cfg_app.base_dir + path.sep, '').split(path.sep);
+        if(cfg_app.app_multi && f_info[0] && f_info[1] && f_info[0] != cfg_app.common_app && f_info[0] != 'config' && !~f_info[0].indexOf('.')) {
+            this._APP = f_info[0];
+        }
+    } else {
+        this._APP = cfg_app.default_app;
     }
+    
 
     const ignore = ['node_modules', 'docker', 'package-lock.json', 'types.js', '.git', '.gitignore'];
     ignore.push(path.basename(module.parent.parent.parent.filename));

package/lib/url.js

@@ -18,19 +18,28 @@ class Url extends Context
      * 编译生成url
      * @public
      * @param {string} [url] - 网址，支持智能解析
-     * @param {object} [vars] - 网址参数
-     * @param {string} [ext] - 网址后缀
-     * @param {string} [domain] - 网址域名
+     * @param {object|string|boolean} [vars] - 网址参数
+     * @param {string|boolean} [ext] - 网址后缀
+     * @param {string|boolean} [domain] - 网址域名
      * @returns {string}
+     * @example - build(url, vars, ext, domain|true)
+     * @example - build(url, ext, domain|true)
+     * @example - build(url, domain|true)
      */
-    build(url='', vars, ext='', domain='') {
-        if(vars && typeof vars != 'object') {
+    build(url='', vars={}, ext='', domain='') {
+        if(typeof vars != 'object') {
             [vars, ext, domain] = [{}, vars, ext];
         }
+        if(ext === true || ext.slice(0, 4) == 'http') {
+            [ext, domain] = ['', ext];
+        }
+        if(domain === true) {
+            domain = this.ctx.protocol + '://' + this.ctx.host;
+        }
         const query = {...vars};
         let urls;
         if(url.slice(0, 1) == ':') {
-            url = this.ruleUrl(url.substr(1), query);
+            url = this.ruleUrl(url.slice(0, 1), query);
         } else if(url.slice(0, 1) != '/' && url.slice(0, 4) != 'http') {
             urls = url.split('/').reverse().map(u => toLine(u));
             if(urls.length < 3) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jj.js",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "A super simple lightweight NodeJS MVC framework（一个超级简单轻量的NodeJS MVC框架）",
   "main": "jj.js",
   "scripts": {},

package/types.js

@@ -10,6 +10,7 @@
  * @typedef {typeof import('./lib/middleware')} Middleware
  * @typedef {typeof import('./lib/model')} Model
  * @typedef {typeof import('./lib/pagination')} Pagination
+ * @typedef {typeof import('./lib/request')} Request
  * @typedef {typeof import('./lib/response')} Response
  * @typedef {typeof import('./lib/storage')} Storage
  * @typedef {typeof import('./lib/upload')} Upload
@@ -26,6 +27,7 @@
  * @typedef {typeof import('./lib/middleware').prototype} MiddlewareInstance
  * @typedef {typeof import('./lib/model').prototype} ModelInstance
  * @typedef {typeof import('./lib/pagination').prototype} PaginationInstance
+ * @typedef {typeof import('./lib/request').prototype} RequestInstance
  * @typedef {typeof import('./lib/response').prototype} ResponseInstance
  * @typedef {typeof import('./lib/upload').prototype} UploadInstance
  * @typedef {typeof import('./lib/url').prototype} UrlInstance
@@ -45,6 +47,7 @@
  * @property {Middleware} Middleware
  * @property {Model} Model
  * @property {Pagination} Pagination
+ * @property {Request} Request
  * @property {Response} Response
  * @property {Upload} Upload
  * @property {Url} Url
@@ -67,6 +70,7 @@
  * @property {MiddlewareInstance} middleware
  * @property {ModelInstance} model
  * @property {PaginationInstance} pagination
+ * @property {RequestInstance} request
  * @property {ResponseInstance} response
  * @property {UploadInstance} upload
  * @property {UrlInstance} url
@@ -86,7 +90,7 @@
  * @property {string} [common_app=common] - 公共应用，存放公共模型及逻辑
  * @property {string} [controller_folder=controller] - 控制器目录名
  * @property {string} [static_dir=''] - 静态文件目录，相对于应用根目录，为空时，关闭静态访问
- * @property {?object} [koa_body=null] - koa-body配置参数，为null或空时，关闭koa-body
+ * @property {import('koa-body').IKoaBodyOptions} [koa_body=null] - koa-body配置参数，为null或空时，关闭koa-body
  * @property {string} [base_dir] - 应用根目录（会自动计算）
  */
 
@@ -96,7 +100,7 @@
  * @property {string} [view_depr='/'] - 模版文件名分割符，'/'代表二级目录
  * @property {string} [view_ext='.htm'] - 模版文件后缀
  * @property {string} [view_engine=art-template] - 默认模版引擎，字符串或引擎类
- * @property {object} [view_filte={}] - 模版函数
+ * @property {Object} [view_filte={}] - 模版函数
  */
 
 /**
@@ -112,7 +116,7 @@
  */
 
 /**
- * @typedef {object} DbConfig - 数据库配置
+ * @typedef {Object.<string, Object>} DbConfig - 数据库配置
  * @property {DbConfigItem} default - 数据库参数
  */
 
@@ -123,7 +127,7 @@
  */
 
 /**
- * @typedef {object} LogConfig - 日志配置
+ * @typedef {Object} LogConfig - 日志配置
  * @property {array} [log_level] - 允许输出的日志级别
  * @property {LogHandle} [log_handle] - 日志驱动
  */
@@ -167,6 +171,7 @@
 
 /**
  * @typedef {import('cookies').SetOption} CookieConfig - Cookie配置，一般不用设置
+ * @typedef {typeof import('koa').prototype.keys} Keygrip
  */
 
 /**
@@ -184,7 +189,7 @@
  * @property {CacheConfig} [cache]
  * @property {PageConfig} [page]
  * @property {RouteConfig} [routes]
- * @property {CookieConfig} [cookie]
+ * @property {CookieConfig & {keys?: String[] | Keygrip | undefined}} [cookie]
  * @property {TplConfig} [tpl]
  */
 
@@ -283,6 +288,9 @@ class Ctx {
     /** @type {(Pagination & PaginationInstance)} */
     $pagination;
 
+    /** @type {(Request & RequestInstance)} */
+    $request;
+
     /** @type {(Response & ResponseInstance)} */
     $response;