@pixel-shell/elpis 1.0.0

package/docs/dashboard-mode.js

@@ -0,0 +1,141 @@
+module.exports = {
+  mode: "dashboard", //模板类型，不同模板类型对应不一样的模板数据结构
+  name: "", //名称
+  desc: "", //描述
+  icon: "", //图标
+  homePage: "", // 首页路径
+  // 头部菜单配置
+  menu: [
+    {
+      key: "", //唯一标识
+      name: "", //菜单名称
+      menuType: "", //菜单类型，枚举值：'group'、'module'
+      // 当menuType为'group'时，子菜单列表
+      subMenu: [{}],
+      // 当menuType为'module'时，模块配置
+      moduleType: "", // 模块类型，枚举值：sider,iframe,custom,schema
+      // 当moduleType为sider时，模块配置
+      siderConfig: {
+        menu: [{}], // 侧边栏菜单列表
+      },
+      // 当moduleType为iframe时，模块配置
+      iframeConfig: {
+        path: "", // iframe路径
+      },
+      // 当moduleType为custom时，模块配置
+      customConfig: {
+        path: "", // 自定义路径
+      },
+      // 当moduleType为schema时，模块配置
+      schemaConfig: {
+        api: "", // 数据源API（遵循RESTful API规范）
+        schema: {
+          type: "object",
+          properties: {
+            key: {
+              ...schema, // 标准schema配置
+              type: "", // 字段类型
+              label: "", // 字段中文名
+              // 字段在table中的相关配置
+              tableOption: {
+                ...elTableColumnConfig, //标准 el-table-column 配置
+                toFixed: 0, // 数值类型字段保留的小数位数
+                visible: true, // 是否在table中显示
+              },
+              // 字段在search-bar中的相关配置
+              searchOption: {
+                ...elComponentConfig, //标准 el-component-column 配置
+                comType: "", // 配置组件类型 ，枚举值：input,select 。。。
+                defaule: "", // 默认值
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+
+                // comType === dynamic-select 时，相关配置
+                api: "", // 下拉选项API
+              },
+              // 字段在component中的相关配置,前缀对应componentConfig中的键值
+              // 如：componentConfig.createForm，这里对应 createFormOption
+              // 字段在createFormz中的相关配置
+              createFormOption: {
+                ...elComponentConfig, //标准 el-component 配置
+                comType: "", // 控件类型，枚举值：input,select 。。。
+                visible: true, // 是否显示
+                disabled: false, // 是否禁用
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+              },
+              // 字段在editForm中的相关配置
+              editFormOption: {
+                ...elComponentConfig, //标准 el-component 配置
+                comType: "", // 控件类型，枚举值：input,select 。。。
+                visible: true, // 是否显示
+                disabled: false, // 是否禁用
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+              },
+              detailPanelOption: {
+                ...elComponentConfig, //标准 el-component 配置
+              }
+            },
+          },
+          required: [], // 必填字段列表
+        },
+        tableConfig: {
+          headerButtons: [
+            {
+              label: "", // 按钮中文名
+              eventKey: "", // 按钮事件名
+              // 按钮事件具体配置
+              eventOption: {
+                // 当eventKey === "showComponent"
+                comName: "", // 组件名称
+              },
+              ...elButtonConfig, // 标准 el-button 配置
+            }
+          ], // 表格头部按钮列表
+          rowButtons: [
+            {
+              label: "", // 按钮中文名
+              eventKey: "", // 按钮事件名
+              eventOption: {
+                // 当eventKey === "showComponent"
+                comName: "", // 组件名称
+                // 当eventKey === 'remove
+                params: {
+                  // paramKey = 参数的键值
+                  // rowValueKey = 参数值(当格式为 schema::tableKey的时候， 到table中找相应的字段)
+                  paramKey: rowValueKey
+                }
+              }, // 按钮事件具体配置
+              ...elButtonConfig, // 标准 el-button 配置
+            }
+          ], // 表格行按钮列表
+        },
+        searchConfig: {},
+        // 动态组件相关配置
+        componentConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文本
+          },
+          // edit-form 表单相关配置
+          editForm: {
+            mainKey: "", // 主键字段名,用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文本
+          },
+          // detail-panel 相关配置
+          detailPanel: {
+            mainKey: "", // 主键字段名,用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+          },
+          // ...支持用户动态扩展
+        },
+      },
+    },
+  ],
+};

package/elpis-core/env.js

@@ -0,0 +1,16 @@
+module.exports = (app) => {
+  return {
+    isLocal: () => {
+      return process.env._ENV === "local";
+    },
+    isBeta: () => {
+      return process.env._ENV === "beta";
+    },
+    isProduction: () => {
+      return process.env._ENV === "production";
+    },
+    get: () => {
+      return process.env._ENV ?? "local";
+    }
+  }
+}

package/elpis-core/index.js

@@ -0,0 +1,70 @@
+const Koa = require("koa");
+const path = require("path");
+const { sep } = path;
+const env = require("./env");
+const configLoader = require("./loader/config");
+const extendLoader = require("./loader/extend");
+const serviceLoader = require("./loader/service");
+const controllerLoader = require("./loader/controller");
+const middlewareLoader = require("./loader/middleware");
+const routerSchemaLoader = require("./loader/roter-schema");
+const routerLoader = require("./loader/router");
+
+module.exports = {
+  /**
+   * 启动服务
+   * @param {Object} options 配置项
+   */
+  start(options = {}) {
+    // 创建koa实例
+    const app = new Koa();
+    // 应用配置
+    app.options = options;
+    // 基础路径
+    app.baseDir = options.baseDir || process.cwd();
+    // 业务文件路径
+    app.businessPath = path.resolve(app.baseDir, `.${sep}app`);
+    // 初始化环境配置
+    app.env = env();
+
+    // 加载config
+    configLoader(app);
+    // 加载extendLoader 
+    extendLoader(app);
+    // 加载service
+    serviceLoader(app);
+    // 加载controller
+    controllerLoader(app);
+    // 加载middleware
+    middlewareLoader(app);
+    // 加载routerSchema
+    routerSchemaLoader(app);
+
+    // 注册 elpis 全局中间件
+    const elpisMiddlewarePath = path.resolve(__dirname, `..${sep}app${sep}middleware.js`);
+    const elpisMiddleware = require(elpisMiddlewarePath);
+    elpisMiddleware(app);
+    console.log(`-- [start] load global elpis middleware done --`);
+
+    // 注册全局中间件
+    try {
+      require(`${app.businessPath}${sep}middleware.js`)(app);
+    } catch (error) {
+      console.log('[exception] there is no global business middleware file', error);
+    }
+
+    // 注册路由
+    routerLoader(app);
+
+    // 启动服务
+    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 at http://${host}:${port}`);
+    } catch (error) {
+      console.error(error);
+    }
+    return app;
+  },
+};

package/elpis-core/loader/config.js

@@ -0,0 +1,51 @@
+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 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 config.default 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("[exception] there is no env.config file");
+  }
+
+  // 覆盖加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,71 @@
+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 目录下的所有文件
+  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));
+  // 读取 业务根目录/app/controller 目录下的所有文件
+  const businessControllerPath = path.resolve(
+    app.businessPath,
+    `.${sep}controller`,
+  );
+  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 => customModule.customController
+    name = name.substring(
+      name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length,
+      name.lastIndexOf(".js"),
+    );
+
+    // 将文件名称转换为驼峰命名
+    name = name.replace(/-([a-z])/g, (all, letter) => letter.toUpperCase());
+
+    // 挂载 controller 到内存 app 对象中
+    let tempController = controller;
+    const names = name.split(sep);
+    for (let i = 0; i < names.length; i++) {
+      if (i === names.length - 1) {
+        const ControllerMoule = require(path.resolve(file))(app);
+        tempController[names[i]] = new ControllerMoule();
+      } else {
+        if (!tempController[names[i]]) {
+          tempController[names[i]] = {};
+        }
+        tempController = tempController[names[i]];
+      }
+    }
+  }
+  app.controller = controller;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,61 @@
+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) => {
+  // 读取 elpis/app/extend/**/**.js 目录下的所有文件
+  const elpisExtendPath = path.resolve(
+    __dirname,
+    `..${sep}..${sep}app${sep}extend`,
+  );
+  const elpisfileList = glob.sync(
+    path.resolve(elpisExtendPath, `.${sep}**${sep}*.js`),
+  );
+  // 遍历文件目录，把内容挂载到app.extend中
+  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`),
+  );
+  // 遍历文件目录，把内容挂载到app.extend中
+  businessFileList.forEach((file) => handleFile(file));
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/extend/custom-extend.js => custom-extend
+    name = name.substring(
+      name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length,
+      name.lastIndexOf(".js"),
+    );
+
+    // 将文件名称转换为驼峰命名
+    name = name.replace(/-([a-z])/g, (all, letter) => letter.toUpperCase());
+
+    // 过滤 app 已经存在的 key
+    for (const key in app) {
+      if (key === name) {
+        console.log(`[extend load error] name:${name} is already in app`);
+        return;
+      }
+    }
+
+    // 挂载到 app.extend 中
+    app[name] = require(path.resolve(file))(app);
+  }
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,69 @@
+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 = {};
+
+  // 读取 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.js => customModule.customMiddleware
+    name = name.substring(
+      name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,
+      name.lastIndexOf(".js"),
+    );
+
+    // 将文件名称转换为驼峰命名
+    name = name.replace(/-([a-z])/g, (all, letter) => letter.toUpperCase());
+
+    // 挂载 middleware 到内存 app 对象中
+    let tempMiddleware = middlewares;
+    const names = name.split(sep);
+    for (let i = 0; i < names.length; i++) {
+      if (i === names.length - 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/roter-schema.js

@@ -0,0 +1,54 @@
+const path = require("path");
+const { sep } = path;
+const glob = require("glob");
+/**
+ * router-schema loader
+ * @param {object} app - koa 实例
+ * 
+ * 通过 'json-schema & ajv' 对 API 规则进行约束，配合 api-params-verifier 中间件使用
+ * 
+ * app/router-schema/**.js
+    输出：
+    app.rouSchema = {
+      `${api1}: ${jsonSchema}`,
+      `${api2}: ${jsonSchema}`, 
+      `${api3}: ${jsonSchema}`, 
+      `${api4}: ${jsonSchema}`, 
+    }
+ */
+module.exports = (app) => {
+  // 注册 routerSchema
+  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);
+  });
+
+  const businessRouterSchemaPath = path.resolve(
+    app.businessPath,
+    `.${sep}router-schema`,
+  );
+  const businessFileList = glob.sync(
+    path.resolve(businessRouterSchemaPath, `.${sep}**${sep}*.js`),
+  );
+  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,42 @@
+const KoaRouter = require("koa-router");
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+
+/**
+ * router loader
+ * @param {object} app Koa 实例
+ *
+ * 解析多有 app/router/下所有 JS 文件, 加载到 KoaRouter 中
+ */
+
+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) => {
+    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);
+  });
+
+  // 路由兜底
+  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,70 @@
+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 = {};
+
+  // 读取 elpis/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));
+
+  function handleFile(file) {
+    // 提取文件名称
+    let name = path.resolve(file);
+
+    // 截取路径 app/service/custom-module/custom-service.js => customModule.customService
+    name = name.substring(
+      name.lastIndexOf(`service${sep}`) + `service${sep}`.length,
+      name.lastIndexOf(".js"),
+    );
+
+    // 将文件名称转换为驼峰命名
+    name = name.replace(/-([a-z])/g, (all, letter) => letter.toUpperCase());
+
+    // 挂载 service 到内存 app 对象中
+    let tempService = service;
+    const names = name.split(sep);
+    for (let i = 0; i < names.length; i++) {
+      if (i === names.length - 1) {
+        const ServiceMoule = require(path.resolve(file))(app);
+        tempService[names[i]] = new ServiceMoule();
+      } else {
+        if (!tempService[names[i]]) {
+          tempService[names[i]] = {};
+        }
+        tempService = tempService[names[i]];
+      }
+    }
+  }
+  app.service = service;
+};

package/index.js

@@ -0,0 +1,35 @@
+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")
+  },
+  /**
+   * 编译构建前端工程
+   * @params env 环境变量, dev 或 prod
+   */
+  frontendBuild(env) {
+    if(env === "local") {
+      FEBuildDev();
+    }else if(env === "production") {
+      FEBuildProd();
+    }
+  },
+  /**
+   * 启动elpis
+   * @params options 项目配置, 透传到elpis-core
+   */
+  serverStart(options={}) {
+    const app = ElpisCore.start(options);
+    return app;
+  }
+};