@isxiaoyuan/elpis 1.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+public/
+docs/

package/.eslintrc

@@ -0,0 +1,52 @@
+{
+  "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/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "files.associations": {
+    "*.tpl": "html"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "vscode.html-language-features"
+  }
+}

package/REMADE.md

@@ -0,0 +1,228 @@
+# elpis
+
+## 一个企业级应用框架，通过全栈实现。
+
+### model配置
+
+```javascript
+{
+  mode: "dashboard", //模板类型，不同模板类型对应不同的模板数据结构
+  name: "", // 名称
+  desc: "", // 描述
+  icon: "", // 图标
+  homePage: "", // 看板首页路由
+  // 头部菜单
+  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: "", // 自定义路由路径
+      },
+      //当 moduleType === schema 时，可填
+      schemaConfig: {
+        api: "", // 数据源API (遵循 RESTFUL 规范)
+        schema: {
+          // 板块数据结构
+          type: "object",
+          properties: {
+            key: {
+              ...schema,
+              type: "", // 字段类型
+              label: "", // 字段中文名
+              // 字段在table 中的相关配置
+              tableOption: {
+                ...elTableColumnConfig, // 标准 el-table-cloumn 配置
+                toFixed: 0, // 数字类型字段保留小数位数
+                visible: true, // 是否在 table 中显示(不配置就展示)
+              },
+              // 字段在 search-bar 中的相关配置
+              searchOption: {
+                ...eleComponentConfig, // 标准 el-component-cloumn 配置
+                comType: "", // 配置控件类型
+                default: "", // 默认值
+
+                // 当 comType === select 时，可填
+                enumList: [
+                  // {
+                  //   value: "", // 选项值
+                  //   label: "", // 选项中文名
+                  // },
+                ],
+
+                // 当 comType === dynamic-select 时，可填
+                api: "", // 动态获取选项列表的 API
+              },
+              // create-form 表单相关配置
+              // 字段在不同动态 component 中的相关配置 前置对应componentConfig 中的键值
+              // 如： componentConfig.createForm 这里对应 createFormOption
+              createFormOption: {
+                ...elComponentConfig, // 标准 el-component-cloumn 配置
+                comType: "", // 配置控件类型
+                visible: true, // 是否在 create-form 中显示(不配置就展示)
+                disabled: false, // 是否禁用
+                default: "", // 默认值
+
+                // 当 comType === select 时，可填
+                enumList: [
+                  // {
+                  //   value: "", // 选项值
+                  //   label: "", // 选项中文名
+                  // },
+                ],
+              },
+              // edit-form 表单相关配置
+              editFormOption: {
+                ...elComponentConfig, // 标准 el-component-cloumn 配置
+                comType: "", // 配置控件类型
+                visible: true, // 是否在 edit-form 中显示(不配置就展示)
+                disabled: false, // 是否禁用
+                default: "", // 默认值
+
+                // 当 comType === select 时，可填
+                enumList: [],
+              },
+              detailPanelOption: {
+                ...elComponentConfig, // 标准 el-component-cloumn 配置
+                // visible: true,
+              },
+            },
+          },
+          required: [], // 必须字段
+        },
+        // tabel 相关配置
+        tableConfig: {
+          headerButtons: [
+            {
+              label: "", // 按钮中文名
+              evenKey: "", // 按钮事件名
+              // 按钮具体配置
+              eventOption: {
+                // 当 eventKey === 'showComponent'
+                comName: "", // 组件名称
+              },
+              ...elButtonConfig, // 标准 el-button 配置
+            },
+          ],
+          rowButtons: [
+            {
+              label: "", // 按钮中文名
+              evenKey: "", // 按钮事件名
+              eventOption: {
+                // 当 eventKey === 'showComponent'
+                comName: "", // 组件名称
+
+                // 当eventKey === remove
+                params: {
+                  // paramKey 参数的键值
+                  // rowValueKey 参数值(当格式为 schema:xxx 的时候，到 table 中找响应的字段)
+                  paramKey: rowValueKey,
+                },
+              }, // 按钮具体配置
+              ...elButtonConfig, // 标准 el-button 配置
+            },
+          ],
+        },
+        searchConfig: {}, // search-bar 相关配置
+        // 模块组件 动态组件
+        componentsConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文案
+          },
+          // edit-form 表单相关配置
+          editForm: {
+            mainKey: "", // 表单主键， 用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文案
+          },
+          // detail-panel 相关配置
+          detailPanel: {
+            mainKey: "", // 详情面板主键， 用于唯一标识要展示的数据对象
+            title: "", // 详情面板标题
+          },
+          // ...支持用户动态扩展其他组件配置
+        },
+      },
+    },...
+  ],
+};
+
+```
+
+### 服务端启动
+
+```javascript
+const { serverStart } = require("@isyuan/elpis");
+
+// 启动 elpis 服务
+
+const app = serverStart();
+```
+
+### 自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+
+```javascript
+const { frontendBuild } = require("@isyuan/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`
+
+### schema-form 控件扩展
+
+1. 在 `app/pages/widgets/schema-form/complex-view` 下写控件
+2. 配置到 `app/pages/widgets/schema-form/complex-view/component-config.js`
+
+### schema-search-bar 控件扩展
+
+1. 在 `app/pages/widgets/schema-search-bar/complex-view` 下写控件
+2. 配置到 `app/pages/widgets/schema-search-bar/complex-view/component-config.js`

package/app/controller/base.js

@@ -0,0 +1,43 @@
+module.exports = (app) =>
+  class BaseController {
+    /**
+     * controller 基类
+     * 统一收拢 controller 中的公共方法
+     * @param {object} app koa 实例
+     */
+    constructor() {
+      this.app = app;
+      this.config = app.config;
+      //   this.service = app.service;
+    }
+
+    /**
+     * 成功响应
+     * @param {object} ctx 上下文
+     * @param {object} data 数据
+     * @param {object} metadata 附加数据
+     */
+    success(ctx, data = {}, metadata = {}) {
+      ctx.status = 200;
+      ctx.body = {
+        success: true,
+        data,
+        metadata,
+      };
+    }
+
+    /**
+     * 失败响应
+     * @param {object} ctx 上下文
+     * @param {string} message 错误信息
+     * @param {number} code 错误码
+     */
+    fail(ctx, message, code) {
+      ctx.status = 400;
+      ctx.body = {
+        success: false,
+        message,
+        code,
+      };
+    }
+  };

package/app/controller/project.js

@@ -0,0 +1,106 @@
+module.exports = (app) => {
+  const BaseController = require("./base")(app);
+  return class ProjectController extends BaseController {
+    /**
+     * 根据 proj_Key 获取项目配置
+     * @param {object} ctx 上下文
+     */
+
+    get(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projConfig = projectService.get(projKey);
+
+      if (!projConfig) {
+        this.fail(ctx, "获取项目异常", 50000);
+        return;
+      }
+      this.success(ctx, projConfig);
+    }
+
+    /**
+     * 获取当前 projKey 对应模型下的项目列表(如果无 projKey, 全量获取)
+     * @param {object} ctx 上下文
+     */
+    getList(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projectList = projectService.getList({ projKey });
+
+      //构造关键数据 list
+      const dtoProjectList = projectList.map((item) => {
+        const { modelKey, key, name, desc, homePage } = item;
+        return {
+          modelKey,
+          key,
+          name,
+          desc,
+          homePage,
+        };
+      });
+
+      // for (let i = 0; i < projectList.length; ++i) {
+      //   const item = projectList[i];
+      //   const { key, name, desc, homePage } = item;
+      //   dtoProjectList.push({
+      //     key,
+      //     name,
+      //     desc,
+      //     homePage,
+      //   });
+      // }
+      // const dtoProjectList = projectList.reduce((preList, item) => {
+      //   const { key, name, desc, homePage } = item;
+      //   preList.push({
+      //     key,
+      //     name,
+      //     desc,
+      //     homePage,
+      //   });
+      //   return preList;
+      // }, []);
+      this.success(ctx, dtoProjectList);
+    }
+    /**
+     * 获取所有项目与项目的结构化数据
+     * @param {object} ctx 上下文
+     */
+    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;
+        }, {});
+        // const dtoProject = {};
+        // 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,21 @@
+module.exports = (app) => {
+  return class ViewController {
+    /**
+     * 渲染页面
+     * @param {object} ctx 上下文
+     */
+    async renderPage(ctx) {
+      const { query } = ctx.request;
+      const { params } = ctx;
+      app.logger.info(`[ViewController] query: ${JSON.stringify(query)}`);
+      app.logger.info(`[ViewController] chapters: ${JSON.stringify(params)}`);
+
+      await ctx.render(`dist/entry.${params.page}`, {
+        projKey: query?.proj_key,
+        name: app.options?.name,
+        env: app.env.get(),
+        options: JSON.stringify(app.options),
+      });
+    }
+  };
+};

package/app/extend/logger.js

@@ -0,0 +1,36 @@
+const log4js = require("log4js");
+
+/**
+ *
+ * 日志工具
+ * 外部调用 app.logger.info.logger.error
+ */
+
+module.exports = (app) => {
+  let logger;
+  if (app.env.isLocal()) {
+    //打印在控制台即可
+    logger = console;
+  } else {
+    // 把日志输出落地到磁盘 （日志落盘）
+    log4js.configure({
+      // 第一步：定义日志输出器（Appenders）—— 日志要输出到哪里
+      appenders: {
+        console: { type: "console" },
+        // 日志文件切分
+        dateFile: {
+          type: "dateFile", // 输出器类型：按日期自动切分文件
+          filename: "./logs/application.log",
+          pattern: ".yyyy-MM-dd",
+          alwaysIncludePattern: true, // 输出器类型：按日期自动切分文件
+        },
+        // file: { type: "file", filename: "app.log" },
+      },
+      categories: {
+        default: { appenders: ["console", "dateFile"], level: "trace" }, // 日志级别：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 koa 实例
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    const $schema = "http://json-schema.org/draft-07/schema#";
+    // 只对api请求做校验
+    if (ctx.path.indexOf("/api/") < 0) {
+      return await next();
+    }
+
+    //获取请求参数
+    const { query, body, headers } = ctx.request;
+    const { params, path, 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 scheam = app.routerSchema[path]?.[method.toLowerCase()];
+    if (!scheam) {
+      return await next();
+    }
+
+    let valid = true;
+
+    // ajv 校验器
+    let validate;
+
+    // 校验headers
+    if (valid && headers && scheam.headers) {
+      scheam.headers.$schema = $schema;
+      validate = ajv.compile(scheam.headers);
+      valid = validate(headers);
+    }
+
+    // 校验body
+    if (valid && body && scheam.body) {
+      scheam.body.$schema = $schema;
+      validate = ajv.compile(scheam.body);
+      valid = validate(body);
+    }
+
+    // 校验query
+    if (valid && query && scheam.query) {
+      scheam.query.$schema = $schema;
+      validate = ajv.compile(scheam.query);
+      valid = validate(query);
+    }
+
+    // 校验params
+    if (valid && params && scheam.params) {
+      scheam.params.$schema = $schema;
+      validate = ajv.compile(scheam.params);
+      valid = validate(params);
+    }
+
+    if (!valid) {
+      ctx.status = 200;
+      ctx.body = {
+        code: 442,
+        success: false,
+        message: `request validate fail: ${ajv.errorsText(validate.errors)}`,
+      };
+      return;
+    }
+    await next();
+  };
+};

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

@@ -0,0 +1,43 @@
+const md5 = require("md5");
+
+/**
+ * 验证 api 签名合法性
+ * @param {object} app koa 实例
+ */
+
+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 = "isyuankkkkkll123kasd2444";
+    const signature = md5(`${signKey}_${st}`);
+
+    app.logger.info(`[${method} ${path}] signature: ${signature}`);
+
+    //时效600s内  并且用户传来的签名要等于signature 并且有时效 有签名
+    //sSign 是用户传的签名  st 是用户传的时间戳
+    // signKey 是服务器端的密钥 signature 是服务器端计算的签名  要具有对称性
+    if (
+      !sSign ||
+      !st ||
+      sSign.toLowerCase() !== signature ||
+      Date.now() - st > 600000
+    ) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 445,
+        message: "signature no correct or api timeout!!",
+      };
+      return;
+    }
+    return await next();
+  };
+};

package/app/middleware/error-handler.js

@@ -0,0 +1,33 @@
+/**
+ * 运行时异常错误处理，兜底所有异常
+ * @param {object} app koa 实例
+ */
+
+module.exports = (app) => {
+  return async (ctx, next) => {
+    try {
+      await next();
+    } catch (err) {
+      const { status, message, detail } = err;
+      app.logger.info(JSON.stringify(err));
+      app.logger.error("[-- exception --]", err);
+      app.logger.error("[-- exception --]", status, message, detail);
+
+      if (message && message.indexOf("template not found") > -1) {
+        // 页面重定向 301 永久重定向(资源被永久移动到新位置 缓存在会一直访问不到) 302 临时重定向(资源临时移动到新位置)
+        ctx.status = 302;
+        ctx.redirect(`${app.options?.homePage}`);
+        return;
+      }
+
+      const resBody = {
+        success: false,
+        code: 50000,
+        message: "网络异常 请稍后重试",
+      };
+
+      ctx.status = 200;
+      ctx.body = resBody;
+    }
+  };
+};

package/app/middleware/project-handle.js

@@ -0,0 +1,26 @@
+/**
+ * 项目相关处理中间件
+ * @param {object} app 应用实例
+ */
+
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 只对 业务 api 进行proj_key 处理
+    if (ctx.path.indexOf("/api/proj/") < 0) {
+      return await next();
+    }
+    const { proj_key: projKey } = ctx.request.headers;
+    if (!projKey) {
+      ctx.status = 2000;
+      ctx.body = {
+        success: false,
+        code: 446,
+        message: "proj_Key is not found",
+      };
+      return;
+    }
+
+    ctx.projKey = projKey;
+    await next();
+  };
+};