chanjs 1.0.33 → 1.0.35

package/core/lib/config/config.js

@@ -0,0 +1,45 @@
+const path = require('path');
+
+/**
+ * @description 根目录
+ */
+const ROOT_PATH = process.cwd();
+// 读取package.json文件
+const {version='1.0.0',author='明空'} = require(path.join(ROOT_PATH, 'package.json'));
+
+/**
+ * @description 程序目录
+ */
+const APP_PATH = path.join(ROOT_PATH, 'app');
+
+let config = {
+  JSON_LIMIT:"100kb",
+  logger : {
+    level: 'dev',
+  },
+  version,
+  author,
+  env:'dev',
+  template:'default',
+  views:[], //模板路径
+  static:[{  //静态文件路径
+    prefix: "/public/",
+    dir: ["app/public"],
+    maxAge: 0,
+  }],
+  database:{
+    client: "mysql2",
+    host: "localhost",
+    port: "3306",
+    user: "root",
+    password: "123456",
+    database: "chancms",
+    charset: "utf8mb4",
+  }
+}
+
+module.exports = {
+  ROOT_PATH,
+  APP_PATH, 
+  ...config
+}

package/core/lib/controller/controller.js

@@ -0,0 +1,25 @@
+/**
+ * @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/extend/helper.js

@@ -0,0 +1,78 @@
+const knex = require('knex');
+
+/**
+ * @description 实例化一个类，并将该类的所有方法绑定到一个新的对象上。
+ * @param {Function} className - 需要实例化的类。
+ *@returns {Object} 包含绑定方法的对象。
+ */
+function bindClass(className) {
+  let obj = {};
+  const cls = new className();
+  Object.getOwnPropertyNames(cls.constructor.prototype).forEach(
+    (methodName) => {
+      if (
+        methodName !== "constructor" &&
+        typeof cls[methodName] === "function"
+      ) {
+        obj[methodName] = cls[methodName].bind(cls);
+      }
+    }
+  );
+  return obj;
+}
+
+
+ function createKnex(opt) {
+    let config = {
+        host:"localhost",
+        port:"3306",
+        client:"mysql2",
+        charset:"utf8mb4",
+        debug:false,
+        ...opt
+    };
+    return knex({
+      client: config.client,
+      connection: {
+        host:config.host,
+        port:config.port,
+        user:config.user,
+        password:config.password,
+        database:config.database,
+        charset:config.charset,
+      },
+      debug: config.debug,
+      //默认为{min: 2, max: 10}
+      pool: { 
+        min: 0,
+        max: 2,
+      },
+      log: {
+        warn(message) {
+          console.error("[knex warn]", message);
+        },
+        error(message) {
+          console.error("[knex error]", message);
+        },
+      },
+    });
+}
+/**
+ * 
+ * @param {*} module 模块目录
+ * @returns Array 
+ * @description 将web模块放到最后加载
+ */
+function loadWebToEnd(module=[]){
+  const index = module.indexOf('web');
+  if (index !== -1) {
+      const web = module.splice(index, 1);
+      module.push(web[0]);
+  }
+  return module;
+}
+module.exports = {
+    bindClass,
+    createKnex,
+    loadWebToEnd
+};

package/core/lib/index.js

@@ -0,0 +1,41 @@
+const express = require("express");
+const cookieParser = require("cookie-parser");
+const favicon = require("serve-favicon");
+const morgan = require("morgan");
+const path = require("path");
+const template = require("./middleware/template.js");
+module.exports = async function (app, config) {
+  const { logger, APP_PATH, cookieKey, static, JSON_LIMIT, appName, version } =
+    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({ limit: JSON_LIMIT }));
+  app.use(express.urlencoded({ extended: false }));
+
+  //配置模板引擎
+  template(app, config);
+
+  //使用静态资源 ,
+  if (static.length > 0) {
+    static.forEach((item) => {
+      const { prefix, dir, maxAge } = item;
+      app.use(prefix, express.static(dir, { maxAge: maxAge || 0 }));
+    });
+  }
+
+  //设置头信息
+  app.use((req, res, next) => {
+    res.setHeader("Create-By", "Chanjs");
+    res.setHeader("X-Powered-By", appName);
+    res.setHeader(appName, version);
+    next();
+  });
+};

package/core/lib/middleware/template.js

@@ -0,0 +1,38 @@
+const path = require("path");
+const template = require("art-template");
+const dayjs = require("dayjs");
+
+// 注册 dateFormat 函数
+template.defaults.imports.dateFormat = function (date, format) {
+  if (!date) {
+    return "";
+  }
+  // 如果传入的是一个 Date 对象，转换为 dayjs 对象
+  if (
+    date instanceof Date ||
+    typeof date === "string" ||
+    typeof date === "number"
+  ) {
+    date = dayjs(date);
+  } else {
+    return "";
+  }
+  return date.format(format);
+};
+
+module.exports = (app, config) => {
+  const { APP_PATH, views, env } = config;
+  //默认home view
+  const home = path.join(APP_PATH, `modules/web/view`);
+  //合并插件中的view
+  const all = [...views, home];
+
+  app.set("view options", {
+    debug: env === "dev",
+    cache: env === "prd",
+    minimize: true,
+  });
+  app.set("view engine", "html");
+  app.set("views", all);
+  app.engine(".html", require("express-art-template"));
+};

package/core/lib/service/service.js

@@ -0,0 +1,190 @@
+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();
+  }
+}
+
+module.exports = BaseService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "chanjs",
-  "version": "1.0.33",
-  "description": "Chanjs is a lightweight MVC framework developed based on express MySQL and pure JavaScript.",
+  "version": "1.0.35",
+  "description": "chanjs基于express 纯js研发的轻量级mvc框架。",
   "main": "core/chan.js",
   "module": "core/chan.js",
   "keywords": [
@@ -26,8 +26,7 @@
     "mysql2": "^3.11.0",
     "dayjs": "^1.11.12"
   },
-  "homepage": "https://www.npmjs.com/package/chanjs",
-  "files": [
-    "README.md"
-  ]
+  "__npminstall_done": true,
+  "_from": "chanjs@1.0.22",
+  "_resolved": "https://registry.npmmirror.com/chanjs/-/chanjs-1.0.22.tgz"
 }

package/publish.bat

@@ -0,0 +1,4 @@
+npm config set proxy null
+npm cache clean --force
+npm config set registry=https://registry.npmjs.org
+npm publish