chanjs 0.0.1

package/README.MD

@@ -0,0 +1,52 @@
+# <center>Chan.js mvc框架</center>
+
+Chan.js 基于express 纯js研发的轻量级mvc框架。基于函数式编程思想，性能优越，代码清晰，流程易读，可持续维护高。
+
+## 特性
+
+- 基于express
+- 支持es6语法
+- 模块化
+  - 支持多模块路由
+  - 支持多模块视图
+  - 支持多模块控制器
+  - 支持多模块服务
+- 插件化
+- 轻量级（核心代码300行内）
+- 长期维护
+
+## 规范 遵循约定优于配置
+
+```code
+|- app
+    |- config 配置
+    |- module 模块1
+        |- module1 模块1
+            |- controller 控制器
+            |- service 服务模型
+            |- view 视图模板
+            |- router.js 路由
+        |- module2 模块2
+            |- controller 控制器
+            |- service 服务模型
+            |- view 视图模板
+            |- router.js路由
+    |- extend 扩展
+    |- middleware 中间件
+    |- plugin 插件
+    |- public 静态文件
+|- index.js
+```
+
+### 初始化流程
+
+- 初始化
+- 加载配置
+- 加载模块
+  - 加载service
+  - 加载controller
+  - 加载router
+- 加载extend
+- 加载plugin
+- beforeStart() 挂在从数据库获取的配置合并到配置文件中
+- run() 启动服务

package/chan.js

@@ -0,0 +1,162 @@
+const express = require("express");
+const config = require("./lib/config/config.js");
+const path = require("path");
+const fs = require("fs");
+
+/**
+ * @description chanjs 
+ */
+class Chan {
+  constructor(options={}) {
+
+    //加载全局对象
+    this.config = Object.assign(config, options);
+    //配置
+    Chan.config = this.config;
+    //模块
+    Chan.modules = this.modules = {};
+    //帮助文档
+    Chan.helper = this.helper = {};
+
+    this.app = express();
+    this.router = express.Router();
+  
+    this.loadConfig();
+    this.beforeStart();
+    this.init();
+  }
+
+  // 加载配置
+  loadConfig() {
+    const configPath = path.join(config.APP_PATH, "config/index.js");
+    if (fs.existsSync(configPath)) {
+      const config = require(configPath);
+      Object.assign(this.config, config);
+    }
+    
+    console.log("config——>配置文件加载完成");
+  }
+
+  //启动加载
+  beforeStart(cb) {
+    // 初始化一些配置
+    console.log("beforeStart--->初始化一些配置");
+    cb && cb();
+  }
+
+  init() {
+    this.loadModules();
+    this.loadExtends();
+    this.loadPlusins();
+    
+  }
+
+  loadModules() {
+    const configPath = path.join(config.APP_PATH, "module");
+    if (fs.existsSync(configPath)) {
+      const dirs = fs
+        .readdirSync(configPath, { withFileTypes: true })
+        .filter((dirent) => dirent.isDirectory())
+        .map((dirent) => dirent.name)
+        .forEach((item, index) => {
+          this.modules[item] = {
+            controller: {},
+            service: {},
+          };
+          this.loadModule(item);
+        });
+      //执行路由
+      this.app.use(this.router);
+    }
+  }
+
+  // 加载插件
+  loadPlugins() {
+    const configPath = path.join(config.APP_PATH, "plugin");
+    if (fs.existsSync(configPath)) {
+      const dirs = fs
+        .readdirSync(configPath, { withFileTypes: true })
+        .filter((dirent) => dirent.isDirectory())
+        .map((dirent) => dirent.name);
+      this.plugins = dirs;
+    } else {
+      this.plugins = [];
+    }
+  }
+
+  loadModule(moduleName) {
+    const moduleDir = path.join(config.APP_PATH, "module", moduleName);
+    this.loadServices(moduleDir,moduleName);
+    this.loadControllers(moduleDir,moduleName);
+    this.loadRoutes(moduleDir,moduleName);
+  }
+
+  // 加载服务
+  loadServices(moduleDir,moduleName) {
+    const servicesDir = path.join(moduleDir, "service");
+    if (fs.existsSync(servicesDir)) {
+      let services = fs
+        .readdirSync(servicesDir)
+        .filter((file) => file.endsWith(".js"));
+      for (let i = 0, file = services[i]; i < services.length; i++) {
+        const Service = require(path.join(servicesDir, file));
+        const serviceName = file.replace(".js", "");
+        this.modules[moduleName].service[serviceName] = {};
+        this.modules[moduleName].service[serviceName] = Service;
+      }
+    }
+  }
+
+  // 加载控制器
+  loadControllers(moduleDir,moduleName) {
+    const controllersDir = path.join(moduleDir, "controller");
+    if (fs.existsSync(controllersDir)) {
+      let controllers = fs
+        .readdirSync(controllersDir)
+        .filter((file) => file.endsWith(".js"));
+      for (let i = 0, file = controllers[i]; i < controllers.length; i++) {
+        const controller = require(path.join(controllersDir, file));
+        const controllerName = file.replace(".js", "");
+        this.modules[moduleName].controller[controllerName] = {};
+        this.modules[moduleName].controller[controllerName] = controller;
+      }
+    }
+  }
+
+  // 加载路由
+  loadRoutes(moduleDir,moduleName) {
+    const routersDir = path.join(moduleDir, "router.js");
+    if (fs.existsSync(routersDir)) {
+      const routes = require(routersDir);
+      routes({router:this.router,controller:this.modules[moduleName].controller});
+    }
+  }
+
+  // 加载扩展
+  loadExtends() {
+    const extendPath = path.join(config.APP_PATH, "extend");
+    if (fs.existsSync(extendPath)) {
+      let controllers = fs
+        .readdirSync(extendPath)
+        .filter((file) => file.endsWith(".js"));
+      for (let i = 0, file = controllers[i]; i < controllers.length; i++) {
+        const helper = require(path.join(extendPath, file));
+        const fileName = file.replace(".js", "");
+        this.helper[fileName] = helper;
+      }
+    }
+  }
+
+  loadPlusins() {
+    // 加载插件
+  }
+
+  run(port) {
+    this.app.listen(port, () => {
+      console.log(`Server is running on port ${port}`);
+    });
+  }
+}
+
+
+module.exports = Chan;

package/lib/base.js

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

package/lib/config/config.js

@@ -0,0 +1,18 @@
+const path = require('path');
+
+/**
+ * @description 根目录
+ */
+const ROOT_PATH = process.cwd();
+
+/**
+ * @description 程序目录
+ */
+const APP_PATH = path.join(ROOT_PATH, 'app');
+
+module.exports = {
+  ROOT_PATH,
+  APP_PATH, 
+}
+
+

package/lib/controller/Base.js

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

package/lib/extend/controller.js

@@ -0,0 +1,217 @@
+
+/**
+ * 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/lib/extend/fsExtend.js

@@ -0,0 +1,135 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * @description 是否存在
+ * @param {*} dir 目录
+ * @returns {Boolean} 返回true false
+ */
+function isExist(dir) {
+  let formatDir = path.normalize(dir);
+  try {
+    fs.accessSync(formatDir, fs.R_OK);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+exports.isExist = isExist;
+
+/**
+ * @description 是否是文件
+ * @param {*} filePath
+ * @returns {Boolean} true 是文件 false 不是文件
+ */
+function isFile(filePath) {
+  if (!isExist(filePath)) return false;
+  try {
+    const stat = fs.statSync(filePath);
+    return stat.isFile();
+  } catch (e) {
+    return false;
+  }
+}
+exports.isFile = isFile;
+
+/**
+ * @description 是否是目录
+ * @param {*} filePath
+ * @returns {Boolean} 返回true false
+ */
+function isDirectory(filePath) {
+  if (!isExist(filePath)) return false;
+  try {
+    const stat = fs.statSync(filePath);
+    return stat.isDirectory();
+  } catch (e) {
+    return false;
+  }
+}
+exports.isDirectory = isDirectory;
+
+/**
+ * @description 修改指定路径 `p` 的权限模式为给定的 `mode`。这是一个同步版本的文件权限更改方法
+ * 如果成功修改权限，则返回 `true`，否则在发生错误时捕获异常并返回 `false`。
+ * @param  {String} p  - 要更改权限的文件或目录的绝对路径。
+ * @param  {String|Number} mode - 指定的新权限模式，可以是八进制数字表示（如0o755）或字符串形式（如"755"）
+ * @return {Boolean}  - 根据操作是否成功，返回 `true` 表示成功，`false` 表示失败。
+ */
+function chmod(p, mode) {
+  try {
+    fs.chmodSync(p, mode);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+exports.chmod = chmod;
+
+/**
+ * @function mkdir
+ * @description 递归创建目录
+ * @param {string} dir - 要创建的目录路径。
+ * @param {string|number}  -  默认为 0o777。可以是八进制数字表示或字符串形式。
+ * @returns {boolean} -  返回 `true` 表示成功，`false` 表示失败。
+ */
+function mkdir(dir, mode) {
+  if (isExist(dir)) {
+    if (mode) return chmod(dir, mode);
+    return true;
+  }
+  const pp = path.dirname(dir);
+  if (isExist(pp)) {
+    try {
+      fs.mkdirSync(dir, mode);
+      return true;
+    } catch (e) {
+      return false;
+    }
+  }
+  if (mkdir(pp, mode)) return mkdir(dir, mode);
+  return false;
+}
+exports.mkdir = mkdir;
+
+function getdirFiles(dir, prefix = "") {
+  dir = path.normalize(dir);
+  if (!fs.existsSync(dir)) return [];
+  const files = fs.readdirSync(dir);
+  let result = [];
+  files.forEach((item) => {
+    const currentDir = path.join(dir, item);
+    const stat = fs.statSync(currentDir);
+    if (stat.isFile()) {
+      result.push(path.join(prefix, item));
+    } else if (stat.isDirectory()) {
+      const cFiles = getdirFiles(currentDir, path.join(prefix, item));
+      result = result.concat(cFiles);
+    }
+  });
+  return result;
+}
+
+exports.getdirFiles = getdirFiles;
+
+/**
+ * remove dir aync
+ * @param  {String} p       [path]
+ * @param  {Boolean} reserve []
+ * @return {Promise}         []
+ */
+function rmdir(p, reserve) {
+  if (!isDirectory(p)) return Promise.resolve();
+  return fsReaddir(p).then((files) => {
+    const promises = files.map((item) => {
+      const filepath = path.join(p, item);
+      if (isDirectory(filepath)) return rmdir(filepath, false);
+      return fsUnlink(filepath);
+    });
+    return Promise.all(promises).then(() => {
+      if (!reserve) return fsRmdir(p);
+    });
+  });
+}
+exports.rmdir = rmdir;

package/lib/extend/router.js

@@ -0,0 +1,17 @@
+
+
+module.exports = {
+    /**
+     * @description 给路由加前缀
+     * @returns viod 0
+     */
+    addRoutePrefix:()=>{
+        return function (req, res, next) {
+            req.baseUrl = `${prefix}${req.baseUrl || ''}`;
+            // 如果有 query 参数，则保留原有参数
+            req.url = `${req.baseUrl}${req.url.includes('?') ? req.url.split('?')[1] : ''}`;
+            next();
+          };
+    }
+}
+

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "chanjs",
+  "version": "0.0.1",
+  "description": "Chan.js 基于express 纯js研发的轻量级mvc框架。基于函数式编程思想，性能优越，代码清晰，流程易读，可持续维护高。",
+  "main": "chan.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "明空",
+  "license": "ISC"
+}