@codertqy/elpis 1.0.0

package/elpis-core/index.js

@@ -0,0 +1,98 @@
+const Koa = require("koa");
+const path = require("path");
+const { sep } = path; // 兼容不同操作系统上的斜杠
+
+const env = require("./env");
+
+const middlewareLoader = require("./loader/middleware");
+const routerSchemaLoader = require("./loader/router-schema");
+const routerLoader = require("./loader/router");
+const controllerLoader = require("./loader/controller");
+const configLoader = require("./loader/config");
+const extendLoader = require("./loader/extend");
+const serviceLoader = require("./loader/service");
+
+module.exports = {
+  /**
+   * 启动项目
+   * @param {} options 项目配置
+   * options = {
+   *    name // 项目名称
+   *    homePath  // 项目首页
+   * }
+   */
+  start(options = {}) {
+    const app = new Koa();
+    // 将配置挂载到app实例上
+    app.options = options;
+
+    // 基础路径
+    app.baseDir = process.cwd();
+
+    // 业务路径
+    app.businessPath = path.resolve(app.baseDir, `.${sep}app`);
+
+    // 初始化环境配置
+    app.env = env();
+    console.log(`----[start] env: ${app.env.get()} ----`);
+
+    // 加载middleware中间件
+    middlewareLoader(app);
+    console.log(`----[start] middleware done ----`);
+
+    // 加载routerSchema路由配置
+    routerSchemaLoader(app);
+    console.log(`----[start] router-schema done ----`);
+
+    // 加载controller控制器
+    controllerLoader(app);
+    console.log(`----[start] controller done ----`);
+
+    // 加载service服务
+    serviceLoader(app);
+    console.log(`----[start] service done ----`);
+
+    // 加载config配置
+    configLoader(app);
+    console.log(`----[start] config done ----`);
+
+    // 加载extend扩展
+    extendLoader(app);
+    console.log(`----[start] extend done ----`);
+
+    // 注册 elpis全局中间件
+    const elpisMiddlewarePath = path.resolve(
+      __dirname,
+      `..${sep}app${sep}middleware.js`,
+    );
+    const elpisMiddleware = require(elpisMiddlewarePath);
+    elpisMiddleware(app);
+    console.log(`----[start] load gloabl elpis middelware done ----`);
+
+    
+    // 注册 业务全局中间件 也就是通过app/middleware.js文件进行注册
+    try {
+      require(`${app.businessPath}${sep}middleware.js`)(app);
+      console.log(`----[start] load gloabl business middelware done ----`);
+    } catch (error) {
+      console.log("[exception] there is no gloabl business middleware file");
+    }
+
+    // 加载router路由 要经过前面所有的
+    routerLoader(app);
+    console.log(`----[start] router done ----`);
+
+    // 启动服务
+    try {
+      const port = process.env.PORT || 8080;
+      const host = process.env.IP || "0.0.0.0";
+      app.listen(port, host);
+      console.log(`Server runing on port: ${port}`);
+    } catch (e) {
+      console.log(e);
+    }
+
+    // 暴露出去交给测试使用
+    return app;
+  },
+};

package/elpis-core/loader/config.js

@@ -0,0 +1,58 @@
+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) => {
+  // elpis config 目录及相关文件
+  const elpisConfigPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}config`,
+  );
+  let defaultConfig = require(
+    path.resolve(elpisConfigPath, `.${sep}config.default.js`),
+  );
+
+  // 业务 config 目录及相关文件
+  const busnissConfigPath = path.resolve(process.cwd(), `.${sep}config`);
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(busnissConfigPath, `.${sep}config.default.js`)),
+    };
+  } catch (e) {
+    console.log("[exception] there is not config.default file");
+  }
+
+  // 3. 获取 env.config
+  let envConfig = {};
+  try {
+    if (app.env.isLocal()) {
+      //本地环境
+      envConfig = require(path.resolve(busnissConfigPath, `.${sep}config.local.js`));
+    } else if (app.env.isBeta()) {
+      //测试环境
+      envConfig = require(path.resolve(busnissConfigPath, `.${sep}config.beta.js`));
+    } else if (app.env.isProd()) {
+      //生产环境
+      envConfig = require(path.resolve(busnissConfigPath, `.${sep}config.prod.js`));
+    }
+  } catch (e) {
+    console.log("[exception] there is not config.env file or logical errors");
+  }
+
+  // 4. 覆盖并加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,93 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * controller loader
+ * @param {object} app Koa实例
+ *
+ * 加载所有controller ， 可通过'app.controller.${目录}.${文件}' 访问
+ * 例子
+ * app/controller
+ *  |
+ *  |-- custom-module
+ *         |
+ *         |-- custom-controller.js
+ * ====> app.controller.customModule.customController
+ *
+ */
+module.exports = (app) => {
+  const controller = {};
+
+  // 读取 elpis/app/controller/**/**.js所有文件
+  const elpisControllerPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}controller`,
+  );
+  // 遍历所有js文件
+  const elpisFileList = glob.sync(
+    path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`),
+  );
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取 业务/app/controller/**/**.js所有文件
+  const businessControllerPath = path.resolve(
+    app.businessPath,
+    `.${sep}controller`,
+  );
+  // 遍历所有js文件
+  const businessFileList = glob.sync(
+    path.resolve(businessControllerPath, `.${sep}**${sep}**.js`),
+  );
+  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.substring(
+      name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 - 统一改为驼峰式
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 根据文件夹构建嵌套对象
+    let tempController = controller;
+
+    // 分割/ 过滤空字符串
+    const names = name.split(sep).filter(Boolean);
+    for (let i = 0, len = names.length; i < len; i++) {
+      const key = names[i];
+      // 最后一层，挂载中间件函数
+      if (i === len - 1) {
+        /**
+         * 因为在koa里面middleware是一个可执行方法，可以直接执行
+         * controller是一个类，需要构造对象执行
+         *
+         * require(file)表示加载执行指定路径下的文件。app是当做参数传递给该文件函数
+         */
+        const ControllerModule = require(file)(app);
+        tempController[key] = new ControllerModule();
+      } else {
+        // 不是最后一层，创建嵌套对象  假设 key为user  tempController={user:{}} 也就是则tempController=.user
+        if (!tempController[key]) {
+          tempController[key] = {};
+        }
+        // tempcontroller就变为tempcontroller.user ={}
+        tempController = tempController[key];
+      }
+      /**
+       * 第二层：key为app  则tempController={ user: { app: { } } } 也就是tempController=.user.app
+       */
+    }
+  }
+  // 遍历所有文件目录，把内容加载到 app.controller 下
+
+  app.controller = controller;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,63 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * extend loader
+ * @param {object} app Koa实例
+ *
+ * 加载所有extend ， 可通过'app.extend.${文件}' 访问  没有多级路径
+ * 例子:
+ * app/extend
+ *    |
+ *    |-- custom-extend.js
+ * ====> app.extend.customExtend
+ *
+ */
+module.exports = (app) => {
+  // 1.读取 eplis/app/extend/**.js所有文件
+  const elpisExtendPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}extend`,
+  );
+  // 2.遍历所有js文件
+  const elpisFileList = glob.sync(
+    path.resolve(elpisExtendPath, `.${sep}**${sep}**.js`),
+  );
+
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 1.读取 业务/app/extend/**.js所有文件
+  const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`);
+  // 2.遍历所有js文件
+  const businessFileList = glob.sync(
+    path.resolve(businessExtendPath, `.${sep}**${sep}**.js`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+  function handleFile(file) {
+    // 3.1提取文件名称
+    let name = path.resolve(file);
+
+    // 3.2截取路径 app/extend/custom-extend.js =》custom-extend
+    name = name.substring(
+      name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 3.3 把 - 统一改为驼峰式
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 3.4 过滤 app 已经存在的key
+    for (const key in app) {
+      if (key === name) {
+        console.log(`[extend load error] name:${name} is already in app`);
+        return;
+      }
+    }
+    // 挂载extend 到 app 上
+    app[name] = require(file)(app);
+  }
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,84 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * middleware loader
+ * @param {object} app Koa实例
+ *
+ * 加载所有middleware ， 可通过'app.middleware.${目录}.${文件}' 访问
+ * 例子
+ * app/middleware
+ *  |
+ *  |-- custom-module
+ *         |
+ *         |-- custom-middleware.js
+ * ====> app.middleware.customModule.customMiddleware
+ */
+module.exports = (app) => {
+  const middlewares = {};
+  // 1. 读取 elpis/app/middleware/**/**.js所有文件
+  const elpisMiddlewarePath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}middleware`,
+  );
+  // 2. 遍历所有js文件
+  const elpisFileList = glob.sync(
+    path.resolve(elpisMiddlewarePath, `.${sep}**${sep}**.js`),
+  );
+  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`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 3. 遍历所有文件目录，把内容加载到 app.middlewares 下
+  function handleFile(file) {
+    // 3.1提取文件名称
+    let name = path.resolve(file);
+
+    // 3.2截取路径 app/middleware/custom-module/custom-middleware.js =》custom-module/custom-middleware
+    name = name.substring(
+      name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 3.3把 - 统一改为驼峰式
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 3.4根据文件夹构建嵌套对象
+    let tempMiddleware = middlewares;
+
+    // 3.5 分割/ 过滤空字符串 [customMoudle, customController]
+    const names = name.split(sep).filter(Boolean);
+    for (let i = 0, len = names.length; i < len; i++) {
+      const key = names[i];
+      // 最后一层，挂载中间件函数
+      if (i === len - 1) {
+        tempMiddleware[key] = require(file)(app);
+      } else {
+        // 不是最后一层，创建嵌套对象  假设 key为user  则tempMiddleware={user:{}} 也就是则tempMiddleware.user
+        if (!tempMiddleware[key]) {
+          tempMiddleware[key] = {};
+        }
+        // tempMiddleware就变为tempMiddleware.user ={}
+        tempMiddleware = tempMiddleware[key];
+      }
+      /**
+       * 第二层：key为app  则tempMiddleware={ user: { app: { } } } 也就是tempMiddleware.user.app
+       * 依次循环
+       */
+    }
+  }
+  // 4. 挂载    不能使用middleware因为koa内置已经有middleware
+  app.middlewares = middlewares;
+};

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

@@ -0,0 +1,56 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * router-schema loader
+ * @param {object} app Koa实例
+ *
+ *
+ * 通过 'json-schema & ajv' 对API规则进行约束，配合api-params-verify中间件使用
+ *  --- json-schema 是定义接口，接受什么参数、参数哪些是必传的，参数类型是什么，参数范围是什么
+ *  --- ajv 是校验json-schema
+ *
+ * app/router-schema/**.js
+ *
+ *  输出：
+ *  app.routerScheam = {
+ *      `${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`),
+  );
+  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`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+  // 注册所有 routerSchema，使得可以 'app.routerSchema’ 这样访问
+
+  function handleFile(file) {
+    // 因为每个接口路径不一样，所以通过扩展运算符的形式，将router-schema下的文件中的数据进行合并
+    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 glob = require("glob");
+const { sep } = path;
+
+/**
+ * router loader
+ * @param {*} app Koa实例
+ * 解析所有 app/router/ 下所有 js 文件，加载到 KoaRouter 下
+ */
+module.exports = (app) => {
+  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) => {
+    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) => {
+    require(path.resolve(file))(app, router);
+  });
+  
+
+  // 4. 路由兜底
+  router.get("*", async (ctx, next) => {
+    console.log("默认传递重定向的路由地址", app?.options?.homePage);
+
+    ctx.status = 302; // 临时重定向
+    ctx.redirect(`${app?.options?.homePage ?? "/"}`);
+  });
+
+  // 5. 路由注册到 app 上
+  app.use(router.routes());
+  app.use(router.allowedMethods());
+};

package/elpis-core/loader/service.js

@@ -0,0 +1,85 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * service loader
+ * @param {object} app Koa实例
+ *
+ * 加载所有service ， 可通过'app.service.${目录}.${文件}' 访问
+ * 例子
+ * app/service
+ *  |
+ *  |-- custom-module
+ *         |
+ *         |-- custom-service.js
+ * ====> app.service.customModule.customService
+ *
+ */
+module.exports = (app) => {
+  const service = {};
+
+  // 读取 app/service/**/**.js所有文件
+  const elpisServicePath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}service`,
+  );
+  // 遍历所有js文件
+  const elpisFileList = glob.sync(
+    path.resolve(elpisServicePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.service 下
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取 app/service/**/**.js所有文件
+  const businessServicePath = path.resolve(app.businessPath, `.${sep}service`);
+  // 遍历所有js文件
+  const businessFileList = glob.sync(
+    path.resolve(businessServicePath, `.${sep}**${sep}**.js`),
+  );
+  // 遍历所有文件目录，把内容加载到 app.service 下
+  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.substring(
+      name.lastIndexOf(`service${sep}`) + `service${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 - 统一改为驼峰式
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 根据文件夹构建嵌套对象
+    let tempService = service;
+
+    // 分割/ 过滤空字符串
+    const names = name.split(sep).filter(Boolean);
+    for (let i = 0, len = names.length; i < len; i++) {
+      const key = names[i];
+      // 最后一层，挂载中间件函数
+      if (i === len - 1) {
+        /**
+         * service返回的是一个构造对象(), 文件名作为键名，值为构造对象实例
+         */
+        const ServiceModule = require(file)(app);
+        // 存入的类型就是键值对，键为文件名，值为构造对象  例如：project: ProjectService{}
+        tempService[key] = new ServiceModule();
+      } else {
+        // 不是最后一层，创建嵌套对象  假设 key为user  tempService={user:{}} 也就是则tempService=.user
+        if (!tempService[key]) {
+          tempService[key] = {};
+        }
+        tempService = tempService[key];
+      }
+    }
+  }
+
+  app.service = service;
+};

package/index.js

@@ -0,0 +1,38 @@
+// 引入模块
+const ElpisCore = require("./elpis-core");
+
+// 引入前端工程化构建方法
+const FEBuildDev = require("./app/webpack/dev.js");
+const FEBuildProd = require("./app/webpack/prod.js");
+
+module.exports = {
+  /**
+   * 服务端基础
+   */
+  Controller: {
+    Base: require("./app/controller/base.js"),
+  },
+  Service: {
+    Base: require("./app/service/base.js"),
+  },
+  /**
+   * 编译构建前端工程
+   * @param {} env 环境变量 local/prod
+   */
+  frontendBuild(env) {
+    if (env === "local") {
+      FEBuildDev();
+    } else if (env === "prod") {
+      FEBuildProd();
+    }
+  },
+  /**
+   * 启动 elpis
+   * @param {Object} options 项目配置，透传到 elpis-core
+   * @returns
+   */
+  serverStart(options = {}) {
+    const app = ElpisCore.start(options);
+    return app;
+  },
+};