chanjs 1.0.21 → 1.0.23

package/README.md

@@ -76,7 +76,7 @@ Chan.js 基于express 纯js研发的轻量级mvc框架。基于函数式编程
 * 多模块mvc
 * 插件mvc
 * 支持cors跨域配置
-* mysql数据库支持
+* mysql数据库支持 
 * 路由控制
 * art-template模板
 * 静态资源

package/core/chan.js

@@ -1,26 +1,34 @@
 const express = require("express");
 const config = require("./lib/config/config.js");
 const bindClass = require("./lib/extend/bindClass.js");
+const Controller = require("./lib/controller/controller.js")
+const Service = require("./lib/service/service.js")
 const path = require("path");
 const fs = require("fs");
-const core = require("./lib/core.js");
-const cors = require('cors')
+const core = require("./lib/index.js");
+const cors = require('cors');
+
 /**
  * @description 基于express封装的mvc框架，遵循约定优于配置原则
  */
 class Chan {
+  static config = {};
+  //模块
+  static modules = {};
+   //插件
+  static plugins = {};
+     //工具
+  static helper = {};
+  static Controller = null;
+  static Service = null;
   constructor(options={}) {
     //配置
     Chan.config = {...config,...options};
-    //模块
-    Chan.modules ={};
-    //插件
-    Chan.plugins ={};
-    //工具
-    Chan.helper ={};
+    //控制器基类
+    Chan.Controller = Controller;
     //应用实例
     this.app = express();
-    this.app.config = Chan.config;
+    // this.app.config = Chan.config;
     this.router = express.Router();
     //加载配置
     this.loadConfig();
@@ -30,6 +38,7 @@ class Chan {
     this.loadCore();
     //加载实例化数据库
     this.loadKnex();
+
     //生命周期钩子：开始启动 
     this.beforeStart();
     //解决跨域
@@ -46,17 +55,18 @@ class Chan {
 
   // 加载配置
   loadConfig() {
-    const configPath = path.join(config.APP_PATH, "config/index.js");
+    const configPath = path.join(Chan.config.APP_PATH, "config/index.js");
     if (fs.existsSync(configPath)) {
       const config = require(configPath);
-      let allConfig = {...Chan.config,...config};
-      this.app.config = Chan.config = allConfig;
+      // let allConfig = {...Chan.config,...config};
+      // this.app.config = Chan.config = allConfig;
+      Chan.config = {...Chan.config,...config};
     }
   }
 
    // 加载扩展
    loadExtends() {
-    const extendPath = path.join(config.APP_PATH, "extend");
+    const extendPath = path.join(Chan.config.APP_PATH, "extend");
     if (fs.existsSync(extendPath)) {
       let controllers = fs
         .readdirSync(extendPath)
@@ -74,7 +84,16 @@ class Chan {
   //数据库操作
   loadKnex(){
     // 连接数据库
-    const {host,port,user,password,database,client='mysql2',charset} = Chan.config.database;
+    const {
+      host='localhost',
+      port='3306',
+      user,
+      password,
+      database,
+      client='mysql2',
+      charset='utf8mb4'
+    } = Chan.config.database;
+
     const knex = require("knex")({
       client: client,
       connection: {
@@ -85,7 +104,7 @@ class Chan {
         database,
         charset,
       },
-      debug: config.debug, //指明是否开启debug模式，默认为true表示开启
+      debug: Chan.config.debug, //指明是否开启debug模式，默认为true表示开启
       pool: {
         //指明数据库连接池的大小，默认为{min: 2, max: 10}
         min: 0,
@@ -100,7 +119,11 @@ class Chan {
         },
       },
     });
+
+    //数据库操作实例
     Chan.knex = knex;
+    //数据库操作基类
+    Chan.Service = Service(knex);
   }
 
   //开始启动
@@ -129,14 +152,15 @@ class Chan {
    * @description app核心模块：日志、favicon 图标、cookie、json、url、模板引擎、静态资源
    */
   loadCore(){
-    core(this.app);
+    console.log()
+    core(this.app, Chan.config);
   }
 
  /**
   * @description 模块加载入口（路由&控制器& 服务）
   */
   loadModules(modules='modules') {
-    const configPath = path.join(config.APP_PATH,modules);
+    const configPath = path.join(Chan.config.APP_PATH,modules);
     if (fs.existsSync(configPath)) {
       const dirs = fs
         .readdirSync(configPath, { withFileTypes: true })
@@ -174,7 +198,7 @@ class Chan {
    * @param {*} moduleName 模块名称
    */
   loadServices(modules,moduleName) {
-    const servicesDir = path.join(config.APP_PATH, modules, moduleName,"service");
+    const servicesDir = path.join(Chan.config.APP_PATH, modules, moduleName,"service");
     if (fs.existsSync(servicesDir)) {
       let services = fs
         .readdirSync(servicesDir)
@@ -197,7 +221,7 @@ class Chan {
    * @param {*} moduleName 模块名称
    */
   loadControllers(modules,moduleName) {
-    const controllersDir = path.join(config.APP_PATH, modules, moduleName,"controller");
+    const controllersDir = path.join(Chan.config.APP_PATH, modules, moduleName,"controller");
     if (fs.existsSync(controllersDir)) {
       let controllers = fs
         .readdirSync(controllersDir)
@@ -218,7 +242,7 @@ class Chan {
    * @param {*} moduleName 模块名称
    */
   loadRoutes(modules,moduleName) {
-    const routersDir = path.join(config.APP_PATH, modules, moduleName,"router.js");
+    const routersDir = path.join(Chan.config.APP_PATH, modules, moduleName,"router.js");
     if (fs.existsSync(routersDir)) {
       const routes = require(routersDir);
       routes({router:this.router,modules:Chan[modules],app:this.app});
@@ -228,10 +252,10 @@ class Chan {
    //通用路由，加载错误处理和500路由和爬虫处理
   loadCommonRouter(){
     try {
-      const baseRouterPath = path.join(config.APP_PATH, "router.js");
+      const baseRouterPath = path.join(Chan.config.APP_PATH, "router.js");
       if (fs.existsSync(baseRouterPath)) {
         const _router = require(baseRouterPath);
-        _router(this.app, this.router);
+        _router(this.app, this.router,Chan.config);
       } 
     } catch (error) {
       console.log(error);
@@ -239,7 +263,7 @@ class Chan {
   }
   
   run() {
-    const port = this.app.config.port || '81';
+    const port = Chan.config.port || '81';
     this.app.listen(port, () => {
       console.log(`Server is running on port ${port}`);
     });

package/core/lib/controller/controller.js

@@ -0,0 +1,30 @@
+/**
+ * @description
+ * 控制器基类
+ */
+class Controller{
+
+    constructor(){
+        
+    }
+
+    download(res,file){
+        res.download(file)
+    }
+
+    success(res,data=null){
+        res.json({code:200,msg:'success',data:data})
+    }
+
+    fail(res,msg='操作失败，请稍后再试'){
+        res.json({code:400,msg:msg})
+    }
+
+    error(res,msg){
+        res.json({code:500,msg:msg})
+    }
+}
+
+
+
+module.exports = Controller;

package/core/lib/{core.js → index.js}

@@ -3,10 +3,10 @@ const cookieParser = require("cookie-parser");
 const favicon = require("serve-favicon");
 const morgan = require("morgan");
 const path = require("path");
-const view = require("./middleware/view.js");
-module.exports = async function (app) {
+const template = require("./middleware/template.js");
+module.exports = async function (app,config) {
   const { logger, APP_PATH, cookieKey, maxAge, JSON_LIMIT, appName, version } =
-    app.config;
+    config;
   //日志
   app.use(morgan(logger.level));
 
@@ -21,7 +21,7 @@ module.exports = async function (app) {
   app.use(express.urlencoded({ extended: false }));
 
   //配置模板引擎
-  view(app);
+  template(app,config);
 
   //使用静态资源 ,
   app.use(
@@ -33,7 +33,7 @@ module.exports = async function (app) {
 
   //设置头信息
   app.use((req, res, next) => {
-    res.setHeader("mvc", "Chanjs");
+    res.setHeader("Create-By", "Chanjs");
     res.setHeader("X-Powered-By", appName);
     res.setHeader(appName, version);
     next();

package/core/lib/middleware/{view.js → template.js}

@@ -1,7 +1,7 @@
 const path = require("path");
-module.exports = (app) => {
+module.exports = (app,config) => {
   const 
-    { APP_PATH, views,env } = app.config;
+    { APP_PATH, views,env } = config;
   //默认home view
   const home = path.join(APP_PATH, `modules/web/view`);
   //合并插件中的view

package/core/lib/service/service.js

@@ -0,0 +1,195 @@
+class BaseService {
+    /**
+     * @description 构造函数
+     * @param {*} knex - knex实例
+     * @param {*} model - 模型名称
+     */
+    constructor(knex, model='') {
+        this.knex = knex;
+        this.model = model;
+    }
+
+     /**
+      * @description 查找所有符合条件的记录
+      * @param {*} query - 查询条件，例如：{name: 'test', age: 18}
+      * @returns {Promise} 返回符合条件的记录
+      */
+    query(query) {
+        return this.knex(this.model).where(query);
+    }
+
+    /**
+     * @description 查询表所有记录，慎用
+     * @returns {Promise} 返回所有记录
+     */
+    all() {
+        return this.knex(this.model).select();
+    }
+
+    /**
+     * @description 查询指定id的记录
+     * @param {*} id 
+     * @returns {Promise} 返回指定id的记录
+     */
+    findById(id) {
+        return this.knex(this.model).where('id', id).first();
+    }
+
+    /**
+     * @description 查询分页数据
+     * @param {*} current 
+     * @param {*} pageSize 
+     * @param {*} query 
+     * @returns {Promise} 返回分页数据
+     */
+    async findListAndQuery(current = 1, pageSize = 10, query = {}) {
+        const offset = (current - 1) * pageSize;
+
+        let countQuery = this.knex(this.model).count('* as total');
+        let dataQuery = this.knex(this.model);
+
+        // 应用查询条件
+        for (const key in query) {
+            dataQuery = dataQuery.where(key, query[key]);
+            countQuery = countQuery.where(key, query[key]);
+        }
+
+        // 获取总记录数
+        const total = await countQuery.first();
+
+        // 获取分页数据
+        const data = await dataQuery.offset(offset).limit(pageSize);
+
+        return { data, total: parseInt(total.total, 10) };
+    }
+
+    /**
+     * @description 查询指定id的记录
+     * @param {*} id - 记录id
+     * @returns {Promise} 返回指定id的记录
+     */
+    findOneById(id) {
+        return this.knex(this.model).where('id', id).select();
+    }
+
+    /**
+     * @description 查询指定条件的记录
+     * @param {Object} query - {<key>:<value>} 
+     * @returns {Promise} 返回指定条件的记录
+     */
+    findOne(query) {
+        return this.knex(this.model).where(query).first();
+    }
+
+    /**
+     * @description 更新指定id的记录
+     * @param {*} id - 记录id
+     * @param {*} params - {<key>:<value>}
+     * @returns {Promise} 返回更新后的记录
+     */
+    findOneAndUpdate(id, params) {
+        return this.knex(this.model).where('id', id).update(params).returning('*');
+    }
+
+
+    /**
+     * @description 查询指定条件的记录数量
+     * @param {*} query - {<key>:<value>}
+     * @returns {Promise} 返回指定条件的记录数量
+     */
+    count(query) {
+        return this.knex(this.model).where(query).count('* as total').first();
+    }
+
+    /**
+     * @description 插入一条记录
+     * @param {*} params - {<key>:<value>}
+     * @returns {Promise} 返回插入后的记录
+     */
+    insert(params) {
+        return this.knex(this.model).insert(params);
+    }
+
+    /**
+     * @description 插入多条记录
+     * @param {*} records - [{<key>:<value>}, {<key>:<value>}, ...]
+     * @returns {Promise} 返回插入后的记录
+     */
+    insertMany(records) {
+        return this.knex(this.model).insert(records);
+    }
+
+    /**
+     * @description 更新指定id的记录
+     * @param {*} id - 记录id
+     * @param {*} params - {<key>:<value>}
+     * @returns {Promise} 返回更新后的记录
+     */
+    updateById(id, params) {
+        return this.knex(this.model).where('id', id).update(params);
+    }
+
+    /**
+     * @description 更新数据
+     * @param {*} query - {<key>:<value>}
+     * @param {*} update - {<key>:<value>}
+     * @returns {Promise<*>} - 返回更新后的数据
+     */
+    update(query, update) {
+        return this.knex(this.model).where(query).update(update);
+    }
+
+    /**
+     * @description 查询并更新
+     * @param {*} query - {<key>:<value>}
+     * @param {*} update - {<key>:<value>}
+     * @returns {Promise<*>} - 返回更新后的记录
+     */
+    findAndModify(query, update) {
+        return this.knex(this.model).where(query).update(update);
+    }
+
+    /**
+     * 
+     * @param {*} id - id
+     * @param {*} update - {<key>:<value>}
+     * @returns {Promise<*>} - 返回更新后的记录
+     */
+    findByIdAndUpdate(id, update) {
+        return this.knex(this.model).where('id', id).update(update);
+    }
+
+    /**
+     * @description 根据条件更新记录
+     * @param {*} query - {<key>:<value>}
+     * @param {*} update - {<key>:<value>}
+     * @returns {Promise} - 返回更新后的记录
+     */
+    findOneAndUpdate(query, update) {
+        return this.knex(this.model).where(query).update(update);
+    }
+
+    /**
+     * @description 根据id删除一条记录
+     * @param {*} id - 记录id
+     * @returns {Promise} - 返回删除的记录
+     */
+    findByIdAndRemove(id) {
+        return this.knex(this.model).where('id', id).del();
+    }
+
+    /**
+     * @description 根据条件删除一条记录
+     * @param {*} query 
+     * @returns {Promise} - 返回删除的记录
+     */
+    findOneAndRemove(query) {
+        return this.knex(this.model).where(query).del();
+    }
+}
+
+const Service = (knex, model='') => {
+    return new BaseService(knex, model);
+};
+
+module.exports = Service;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chanjs",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Chan.js基于express 纯js研发的轻量级mvc框架。",
   "main": "core/chan.js",
   "module": "core/chan.js",
@@ -22,5 +22,8 @@
     "knex": "^3.1.0",
     "morgan": "^1.10.0",
     "mysql2": "^3.11.0"
-  }
+  },
+  "__npminstall_done": true,
+  "_from": "chanjs@1.0.22",
+  "_resolved": "https://registry.npmmirror.com/chanjs/-/chanjs-1.0.22.tgz"
 }

package/core/lib/base.js

@@ -1,35 +0,0 @@
-const express = require("express");
-const cookieParser = require("cookie-parser");
-const favicon = require("serve-favicon");
-const morgan = require("morgan");
-const path = require("path");
-
-const view = require("./middleware/view.js");
-module.exports = async function (app) {
-
-  const { logger,APP_PATH, cookieKey, maxAge } = app.config;
-  //日志
-  app.use(morgan(logger.level));
-
-  // favicon 图标
-  app.use(favicon(path.join(APP_PATH, "public/favicon.ico")));
-
-  //cookie
-  app.use(cookieParser(cookieKey));
-
-  //解析接口 json & url
-  app.use(express.json());
-  app.use(express.urlencoded({ extended: false }));
-
-  //配置模板引擎
-  view(app);
-
-  //使用静态资源 ,
-  app.use(
-    "/public",
-    express.static(path.join(APP_PATH, "public"), {
-      maxAge:maxAge,
-    })
-  );
-
-};

package/core/lib/controller/Base.js

@@ -1,13 +0,0 @@
-class Base{
-    constructor(config){
-        this.config = config;
-    }
-
-    log(...args){
-        console.log(...args); 
-    }
-
-    success(){
-        
-    }
-}

package/core/lib/extend/controller.js

@@ -1,217 +0,0 @@
-
-/**
- * extend controller
- */
-module.exports = {
-  /**
-   * body getter
-   */
-  get body() {
- 
-  },
-  /**
-   * body setter
-   */
-  set body(value) {
-
-  },
-  /**
-   * get client ip
-   */
-  get ip() {
-
-  },
-  /**
-   * get client ips
-   */
-  get ips() {
-
-  },
-  /**
-   * get status code
-   */
-  get status() {
-
-  },
-  /**
-   * set status code
-   */
-  set status(status) {
-
-  },
-  /**
-   * get content type
-   */
-  get type() {
-
-  },
-  /**
-   * set content type
-   */
-  set type(contentType) {
-
-  },
-  /**
-   * get userAgent header
-   */
-  get userAgent() {
-
-  },
-  /**
-   * get request method
-   */
-  get method() {
-
-  },
-  /**
-   * is get method
-   */
-  get isGet() {
-
-  },
-  /**
-   * is post method
-   */
-  get isPost() {
-
-  },
-  /**
-   * is command line invoke
-   */
-  get isCli() {
-
-  },
-  /**
-   * get or set config
-   * @param {String} name
-   * @param {Mix} value
-   * @param {String} m
-   */
-  config(name, value, m ) {
-
-  },
-  /**
-   * is method
-   * @param {String} method
-   */
-  isMethod(method) {
-
-  },
-  /**
-   * check if is ajax request
-   * @param {String} method
-   */
-  isAjax(method) {
-
-  },
-  /**
-   * is jsonp request
-   * @param {String} callback
-   */
-  isJsonp(callbackField) {
-
-  },
-  /**
-   * send jsonp data
-   */
-  jsonp(data, callbackField) {
-
-  },
-  /**
-   * send json data
-   */
-  json(data) {
-
-  },
-  /**
-   * send success data
-   */
-  success(data, message) {
-
-  },
-  /**
-   * send fail data
-   */
-  fail(errno, errmsg, data) {
-
-  },
-  /**
-   * set expires header
-   * @param {Number} time
-   */
-  expires(time) {
-
-  },
-  /**
-   * get query data
-   * @param {String} name
-   * @param {Mixed} value
-   */
-  get(name, value) {
-
-  },
-  /**
-   * get query data
-   * @param {String} name
-   * @param {Mixed} value
-   */
-  query(name, value) {
-
-  },
-  /**
-   * get or set post data
-   * @param {String} name
-   * @param {Mixed} value
-   */
-  post(name, value) {
-
-  },
-  /**
-   * get or set file data
-   * @param {String} name
-   * @param {Mixed} value
-   */
-  file(name, value) {
-
-  },
-  /**
-   * get or set cookies
-   * @param {String} name
-   * @param {String} value
-   * @param {Object} options
-   */
-  cookie(name, value, options) {
-
-  },
-  
-  /**
-   * get referer header
-   */
-  referrer(onlyHost) {
-   
-  },
-  /**
-   * get referer header
-   */
-  referer(onlyHost) {
-
-  },
-  /**
-   * Perform a 302 redirect to `url`.
-   * @param {String} url
-   * @param {String} alt
-   */
-  redirect(url, alt) {
-  
-  },
- 
-  
-  /**
-   * download
-   * @param {String} filepath
-   * @param {String} filename
-   */
-  download(filepath, filename) {
-   
-  }
-};

package/core/lib/middleware/router.js

@@ -1,31 +0,0 @@
-const path = require("path");
-const dealRouter = (app,router) => {
-
-   const {config:{template='default',APP_PATH}} = app;
-    //机器人抓取
-    router.get("/robots.txt", function (req, res, next) {
-        res.type('text/plain');
-        res.sendFile(path.join(APP_PATH, "/public/robots.txt"));
-    });
-    
-  //404处理
-    router.use((req, res, next) => {
-        let ip = req.headers["x-forwarded-for"] || req.ip;
-        console.log("404-->", `${req.method}-${decodeURI(req.url)}-${ip}`);
-        res.render(`${template}/404.html`);
-    });
-  
-  //处理错误
-    router.use((err, req, res) => {
-        console.error("500-->", req.method, req.url, err);
-        let data = { url: req.url, method: req.method, error: err.message };
-        if (req.is("html") || req.is("html") == null) {
-        res.render(`${template}/500.html`, { data });
-        } else {
-        res.json({ code: 500, data, msg: data.error });
-        }
-    });
-
-};
-
-module.exports = dealRouter;