@xujingquan/elpis 1.0.0

package/elpis-core/loader/config.js

@@ -0,0 +1,54 @@
+const path = require('path');
+const { sep } = path;
+
+/**
+ * config loader
+ * @param {object} app Koa 实例
+ *
+ * 配置区分 本地/测试/生成 环境，通过 env 环境读取不同文件配置 env.config
+ * 通过 env.config 覆盖 default.config 加载到 app.config 中
+ *
+ * 目录下对应的 config 配置
+ * 默认配置 config/config.default.js（框架｜业务）
+ * 本地配置 config/config.local.js（业务）
+ * 测试配置 config/config.beta.js（业务）
+ * 生产配置 config/config.prod.js（业务）
+ */
+
+module.exports = (app) => {
+  // 01、获取 elpis config 目录及相关文件
+  const elipsConfigPath = path.resolve(__dirname, `..${sep}..${sep}config`);
+  let defaultConfig = require(path.resolve(elipsConfigPath, `.${sep}config.default.js`));
+
+  // 02、获取 业务 config 目录及相关文件
+  const businessConfigPath = path.resolve(process.cwd(), `.${sep}config`);
+
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`)),
+    };
+  } catch (e) {
+    console.log('[exception] there is no default.config.js file');
+  }
+
+  // 03、获取 env.config
+  let envConfig = {};
+  try {
+    if (app.env.isLocal()) {
+      // 本地环境
+      envConfig = require(path.resolve(businessConfigPath, `.${sep}config.local.js`));
+    } else if (app.env.isBeta()) {
+      // 测试环境
+      envConfig = require(path.resolve(businessConfigPath, `.${sep}config.beta.js`));
+    } else if (app.env.isProduction()) {
+      // 生产环境
+      envConfig = require(path.resolve(businessConfigPath, `.${sep}config.prod.js`));
+    }
+  } catch (e) {
+    console.log(e, '/loader/config.js');
+  }
+
+  // 04、覆盖并加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,69 @@
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+/**
+ * controller loader
+ * @param {object} app Koa 实例
+ *
+ * 加载使用 controller，可通过 'app.controller.${目录}.${文件}' 访问
+ *
+ * 例子：
+ * app/controller
+ *   ｜
+ *   ｜—— custom-module
+ *        ｜—— custom-controller.js
+ *
+ *  => app.controller.customModule.customController (通过这个loader可以实现这个方式去访问上面目录中的文件)
+ * */
+module.exports = (app) => {
+  // 01、读取 elpis/app/controller/**/**.js 下的所有文件 （当前框架）
+  const elpisControllerPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}controller`);
+  const elpisFileList = glob.sync(path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`));
+
+  // 02、读取业务根目录  app/controller/**/**.js 下的所有文件（客户业务项目）
+  const businessControllerPath = path.resolve(app.businessPath, `.${sep}controller`);
+  const businessFileList = glob.sync(path.resolve(businessControllerPath, `.${sep}**${sep}**.js`));
+
+  // 03、遍历所有文件目录，把内容加载到 app.controller 下
+  const controller = {};
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file); // 将文件名拼接到文件路径上
+    // 截取路径 app/controller/custom-module/custom-controller.js => custom-module/custom-controller
+    name = name.slice(
+      name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length,
+      name.lastIndexOf('.')
+    );
+
+    // 04、把 '-' 统一改为驼峰式，custom-module/custom-controller => customModule/customController
+    name = name.replace(/[_-][a-z]/gi, (s) => s.slice(1).toUpperCase());
+
+    // 05、挂载 controller 到内存 app 对象中
+    let tempController = controller;
+    const names = name.split(sep); // => [ customModule(目录), customController（文件） ]
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i === len - 1) {
+        // 文件
+        const ControllerMoule = require(path.resolve(file))(app); // 导入文件并且传入 app 实例
+        tempController[names[i]] = new ControllerMoule();
+      } else {
+        // 目录
+        if (!tempController[names[i]]) {
+          tempController[names[i]] = {};
+        }
+        tempController = tempController[names[i]];
+        // tempController === {}
+        // tempController = { customModule: { a: { b: { } } } }
+      }
+    }
+  }
+
+  app.controller = controller;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,57 @@
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+/**
+ * extend loader
+ * @param {object} app Koa 实例
+ *
+ * 加载使用 extend，可通过 'app.extend.${文件}' 访问
+ *
+ * 例子：
+ * app/extend
+ *        ｜
+ *        ｜—— custom-extend.js
+ *
+ *  => app.extend.customExtend (通过这个loader可以实现这个方式去访问上面目录中的文件)
+ * */
+module.exports = (app) => {
+  // 01、读取 elpis/app/extend/**/**.js 下的所有文件（当前框架）
+  const elipsExtendPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}extend`);
+  const elpisFileList = glob.sync(path.resolve(elipsExtendPath, `.${sep}**${sep}**.js`));
+
+  // 02、读取业务根目录  app/extend/**/**.js 下的所有文件（客户业务项目）
+  const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`);
+  const businessFileList = glob.sync(path.resolve(businessExtendPath, `.${sep}**${sep}**.js`));
+
+  // 03、遍历所有文件目录，把内容加载到 app.extend 下
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file); // 将文件名拼接到文件路径上
+    // 截取路径 app/extend/custom-extend.js => custom-extend
+    name = name.slice(
+      name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length,
+      name.lastIndexOf('.')
+    );
+
+    // 04、把 '-' 统一改为驼峰式，custom-extend => customExtend
+    name = name.replace(/[_-][a-z]/gi, (s) => s.slice(1).toUpperCase());
+
+    // 05、过滤 app 已存在的 key
+    for (const key in app) {
+      if (key === name) {
+        console.log(`[extend load error] name:${name} is already in app`);
+        return;
+      }
+    }
+
+    // 06、挂载 extend 到 app 上
+    app[name] = require(path.resolve(file))(app);
+  }
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,66 @@
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+/**
+ * middleware loader
+ * @param {object} app Koa 实例
+ *
+ * 加载使用 middleware，可通过 'app.middleware.${目录}.${文件}' 访问
+ *
+ * 例子：
+ * app/middleware
+ *   ｜
+ *   ｜—— custom-module
+ *        ｜—— custom-middleware.js
+ *
+ *  => app.middleware.customModule.customMiddleware (通过这个loader可以实现这个方式去访问上面目录中的文件)
+ * */
+module.exports = (app) => {
+  // 01、读取 elpis/app/middleware/**/**.js 下的所有文件（当前框架）
+  const elpisMiddlewarePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}middleware`);
+  const elpisFileList = glob.sync(path.resolve(elpisMiddlewarePath, `.${sep}**${sep}**.js`));
+
+  // 02、读取业务根目录  app/middleware/**/**.js 下的所有文件（客户业务项目）
+  const businessMiddlewarePath = path.resolve(app.businessPath, `.${sep}middleware`);
+  const businessFileList = glob.sync(path.resolve(businessMiddlewarePath, `.${sep}**${sep}**.js`));
+
+  // 03、遍历所有文件目录，把内容加载到 app.middleware 下
+  const middlewares = {};
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file); // 将文件名拼接到文件路径上
+    // 截取路径 app/middleware/custom-module/custom-middleware.js => custom-module/custom-middleware
+    name = name.slice(
+      name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,
+      name.lastIndexOf('.')
+    );
+    // 04、把 '-' 统一改为驼峰式，custom-module/custom-middleware => customModule/customMiddleware
+    name = name.replace(/[_-][a-z]/gi, (s) => s.slice(1).toUpperCase());
+
+    // 05、挂载 middleware 到内存 app 对象中
+    let tempMiddleware = middlewares;
+    const names = name.split(sep);
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i === len - 1) {
+        // 文件
+        tempMiddleware[names[i]] = require(path.resolve(file))(app); // 导入文件并且传入 app 实例
+      } else {
+        // 目录
+        if (!tempMiddleware[names[i]]) {
+          tempMiddleware[names[i]] = {};
+        }
+        tempMiddleware = tempMiddleware[names[i]];
+        // tempMiddleware === {}
+        // tempMiddleware = { customModule: { a: { b: { } } } }
+      }
+    }
+  }
+  app.middlewares = middlewares;
+};

package/elpis-core/loader/router-schema.js

@@ -0,0 +1,49 @@
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+/**
+ * router-schema loader
+ * @param {object} app koa 实例
+ *
+ * 通过 'json-schema & ajv' 对 API 规则进行约束，配合 api-params-verify 中间件使用
+ *
+ * app/routerSchema/**.js
+ *
+ * 输出：
+ * app.rouShcema = {
+ *   `${api1}: ${jsonSchema}`,
+ *   `${api2}: ${jsonSchema}`,
+ *   `${api3}: ${jsonSchema}`,
+ *   `${api4}: ${jsonSchema}`,
+ * }
+ */
+
+module.exports = (app) => {
+  // 01、读取 elpis/app/router-schema/**/**.js 下的所有文件（当前框架）
+  const elpisRouterSchemaPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}router-schema`);
+  const elpisFileList = glob.sync(path.resolve(elpisRouterSchemaPath, `.${sep}**${sep}**.js`));
+
+  // 02、读取业务根目录  app/router-schema/**/**.js 下的所有文件（客户业务项目）
+  const businessRouterSchemaPath = path.resolve(app.businessPath, `.${sep}router-schema`);
+  const businessFileList = glob.sync(
+    path.resolve(businessRouterSchemaPath, `.${sep}**${sep}**.js`)
+  );
+
+  // 03、注册所有 routerSchema，使得可以 'app.routerSchema' 这样访问
+  let routerSchema = {};
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    routerSchema = {
+      ...routerSchema,
+      ...require(path.resolve(file)),
+    };
+  }
+
+  app.routerSchema = routerSchema;
+};

package/elpis-core/loader/router.js

@@ -0,0 +1,50 @@
+const KoaRouter = require('koa-router');
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+
+/**
+ * router loader
+ * @param {object} app Koa 实例
+ *
+ * 解析所有 app/router/ 下的所有 js 文件，加载到 KoaRouter 下
+ */
+
+module.exports = (app) => {
+  // 01、实例化 KoaRouter
+  const router = new KoaRouter();
+
+  // 02、elips 路由
+  const elipsRouterPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}router`);
+  const elipsFileList = glob.sync(path.resolve(elipsRouterPath, `.${sep}**${sep}**.js`));
+
+  // 03、业务路由
+  const businessRouterPath = path.resolve(app.businessPath, `.${sep}router`);
+  const businessFileList = glob.sync(path.resolve(businessRouterPath, `.${sep}**${sep}**.js`));
+
+  // 04、注册所有路由
+  elipsFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // router 文件的写法
+    // module.exports = (app, router) => {
+    //   router.get('url', Function)
+    // }
+    require(path.resolve(file))(app, router);
+  }
+
+  // 05、路由兜底（健壮性）
+  router.get('*', async (ctx, next) => {
+    ctx.status = 302; // 临时重定向
+    ctx.redirect(`${app?.options?.homePage ?? '/'}`);
+  });
+
+  // 06、路由注册到 app实例上
+  app.use(router.routes());
+  app.use(router.allowedMethods());
+};

package/elpis-core/loader/service.js

@@ -0,0 +1,69 @@
+const path = require('path');
+const { sep } = path;
+const glob = require('glob');
+/**
+ * service loader
+ * @param {object} app Koa 实例
+ *
+ * 加载使用 service，可通过 'app.service.${目录}.${文件}' 访问
+ *
+ * 例子：
+ * app/service
+ *   ｜
+ *   ｜—— custom-module
+ *        ｜—— custom-service.js
+ *
+ *  => app.service.customModule.customService (通过这个loader可以实现这个方式去访问上面目录中的文件)
+ * */
+module.exports = (app) => {
+  // 01、读取 elips/app/service/**/**.js 下的所有文件（当前框架）
+  const elipsServicePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}service`);
+  const elipsFileList = glob.sync(path.resolve(elipsServicePath, `.${sep}**${sep}**.js`));
+
+  // 02、读取业务根目录  app/service/**/**.js 下的所有文件（客户业务项目）
+  const businessServicePath = path.resolve(app.businessPath, `.${sep}service`);
+  const businessFileList = glob.sync(path.resolve(businessServicePath, `.${sep}**${sep}**.js`));
+
+  // 03、遍历所有文件目录，把内容加载到 app.service 下
+  const service = {};
+  elipsFileList.forEach((file) => {
+    handleFile(file);
+  });
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file); // 将文件名拼接到文件路径上
+    // 截取路径 app/service/custom-module/custom-service.js => custom-module/custom-service
+    name = name.slice(
+      name.lastIndexOf(`service${sep}`) + `service${sep}`.length,
+      name.lastIndexOf('.')
+    );
+
+    // 04、把 '-' 统一改为驼峰式，custom-module/custom-service => customModule/customService
+    name = name.replace(/[_-][a-z]/gi, (s) => s.slice(1).toUpperCase());
+
+    // 05、挂载 service 到内存 app 对象中
+    let tempService = service;
+    const names = name.split(sep); // => [ customModule(目录), customService（文件） ]
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i === len - 1) {
+        // 文件
+        const ServiceMoule = require(path.resolve(file))(app); // 导入文件并且传入 app 实例
+        tempService[names[i]] = new ServiceMoule();
+      } else {
+        // 目录
+        if (!tempService[names[i]]) {
+          tempService[names[i]] = {};
+        }
+        tempService = tempService[names[i]];
+        // tempService === {}
+        // tempService = { customModule: { a: { b: { } } } }
+      }
+    }
+  }
+
+  app.service = service;
+};

package/index.js

@@ -0,0 +1,47 @@
+const consoler = require('consoler');
+const ElpisCore = require('./elpis-core/index');
+
+// 引入前端工程化构建方法
+const FEBuildDev = require('./app/webpack/dev');
+const FEBuildProd = require('./app/webpack/prod');
+
+// 启动 koa 服务
+// ElpisCore.start({ name: 'Elpis', homePage: '/view/project-list' });
+
+// 导出 SKD 入口给外部使用
+module.exports = {
+  /**
+   * 服务端基础
+   * */
+  Controller: {
+    Base: require('./app/controller/base.js'),
+  },
+  Service: {
+    Base: require('./app/service/base.js'),
+  },
+  /**
+   * 编译构建前端工程
+   * @param env 环境变量 local/production
+   */
+  frontendBuild(env) {
+    switch (env) {
+      case 'local':
+        FEBuildDev();
+        break;
+      case 'production':
+        FEBuildProd();
+        break;
+      default:
+        consoler.log('请传入正确的环境变量值 local/production');
+        break;
+    }
+  },
+  /**
+   * 启动 elpis
+   * @param options  项目配置，透传到 elpis-core
+   */
+  serverStart(options = {}) {
+    const app = ElpisCore.start(options);
+    return app;
+  },
+};

package/jsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES2017",
+    "checkJs": false,
+    "lib": ["ES2017", "dom"],
+    "types": ["node", "koa"],
+    "moduleResolution": "node",
+    "baseUrl": ".",
+    "paths": {
+      "$elpisPages/*": ["app/pages/*"],
+      "$elpisCommon/*": ["app/pages/common/*"],
+      "$elpisWidgets/*": ["app/pages/widgets/*"],
+      "$elpisStore/*": ["app/pages/store/*"]
+    }
+  },
+  "include": ["**/*.js", "**/*.vue"],
+  "exclude": ["node_modules"]
+}

package/model/index.js

@@ -0,0 +1,103 @@
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+const _ = require('lodash');
+
+// project 继承 model 方法
+const projectExtentModel = (model, project) => {
+  return _.mergeWith({}, model, project, (modelValue, projValue) => {
+    // 处理数组合并的特殊情况
+    if (Array.isArray(modelValue) && Array.isArray(projValue)) {
+      let result = [];
+
+      // 因为 project 继承 model,所以需要处理修改和新增内容的情况
+      // project 有的键值，model也有 => 修改（重载）
+      // project 有的键值，model没有 => 新增（扩展）
+      // model 有的键值，project没有 => 保留（继承）
+
+      // 处理修改和保留
+      for (let i = 0; i < modelValue.length; i++) {
+        let modelItem = modelValue[i];
+        const projItem = projValue.find((projItem) => projItem.key === modelItem.key);
+        // project 有的键值，model也有，则递归调用 projectExtentModel 方法覆盖修改
+        result.push(projItem ? projectExtentModel(modelItem, projItem) : modelItem);
+      }
+
+      // 处理新增
+      for (let i = 0; i < projValue.length; i++) {
+        const projItem = projValue[i];
+        const modelItem = modelValue.find((modelItem) => modelItem.key === projItem.key);
+        if (!modelItem) {
+          result.push(projItem);
+        }
+      }
+
+      return result;
+    }
+  });
+};
+
+/**
+ * 解析 model 配置，并返回组织且继承后的数据结构
+ * [{
+ *   model: ${model},
+ *   project: {
+ *     proj1Key: ${proj1},
+ *     proj2Key: ${proj2},
+ *   }
+ * }, ...]
+ */
+
+module.exports = (app) => {
+  const modelList = [];
+
+  // 01.遍历当前文件夹，构造模型数据结构，挂载到 modelList 上
+  const modelPath = path.resolve(app.baseDir, `.${sep}model`);
+  const fileList = glob.sync(path.resolve(modelPath, `.${sep}**${sep}**.js`)); // 获取model文件下的所有文件路径
+  fileList.forEach((file) => {
+    if (file.indexOf('index.js') > -1) return; // 排出当前解析文件
+
+    // 02.区分配置类型 (model / project)
+    const type = file.indexOf(`${sep}project${sep}`) > -1 ? 'project' : 'model';
+
+    if (type === 'project') {
+      const modelKey = file.match(/\/model\/(.*?)\/project/)?.[1];
+      const projKey = file.match(/\/project\/(.*?)\.js/)?.[1];
+      let modelItem = modelList.find((item) => item.model?.key === modelKey);
+      if (!modelItem) {
+        // 初始化 model 数据结构
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+      if (!modelItem.project) {
+        // 初始化 project 数据结构
+        modelItem.project = {};
+      }
+      modelItem.project[projKey] = require(path.resolve(file));
+      modelItem.project[projKey].key = projKey; // 注入 projectKey
+      modelItem.project[projKey].modelKey = modelKey; // 注入 modelKey
+    }
+
+    if (type === 'model') {
+      const modelKey = file.match(/\/model\/(.*?)\/model\.js/)?.[1];
+      let modelItem = modelList.find((item) => item.model?.key === modelKey);
+      if (!modelItem) {
+        // 初始化 model 数据结构
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+      modelItem.model = require(path.resolve(file));
+      modelItem.model.key = modelKey; // 注入 modelKey
+    }
+  });
+
+  // 数据进一步整理，project => 继承 model
+  modelList.forEach((item) => {
+    const { model, project } = item;
+    for (const key in project) {
+      project[key] = projectExtentModel(model, project[key]);
+    }
+  });
+
+  return modelList;
+};