@siven-li/elpis 1.0.0

package/.eslintignore

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

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,201 @@
+# Elips
+## 企业级全栈应用框架
+
+### model配置
+```javascript
+{
+  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 时
+    customConfig: {
+      path: '' // 自定路由路径
+    },
+
+    // 当 moduleType === schema 时
+    schemaConfig: {
+      api: '', // 数据源API（遵循 RESTFUL 规范）
+      schema: { // 板块数据结构
+        type: 'object',
+        properties: {
+          key: {
+            ...schema, // 标准 schema 配置
+            type: '', // 字段类型
+            label: '', // 字段中文名
+            // 字段在 table 中的相关配置
+            tableOption: {
+              ...elTableColumnConfig, // 标准 el-table-column 配置
+              toFixed: 0, // 保留小数点第几位
+              visible: true, // 是否显示在 table 中（只有配置为 false 时才不展示）
+            },
+            // 字段在 search 中的相关配置
+            searchOption: {
+              ...elComponentConfig, // 标准 el-component 配置
+              comType: '', // 组件类型 input / select / date-picker / cascader / ...
+              default: '', // 搜索默认值
+              // comType 为 select / cascader 时，可填
+              enumList: [], // 下拉选项列表
+              // comType 为 dynamicSelect 时
+              api: '',
+            },
+            // 字段在不同 component 中的相关配置，前缀对应 componentConfig 中的键值
+            // 如：componentConfig.createForm，这里对应 createFormOption
+            // 字段在 createForm 中相关配置
+            createFormOption: {
+              ...elFormItemConfig, // 标准 el-form-item 配置
+              comType: '', // 空间类型 input / select / input-number / ...
+              visible: true, // 是否展示 (true/false)，默认为 true
+              disabled: false, // 是否禁用 (true/false)，默认为 false
+              default: '', // 默认值
+
+              // comType === 'select'时生效
+              enumList: [], // 下拉选项列表
+            },
+            editFormOption: {
+              ...elFormItemConfig, // 标准 el-form-item 配置
+              comType: '', // 空间类型 input / select / input-number / ...
+              visible: true, // 是否展示 (true/false)，默认为 true
+              disabled: false, // 是否禁用 (true/false)，默认为 false
+              default: '', // 默认值
+
+              // comType === 'select'时生效
+              enumList: [], // 下拉选项列表
+            },
+            detailPanelOption: {
+              ...elFormItemConfig, // 标准 el-form-item 配置
+            }
+          },
+          ...
+        },
+        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::tableKey，到 table中找相应的字段
+              paramKey: rowValueKey
+            }
+          },
+          ...elButtonConfig // 标准 el-button 配置
+        }, ...]
+      },
+      searchConfig: {}, // search-bar 相关配置
+      // 动态组件相关配置
+      componentConfig: {
+        // create-form 表单相关配置
+        createForm: {
+          title: '', // 表单标题
+          saveBtnText: '', // 保存按钮文本
+        },
+        // edit-form 表单相关配置
+        editForm: {
+          mainKey: '', // 表单主键
+          title: '', // 表单标题
+          saveBtnText: '', // 保存按钮文本
+        },
+        // detail-panel 详情面板相关配置
+        detailPanel: {
+          mainKey: '', // 表单主键
+          title: ''
+        }
+        // ...支持用户动态扩展
+      }
+    }
+  }, ...]
+}
+```
+
+### 服务端启动
+```javascript
+const {
+  serverStart
+} = require('@siven-li/elpis');
+
+// 启动 elpis 服务
+const app = serverStart({});
+```
+
+### 自定义服务端
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+```javascript
+const { frontendBuild } = require('@siven-li/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,37 @@
+module.exports = (app) => 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 {object} code 错误码
+   */
+  fail(ctx, message, code) {
+    ctx.body = {
+      success: false,
+      message,
+      code
+    }
+  }
+}

package/app/controller/project.js

@@ -0,0 +1,65 @@
+module.exports = (app) => {
+  const BaseController = require('./base')(app);
+  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) return this.fail(ctx, '项目配置不存在', 50000);
+      this.success(ctx, projConfig);
+    }
+    /**
+     * 获取当前 projectKey 对应模型下的项目列表（如果无 projectKey，全量获取）
+     */
+    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 };
+      });
+
+      this.success(ctx, dtoProjectList);
+    }
+    /**
+     * 获取所有模型与项目的结构化数据
+     * @param {*} 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;
+        }, {});
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject
+        })
+
+        return preList;
+      }, [])
+
+      this.success(ctx, dtoModelList);
+    }
+  }
+}

package/app/controller/view.js

@@ -0,0 +1,20 @@
+module.exports = (app) => {
+  return class ViewController {
+    /**
+     * 渲染页面
+     * @param {Object} ctx 上下文对象
+     */
+    async renderPage(ctx) {
+      // 注册了koa-nunjucks-2中间件，所以ctx上会有render方法,这里的本质就是服务端渲染（SSR - server side rendering）
+      app.logger.info(`[ViewController] query: ${JSON.stringify(ctx.query)}`);
+      app.logger.info(`[ViewController] params: ${JSON.stringify(ctx.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/logger.js

@@ -0,0 +1,35 @@
+const log4js = require('log4js');
+
+/**
+ * 日志工具
+ * 外部调用 app.logger.info app.logger.error
+ */
+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,97 @@
+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) {
+      return await next();
+    };
+
+    // 此时ctx.params还未被添加到路由上，先执行下一个中间件（包括路由中间件）
+    await next();
+
+    // 获取请求参数
+    const { body, query, 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}] headers: ${JSON.stringify(headers)}`);
+    app.logger.info(`[${method} ${path}] params: ${JSON.stringify(params)}`);
+
+    // 查找匹配的 schema（支持动态路由）
+    let schema = null;
+    const methodLower = method.toLowerCase();
+    
+    // 遍历所有路由 schema，查找匹配的动态路由
+    Object.keys(app.routerSchema).forEach(schemaPath => {
+      // 如果已找到匹配的 schema，跳过
+      if (schema) return;
+      
+      // 检查是否为动态路由（包含 :param）
+      if (schemaPath.includes(':')) {
+        // 构建正则表达式
+        const regexPath = schemaPath.replace(/:\w+/g, '([^/]+)');
+        const regex = new RegExp(`^${regexPath}$`);
+        
+        // 匹配请求路径
+        if (regex.test(path)) {
+          schema = app.routerSchema[schemaPath][methodLower];
+        }
+      } else {
+        // 静态路由直接匹配
+        if (schemaPath === path) {
+          schema = app.routerSchema[schemaPath][methodLower];
+        }
+      }
+    });
+
+
+    if (!schema) {
+      return;
+    }
+
+    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,
+        message: `request validate fail: ${ajv.errorsText(validate.errors)}`,
+        code: 442
+      }
+    }
+  }
+}

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

@@ -0,0 +1,30 @@
+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; // s_t-请求时间戳，s_sign-请求端提供的签名
+
+    const signKey = 'li11shi08z2cx3shi0wen920';
+    const signature = md5(`${signKey}_${st}`); // 自己生成的md5签名
+    app.logger.info(`[${method} ${path}] signature: ${signature}`);
+
+    if (!sSign || !st || signature !== sSign.toLowerCase() || Date.now() - st > 600000) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: 'signature not correct or api timeout!!',
+        code: 445
+      }
+      return;
+    }
+    await next();
+  }
+}

package/app/middleware/error-handler.js

@@ -0,0 +1,34 @@
+/**
+ * 运行时异常错误处理，兜底所有异常
+ * @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('[-- excption --]:', err);
+      app.logger.error('[-- excption --]:', status, message, detail);
+
+      if (message && message.indexOf('template not found') > -1) {
+        // 页面重定向
+        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-handler.js

@@ -0,0 +1,22 @@
+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,
+        message: 'proj_key not found',
+        code: 446
+      }
+      return;
+    };
+
+    ctx.projKey = projKey;
+    await next();
+  }
+}

package/app/middleware.js

@@ -0,0 +1,37 @@
+const path = require('path');
+
+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',
+    path: path.resolve(process.cwd(), './app/public'),
+    nunjucksConfig: {
+      trimBlocks: true,
+      noCache: true
+    }
+  }));
+
+  // 引入 ctx.body 解析中间件
+  const bodyParser = require('koa-bodyparser');
+  app.use(bodyParser({
+    formList: '1000mb',
+    enableTypes: [ 'form', 'json', 'text' ]
+  }));
+
+  // 引入异常捕获中间件
+  app.use(app.middlewares.errorHandler);
+
+  // 引入签名合法性校验
+  app.use(app.middlewares.apiSignVerify);
+
+  // 引入 API 参数校验
+  app.use(app.middlewares.apiParamsVerify);
+
+  // 引入项目相关处理中间件
+  app.use(app.middlewares.projectHandler);
+}

package/app/pages/assets/custom.css

@@ -0,0 +1,16 @@
+html, body {
+ height: 100%;
+}
+
+#root {
+  height: 100%;
+}
+
+input:-webkit-autofill {
+  /* 覆盖自动填充背景颜色 */
+  -webkit-box-shadow: 0 0 0 1000px #121212 inset;
+}
+
+li {
+  list-style: none;
+}