@isxiaoyuan/elpis 1.0.0

package/app/webpack/prod.js

@@ -0,0 +1,22 @@
+const webpack = require("webpack");
+const webpackProdConfig = require("./config/webpack.prod.js");
+
+module.exports = () => {
+  console.log("\nbuilding...\n");
+  webpack(webpackProdConfig, (err, stats) => {
+    if (err) {
+      console.log(err);
+      return;
+      // throw err;
+    }
+    process.stdout.write(
+      `${stats.toString({
+        colors: true, //在控制台输出色彩信息
+        modules: false, //不显示每个模块打包信息
+        children: false, //不显示子编译任务的信息
+        chunk: false, //不显示每个chunk（代码块）的详细信息
+        chunkModules: true, //显示每个chunk（代码块）包含的模块信息
+      })}\n`,
+    );
+  });
+};

package/config/config.beta.js

@@ -0,0 +1,3 @@
+module.exports = {
+  name: "isYuan1",
+};

package/config/config.default.js

@@ -0,0 +1,3 @@
+module.exports = {
+  name: "isYuan",
+};

package/config/config.prod.js

@@ -0,0 +1,3 @@
+module.exports = {
+  name: "isYuan3",
+};

package/elpis-core/env.js

@@ -0,0 +1,20 @@
+module.exports = (app) => {
+  return {
+    // 判断是否本地环境
+    isLocal() {
+      return process.env._ENV === "local";
+    },
+    // 判断是否测试环境
+    isBeta() {
+      return process.env._ENV === "beta";
+    },
+    // 判断是否生产环境
+    isProd() {
+      return process.env._ENV === "prod";
+    },
+    // 判断是否当前环境
+    get() {
+      return process.env._ENV ?? "local";
+    },
+  };
+};

package/elpis-core/index.js

@@ -0,0 +1,97 @@
+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 serviceLoader = require("./loader/service");
+const configLoader = require("./loader/config");
+const extendLoader = require("./loader/extend");
+
+module.exports = {
+  /**
+   * 启动服务
+   * @param {Object} options - 启动选项
+   * @param {name} options.name - 项目名称
+   * @param {homePath} options.homePath - 项目跳转路径，默认值为 "/"
+   * @param {number} options.port - 端口号，默认值为 8080
+   * @param {string} options.host - 主机名，默认值为 "0.0.0.0"
+   */
+  start(options = {}) {
+    // koa实例
+    const app = new Koa();
+
+    // 应用配置
+    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] load middleware done --`);
+
+    // 加载 router schema
+    routerSchemaLoader(app);
+    console.log(`-- [start] load routerSchema done --`);
+
+    // 加载 controller
+    controllerLoader(app);
+    console.log(`-- [start] load controller done --`);
+
+    // 加载 service
+    serviceLoader(app);
+    console.log(`-- [start] load service done --`);
+
+    // 加载 config
+    configLoader(app);
+    console.log(`-- [start] load config done --`);
+
+    // 加载 extend
+    extendLoader(app);
+    console.log(`-- [start] load extend done --`);
+
+    // app/middleware.js
+    // 注册elpis全局中间件
+    const elpisMiddlewarePath = path.resolve(
+      __dirname,
+      `..${sep}app${sep}middleware.js`,
+    );
+    const elpisMiddleware = require(elpisMiddlewarePath);
+    elpisMiddleware(app);
+    console.log(`-- [start] load gloval elpis appMiddleware done --`);
+
+    // 注册业务全局中间件
+    try {
+      require(`${app.businessPath}${sep}middleware.js`)(app);
+      console.log(`-- [start] load gloval business appMiddleware done --`);
+    } catch (error) {
+      console.log("[business] is not middleware file");
+    }
+
+    // 注册路由
+    routerLoader(app);
+    console.log(`-- [start] load 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 is running on ${port}`);
+    } catch (error) {
+      console.error("Error starting server:", error);
+    }
+    return app;
+  },
+};

package/elpis-core/loader/config.js

@@ -0,0 +1,66 @@
+/**
+ * 配置文件加载器 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
+ 
+ */
+
+const path = require("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`);
+
+  // let defaultConfig = {};
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`)),
+    };
+  } catch (error) {
+    console.log("default.config not found");
+  }
+
+  //获取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.isProd()) {
+      envConfig = require(
+        path.resolve(businessConfigPath, `.${sep}config.prod.js`),
+      );
+    }
+    // envConfig = require(
+    //   path.resolve(configPath, `.${sep}config.${app.env.get()}.js`),
+    // );
+  } catch (error) {
+    console.log(`env.config not found: ${app.env.get()}`);
+  }
+  //覆盖并加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+  console.log("app.config ", envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,86 @@
+/**
+ * middleware loader
+ * @param {object} app koa 实例
+ *
+ * 加载所有 controller, 可通过 'app.controller.${目录}.${文件}' 访问
+ * 
+    例子：
+    app/
+    ├── controller
+    │   ├── auth.js
+    │   └── logger.js
+    =>
+    app.controller.auth
+    app.controller.logger
+ *   
+ */
+
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+module.exports = (app) => {
+  const controller = {};
+
+  // 读取 app/controller/**/**.js 下所有文件
+  const elpisControllerPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}controller`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`),
+  );
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 业务/controller/**/**.js 下所有文件
+  const businessControllerPath = path.resolve(
+    app.businessPath,
+    `.${sep}controller`,
+  );
+  const businessFileList = glob.sync(
+    path.resolve(businessControllerPath, `.${sep}**${sep}**.js`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // const fileList = glob.sync(
+  //   path
+  //     .resolve(app.businessPath, `**${sep}controller${sep}**${sep}**.js`)
+  //     .replace(/\\/g, "/"),
+  // );
+  //吧内容加载到 app.controller 下
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/controller/custom-module/custom-controller => custom-module/custom-controller
+    name = name.substring(
+      name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 ’-‘ 统一改为驼峰式 custom-module/custom-controller => customModule/customController
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 挂载 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 ControllerModule = require(path.resolve(file))(app);
+        tempController[names[i]] = new ControllerModule();
+      } else {
+        // 文件夹
+        if (!tempController[names[i]]) {
+          tempController[names[i]] = {};
+        }
+        tempController = tempController[names[i]];
+      }
+    }
+  }
+  app.controller = controller;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,66 @@
+/**
+ * extend loader
+ * @param {object} app koa 实例
+ *
+ * 加载所有 extend, 可通过 'app.extend.${文件}' 访问
+ * 
+    例子： 无多级目录
+    app/
+    ├── extend
+    │   ├── custom-extend.js
+    => app.extend.customExtend
+ *   
+ */
+
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+module.exports = (app) => {
+  // 读取 app/extend/**.js 下所有文件
+  const elpisExtendPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}extend`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisExtendPath, `.${sep}**${sep}**.js`),
+  );
+  elpisFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // 读取 业务app/extend/**.js 下所有文件
+  const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`);
+  const businessFileList = glob.sync(
+    path.resolve(businessExtendPath, `.${sep}**${sep}**.js`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+  //吧内容加载到 app.extend 下
+  // const extend = {};
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/extend/custom-module/custom-extend => custom-module/custom-extend
+    name = name.substring(
+      name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 ’-‘ 统一改为驼峰式 custom-module/custom-extend => customModule/customExtend
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 过滤app已经存在key
+    for (const key in app) {
+      if (key === name) {
+        console.log(`extend ${name} 已存在`);
+        // throw new Error(`extend ${name} 已存在`);
+        return;
+      }
+    }
+    app[name] = require(path.resolve(file))(app);
+  }
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,74 @@
+/**
+ * middleware loader
+ * @param {object} app koa 实例
+ *
+ * 加载所有 middleware, 可通过 'app.middleware.${目录}.${文件}' 访问
+ *
+ *    例子：
+ *    app/
+ *    ├── middleware
+ *    │   ├── auth.js
+ *    │   └── logger.js
+ *    =>
+ *    app.middleware.auth
+ *    app.middleware.logger
+ *
+ */
+
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+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`),
+  );
+  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));
+
+  //吧内容加载到 app.middleware 下
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/middleware/custom-module/custom-middleware => custom-module/custom-middleware
+    name = name.substring(
+      name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 ’-‘ 统一改为驼峰式 custom-module/custom-middleware => customModule/customMiddleware
+    // name = name.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 挂载 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);
+      } else {
+        if (!tempMiddleware[names[i]]) {
+          tempMiddleware[names[i]] = {};
+        }
+        tempMiddleware = tempMiddleware[names[i]];
+      }
+    }
+  }
+  app.middlewares = middlewares;
+};

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

@@ -0,0 +1,56 @@
+/**
+ * router-schema loader
+ * @param {object} app koa 实例
+ *
+ * 通过 ’json-schema & ajv‘(工具)  对api规则进行约束，配合 api-params-verify 中间件使用
+ *
+ *   app/router-schema/**.js
+   输出：
+   app.rouSchema = {
+    '${app1}': ${jsonSchema1},
+    '${app2}': ${jsonSchema2},
+   }
+ */
+
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+module.exports = (app) => {
+  let routerSchema = {};
+
+  // 读取 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);
+  });
+
+  //注册所有 router-schema  使得可以 ’app.routerSchema‘ 这样访问
+  function handleFile(file) {
+    routerSchema = {
+      ...routerSchema,
+      ...require(path.resolve(file)),
+    };
+  }
+
+  // 挂载 router-schema 到内存app中
+  app.routerSchema = routerSchema;
+};

package/elpis-core/loader/router.js

@@ -0,0 +1,49 @@
+const KoaRouter = require("koa-router");
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+/**
+ * 加载路由 router loader
+ * @param {object} app koa 实例
+ *
+ * 解析所有app/router/ 下所有 js 文件 加载到 KoaRouter 下
+ */
+
+module.exports = (app) => {
+  // 实例化 KoaRouter
+  const router = new KoaRouter();
+  // 找到路由文件路径
+  const elpisRouterPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}router`,
+  );
+  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) => {
+    //module.exports = (app.router) => router.get('xxxx/xx/xx/x/x',xxxcontroller)
+    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()); //处理405 501
+};

package/elpis-core/loader/service.js

@@ -0,0 +1,82 @@
+/**
+ * service loader
+ * @param {object} app koa 实例
+ *
+ * 加载所有 service, 可通过 'app.service.${目录}.${文件}' 访问
+ *
+ *    例子：
+ *    app/
+ *    ├── service
+ *    │   ├── auth.js
+ *    │   └── logger.js
+ *    =>
+ *    app.service.auth
+ *    app.service.logger
+ *
+ */
+
+const glob = require("glob");
+const path = require("path");
+const { sep } = path;
+
+module.exports = (app) => {
+  const service = {};
+
+  // 读取 app/service/**/**.js 下所有文件
+  const elpisServicePath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}service`,
+  );
+  const elpisFileList = glob.sync(
+    path.resolve(elpisServicePath, `.${sep}**${sep}**.js`),
+  );
+  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`),
+  );
+  businessFileList.forEach((file) => {
+    handleFile(file);
+  });
+
+  // const fileList = glob.sync(
+  //   path
+  //     .resolve(app.businessPath, `**${sep}service${sep}**${sep}**.js`)
+  //     .replace(/\\/g, "/"),
+  // );
+  //吧内容加载到 app.service 下
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/service/custom-module/custom-service => custom-module/custom-service
+    name = name.substring(
+      name.lastIndexOf(`service${sep}`) + `service${sep}`.length,
+      name.lastIndexOf("."),
+    );
+
+    // 把 ’-‘ 统一改为驼峰式 custom-module/custom-service => customModule/customService
+    // name = name.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+
+    // 挂载 service 到内存app中
+    let tempService = service;
+    const names = name.split(sep);
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i === len - 1) {
+        const ServiceModule = require(path.resolve(file))(app);
+        tempService[names[i]] = new ServiceModule();
+      } else {
+        if (!tempService[names[i]]) {
+          tempService[names[i]] = {};
+        }
+        tempService = tempService[names[i]];
+      }
+    }
+  }
+  app.service = service;
+};

package/index.js

@@ -0,0 +1,42 @@
+//引入eplis-core
+const ElpisCore = require("./elpis-core");
+// 引入前端工程化构建方法
+const FEBulidDev = require("./app/webpack/dev.js");
+const FEBulidProd = require("./app/webpack/prod.js");
+
+module.exports = {
+  /**
+   * 服务端基础
+   */
+  Controller: {
+    Base: require("./app/controller/base.js"),
+  },
+  Service: {
+    Base: require("./app/service/base.js"),
+  },
+
+  /**
+   *
+   * 编译构建前端工程
+   * @params env 环境变量，local 或 prod
+   */
+  frontendBuild(env) {
+    if (env === "local") {
+      FEBulidDev();
+    } else if (env === "prod") {
+      FEBulidProd();
+    } else {
+      throw new Error("env must be local or prod");
+    }
+  },
+  /**
+   *
+   * 启动elpis
+   * @params options 项目配置，透传到 elpis-core
+   */
+
+  serverStart(options = {}) {
+    const app = ElpisCore.start(options);
+    return app;
+  },
+};