@mangjuxiong/elpis 1.0.2

package/.babelrc

@@ -0,0 +1,5 @@
+{
+    "presets": [
+        "@babel/preset-env"
+    ]
+}

package/.eslintignore

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

package/.eslintrc

@@ -0,0 +1,66 @@
+{
+  "extends": [
+    "plugin:vue/base",
+    "plugin:vue/recommended",
+  ],
+  "plugins": [
+    "vue"
+  ],
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "parser": "vue-eslint-parser",
+  "parserOptions": {
+    "parser": "@babel/eslint-parser",
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "rules": {
+    "semi": [
+      "error",
+      "always"
+    ],
+    "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,214 @@
+# elpis
+
+## 一个企业级
+
+### model 配置
+
+```javascript
+{
+ // 模板类型，不同模板类型对应不一样的模板数据结构
+mode: 'dashboard',
+// 名称
+name:'',
+// 描述
+desc:'',
+// icon
+icon:'',
+// 首页配置
+homePage:'',
+// 头部菜单
+menu: [{
+// 菜单唯一值
+key:'',
+// 菜单名称
+name:'',
+// 枚举值，group/module
+menuType:'',
+
+    // 当menuType为group时，subMenu为子菜单
+    subMenu:[{
+        // 可递归MenuItem
+    }, ...],
+
+    // 当menuType为module时，选择模块类型
+    moduleType:'',// 枚举值，  sider/iframe/custom/schema
+
+    // 当moduleType为sider时，siderConfig为sider配置
+    siderConfig:{
+        menu:[{
+            // 可递归MenuItem(除moduleType === module)
+        }, ...]
+    },
+
+    // 当moduleType为iframe时，iframeConfig为iframe配置
+    iframeConfig:{
+        path: ''// iframe路径
+    },
+
+    // 当moduleType为custom时，customConfig为配置
+    customConfig:{
+        path: '',// 自定义组件路径
+    },
+
+    // 当moduleType为schema时，schemaConfig为schema配置
+    schemaConfig:{
+        api:'',// 数据源API（遵循RESTFUL规范）（GET获取，POST新增，PUT修改，DELETE删除）
+        schema:{ // 板块数据结构
+            type:'object',
+            properties:{
+                key:{
+                    ...schema,// 标准的shema配置
+                    type:'',// 字段类型
+                    label:'',// 字段的中文名
+                    // 字段在 table中的相关配置
+                    tableOptions:{
+                        ...elTableColumnConfig,// 标准的el-table-column配置
+                        visible: true,// 是否在表单中显示,默认为true
+                        toFixed: 0// 保留小数点后几位
+                    },
+                    // 字段在search-bar中的相关配置
+                    searchOptions:{
+                        ...eleComponentConfig,// 标准的el-component-column配置
+                        comType: '',// 配置组件类型，input/select/...
+                        default: '',// 默认值
+
+                        // 当comType === 'select'时，enumList为select配置
+                        enumList:[{}] // 下拉框选项
+
+                        // 当comType === 'dynamicSelect'时
+                        api:'' // 下拉框选项的接口
+                    },
+                    // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
+                    // 如： componentConfig.createForm, 这里对应 createFormOption
+                    // 字段在 createForm 中相关配置
+                    createFormOptions: {
+                        ...eleComponentConfig,// 标准的el-component配置
+                        comType: '', // 空间类型 input/select/input-number
+                        visible: true, // 是否展示(true/flase), 默认为true
+                        disable: false, // 是否禁用
+                        default: '', // 默认值
+
+                        // comType === 'select' 时生效
+                        enumList: [], // 枚举列表
+                    },
+                    // 字段在 editForm 中相关配置
+                    editFormOptions: {
+                        ...eleComponentConfig,// 标准的el-component配置
+                        comType: '', // 空间类型 input/select/input-number
+                        visible: true, // 是否展示(true/flase), 默认为true
+                        disable: false, // 是否禁用
+                        default: '', // 默认值
+
+                        // comType === 'select' 时生效
+                        enumList: [], // 枚举列表
+                    },
+                    detailPanelOptions: {
+                        ...eleComponentConfig,// 标准的el-component配置
+                    }
+                },
+                ...
+            },
+            required: [], // 标记哪些字段是必填项
+        },
+        // table相关配置
+        tableConfig:{
+            headerButtons:[{
+                label: '',// 按钮名称
+                eventKey: '',// 按钮事件key
+                // 按钮事件具体配置
+                eventOptions:{
+                    // 当 eventKey === 'showComponent' 时生效
+                    comName: '' // 组件名称
+                }
+                ...elButtonConfig,// 标准的el-button配置
+            },...],// table头部按钮
+            rowButtons:[{
+                label: '',// 按钮名称
+                eventKey: '',// 按钮事件key
+                eventOptions:{
+                    // 当 eventKey === 'showComponent' 时生效
+                    comName: '' // 组件名称
+
+                    // 当eventKey === 'remove'
+                    params:{
+                        // paramsKey = 参数的键值
+                        // rowValueKey = 参数的值( 当格式为 schema::tableKeys时，到table中找响应字段 )
+                        paramsKey: rowValueKey
+                    }
+                } // 按钮事件具体配置
+                ...elButtonConfig,// 标准的el-button配置
+            },...],// table行按钮
+        },
+        // search-bar相关配置
+        searchConfig:{},
+        // 动态组件相关配置
+        componentConfig:{
+            // create-from 表单相关配置
+            createForm: {
+                title: '', // 表单标题
+                saveBtnText: '', // 保存按钮文案
+            },
+            editForm: {
+                mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+                title: '', // 表单标题
+                saveBtnText: '', // 保存按钮文案
+            }，
+            // detail-panel相关设置
+            detailPanel: {
+                mainKey: '', // 主键，用于唯一标识要查看的数据对象
+                title: '', // 标题
+            }
+            // ...支持用户动态扩展
+        },
+    },
+
+}, ...],
+
+};
+```
+
+### 服务端启动
+
+```javascript
+const { serverStart } = require('@mangjuxiong/elpis');
+
+// 启动 elpis 服务
+const app = serverStart({});
+```
+
+### 自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+
+```javascript
+const { frontendBuild } = require('@mangjuxiong/elpis');
+
+// 编译构建前端工程
+frontendBuild(process.env._ENV);
+```
+
+### 自定义页面扩展
+
+- 在 `app/pages/` 目录写入口 entry.xxx.js
+
+### dashboard / custom-view 自定义页面扩展
+
+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/seach-item-config.js`

package/app/controller/base.js

@@ -0,0 +1,39 @@
+module.exports = (app) =>
+  class BaseController {
+    /**
+     *  controller 基类
+     *  统一收拢 controller 相关公共方法
+     */
+    constructor() {
+      this.app = app;
+      this.config = app.config;
+    }
+
+    /**
+     *  API 处理成功时统一返回结构
+     * @param {Object} ctx 上下文
+     * @param {Object} data 返回数据
+     * @param {Object} metadatas 附加数据
+     */
+    success(ctx, data = {}, metadatas = {}) {
+      ctx.status = 200;
+      ctx.body = {
+        success: true,
+        data: data,
+        metadatas: metadatas,
+      };
+    }
+    /**
+     *  API 处理失败时统一返回结构
+     * @param {Object} ctx 上下文
+     * @param {Object} message 错误信息
+     * @param {Object} 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);
+  return class ProjectController extends BaseController {
+    /**
+     * 获取所有模型和项目的结构化数据
+     * @param {Object} 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, keyItem) => {
+          const { key, name, desc, homePage } = project[keyItem];
+          preObj[keyItem] = { key, name, desc, homePage };
+          return preObj;
+        }, {});
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject,
+        });
+        // 构造project关键数据
+        return preList;
+      }, []);
+
+      this.success(ctx, dtoModelList);
+    };
+    /**
+     * 获取当前projKey 对应模型下的项目列表，如果无projKey，则返回所有项目列表
+     */
+    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 => {
+        return {
+          modelKey: item.modelKey,
+          key: item.key,
+          name: item.name,
+          homePage: item.homePage,
+          desc: item.desc
+        };
+      });
+      this.success(ctx, dtoProjectList);
+    };
+    /**
+     * 根据proj_key获取项目配置
+     */
+    getProject(ctx){
+      const { proj_key:projKey } = ctx.request.query;
+
+      const { project: projectService } = app.services;
+      const projectConfig = projectService.getProject({projKey});
+
+      if(!projectConfig){
+        this.fail(ctx, '项目不存在',50000);
+        return;
+      }
+      this.success(ctx, projectConfig);
+    }
+  };
+};

package/app/controller/view.js

@@ -0,0 +1,19 @@
+module.exports = (app) => {
+  return class ViewController {
+    /**
+     * 渲染页面
+     * @param {Object} ctx 上下文
+     */
+    async renderPage(ctx) {
+      const { query, params } = ctx;
+      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: ctx.query?.proj_key,
+        name: app.options?.name,
+        env: app.env.get(),
+        options: JSON.stringify(app.options),
+      });
+    }
+  };
+};

package/app/extend/database.js

@@ -0,0 +1,5 @@
+module.exports = (app) => {
+  const { db: dbConfig } = app.config;
+  if (!dbConfig) return;
+  return require('knex')(dbConfig);
+};

package/app/extend/logger.js

@@ -0,0 +1,38 @@
+const log4js = require('log4js');
+
+/**
+ * 日志工具
+ * 外部调用 app.logger.info  app.logger.error
+ * @param {*} app
+ */
+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,74 @@
+const Ajv = require('ajv');
+const ajv = new Ajv();
+
+/**
+ * API 参数校验
+ * @param {*} app
+ * @returns
+ */
+module.exports = (app) => {
+  // 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 { body, query, headers } = ctx.request;
+    const { params, path, method } = ctx;
+
+    // 打印日志
+    app.logger.info(`[${path} ${method}] body: ${JSON.stringify(body)}`);
+    app.logger.info(`[${path} ${method}] query: ${JSON.stringify(query)}`);
+    app.logger.info(`[${path} ${method}] params: ${JSON.stringify(params)}`);
+    app.logger.info(`[${path} ${method}] 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,36 @@
+const md5 = require('md5');
+
+/**
+ * API签名合法性校验
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 校验白名单
+    if (app.config?.apiSignVerify?.whiteList?.includes(ctx.path)) {
+      return await next();
+    }
+
+    // 只对API请求做签名校验
+    if (ctx.path.indexOf('/api/') < 0) {
+      return await next();
+    }
+
+    const { path, method } = ctx;
+    const { headers } = ctx.request;
+    const { s_sign: sSgin, s_t: st } = headers;
+    const signKey = 'mshsiksjksnnmsma';
+    const signature = md5(`${signKey}_${st}`);
+    app.logger.info(`[${path} ${method}] signature ${signature}`);
+
+    if (!sSgin || !st || signature !== sSgin.toLowerCase() || Date.now() - st > 600 * 1000) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 445,
+        message: 'signature not correct or timeout!!',
+      };
+      return;
+    }
+    await next();
+  };
+};

package/app/middleware/error-handle.js

@@ -0,0 +1,32 @@
+/**
+ * 运行时异常错误处理，兜底所有异常
+ * @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) {
+        // 页面重定向
+        ctx.status = 302; // 临时重定向
+        ctx.redirect(`${app.options?.homePage}`);
+      }
+
+      const resBody = {
+        success: false,
+        code: 50000,
+        message: message || '服务器异常',
+      };
+
+      ctx.body = 200;
+      ctx.body = resBody;
+    }
+  };
+};

package/app/middleware/project-handler.js

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

package/app/middleware.js

@@ -0,0 +1,39 @@
+const path = require('path');
+
+module.exports = (app) => {
+  // 配置静态根目录
+  const koaStatic = require('koa-static');
+  app.use(koaStatic(path.resolve(__dirname, './public')));
+  app.use(koaStatic(path.resolve(app.baseDir, './app/public')));
+
+  // 模板渲染引擎
+  const koaNunjucks = require('koa-nunjucks-2');
+  app.use(
+    koaNunjucks({
+      ext: 'tpl',
+      path: path.resolve(app.baseDir, './app/public'),
+      nunjucksConfig: {
+        noCache: true,
+        trimBlocks: true,
+      },
+    })
+  );
+
+  // 使用ctx.body 解析中间件
+  const bodyParser = require('koa-bodyparser');
+  app.use(
+    bodyParser({
+      formList: '1000mb',
+      enableTypes: ['form', 'json', 'text'],
+    })
+  );
+
+  // 引入错误处理中间件
+  app.use(app.middlewares.errorHandle);
+  // 引入签名合法性
+  app.use(app.middlewares.apiSignVerify);
+  // 引入api参数校验
+  app.use(app.middlewares.apiParamsVerify);
+  // 引入项目处理中间件
+  app.use(app.middlewares.projectHandler);
+};