@xujingquan/elpis 1.0.0

package/.browserslistrc

@@ -0,0 +1,3 @@
+> 0.01%
+last 2 version
+not dead

package/.eslintignore

@@ -0,0 +1,4 @@
+**/node_modules/*
+**/public/*
+**/view/*
+**/docs/*

package/.eslintrc

@@ -0,0 +1,63 @@
+{
+  "root": true,
+  "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",
+    "vue/html-self-closing": "off",
+    "vue/html-closing-bracket-newline": "off",
+    "vue/html-closing-bracket-spacing": "off",
+    "vue/max-attributes-per-line": "off",
+    "vue/script-setup-uses-vars": "error",
+    "vue/singleline-html-element-content-newline": "off",
+    "vue/require-default-prop": "off",
+    "vue/multiline-html-element-content-newline": "off",
+    "vue/attribute-hyphenation": "off",
+    "vue/html-indent": "off"
+  },
+  "globals": {
+    "$": true,
+    "axios": true,
+    "Vue": true
+  }
+}

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.prettierignore

@@ -0,0 +1,16 @@
+package-lock.json
+README.md
+**/.next/*
+**/node_modules/*
+**/out/*
+**/.vscode/*
+**/*.yml
+**/*.svg
+**/*.png
+**/*.jpg
+**/*.gif
+**/*.md
+**/*.ejs
+**/*.min.js
+**/*.min.css
+**/docs/*

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

package/README.md

@@ -0,0 +1,248 @@
+# elips 
+## 一个企业级全栈应用框架
+
+### model 配置
+```js
+{
+  mode: 'dashboard', // 模版类型，不同模版类型对应不一样的模版数据结构
+  name: '', // 名称
+  desc: '', // 描述
+  icon: '', // icon
+  homePage: '', // 首页（项目配置）
+  // 头部菜单
+  menu: [
+    {
+      key: '', // 菜单唯一描述
+      name: '', // 菜单名称
+      menuType: '', // 枚举值 group / module
+      // 当 menuType === group 时，可填
+      subMenu: [
+        {
+          // 可递归 menuItem
+        },
+        ...,
+      ],
+      // 当 menuType === module 时，可填
+      moduleType: '', // 枚举 iframe（第三方页面）/custom（自定义页面）/schema（架构系统页面）
+      // 当 moduleType === sider 时
+      // 侧边栏
+      siderConfig: {
+        menu: [
+          {
+            // 可递归 menuItem (除 moduleType === sider)
+          },
+          ...,
+        ],
+      },
+      // 当 menuType === iframe 时
+      iframeConfig: {
+        path: '', // iframe 路径
+      },
+      // 当 menuType === custom 时
+      customConfig: {
+        path: '', // 自定义路由路径
+      },
+      // 当 menuType === schema 时
+      schemaConfig: {
+        api: '', // 数据源API（遵循 RESTFUL 规范）
+        schema: {
+          // 板块数据结构
+          type: 'object',
+          properties: {
+            key: {
+              ...schema, // 标准 schema 配置
+              type: '', //字段类型
+              label: '', // 字段的中文名
+              // 字段在 table 中的相关配置
+              tableOption:{
+                ...elTableColumnConfig, // 标准 el-table-column
+                toFixed: 0, // 保留小数点后几位
+                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
+              createFormOption: {
+                ...eleComponentConfig, // 标准 el-component-column 配置
+                comType: '', // 控件类型 如 input/select/input-number
+                visible: true, // 是否展示 true/false 默认 true
+                disabled: false, // 是否禁用 true/false 默认 fasle
+                default: '', // 默认值
+
+                // 当 comType === 'select' 时生效
+                enumList: [] // 枚举列表
+              },
+              // 字段在 editForm 中的相关配置
+              editFormOption: {
+                ...eleComponentConfig, // 标准 el-component-column 配置
+                comType: '', // 控件类型 如 input/select/input-number
+                visible: true, // 是否展示 true/false 默认 true
+                disabled: false, // 是否禁用 true/false 默认 fasle
+                default: '', // 默认值
+                // 当 comType === 'select' 时生效
+                enumList: [] // 枚举列表
+              },
+               // 字段在 detailPanel 中的相关配置
+              detailPanelOption: {
+                ...eleComponentConfig, // 标准 el-component-column 配置
+                comType: '', // 控件类型 如 input/select/
+                // 当 comType === 'select' 时生效
+                
+                enumList: [] // 枚举列表
+              }
+            },
+            ...,
+          },
+        },
+        required: [], // 标记那些字段是必填项
+        // tabel 相关配置
+        tableConfig: {
+          headerButtons:[{
+            label: '', // 按钮中文名
+            eventKey: '', // 按钮事件名
+            // 按钮事件具体配置
+            eventOption: {
+              // 当 eventKey === 'showComponent'
+              comName: '', // 组件名称
+            }, 
+            ...elButtonConfig // 标准的 el-botton 配置
+          }, ...],
+          rowButtons:[{
+             label: '', // 按钮中文名
+             eventKey: '', // 按钮事件名
+             eventOption: {
+              // 当 eventKey === 'showComponent'
+              comName: '', // 组件名称
+
+              // 当 eventKey === 'remove 或者其他的时候'
+              params:{
+                // paramKey = 参数的键值
+                // rowValueKey = 参数值（当格式为 schema::tableKey 的时候，到table 中找到相应的字段）
+                // 例如 user_id: schema::user_id
+                paramKey: rowValueKey
+               
+              }
+             }, // 按钮事件具体配置
+             ...elButtonConfig // 标准的 el-botton 配置
+          },...]
+        }, 
+        // search-bar 相关配置
+        searchConfig: {}, 
+        // 动态组件，相关配置
+        componentConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: '', // 表单标题
+            saveBtnText: '' , // 保存按钮
+          },
+          // edit-form 表单相关配置
+          editForm: {
+            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+            title: '', // 表单标题
+            saveBtnText: '' , // 保存按钮
+          },
+          // detail-panel 相关配置
+          detailPanel:{
+            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+            title: '', // 表单标题
+            saveBtnText: '' , // 保存按钮
+          }
+          // ...支持用户动态扩展
+        }, 
+      },
+    },
+    ...,
+  ],
+}
+```
+
+### 服务端启动
+```js
+const { serverStart } = require('@xujingquan/elpis');
+
+// 服务端启动
+const app = serverStart({
+  name: '', // 项目名称
+  homePage: '', // 项目首页
+});
+```
+
+### 自定义服务端
+├── app/
+│   ├── router-schema
+│   ├── router
+│   ├── controller
+│   ├── service
+│   ├── extend
+├── config/
+
+### 前端构建
+```js
+const { frontendBuild } = require('@xujingquan/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`
+```js
+import demoComponent from './components/demo-component.vue';
+
+const ComponentConfig = {
+  demoComponent: {
+    component: demoComponent,
+  },
+};
+
+export default ComponentConfig;
+```
+
+### schema-form 控件控制
+- 1.在 `app/pages/widgets/schema-form/complex-view` 下写组件
+- 2.配置到 `app/pages/widgets/schema-form/form-item-config.js` 
+``` javascript
+import demoFormItem from './complex-view/demo-form-item/demo-form-item.vue';
+
+const FormItemConfig = {
+  demoFormItem: {
+    component: demoFormItem,
+  },
+};
+
+export default FormItemConfig;
+```
+
+### schema-search-bar 控件控制
+- 1.在 `app/pages/widgets/schema-search-bar/complex-view` 下写组件
+- 2.配置到 `app/pages/widgets/schema-search-bar/search-item-config.js` 
+
+```js
+import demoSearchItem from './complex-view/demo-search-item/demo-search-item.vue';
+
+const SearchItemConfig = {
+  demoSearchItem: {
+    component: demoSearchItem,
+  },
+};
+
+export default SearchItemConfig;
+```

package/app/controller/base.js

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

package/app/controller/project.js

@@ -0,0 +1,75 @@
+/**
+ * 控制层
+ * */
+module.exports = (app) => {
+  const BaseController = require('./base')(app);
+  // 后续在 controller loader 中会使用 new XXX()
+  return class ProjectController extends BaseController {
+    /**
+     * 根据 proj_key 获取项目配置
+     * */
+    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);
+    }
+    /**
+     * 获取当前 projectKey 对应模型下的项目列表（如果无 projectKey 全量获取）
+     * */
+    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) => {
+        const { modelKey, key, name, desc, homePage } = item;
+        return { modelKey, key, name, desc, 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;
+        }, {});
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject,
+        });
+
+        return preList;
+      }, []);
+
+      // success 继承 BaseController 方法
+      this.success(ctx, dtoModelList);
+    }
+  };
+};

package/app/controller/view.js

@@ -0,0 +1,28 @@
+/**
+ * 控制层
+ * */
+module.exports = (app) => {
+  // 后续在 controller loader 中会使用 new XXX()
+  return class ViewController {
+    /**
+     * 渲染页面
+     * @param {object} 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)}`);
+
+      // 这个是 koa-nunjucks-2 渲染引擎中间件 使用后挂载在上下文对象 ctx 中的 render方法
+      // render 第二个参数可以把模版预留的变量注入渲染模版
+      await ctx.render(`dist/entry.${ctx.params.page}`, {
+        // options、env 启动服务挂载在 app 上的对象
+        name: app.options?.name,
+        env: app.env.get(),
+        options: JSON.stringify(app.options),
+        projKey: ctx.query?.proj_key,
+      });
+    }
+  };
+};

package/app/extend/logger.js

@@ -0,0 +1,39 @@
+const log4js = require('log4js'); // 日志
+
+/**
+ * 日志工具
+ * 外部调用 app.logger.log  app.logger.error
+ */
+
+module.exports = app => {
+  let logger;
+  // 本地环境使用 console 其他环境使用 log4js
+  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,90 @@
+const Ajv = require('ajv');
+const ajv = new Ajv();
+/**
+ * API 参数校验
+ */
+module.exports = (app) => {
+  // 校验版本
+  const $schema = 'http://json-schema.org/draft-07/schema#';
+  return async (ctx, next) => {
+    // 只对API请求做参数校验
+    if (ctx.path.indexOf('/api/') < 0) {
+      // 不是API不做校验
+      return await next();
+    }
+
+    const { request, params, path, method } = ctx;
+    // 获取请求参数
+    const { body, query, headers } = 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)}`);
+
+    const sheama = app.routerSchema[path]?.[method.toLowerCase()];
+
+    if (!sheama) {
+      // 没有校验规则直接通过
+      return await next();
+    }
+
+    let valid = true;
+
+    // ajv 校验器
+    let validate;
+
+    // 检验 headers
+    if (valid && headers && sheama.headers) {
+      // 添加 $schema 版本
+      sheama.headers.$schema = $schema;
+      // ajv.compile 解析 sheama.headers 返回校验器
+      validate = ajv.compile(sheama.headers);
+      // 校验器去解析参数是否满足，返回校验结构
+      valid = validate(headers);
+    }
+
+    // 校验body
+    if (valid && body && sheama.body) {
+      // 添加 $schema 版本
+      sheama.body.$schema = $schema;
+      // ajv.compile 解析 sheama.body 返回校验器
+      validate = ajv.compile(sheama.body);
+      // 校验器去解析参数是否满足，返回校验结构
+      valid = validate(body);
+    }
+
+    // 校验query
+    if (valid && query && sheama.query) {
+      // 添加 $schema 版本
+      sheama.query.$schema = $schema;
+      // ajv.compile 解析 sheama.query 返回校验器
+      validate = ajv.compile(sheama.query);
+      // 校验器去解析参数是否满足，返回校验结构
+      valid = validate(query);
+    }
+
+    // 校验params
+    if (valid && params && sheama.params) {
+      // 添加 $schema 版本
+      sheama.params.$schema = $schema;
+      // ajv.compile 解析 sheama.params 返回校验器
+      validate = ajv.compile(sheama.params);
+      // 校验器去解析参数是否满足，返回校验结构
+      valid = validate(params);
+    }
+
+    if (valid === false) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: `request validate fail: ${ajv.errorsText(validate.errors)}`,
+        code: 442,
+      };
+      return;
+    }
+
+    await next();
+  };
+};

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

@@ -0,0 +1,47 @@
+const md5 = require('md5');
+/**
+ * API 签名合法校验
+ * */
+module.exports = app => {
+  return async (ctx, next) => {
+    const { path, method, request } = ctx;
+    // 只对API请求做签名校验
+    if (path.indexOf('/api') < 0) {
+      // 不是API不做校验
+      return await next();
+    }
+
+    const { headers } = request;
+    /**
+     * s_sign 签名
+     * s_t 时间
+     */
+    const { s_sign: sSign, s_t: st } = headers;
+
+    const signKey = 'da98fc11-295c-a64f-5b31-d6dc4055dd06'; // UUID
+    const signature = md5(`${signKey}_${st}`); // 签名
+    app.logger.info(`[${method} ${path}] signature:${signature}`);
+
+    /**
+     * 用户没有传递签名
+     * 用户没有传递时间
+     * 签名不正确
+     * 时间超过 600s（超出时效）
+     */
+    if (
+      !sSign ||
+      !st ||
+      signature !== sSign.toLowerCase() ||
+      Date.now() - st > 1000 * 600
+    ) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: 'signature not correct or api timerout',
+        code: 445
+      };
+      return;
+    }
+    await next();
+  };
+};