jj.js 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.12.0 / 2024-02-26
+1. 添加依赖`watch`
+
+# v0.11.0 / 2024-02-26
+1. 基于`AsyncLocalStorage`重构核心类
+2. 空控制器和空方法名改为`_empty`
+
 # v0.10.0 / 2024-02-26
 1. 类型文件位置调整及优化
 2. 自动生成应用端类型文件（开启app_debug，并且根目录下存在jsconfig.json文件）

package/README.md

@@ -6,15 +6,15 @@ A super simple lightweight NodeJS MVC framework（一个超级简单轻量的Nod
 
 ## 项目介绍
 
-本框架依赖koa2、@koa/router、art-template、mysql，基于proxy实现了代码自动加载及懒加载技术，最低运行依赖仅仅为koa和koa-router，非常轻量。
+无论什么语言什么框架的程序，类库的使用都离不开require、import、include等导入模块，不用时，还得删除。而本框架基于proxy实现了类库自动加载、懒加载和Class自动实例化及单例化技术，所有的类库，想用直接调用，系统会自动导入。
 
 ### 项目特性
 
-1. 系统架构模仿Thinkphp5，很容易上手
-2. 系统类库、用户类库都支持自动加载、懒加载、自动生成单实例
+1. 系统架构为经典的MVC模式，模仿Thinkphp5，很容易上手
+2. 系统类库、用户类库都支持自动加载、懒加载、Class自动生成单实例
 3. 支持应用级、路由级、控制器级三级中间件，方便插件及二次开发
 4. 支持单应用和多应用两种运行模式
-5. 基于jsdoc，提供完整的代码提示。支持自动生成应用端jsdoc文件
+5. 基于jsdoc，提供完整的代码提示，自动生成应用端types类型文件
 
 ### 项目地址
 
@@ -230,17 +230,6 @@ const app = {
 }
 module.exports = app;
 ```
-- 模板配置`./config/view.js`：
-```javascript
-const view = {
-    view_folder: 'view', // 模板目录名
-    view_depr: '/', // 模版文件名分割符，'/'代表二级目录
-    view_ext: '.htm', // 模版文件后缀
-    view_engine: 'art-template', // 默认模版引擎，字符串或引擎类，咱不支持更换
-    view_filter: {}, // 模版函数，配置注入模板的函数，默认会自动注入url函数
-}
-module.exports = view;
-```
 - 数据库配置`./config/db.js`：可以配置多个，方便程序里切换使用。
 ```javascript
 const db = {
@@ -257,67 +246,7 @@ const db = {
 }
 module.exports = db;
 ```
-- 日志配置`./config/log.js`：log_handle可以自定义日志handle
-```javascript
-const log = {
-    log_level: [], // [error, warning, info, debug, http, sql]
-    log_handle: function(msg, level) {console.log(`[${format('YY-mm-dd HH:ii:ss')}] [${level}] ${typeof msg == 'String' ? msg : JSON.stringify(msg)}`);} //function(msg, level) {}
-}
-module.exports = log;
-```
-- 缓存配置`./config/cache.js`：
-```javascript
-const cache = {
-    cache_time: 60 * 60 * 24, // 默认缓存时间（1天），为空或false则为10年
-    clear_time: undefined // (undefined: 一天清理一次, 0: 关闭自动清理, >0: 为自动清理周期)
-}
-module.exports = cache;
-```
-- 分页配置`./config/page.js`：
-```javascript
-const page = {
-    page_key    : 'page', // 默认分页标识
-    key_origin    : 'query', // query 或 params
-    page_size   : 10, // 默认分页大小
-    page_length : 5, // 默认分页长度，数字页码链接数量
-
-    //网址规则，可为空，可为路由名字，可用参数：页码${page}
-    //样例：':name'
-    //样例：'/list_${page}.html'
-    url_page    : '',
-    url_index   : '',
-
-    //模块样式 可用参数：网址${url}，页码${page}，总数${total_page}，总页数${total_page}
-    index_tpl   : '<li class="index"><a href="${url}">首页</a></li>',
-    end_tpl     : '<li class="end"><a href="${url}">末页</a></li>',
-    prev_tpl    : '<li class="prev"><a href="${url}">上一页</a></li>',
-    next_tpl    : '<li class="next"><a href="${url}">下一页</a></li>',
-    list_tpl    : '<li><a href="${url}">${page}</a></li>',
-    active_tpl  : '<li class="active"><a href="${url}">${page}</a></li>',
-    info_tpl    : '<span class="info">共${total_page}页，${total}条记录</span>',
-
-    //渲染模版
-    template   : '<div class="pagination"><ul class="page">${index}${prev}${list}${next}${end}</ul>${info}</div>'
-}
-module.exports = page;
-```
-- 跳转模板配置`./config/tpl.js`：模板可以配置为自定义的
-```javascript
-const tpl = {
-    jump: require('./tpl/jump'), // 跳转模板
-    exception: require('./tpl/exception') //  异常页面模板
-}
-module.exports = tpl;
-```
-- 自定义配置`./config/self.js`：自定义配置同样可以直接通过`this.$config.self`使用。
-```javascript
-const self = {
-    option1: ''
-    option2: ''
-    ...
-}
-module.exports = self;
-```
+
 - 路由配置`./config/routes.js`：
 路由功能基于`@koa/router`开发，关于url匹配规则可以参考官方文档：[文档地址](https://www.npmjs.com/package/@koa/router)
 
@@ -338,26 +267,22 @@ module.exports = routes;
 ```
 > 注意：本路由配置示例前两条规则为常规用法，后面的非常规用法，不建议使用。如果是单应用模式，可以去掉path参数里的app。
 
-### 应用入口文件
-
-应用入口文件放在项目的根目录，名字可以任意改。
-
-示例文件 `./server.js`
+- 自定义配置`./config/self.js`：自定义配置同样可以直接通过`this.$config.self`使用。
 ```javascript
-const {app, Logger} = require('jj.js');
-
-app.run(3000, '127.0.0.1', function(err){
-    !err && Logger.info('http server is ready on 3000');
-});
+const self = {
+    option1: ''
+    option2: ''
+    ...
+}
+module.exports = self;
 ```
-其中`app`是一个koa实例，可以使用`use`方法添加应用级中间件，使用方法参考koa文档。`app`的`run`方法经过了封装，仅允许调用一次。其中`Logger`因为是一个静态类，所以可以直接调用`info`方法输出日志。
+- 其他配置项，请参考系统配置文件`jj.js/lib/config.js`
+
+### 编码命名规范
 
-## 总结
+类名使用大驼峰，方法名使用小驼峰，私有方法使用下划线前缀。
+控制器文件名使用小写下划线。
 
-通过以上文档，可以看到：
-1. jj.js是一个轻量的mvc框架，几乎所有文件不使用就不会调用。
-2. 同时也是个功能强大的框架，支持应用级、路由级、控制器级三级中间件。
-3. 类库自动加载，只要是继承自`Context`的类库，都可以在方法内使用包含`$`前缀的属性自动加载其他资源。
 
 ## 应用案例
 

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}
+ * {App, Cache, Context, Controller, Cookie, Ctx, Db, Logger, Middleware, Model, Pagination, Response, Upload, Url, View, utils, config}
  * @module core
  * @type {import('./types').Core}
  */

package/lib/app.js

@@ -4,6 +4,7 @@ const {app: cfg_app} = require('./config');
 const Logger = require('./logger');
 const Response = require('./response');
 const router = require('./router');
+const storage = require('./storage');
 const pjson = require('../package.json');
 
 /**
@@ -16,6 +17,13 @@ class App extends Koa
      * @param {...any} args - listen(port, ip, callback(err){})
      */
     listen(...args) {
+        // storage
+        this.use(async (ctx, next) => {
+            await storage.run({}, async() => {
+                await next();
+            });
+        });
+
         // exception
         this.use(async (ctx, next) => {
             ctx.APP_TIME = Date.now();

package/lib/ctx.js

@@ -1,5 +1,5 @@
 // @ts-nocheck
-const loader = require('./loader');
+const storage = require('./storage');
 
 /**
  * 开发jj.js库本身时，可以设置为import('../types')
@@ -8,46 +8,48 @@ const loader = require('./loader');
 const Ctx = new Proxy(class {}, {
         construct() {
             return new Proxy({__proto__: arguments[2].prototype}, {
-                get: (target, prop, receiver) => {
-                    if(prop in target || typeof prop == 'symbol' || prop == 'inspect') {
-                        return Reflect.get(target, prop, receiver);
+                get: (target, $prop, receiver) => {
+                    if($prop in target || typeof $prop == 'symbol' || $prop == 'inspect') {
+                        return Reflect.get(target, $prop, receiver);
                     }
-                    if(prop == '$' || prop == '_') {
-                        return target.ctx && target.ctx[prop]
-                            || prop == '$' && (target.$ || (target.$ = loader('../'))) && target.$
-                            || undefined;
+
+                    const store = storage.getStore();
+                    const $ = store.$;
+                    const _ = store._;
+                    if($prop == '$' || $prop == '_') {
+                        return store[$prop];
                     }
-                    if(prop.slice(0, 1) != '$') {
+                    if($prop.slice(0, 1) != '$') {
                         return undefined;
                     }
-                    const pp = prop.slice(1);
-                    const ctx = target.ctx;
-                    if(ctx && ctx._) {
-                        const _ = ctx._;
-                        const APP = ctx.APP;
-                        const COMMON = _.config.app.common_app;
-                        if(_[APP][prop] === undefined) {
-                            if(_[APP][pp] && _[COMMON] && _[COMMON][pp]) {
-                                _[APP][prop] = new Proxy({}, {
-                                    get: (...args) => {
-                                        return _[APP][pp][args[1]] || _[COMMON][pp][args[1]];
-                                    }
-                                });
-                            } else if(_[APP][pp]) {
-                                _[APP][prop] = _[APP][pp];
-                            } else if(_[COMMON] && _[COMMON][pp]) {
-                                _[APP][prop] = _[COMMON][pp];
-                            } else {
-                                _[APP][prop] = null;
-                            }
-                            if(~['view', 'response'].indexOf(pp) && _[APP][prop] && _[APP][prop].__node && !_[APP][prop].__node.isClass && ctx.$ && ctx.$[pp]) {
-                                _[APP][prop] = ctx.$[pp];
-                            }
+
+                    const prop = $prop.slice(1);
+                    const APP = store.APP;
+                    const COMMON = store.COMMON;
+
+                    // 缓存
+                    if(_[APP][$prop] === undefined) {
+                        if(_[APP][prop] && _[COMMON] && _[COMMON][prop]) {
+                            _[APP][$prop] = new Proxy({}, {
+                                get: (...args) => {
+                                    return _[APP][prop][args[1]] || _[COMMON][prop][args[1]];
+                                }
+                            });
+                        } else if(_[APP][prop]) {
+                            _[APP][$prop] = _[APP][prop];
+                        } else if(_[COMMON] && _[COMMON][prop]) {
+                            _[APP][$prop] = _[COMMON][prop];
+                        } else {
+                            _[APP][$prop] = null;
+                        }
+                        // lib调用，防止覆盖
+                        if(['logger', 'pagination', 'response', 'url', 'view'].includes(prop) && _[APP][$prop] && _[APP][$prop].__node && !_[APP][$prop].__node.isClass && $[prop]) {
+                            _[APP][$prop] = $[prop];
                         }
-                        return _[APP][prop] || _[pp] || (ctx.$ && ctx.$[pp]) || undefined;
-                    } else {
-                        return (target.$ || (target.$ = loader('../'))) && target.$[pp];
                     }
+
+                    // 屏蔽部分lib
+                    return _[APP][$prop] || _[prop] || (!['app', 'loader', 'router', 'run', 'storage', 'types'].includes(prop) && $[prop]) || undefined;
                 }
             });
         }

package/lib/db.js

@@ -699,9 +699,7 @@ class Db extends Context
     async pagination({page, page_size, pagination} = {}) {
         !page && (page = this._options.page.page);
         !page_size && (page_size = this._options.page.pageSize);
-        if(!pagination) {
-            pagination = this.$pagination.__node && this.$pagination.__node.isClass ? this.$pagination : this.$.pagination;
-        }
+        !pagination && (pagination = this.$pagination);
 
         const options = {...this._options}; // 暂存options
         const total = await this.count();

package/lib/run.js

@@ -2,38 +2,42 @@ const path = require('path');
 const loader = require('./loader');
 const {readFile} = require('fs').promises;
 const {toHump} = require('./utils/str');
-const {app: cfg_app, view: cfg_view, db, page, log, cache, cookie, tpl} = require('./config');
+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) {
     if(cfg_app.app_debug) {
         Logger.http('Request:', ctx.request);
-        Logger.http(`Router(${control_type}): {APP: '${ctx.APP}', CONTROLLER: '${ctx.CONTROLLER}', ACTION: '${ctx.ACTION}'}`);
+        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);
         Object.keys(ctx.request.body || {}).length && Logger.http('Post:', ctx.request.body);
     }
     
+    // 设置store
+    const store = storage.getStore();
+    store.APP = ctx.APP;
+    store.CONTROLLER = ctx.CONTROLLER;
+    store.ACTION = ctx.ACTION;
+    store.COMMON = cfg_app.common_app;
     // 设置根加载器
-    ctx.$ = loader('./', ctx);
-    ctx._ = loader(cfg_app.base_dir, ctx);
-    ctx._.config === undefined && (ctx._.config = {});
-    ctx._.config.app = cfg_app;
-    ctx._.config.view = cfg_view;
-    ctx._.config.db = db;
-    ctx._.config.page = page;
-    ctx._.config.log = log;
-    ctx._.config.cache = cache;
-    ctx._.config.cookie = cookie;
-    ctx._.config.tpl = tpl;
+    store.$ = loader('./', ctx);
+    store._ = loader(cfg_app.base_dir, ctx);
+    // 配置特殊处理
+    store._.config === undefined && (store._.config = {});
+    Object.entries(config).forEach(([key, value]) => {
+        store._.config[key] = value;
+    });
 
     // 应用、控制器、方法名字验证
     if(~ctx.APP.indexOf('.') || ~ctx.CONTROLLER.indexOf('.') || ~ctx.ACTION.indexOf('.')) {
         throw new Error(`RunError: 应用、控制器或方法名字不合法！`);
     }
 
-    if(ctx.APP[0] == '_' || ctx.APP[0] == '$' || !ctx._[ctx.APP]) {
+    if(ctx.APP[0] == '_' || ctx.APP[0] == '$' || !store._[ctx.APP]) {
         if(cfg_app.app_debug) {
             throw new Error(`RunError: 应用:${ctx.APP}不存在！`);
         } else {
@@ -41,7 +45,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
         }
     }
 
-    if(!ctx._[ctx.APP][control_type]) {
+    if(!store._[ctx.APP][control_type]) {
         if(cfg_app.app_debug) {
             throw new Error(`RunError: 目录:${ctx.APP}/${control_type}不存在！`);
         } else {
@@ -51,7 +55,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
 
     // 模版文件内容直接输出
     if(control_type == cfg_view.view_folder) {
-        const content = await readFile(path.join(ctx._[ctx.APP][control_type].__node.path, ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext));
+        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(!content) {
             throw new Error(`RunError: 模板文件:${ctx.APP}/${control_type}/${ctx.CONTROLLER + cfg_view.view_depr + ctx.ACTION + cfg_view.view_ext}不存在！`);
         }
@@ -60,7 +64,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
     }
 
     // 控制器
-    const Controller = ctx._[ctx.APP][control_type][ctx.CONTROLLER] || ctx._[ctx.APP][control_type]['empty'];
+    const Controller = store._[ctx.APP][control_type][ctx.CONTROLLER] || store._[ctx.APP][control_type]['_empty'];
 
     if(ctx.CONTROLLER[0] == '_' || ctx.CONTROLLER[0] == '$' || typeof Controller != 'function') {
         if(cfg_app.app_debug) {
@@ -73,7 +77,7 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
     // 控制器实例
     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' ? humpAction : '_empty';
 
     if(ctx.ACTION[0] == '_' || ctx.ACTION[0] == '$' || typeof $controller[action] != 'function') {
         if(cfg_app.app_debug) {
@@ -96,13 +100,13 @@ async function run(ctx, next, control_type=cfg_app.controller_folder) {
                 }
                 return stack.concat(async (ctx, next) => {
                     const [METHOD = action, MIDDLEWARE = ctx.CONTROLLER, APP = ctx.APP] = middle.middleware.split('/').reverse();
-                    if(!ctx._[APP]) {
+                    if(!store._[APP]) {
                         throw new Error(`RunError: 中间件应用:${APP}不存在！`);
                     }
-                    if(!ctx._[APP]['middleware']) {
+                    if(!store._[APP]['middleware']) {
                         throw new Error(`RunError: 中间件目录:${APP}/middleware不存在！`);
                     }
-                    const Middleware = ctx._[APP]['middleware'][MIDDLEWARE];
+                    const Middleware = store._[APP]['middleware'][MIDDLEWARE];
                     if(!Middleware || typeof Middleware != 'function') {
                         throw new Error(`RunError: 中间件文件:${APP}/middleware/${MIDDLEWARE}不存在！`);
                     }

package/lib/storage.js

@@ -0,0 +1,5 @@
+const {AsyncLocalStorage} = require('async_hooks');
+
+const storage = new AsyncLocalStorage();
+
+module.exports = storage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jj.js",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "A super simple lightweight NodeJS MVC framework（一个超级简单轻量的NodeJS MVC框架）",
   "main": "jj.js",
   "scripts": {},
@@ -27,9 +27,7 @@
     "koa": "^2.15.0",
     "koa-body": "^5.0.0",
     "koa-static": "^5.0.0",
-    "mysql": "^2.18.1"
-  },
-  "devDependencies": {
+    "mysql": "^2.18.1",
     "watch": "^1.0.2"
   },
   "engines": {

package/types.js

@@ -11,13 +11,13 @@
  * @typedef {typeof import('./lib/model')} Model
  * @typedef {typeof import('./lib/pagination')} Pagination
  * @typedef {typeof import('./lib/response')} Response
+ * @typedef {typeof import('./lib/storage')} Storage
  * @typedef {typeof import('./lib/upload')} Upload
  * @typedef {typeof import('./lib/url')} Url
  * @typedef {typeof import('./lib/view')} View
  */
 
 /**
- * @typedef {typeof import('./lib/app').prototype} AppInstance
  * @typedef {typeof import('./lib/context').prototype} ContextInstance
  * @typedef {typeof import('./lib/controller').prototype} ControllerInstance
  * @typedef {typeof import('./lib/cookie').prototype} CookieInstance
@@ -50,12 +50,14 @@
  * @property {Url} Url
  * @property {View} View
  * @property {Utils} utils
+ * @property {Config} config
+ * @property {Storage} storage
  */
 
 /**
  * @typedef {Object} $
- * @property {(App & AppInstance)} app
  * @property {Cache} cache
+ * @property {Config} config
  * @property {ContextInstance} context
  * @property {ControllerInstance} controller
  * @property {CookieInstance} cookie