@wanglindoc/elpis 1.0.0

package/.eslintignore

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

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/.idea/codeStyles/Project.xml

@@ -0,0 +1,14 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_ENFORCE_QUOTES" value="true" />
+      <option name="HTML_NEWLINE_AFTER_LAST_ATTRIBUTE" value="When multiline" />
+    </HTMLCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/elpis.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/elpis.iml" filepath="$PROJECT_DIR$/.idea/elpis.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+    <option name="myRunOnSave" value="true" />
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,232 @@
+# elpis
+
+## 企业级应用框架
+
+### model配置：
+
+```javascript
+export const obj = {
+  mode: "dashboard", // 模版类型，不同模板类型对应不一样的模板数据结构
+  name: "", // 名称
+  desc: "", // 描述
+  icon: "", // 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 时可填
+      customCofig: {
+        path: "", // 自定义路由
+      },
+
+      // 当 moduleType 为 schema 时可填
+      schemaConfig: {
+        api: "", // 数据源 API （遵循 RESTFUL 规范）
+        schema: {
+          // 板块数据结构
+          type: "object",
+          properties: {
+            key: {
+              ...schema, // 标准 schema 配置
+              type: "", // 字段类型
+              label: "", // 字段中文名
+
+              // 字段在 table 中的相关配置
+              tableOption: {
+                ...elTableColumnConfig, // 标准 el-table-column 配置
+                visible: true, // 默认为 true（false 或不配置时，表示不在表格中显示）
+              },
+
+              // 字段在 search-bar 中的相关配置
+              searchOption: {
+                ...eleComponentConfig, // 标准 el-component-column 配置
+                comType: "", // 配置组件类型 input/select…
+                default: "", // 默认值
+
+                // 当 comType === ‘select‘ 时
+                enumList: [], // 下拉框可选项
+
+                // 当 comType === 'dynamicSelect' 时
+                api: "",
+              },
+
+              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
+              // 如：componentConfig.createForm，这里对应 createFormOption
+              // 字段在 createForm 中相关配置
+              createFormOption: {
+                ...eleComponentConfig, // 标准 el-component 配置
+                comType: "", // 控件类型 input/select/input-number
+                visible: true, // 是否展示（true/false）默认为 true
+                disabled: false, // 是否禁用（true/false）默认为 false
+                default: "", // 默认值
+
+                // comType === 'select' 时生效
+                enumList: [], // 枚举列表
+              },
+
+              // 字段在 edit-form 表单中的相关配置
+              editFormOption: {
+                ...eleComponentConfig, // 标准 el-component 配置
+                comType: "", // 控件类型 input/select/input-number
+                visible: true, // 是否展示（true/false）默认为 true
+                disabled: false, // 是否禁用（true/false）默认为 false
+                default: "", // 默认值
+
+                // comType === 'select' 时生效
+                enumList: [], // 枚举列表
+              },
+
+              detailPanelOption: {
+                ...eleComponentConfig, // 标准 el-component 配置
+              },
+            },
+            // ...
+          },
+
+          // 必填 properties
+          required: [],
+        },
+
+        // table 相关配置
+        tableConfig: {
+          headerButtons: [
+            {
+              label: "", // 按钮中文名
+              eventKey: "", // 按钮事件名
+              // 按钮配置
+              eventOption: {
+                // 当 eventKey === 'showComponent' 时
+                comName: "", // 组件名称（showComponent 调起的组件）
+              },
+              ...elButtonConfig,
+            },
+            // ...
+          ],
+          rowButtons: [
+            {
+              label: "", // 按钮中文名
+              eventKey: "", // 按钮事件名
+              // 按钮事件具体配置
+              eventOption: {
+                // 当 eventKey === 'showComponent' 时
+                comName: "", // 组件名称（showComponent 调起的组件）
+
+                // 当 eventKey === 'remove' 时
+                params: {
+                  // paramKey=接口参数名
+                  // rowValueKey= 参数值 （格式为 schema::tableKey，到 table 中找相应的字段）
+                  paramKey: rowValueKey,
+                },
+              }, // 按钮配置
+              ...elButtonConfig,
+            },
+            // ...
+          ],
+        }, // table 相关配置
+
+        // search-bar 相关配置
+        searchConfig: {},
+
+        // 动态组件 相关配置
+        componentConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文案
+          },
+          // edit-form 表单相关配置
+          editForm: {
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文案
+            mainKey: "", // 表单主键，用于唯一表示要修改的数据对象
+          },
+
+          // 详情面板的相关配置
+          detailPanel: {
+            title: "", // 表单标题
+            mainKey: "", // 表单主键，用于唯一表示要修改的数据对象
+          },
+        },
+      },
+    },
+    // ...
+  ],
+};
+```
+
+### 服务端启动：
+
+```javascript
+const { serverStart } = require("@wanglindoc/elpis");
+
+const app = serverStart({});
+```
+
+### 自定义服务端：
+
+- router-schema
+- router
+- controller
+- service
+- config
+- extend
+
+### 前端构建：
+
+```javascript
+const { frontendBuild } = require("@wanglindoc/elpis");
+
+frontendBuild(process.env._ENV);
+```
+
+### 自定义页面拓展：
+
+- 在 `app/pages/` 目录下写入口 entry.xxx.js
+
+### dashboard / custom-view 自定义页面拓展：
+
+- 在 `app/pages/dashboard/xxxx` 下写页面
+
+### 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/widgets/schema-form/complex-view` 写组件
+2. 配置到 `app/widgets/schema-form/form-item-config.js`
+
+### schema-search-bar 控件拓展
+
+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,42 @@
+module.exports = (app) => {
+  return class BaseController {
+    /**
+     * controller 基类
+     * 统一收拢 controller 的公共方法
+     */
+    constructor() {
+      this.app = app;
+      this.config = app.config;
+      this.service = app.service;
+    }
+
+    /**
+     * API 处理成功时的统一返回结构
+     * @param {*} ctx ctx 上下文
+     * @param {*} data data核心数据
+     * @param {*} metadata metadata附加数据
+     */
+    success(ctx, data = {}, metadata = {}) {
+      ctx.status = 200;
+      ctx.body = {
+        success: true,
+        data,
+        metadata,
+      };
+    }
+
+    /**
+     * API 处理失败时的统一返回结构
+     * @param {*} ctx ctx 上下文
+     * @param {*} message 错误信息
+     * @param {*} code 错误码
+     */
+    fail(ctx, message, code) {
+      ctx.body = {
+        success: false,
+        message,
+        code,
+      };
+    }
+  };
+};

package/app/controller/project.js

@@ -0,0 +1,76 @@
+module.exports = (app) => {
+  const BaseController = require("./base")(app);
+  return class ProjectController extends BaseController {
+    /**
+     * 获取所有模型与项目的结构化数据
+     * @param {*} ctx
+     */
+    async getModelList(ctx) {
+      const { project: projectService } = app.services;
+
+      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;
+        }, {});
+
+        // 整合返回结果
+        preList.push({
+          model: dtoModel,
+          project: dtoProject,
+        });
+
+        return preList;
+      }, []);
+
+      this.success(ctx, dtoModelList);
+    }
+
+    /**
+     * 获取当前 projectKey 对应模型下的项目列表（如果无projectKey，全量获取）
+     */
+    getList(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+
+      const { project: projectService } = app.services;
+      const projectList = projectService.getList({ projKey });
+
+      // 构造关键数据 list
+      const dtoProjectList = projectList.map((item) => {
+        const { modelKey, key, name, desc, homePage } = item;
+        return { modelKey, key, name, desc, homePage };
+      });
+
+      this.success(ctx, dtoProjectList);
+    }
+
+    /**
+     * 根据 proj_key 获取项目配置
+     * @param {*} ctx
+     */
+    get(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.services;
+      const projConfig = projectService.get({ projKey });
+
+      if (!projConfig) {
+        this.fail(ctx, "获取项目异常", 50000);
+        return;
+      }
+
+      this.success(ctx, projConfig);
+    }
+  };
+};

package/app/controller/view.js

@@ -0,0 +1,19 @@
+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)}`);
+
+      await ctx.render(`dist/entry.${ctx.params.page}`, {
+        projKey: query?.proj_key,
+        name: app.options?.name,
+        env: app.env.get(),
+      });
+    }
+  };
+};

package/app/extend/logger.js

@@ -0,0 +1,42 @@
+const log4js = require("log4js");
+
+/**
+ * 日志工具
+ * 外部调用 app.logger.info app.logger.error
+ * @param {*} 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,81 @@
+const Ajv = require("ajv");
+const ajv = new Ajv();
+
+/**
+ * API 参数校验
+ * @param {*} app
+ * @returns
+ */
+module.exports = (app) => {
+  // json-schema标准的版本
+  const $schema = "http://json-schema.org/draft-07/schema#";
+
+  return async (ctx, next) => {
+    // 只对API请求做参数校验
+    if (ctx.path.indexOf("/api/") < 0) {
+      return await next();
+    }
+
+    // 获取参数
+    const { params, path, method } = ctx;
+    const { body, query, headers } = ctx.request;
+
+    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)}`);
+
+    // 获取routerSchema
+    const schema = app.routerSchema[path]?.[method.toLowerCase()];
+
+    if (!schema) {
+      return await next();
+    }
+
+    let valid = true;
+
+    // ajv 校验器
+    let validate;
+
+    // 校验header
+    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 ?a=''&b=''
+    if (valid && query && schema.query) {
+      schema.query.$schema = $schema;
+      validate = ajv.compile(schema.query);
+      valid = validate(query);
+    }
+
+    // 校验params /api/project/detail/:id => /api/project/detail/1001
+    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,
+        message: `request validate fial: ${ajv.errorsText(validate.errors)}`,
+        code: 442,
+      };
+
+      return;
+    }
+
+    await next();
+  };
+};

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

@@ -0,0 +1,45 @@
+const md5 = require("md5");
+
+/**
+ * API 签名合法性校验
+ */
+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;
+
+    // key可以是任意自定义的内容，也可以是生成的 uuid
+    const signKey = "ajflskjflaskdjfqoiwefjlaskdjflka";
+    const signature = md5(`${signKey}_${st}`);
+
+    app.logger.info(`[${method} ${path}] signature: ${signature}`);
+
+    // 如果用户没有传递签名 sSign
+    // 或者用户没有传递时间 st
+    // 或者[用户传递的签名(sSign)]与[signKey和用户传递的时间(st)生成的签名]不匹配
+    // 或者当前时间比用户传递的时间大于一定时间
+    if (
+      !sSign ||
+      !st ||
+      signature !== sSign.toLowerCase() ||
+      Date.now() - st > 600000
+    ) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: "signature no correct or time out",
+        code: 445, // 445 签名错误
+      };
+
+      return;
+    }
+
+    await next();
+  };
+};