@wanglindoc/elpis 1.0.0

package/elpis-core/loader/config.js

@@ -0,0 +1,62 @@
+/**
+ * config loader 配置加载器
+ * @param {*} 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
+ */
+const path = require("node:path");
+const { sep } = path;
+
+module.exports = (app) => {
+  // elpis config 目录及相关文件
+  const elpisConfigPath = path.resolve(__dirname, `..${sep}..${sep}config`);
+  let defaultConfig = require(
+    path.resolve(elpisConfigPath, `.${sep}config.default.js`),
+  );
+
+  // 获取业务 config 目录及相关配置
+  const businessConfigPath = path.resolve(process.cwd(), `.${sep}config`);
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`)),
+    };
+  } catch (error) {
+    console.log("[exception] there is no default.config file");
+  }
+
+  // 获取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 (error) {
+    console.log(error, "error");
+    console.log("[exception] there is no env.config file");
+  }
+
+  // 覆盖并加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,79 @@
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * controller loader
+ * @param {*} app koa实例
+ * @description 加载所有 controller，可通过 'app.controllers.${目录}.${文件}' 访问
+ * @example app/controller
+ *          |
+ *          | -- custom-module
+ *               |
+ *               | -- custom-controller.js
+ * => app.controller.customModule.costomController
+ *
+ */
+module.exports = (app) => {
+  const controllers = {};
+
+  // 读取 elpis/app/controller/**/**.js 下的所有文件
+  const elpisControllerPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}controller`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.controllers 中
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取业务 app/controller/**/**.js 下的所有文件
+  const businessControllerPath = path.resolve(
+    app.businessPath,
+    `.${sep}controller`,
+  );
+  const businessFileList = glob.sync(
+    path.resolve(businessControllerPath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.controllers 中
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let fileName = path.resolve(file);
+
+    // 截取路径 app/controller/custom-module/custom-controller.js => custom-module/custom-controller
+    fileName = fileName.substring(
+      fileName.lastIndexOf(`controller${sep}`) + `controller${sep}`.length,
+      fileName.lastIndexOf("."),
+    );
+
+    // 把 '-' 统一改为驼峰式，custom-module/costom-controller => customModule/costomController
+    fileName = fileName.replace(/[_-][a-z]/gi, (s) =>
+      s.substring(1).toUpperCase(),
+    ); // s：-a或者_a
+
+    let tempController = controllers; // {}
+    const splitFileNames = fileName.split(`${sep}`); // ["customModule(目录)","costomController(文件)"]
+    for (let i = 0, len = splitFileNames.length; i < len; ++i) {
+      if (i === len - 1) {
+        // controller 是一些 class类
+        const ControllerMoule = require(path.resolve(file))(app);
+        tempController[splitFileNames[i]] = new ControllerMoule(); // 3、tempController = { b: file }、controllers = { a: { b: file }}
+      } else {
+        if (!tempController[splitFileNames[i]]) {
+          tempController[splitFileNames[i]] = {}; // 1、tempController: { a:{} }、controllers = { a:{} }
+        }
+        tempController = tempController[splitFileNames[i]]; // 2、tempController = a:{}、controllers = { a:{} }
+      }
+    }
+  }
+
+  // 将 middlewares 对象挂载到内存中的 app 对象上
+  app.controllers = controllers;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,67 @@
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * extend loader
+ * @param {*} app koa实例
+ * @description 加载所有 extend，可通过 'app.extend.${文件}' 访问
+ * @example app/extend
+ *              |
+ *              | -- custom-extend.js
+ * => app.extend.costomExtend 访问
+ * extend 是 app 的拓展，只允许有一级目录
+ *
+ */
+
+module.exports = (app) => {
+  // 读取 elpis/app/extend/**.js 下的所有文件
+  const elpisExtendPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}extend`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisExtendPath, `.${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app 上
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取业务 app/extend/**.js 下的所有文件
+  const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`);
+  const businessFileList = glob.sync(
+    path.resolve(businessExtendPath, `.${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app 上
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let fileName = path.resolve(file);
+
+    // 截取路径 app/extend/custom-extend.js => custom-extend
+    fileName = fileName.substring(
+      fileName.lastIndexOf(`extend${sep}`) + `extend${sep}`.length,
+      fileName.lastIndexOf("."),
+    );
+
+    // 把 '-' 统一改为驼峰式，costom-extend => costomExtend
+    fileName = fileName.replace(/[_-][a-z]/gi, (s) =>
+      s.substring(1).toUpperCase(),
+    ); // s：-a或者_a
+
+    // 过滤 app 已经存在的 key
+    for (const key in app) {
+      if (key === fileName) {
+        console.log(`[extend load error] name:${fileName} is already in app`);
+        return;
+      }
+    }
+
+    // 将 extend 挂载到 app 上
+    app[fileName] = require(path.resolve(file))(app);
+  }
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,77 @@
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * middleware loader
+ * @param {*} app koa实例
+ * @description 加载所有 middleware，可通过 'app.middlewares.${目录}.${文件}' 访问
+ * @example app/middleware
+ *          |
+ *          | -- custom-module
+ *               |
+ *               | -- custom-middleware.js
+ * => app.middlewares.customModule.costomMiddleware
+ *
+ */
+module.exports = (app) => {
+  const middlewares = {};
+
+  // 读取  elpis/app/middleware/**/**.js 下的所有文件
+  const elpisMiddlewarePath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}middleware`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisMiddlewarePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.middlewares 中
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取业务根目录 app/middleware/**/**.js 下的所有文件
+  const businessMiddlewarePath = path.resolve(
+    app.businessPath,
+    `.${sep}middleware`,
+  );
+  const businessFileList = glob.sync(
+    path.resolve(businessMiddlewarePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.middlewares 中
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let fileName = path.resolve(file);
+
+    // 截取路径 app/middleware/custom-module/custom-middleware.js => custom-module/custom-middleware
+    fileName = fileName.substring(
+      fileName.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,
+      fileName.lastIndexOf("."),
+    );
+
+    // 把 '-' 统一改为驼峰式，custom-module/custom-middleware => customModule/customMiddleware
+    fileName = fileName.replace(/[_-][a-z]/gi, (s) =>
+      s.substring(1).toUpperCase(),
+    ); // s：-a或者_a
+
+    let tempMiddleware = middlewares; // {}
+    const splitFileNames = fileName.split(`${sep}`);
+    for (let i = 0, len = splitFileNames.length; i < len; ++i) {
+      if (i === len - 1) {
+        tempMiddleware[splitFileNames[i]] = require(path.resolve(file))(app); // { a: { b: file }}
+      } else {
+        if (!tempMiddleware[splitFileNames[i]]) {
+          tempMiddleware[splitFileNames[i]] = {}; // tempMiddleware: { a:{} }
+        }
+        tempMiddleware = tempMiddleware[splitFileNames[i]]; // tempMiddleware = {}
+      }
+    }
+  }
+
+  // 将 middlewares 对象挂载到内存中的 app 对象上
+  app.middlewares = middlewares;
+};

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

@@ -0,0 +1,57 @@
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * router-schema loader
+ * @param {object} app Koa实例
+ * @description 通过 'json-schema' & 'ajv' 对 API 规则进行约束，配合 api-params-verify 中间件进行验证
+ * 路由router会定义好接口的路径、请求方式、调用哪个controller等
+ * 而router-schema做的事情是定义好这个接口接收什么参数，哪些参数是必传项、是什么类型
+ * @example app/router-schema/**.js
+ * 输出：
+ * app.routerSchema = {
+ *  '${api1}': ${jsonSchema},
+ *  '${api2}': ${jsonSchema},
+ *  '${api3}': ${jsonSchema},
+ *  '${api4}': ${jsonSchema},
+ * }
+ */
+module.exports = (app) => {
+  let routerSchema = {};
+
+  // 读取 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`),
+  );
+  // 注册所有 routerSchema ，使得可以通过 'app.routerSchema' 的方式访问
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取业务 app/router-schema/**/**.js 下的所有文件
+  const businessRouterSchemaPath = path.resolve(
+    app.businessPath,
+    `.${sep}router-schema`,
+  );
+  const businessFileList = glob.sync(
+    path.resolve(businessRouterSchemaPath, `.${sep}**${sep}**.js`),
+  );
+  // 注册所有 routerSchema ，使得可以通过 'app.routerSchema' 的方式访问
+  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,57 @@
+/**
+ * router loader 将路由注册到KoaRouter上
+ * @param {*} app
+ *
+ * 解析所有 app/router/ 下所有js文件，加载到 KoaRouter 上
+ */
+
+const KoaRouter = require("koa-router");
+const path = require("node:path");
+const { sep } = path;
+const glob = require("glob");
+
+module.exports = (app) => {
+  // 实例化 KoaRouter 实例
+  const router = new KoaRouter();
+
+  // 找到 elpis 所有路由文件
+  const elpisRouterPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}router`,
+  );
+  // 注册 elpis 所有路由
+  const elpisFileList = glob.sync(
+    path.resolve(elpisRouterPath, `.${sep}**${sep}**.js`),
+  );
+  elpisFileList.forEach((file) => {
+    // router 文件如下:
+    // module.exports = (app, router) => {
+    //    router.get('/**', **Controller)
+    // }
+    require(path.resolve(file))(app, router);
+  });
+
+  // 找到业务所有路由文件
+  const businessRouterPath = path.resolve(app.businessPath, `.${sep}router`);
+  // 注册业务所有路由
+  const businessFileList = glob.sync(
+    path.resolve(businessRouterPath, `.${sep}**${sep}**.js`),
+  );
+  businessFileList.forEach((file) => {
+    // router 文件如下:
+    // module.exports = (app, router) => {
+    //    router.get('/**', **Controller)
+    // }
+    require(path.resolve(file))(app, router);
+  });
+
+  // 路由兜底 (健壮性)
+  router.get("*", async (ctx, next) => {
+    ctx.status = 302; // 临时重定向
+    ctx.redirect(`${app?.options?.homePage ?? "/"}`);
+  });
+
+  // 路由注册到 app 上
+  app.use(router.routes());
+  app.use(router.allowedMethods());
+};

package/elpis-core/loader/service.js

@@ -0,0 +1,76 @@
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * service loader
+ * @param {*} app koa实例
+ * @description 加载所有 service，可通过 'app.services.${目录}.${文件}' 访问
+ * @example app/service
+ *          |
+ *          | -- custom-module
+ *               |
+ *               | -- custom-service.js
+ * => app.services.customModule.costomService
+ *
+ */
+module.exports = (app) => {
+  const services = {};
+
+  // 读取 elpis/app/service/**/**.js 下的所有文件
+  const elpisServicePath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}service`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisServicePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.services 中
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取业务 app/service/**/**.js 下的所有文件
+  const businessServicePath = path.resolve(app.businessPath, `.${sep}service`);
+  const businessFileList = glob.sync(
+    path.resolve(businessServicePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.services 中
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  function handleFile(file) {
+    // 提取文件名称
+    let fileName = path.resolve(file);
+
+    // 截取路径 app/service/custom-module/custom-service.js => custom-module/custom-service
+    fileName = fileName.substring(
+      fileName.lastIndexOf(`service${sep}`) + `service${sep}`.length,
+      fileName.lastIndexOf("."),
+    );
+
+    // 把 '-' 统一改为驼峰式，custom-module/custom-service => customModule/customService
+    fileName = fileName.replace(/[_-][a-z]/gi, (s) =>
+      s.substring(1).toUpperCase(),
+    ); // s：-a或者_a
+
+    let tempService = services; // {}
+    const splitFileNames = fileName.split(`${sep}`);
+    for (let i = 0, len = splitFileNames.length; i < len; ++i) {
+      if (i === len - 1) {
+        // service 是一些 class类
+        const ServiceMoule = require(path.resolve(file))(app);
+        tempService[splitFileNames[i]] = new ServiceMoule(); // tempService = { b: file }、services = { a: { b: file }}
+      } else {
+        if (!tempService[splitFileNames[i]]) {
+          tempService[splitFileNames[i]] = {}; // tempService: { a:{} }
+        }
+        tempService = tempService[splitFileNames[i]]; // tempMiddleware = {}
+      }
+    }
+  }
+
+  // 将 services 对象挂载到内存中的 app 对象上
+  app.services = services;
+};

package/index.js

@@ -0,0 +1,39 @@
+const ElpisCore = require("./elpis-core");
+
+// 引入前端工程化构建
+const FEBuildDev = require("./app/webpack/build-dev");
+const FEBuildProd = require("./app/webpack/build-prod");
+
+module.exports = {
+  /**
+   * 服务端基础
+   */
+  Controller: {
+    Base: require("./app/controller/base"),
+  },
+  Service: {
+    Base: require("./app/service/base"),
+  },
+
+  /**
+   * 编译构建前端工程化
+   * @param {*} env
+   */
+  frontendBuild(env) {
+    if (env === "local") {
+      FEBuildDev();
+    } else if (env === "prod") {
+      FEBuildProd();
+    }
+  },
+
+  /**
+   * 启动 elpis
+   * @param {*} options
+   * @returns
+   */
+  serverStart(options = {}) {
+    const app = ElpisCore.start(options);
+    return app;
+  },
+};

package/model/index.js

@@ -0,0 +1,128 @@
+const _ = require("lodash");
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * project 继承 model
+ * @param {*} model
+ * @param {*} project
+ * @returns
+ */
+const projectExtendModel = (model, project) => {
+  // 第一个参数 {} 是目标对象，最终返回的
+  // 第二和第三个参数 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 也有，则递归调用 projectExtendModel 方法覆盖修改
+        result.push(
+          projItem ? projectExtendModel(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}
+ *         }
+ *      }
+ * ]
+ * @param {*} app
+ */
+module.exports = (app) => {
+  const modelList = [];
+
+  // 遍历当前文件夹，构造模型数据结构，挂载到 modelList 上
+  const modelPath = path.resolve(app.baseDir, `.${sep}model`);
+  const fileList = glob.sync(path.resolve(modelPath, `.${sep}**${sep}**.js`));
+
+  fileList.forEach((file) => {
+    if (file.indexOf("index.js") > -1) {
+      return;
+    }
+
+    // 区分配置类型 model/project
+    const type = file.indexOf(`${sep}project${sep}`) > -1 ? "project" : "model";
+
+    if (type === "project") {
+      const modelKey = file.match(/\/model\/(.*?)\/project/)?.[1];
+      const projectKey = file.match(/\/project\/(.*?)\.js/)?.[1];
+      let modelItem = modelList.find((item) => item.model?.key === modelKey);
+      // 初始化 model 数据结构
+      if (!modelItem) {
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+
+      // 初始化 project 数据结构
+      if (!modelItem.project) {
+        modelItem.project = {};
+      }
+
+      modelItem.project[projectKey] = require(path.resolve(file));
+      // 注入 projectKey
+      modelItem.project[projectKey].key = projectKey;
+      modelItem.project[projectKey].modelKey = modelKey;
+    }
+
+    if (type === "model") {
+      const modelKey = file.match(/\/model\/(.*?)\/model.js/)?.[1];
+      let modelItem = modelList.find((item) => item.model?.key === modelKey);
+      // 初始化 model 数据结构
+      if (!modelItem) {
+        modelItem = {};
+        modelList.push(modelItem);
+      }
+      modelItem.model = require(path.resolve(file));
+      // 注入 modelKey
+      modelItem.model.key = modelKey;
+    }
+  });
+
+  // 处理继承
+  modelList.forEach((item) => {
+    const { model, project } = item;
+    for (const key in project) {
+      project[key] = projectExtendModel(model, project[key]);
+    }
+  });
+
+  return modelList;
+};