@codertqy/elpis 1.0.0

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+public/

package/.eslintrc

@@ -0,0 +1,55 @@
+{
+  "extends": [
+    "plugin:vue/base",
+    "plugin:vue/recommended"
+  ],
+  "plugins": ["vue"],
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "parser": "vue-eslint-parser",
+  "parserOptions": {
+    "parser": "babel-eslint",
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-unused-vars": [2, {"args": "none"}],
+    "strict": "off",
+    "valid-jsdoc": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-param-type": "off",
+    "jsdoc/check-param-names": "off",
+    "jsdoc/require-param": "off",
+    "jsdoc/check-tag-names": "off",
+    "linebreak-style": "off",
+    "array-bracket-spacing": "off",
+    "prefer-promise-reject-errors": "off",
+    "comma-dangle": "off",
+    "newline-per-chained-call": "off",
+    "no-loop-func": "off",
+    "no-empty": "off",
+    "no-else-return": "off",
+    "no-unneeded-ternary": "off",
+    "no-eval": "off",
+    "prefer-destructuring": "off",
+    "no-param-reassign": "off",
+    "max-len": "off",
+    "no-restricted-syntax": "off",
+    "no-plusplus": "off",
+    "no-useless-escape": "off",
+    "no-nested-ternary": "off",
+    "radix": "off",
+    "arrow-body-style": "off",
+    "arrow-parens": "off",
+    "vue/multi-word-component-names": "off",
+    "vue/valid-v-for": "off",
+    "vue/no-multiple-template-root": "off"
+  },
+  "globals": {
+    "$": true,
+    "axios": true,
+    "Vue": true
+  }
+}

package/README.md

@@ -0,0 +1,218 @@
+# elpis
+
+## 这是一个企业级应用框架,通过全栈实现
+
+### model 配置
+
+```javascript
+{
+  mode: "dashboard"; // 模版类型，不同模版类型对应不一样的模版数据结构
+  name: ""; // 名称
+  desc: ""; // 描述
+  icon: ""; // icon
+  homePgae: ""; // 首页(项目配置)
+  // 头部菜单 多个
+  menu: [
+    {
+      key: "", //菜单唯一描述
+      name: "", //菜单名称
+      menuType: "", // 枚举值：group / module
+
+      // 当 menuType === group 时，可填
+      subMenu: [
+        {
+          //   可递归 menuItem
+        },
+        // ... 表示多个
+      ],
+      // 当 menuType === module 时，可填
+      moduleType: "", // 枚举值：sider / iframe / custom / schema
+
+      //   当 moduleType === sider 时  左侧菜单
+      siderConfig: {
+        menu: [
+          {
+            // 可递归 menuItem ( 除 moduleType === sider)
+          },
+        ],
+      },
+      //   当 moduleType === iframe 时
+      iframeConfig: {
+        path: "", // iframe 路径
+      },
+      //   当 moduleType === custom 时
+      customConfig: {
+        path: "", // custom 路径
+      },
+      //   当 moduleType === schema 时
+      schemaConfig: {
+        api: "", // 数据源 API （遵循 RESTFUL 规范）
+        shcema: {
+          // 板块数据结构
+          type: "object",
+          properties: {
+            key: {
+              ...schema, // 标准 schema 配置
+              type: "", // 字段类型
+              tabel: "", // 字段的中文名
+              // 字段在 table 中的相关配置
+              tableOption: {
+                ...elTableColumnConfig, // 标准 el-table-column 配置
+                visiable: true, // 默认为 true (false ，表示不在表单中显示)
+                toFixed: 2,
+              },
+              // 字段在 search-abr 中的相关配置
+              searchOption: {
+                ...elComponentConfig, // 标准 el-component-column 配置 比如组件库中的input、form等
+                comType: "", // 配置组件类型 input/select/....
+                default: "", // 默认值
+
+                // comType ===='select'
+                enumList: [], // 下拉框可选项
+                // comType ===='dynamicSelect'
+                api: "", // 请求api获取
+              },
+              // 字段在不同状态 component 中的相关配置，前缀对应 componentConfig 中的键值
+              // 如：componentConfig.createForm 这里对应 createFormOption
+              // 字段在 createForm 中相关配置
+              createFormOption: {
+                ...elTableColumnConfig, // 标准 el-component-column 配置
+                comType: "", // 控件类型 input/select/....
+                visible: true, // 是否展示（true/false） 默认为 true
+                disabled: false, //是否禁用（true/false） 默认为 false
+                default: "", //默认值
+
+                // comType ===='select'时生效
+                enumList: [], //枚举列表
+              },
+
+              // 字段在 editForm 表单中的相关配置
+              editFormOption: {
+                ...elTableColumnConfig, // 标准 el-component-column 配置
+                comType: "", // 控件类型 input/select/....
+                visible: true, // 是否展示（true/false） 默认为 true
+                disabled: false, //是否禁用（true/false） 默认为 false
+                default: "", //默认值
+
+                // comType ===='select'时生效
+                enumList: [], //枚举列表
+              },
+              detailPanelOption: {
+                ...elTableColumnConfig, // 标准 el-component-column 配置
+              },
+            },
+          },
+          required: [], // 标记哪些字段是必填
+        },
+        // table 相关配置
+        tableConfig: {
+          // 多个
+          headerButtons: [
+            {
+              label: "", //按钮中文名
+              eventKey: "", // 按钮事件名
+              // 按钮事件具体操作配置
+              eventOption: {
+                // 当 eventKey === 'showComponent'
+                comName: "", //组件名称
+              },
+              ...elButtonConfig, // 标准 el-button 配置 样式外观
+            },
+          ],
+          // 多个
+          rowButtons: [
+            {
+              label: "", //按钮中文名
+              eventKey: "", // 按钮事件名
+              eventOption: {}, // 按钮事件具体操作配置
+
+              // 当 eventKey === 'showComponent'
+              comName: "", //组件名称
+
+              // 当eventKey === 'remove'
+              params: {
+                // paramKey 为参数的键
+                // rowValueKey 为参数值（当格式为 schema::xxx 的时候，到 table中找响应字段）
+                // user_id: schema::1
+                paramKey: rowValueKey,
+              },
+              ...elButtonConfig, // 标准 el-button 配置 样式外观
+            },
+          ],
+        },
+        // search-bar 相关配置
+        searchConfig: {},
+        // 动态组件 相关配置   模块组件
+        componentConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: "", // 表单标题
+            saveBtnText: "", //保存按钮文案
+          },
+          editForm: {
+            mainKey: "", //  表单主键，用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文案
+          },
+          // detail-panel 相关配置
+          detailPanel: {
+            mainKey: "", //  表单主键，用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+          },
+          // ...支持用户动态扩展
+        },
+      },
+    },
+  ];
+}
+```
+
+### 服务端启动
+
+```javascript
+const { serverStart } = require("@codertqy/elpis");
+
+// 启动 elpis 服务
+const app = serverStart({});
+```
+
+### 自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+
+```javascript
+const { frontendBuild } = require("@codertqy/elpis");
+
+// 编译构建前端工程
+frontendBuild(process.env._ENV);
+```
+
+### 自定义页面扩展
+
+- 在 `app/pages/` 目录下写入口 entry.xxx.js
+
+### dashboard/custom-view 自定义页面扩展
+
+- 在 `app/pages/dashboard/xxx` 下写页面
+
+### dashboard/schema-view/components 动态组件扩展
+
+1. 在 `app/pages/dashboard/complex-view/schema-view/components` 下写组件
+2. 配置到 `app/pages/dashboard/complex-view/schema-view/components/component-config.js`
+
+### dashboard/schema-view/components 动态组件扩展
+
+1. 在 `app/widgets/schema-form/complex-view` 下写控件
+2. 配置到 `app/widgets/schema-form/form-item-config.js`
+
+### dashboard/schema-view/components 动态组件扩展
+
+1. 在 `app/widgets/schema-search-bar/complex-view` 下写控件
+2. 配置到 `app/widgets/schema-search-bar/search-item-config.js`

package/app/controller/base.js

@@ -0,0 +1,40 @@
+module.exports = (app) => {
+  return class BaseController {
+    /**
+     * 基类
+     * 统一收拢 controller 相关的公共方法
+     */
+    constructor() {
+      this.app = app;
+      this.config = app.config;
+    }
+
+    /**
+     * API处理成功时统一返回结构
+     * @param {Object} ctx 上下文
+     * @param {Object} data 核心数据
+     * @param {Object} metadata 附加数据
+     */
+    success(ctx, data = {}, metadata = {}) {
+      ctx.status = 200;
+      ctx.body = {
+        success: true,
+        data,
+        metadata,
+      };
+    }
+    /**
+     * API处理失败时统一返回结构
+     * @param {Object} ctx 上下文
+     * @param {Object} message 错误信息
+     * @param {Object} code 错误码
+     */
+    error(ctx, message, code) {
+      ctx.body = {
+        success: false,
+        message,
+        code,
+      };
+    }
+  };
+};

package/app/controller/project.js

@@ -0,0 +1,81 @@
+/**
+ * 第二步：编写controller层 对数据进行处理
+ * @param {Object} app
+ * @returns
+ */
+
+module.exports = (app) => {
+  const BaseController = require("./base")(app);
+  return class ProjectController extends BaseController {
+    /**
+     * 根据 proj_key 获取项目配置
+     * @param {Object} ctx
+     */
+    async get(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: ProjectService } = app.service;
+      const projConfig = await ProjectService.get(projKey);
+      if (!projConfig) {
+        return this.error(ctx, "获取项目异常", 50000);
+      }
+      this.success(ctx, projConfig);
+    }
+    /**
+     * 获取当前 projKey 对应模型下的项目列表（如果无 projKey ，全量获取）
+     */
+    async getList(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: ProjectService } = app.service;
+      const projectList = await ProjectService.getList({ projKey });
+      // 构造关键数据 list
+      const dtoProjectList = projectList.map((item) => {
+        return {
+          modelKey: item.modelKey,
+          key: item.key,
+          name: item.name,
+          desc: item.desc,
+          homePage: item.homePage,
+        };
+      });
+
+      this.success(ctx, dtoProjectList);
+    }
+    /**
+     * 获取所有模型与项目的结构化数据
+     *
+     */
+    async getModelList(ctx) {
+      const { project: ProjectService } = app.service;
+      const modelList = await ProjectService.getModelList();
+
+      // 构造返回结构，只返回关键数据
+      const dtoModelList = modelList.reduce((preList, item) => {
+        const { model, project } = item;
+
+        // 构造 model 关键数据
+        const { key, name, desc } = model;
+        const dtoModel = { key, name, desc };
+
+        // 构造 project 关键数据
+        const dtoProject = Object.keys(project).reduce((preObj, projKey) => {
+          const { key, name, desc, homePage } = project[projKey];
+          preObj[projKey] = { key, name, desc, homePage };
+          return preObj;
+        }, {});
+        // for (const projKey in project) {
+        //   const { key, name, desc, homePage } = project[projKey];
+        //   dtoProject[projKey] = { key, name, desc, homePage };
+        // }
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject,
+        });
+
+        return preList;
+      }, []);
+
+      this.success(ctx, dtoModelList);
+    }
+  };
+};

package/app/controller/view.js

@@ -0,0 +1,22 @@
+module.exports = (app) => {
+  return class ViewController {
+    /**
+     * 渲染页面
+     * @param {*} ctx 上下文
+     */
+    async renderPage(ctx) {
+      const { query, params } = ctx.request;
+      app.logger.info(`[ViewController] query: ${JSON.stringify(query)}`);
+      app.logger.info(`[ViewController] params: ${JSON.stringify(params)}`);
+      // 拿到用户传递的page1，page2  ,第二个参数可以是给页面传递的一些值
+      await ctx.render(`dist/entry.${ctx.params.page}`, {
+        // 通过 SSR 的形式注入到页面中
+        projKey: ctx.query?.proj_key,
+        // 因为options的一些配置已经挂载到app上
+        name: app.options?.name,
+        env: app.env.get(),
+        options: JSON.stringify(app.options),
+      });
+    }
+  };
+};

package/app/extend/logger.js

@@ -0,0 +1,43 @@
+const log4js = require("log4js");
+
+/**
+ * 日志工具
+ * 外部调用 因为是通过app[name]的方式挂载的，所以可以直接.调用
+ *  在之后使用console打印，都使用app.logger.对应的信息
+ * 如果是本地，经过转换就是console.log
+ * 如果不是本地，则直接调用log4js上的方法，带有时间
+ * @param {Object} app
+ * @returns
+ */
+module.exports = (app) => {
+  let logger;
+  if (app.env.isLocal()) {
+    // 打印在控制台
+    logger = console;
+  } else {
+    // 把日志输出并落地到磁盘（日志落盘）
+    log4js.configure({
+      appenders: {
+        console: {
+          type: "console",
+        },
+        // 日志文件切分
+        dateFile: {
+          type: "dateFile",
+          filename: "./logs/application.log",
+          pattern: ".yyyy-MM-dd",
+        },
+      },
+      categories: {
+        default: {
+          appenders: ["console", "dateFile"],
+          level: "trace",
+        },
+      },
+    });
+
+    logger = log4js.getLogger();
+  }
+
+  return logger;
+};

package/app/middleware/api-params-verify.js

@@ -0,0 +1,73 @@
+const Ajv = require("ajv");
+const ajv = new Ajv();
+
+/**
+ * API 参数校验
+ * @param {Object} app
+ */
+module.exports = (app) => {
+  const $schema = "http://json-schema.org/draft-07/schema#";
+
+  return async (ctx, next) => {
+    // 只对 API 做参数校验
+    if (ctx.path.indexOf("/api") < 0) {
+      return await next();
+    }
+    // 获取请求参数
+    const { body, query, headers } = ctx.request;
+    const { path, params, method } = ctx;
+    app.logger.info(`[${method} ${path}] body: ${JSON.stringify(body)}`);
+    app.logger.info(`[${method} ${path}] query: ${JSON.stringify(query)}`);
+    app.logger.info(`[${method} ${path}] params: ${JSON.stringify(params)}`);
+    app.logger.info(`[${method} ${path}] headers: ${JSON.stringify(headers)}`);
+
+    const schema = app.routerSchema[path]?.[method.toLowerCase()];
+    if (!schema) {
+      return await next();
+    }
+
+    let valid = true;
+
+    // ajv校验器
+    let validate;
+
+    // 校验headers
+    if (valid && headers && schema.headers) {
+      schema.headers.$schema = $schema;
+      //   解析
+      validate = ajv.compile(schema.headers);
+      //   校验用户传递的值校验
+      valid = validate(headers);
+    }
+    // 校验body
+    if (valid && body && schema.body) {
+      schema.body.$schema = $schema;
+
+      validate = ajv.compile(schema.body);
+      valid = validate(body);
+    }
+    // 校验query
+    if (valid && query && schema.query) {
+      schema.query.$schema = $schema;
+      validate = ajv.compile(schema.query);
+      valid = validate(query);
+    }
+    // 校验params
+    if (valid && params && schema.params) {
+      schema.params.$schema = $schema;
+      validate = ajv.compile(schema.params);
+      valid = validate(params);
+    }
+
+    if (!valid) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 442,
+        message: `request validate fail: ${ajv.errorsText(validate.errors)}`,
+      };
+      return;
+    }
+    await next();
+  };
+};

package/app/middleware/api-sign-verify.js

@@ -0,0 +1,49 @@
+const md5 = require("md5");
+
+/**
+ * API 签名合法性校验中间件
+ * @param {Object} app
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 只对 API 请求做签名校验，针对页面的请求路径不会拦截处理
+    if (ctx.path.indexOf("/api") < 0) {
+      return await next();
+    }
+    // 解析请求的路径和方式
+    const { path, method } = ctx;
+    // 拿到请求头的信息
+    const { headers } = ctx.request;
+    // 解析请求的签名和时间戳
+    const { s_sign: sSign, s_t: st } = headers;
+
+    // 后端根据秘钥与前端请求的时间戳生成签名
+    const signKey = "bgkjibal2kbhkc4vbakjl3sdvhja";
+    const signature = md5(`${signKey}_${st}`);
+
+    app.logger.info(`[${method} ${path}] signature: ${signature}}`);
+
+    /**
+     * 校验：有一个为真的都会校验失败，返回报错信息
+     *  1. 签名是否为空
+     *  2. 时间戳是否为空
+     *  3. 后端生成的签名与前端生成的签名是否一致
+     *  4. 时间戳是否超时
+     */
+    if (
+      !sSign ||
+      !st ||
+      (signature !== sSign.toLowerCase()) | (Date.now() - st > 600000)
+    ) {
+
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 445,
+        message: "signature no correct or timeout !!!!",
+      };
+      return;
+    }
+    await next();
+  };
+};

package/app/middleware/error-handler.js

@@ -0,0 +1,31 @@
+/**
+ * 运行时异常错误处理，兜底所有异常
+ * @param {Object} app koa实例 ctx是Koa的上下文对象，是Koa框架融合了req与res以及封装便捷属性和方法
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    try {
+      await next();
+    } catch (error) {
+      // 异常处理
+      const { status, message, detail } = error;
+      app.logger.info(JSON.stringify(error));
+      app.logger.error("[-- expection --]", error);
+      app.logger.error("[-- expection --]", status, message, detail);
+
+      if (message && message.indexOf("template not found") > -1) {
+        // 进行页面临时重定向 不是301永久的，301除非清缓存
+        ctx.status = 302;
+        ctx.redirect(`${app.options?.homePage}`);
+        return;
+      }
+      const resBody = {
+        success: false,
+        code: 500000,
+        message: "网络异常，请稍后重试",
+      };
+      ctx.status = 200;
+      ctx.body = resBody;
+    }
+  };
+};

package/app/middleware/project-handler.js

@@ -0,0 +1,26 @@
+/**
+ * projectHandler 项目相关处理内容
+ * @param {Object} app
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 只针对 业务API 进行 proj_key 处理
+    if (ctx.path.indexOf("/api/projk") < 0) {
+      return await next();
+    }
+    // 获取 projKey
+    const { proj_key: projKey } = ctx.request.headers;
+
+    if (!projKey) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 446,
+        message: "proj_key not found",
+      };
+      return;
+    }
+    ctx.projKey = projKey;
+    await next();
+  };
+};

package/app/middleware.js

@@ -0,0 +1,44 @@
+const path = require("path");
+/**
+ * 注册全局中间件，利用Koa实例，进行注册
+ * @param {Object} app
+ */
+module.exports = (app) => {
+  // 配置静态根目录
+  const koaStatic = require("koa-static");
+  app.use(koaStatic(path.resolve(process.cwd(), "./app/public")));
+  // 模版渲染引擎
+  const koaNunjucks = require("koa-nunjucks-2");
+  app.use(
+    koaNunjucks({
+      ext: "tpl", // 有动态数据，并且有服务端注入的。方便后续tsx方式编写
+      path: path.resolve(process.cwd(), "./app/public"),
+      nunjucksConfig: {
+        noCache: true,
+        trimBlocks: true, //去掉多余的行
+      },
+    }),
+  );
+
+  // 引入 ctx.body 解析中间件
+  const bodyParser = require("koa-bodyparser");
+  app.use(
+    bodyParser({
+      formLimit: "1000mb",
+      enableTypes: ["form", "json", "text"],
+    }),
+  );
+
+  // 异常捕获引入
+  app.use(app.middlewares.errorHandler);
+
+  // 请求签名合法性校验，限制请求频率
+  app.use(app.middlewares.apiSignVerify);
+
+  // API请求参数校验  params在 handler 链中临时存在，一旦路由执行完毕就清空
+  // 所以下面这段代码注册在router.routes()之后，不在handler链中，拿不到params
+  app.use(app.middlewares.apiParamsVerify);
+
+  // 引入 项目处理中间价
+  app.use(app.middlewares.projectHandler);
+};