@pixel-shell/elpis 1.0.0

package/.eslintgnore

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

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,194 @@
+# Elpis
+
+# 一个企业级全栈应用框架
+
+### model配置
+
+```js
+{
+  mode: "dashboard", //模板类型，不同模板类型对应不一样的模板数据结构
+  name: "", //名称
+  desc: "", //描述
+  icon: "", //图标
+  homePage: "", // 首页路径
+  // 头部菜单配置
+  menu: [
+    {
+      key: "", //唯一标识
+      name: "", //菜单名称
+      menuType: "", //菜单类型，枚举值：'group'、'module'
+      // 当menuType为'group'时，子菜单列表
+      subMenu: [{}, ...],
+      // 当menuType为'module'时，模块配置
+      moduleType: "", // 模块类型，枚举值：sider,iframe,custom,schema
+      // 当moduleType为sider时，模块配置
+      siderConfig: {
+        menu: [{}, ...], // 侧边栏菜单列表
+      },
+      // 当moduleType为iframe时，模块配置
+      iframeConfig: {
+        path: "", // iframe路径
+      },
+      // 当moduleType为custom时，模块配置
+      customConfig: {
+        path: "", // 自定义路径
+      },
+      // 当moduleType为schema时，模块配置
+      schemaConfig: {
+        api: "", // 数据源API（遵循RESTful API规范）
+        schema: {
+          type: "object",
+          properties: {
+            key: {
+              ...schema, // 标准schema配置
+              type: "", // 字段类型
+              label: "", // 字段中文名
+              // 字段在table中的相关配置
+              tableOption: {
+                ...elTableColumnConfig, //标准 el-table-column 配置
+                toFixed: 0, // 数值类型字段保留的小数位数
+                visible: true, // 是否在table中显示
+              },
+              // 字段在search-bar中的相关配置
+              searchOption: {
+                ...elComponentConfig, //标准 el-component-column 配置
+                comType: "", // 配置组件类型 ，枚举值：input,select 。。。
+                defaule: "", // 默认值
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+
+                // comType === dynamic-select 时，相关配置
+                api: "", // 下拉选项API
+              },
+              // 字段在component中的相关配置,前缀对应componentConfig中的键值
+              // 如：componentConfig.createForm，这里对应 createFormOption
+              // 字段在createFormz中的相关配置
+              createFormOption: {
+                ...elComponentConfig, //标准 el-component 配置
+                comType: "", // 控件类型，枚举值：input,select 。。。
+                visible: true, // 是否显示
+                disabled: false, // 是否禁用
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+              },
+              // 字段在editForm中的相关配置
+              editFormOption: {
+                ...elComponentConfig, //标准 el-component 配置
+                comType: "", // 控件类型，枚举值：input,select 。。。
+                visible: true, // 是否显示
+                disabled: false, // 是否禁用
+
+                // comType === select 时，相关配置
+                enumList: [], // 下拉选项列表
+              },
+              detailPanelOption: {
+                ...elComponentConfig, //标准 el-component 配置
+              }
+            },
+          },
+          required: [], // 必填字段列表
+        },
+        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: {},
+        // 动态组件相关配置
+        componentConfig: {
+          // create-form 表单相关配置
+          createForm: {
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文本
+          },
+          // edit-form 表单相关配置
+          editForm: {
+            mainKey: "", // 主键字段名,用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+            saveBtnText: "", // 保存按钮文本
+          },
+          // detail-panel 相关配置
+          detailPanel: {
+            mainKey: "", // 主键字段名,用于唯一标识要修改的数据对象
+            title: "", // 表单标题
+          },
+          // ...支持用户动态扩展
+        },
+      },
+    }, ...
+  ],
+}
+```
+
+### 服务端启动
+
+```js
+const {
+  serverStart
+} = require("@pixel-shell/elpis");
+
+// 启动elpis服务
+const app = serverStart({});
+```
+
+### 自定义服务端
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+```js
+const { frontendBuild } = require("@pixel-shell/elpis");
+
+// 编译构建前端工程
+frontendBuild(process.env._ENV);
+```
+
+### 自定义页面扩展
+ * 在 `app/pages/` 目录下写入口 entry.xxx.js
+
+### dashboard / custom-view 自定义页面扩展
+* 在 `app/pages/dashboard/xxxx` 下写页面
+
+### dashboard / schemaview / components 动态组件扩展
+1. 在 `app/pages/dashbpard/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/component-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,40 @@
+module.exports = (app) =>
+  class BaseController {
+    /**
+     * controller 基类
+     * 统一收拢 controller 相关的公共方法
+     */
+    constructor() {
+      this.app = app;
+      this.config = app.config;
+    }
+
+    /**
+     * API 处理成功时统一返回结构
+     * @param {object} ctx 上下文
+     * @param {object} data data 核心数据
+     * @param {object} metadata metadata 附加数据
+     */
+    success(ctx, data = {}, metadata = {}) {
+      ctx.status = 200;
+      ctx.body = {
+        success: true,
+        data,
+        metadata,
+      };
+    }
+
+    /**
+     * 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,56 @@
+module.exports = (app) => {
+  const BaseController = require("./base")(app);
+  return class ProjectController extends BaseController {
+    /**
+     * 获取所有模型与项目的结构化数据
+     */
+    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 } = model;
+        const dtoModel = { key, name };
+        // 构造 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);
+    };
+    /**
+     * 获取当前 projKey 下的项目列表（如果没有传projKey则全量获取）
+     */
+    async getProjectList(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projectList = await projectService.getProjectList(projKey);
+      // 构造关键数据 list
+      const dtoProjectList = projectList.map((item)=>{
+        const { modelKey, key, name, desc, homePage } = item;
+        return { modelKey, key, name, desc, homePage };
+      });
+      this.success(ctx, dtoProjectList);
+    };
+    /**
+     * 获取当前 projKey 下的项目配置
+     */
+    async getProjectConfig(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projConfig = await projectService.getProjectConfig(projKey);
+      if (!projConfig) {
+        this.fail(ctx, '获取项目异常', 50000);
+        return;
+      }
+      this.success(ctx, projConfig);
+    }
+  };
+};

package/app/controller/view.js

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

package/app/extend/logger.js

@@ -0,0 +1,37 @@
+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,71 @@
+const Ajv = require("ajv");
+const ajv = new Ajv();
+
+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();
+    }
+    // 获取请求参数
+    const { body, query, headers } = ctx.request;
+    const { params, path, method } = ctx;
+
+    app.logger.info(`[${method} ${path}] params: ${JSON.stringify(params)}`);
+    app.logger.info(`[${method} ${path}] query: ${JSON.stringify(query)}`);
+    app.logger.info(`[${method} ${path}] body: ${JSON.stringify(body)}`);
+    app.logger.info(`[${method} ${path}] 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);
+    }
+
+    // 检验query
+    if (valid && query && schema.query) {
+      schema.query.$schema = $schema;
+      validate = ajv.compile(schema.query);
+      valid = validate(query);
+    }
+
+    // 检验body
+    if (valid && body && schema.body) {
+      schema.body.$schema = $schema;
+      validate = ajv.compile(schema.body);
+      valid = validate(body);
+    }
+
+    // 检验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
+      };
+      return;
+    }
+
+    await next();
+  };
+};

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

@@ -0,0 +1,32 @@
+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;
+
+    const signKey = "hgy3ghj5gyu03ghjk2ghje3kgu4ghj";
+    const signature = md5(`${signKey}_${st}`);
+    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!!',
+        code: 445
+      };
+      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) {
+        // 页面重定向
+        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,27 @@
+/**
+ * projecthandler相关项目处理内容
+ */
+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: "proj_key not found",
+      };
+      return;
+    }
+
+    ctx.projKey = projKey;
+    await next();
+  };
+};

package/app/middleware.js

@@ -0,0 +1,31 @@
+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: {
+      noCache: true,
+      trimBlocks: true,
+    },
+  }));
+
+  // 引入 ctx.body 解析中间件
+  const koaBodyParser = require("koa-bodyparser");
+  app.use(koaBodyParser({
+    formLimit: "1000mb",
+    enableTypes: ["json", "form", "text"],
+  }));
+  // 引入错误处理中间件
+  app.use(app.middlewares.errorHandler);
+  // 引入 API 签名校验中间件
+  app.use(app.middlewares.apiSignVerify);
+  // 引入 API 参数校验中间件
+  app.use(app.middlewares.apiParamsVerify);
+  // 引入项目处理中间件
+  app.use(app.middlewares.projectHandler);
+}

package/app/pages/asserts/custom.css

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

package/app/pages/boot.js

@@ -0,0 +1,47 @@
+import { createApp } from "vue";
+
+// 引入element-plus
+import ElementPlus from "element-plus";
+import "element-plus/theme-chalk/index.css";
+import "element-plus/theme-chalk/dark/css-vars.css";
+
+// 引入自定义样式
+import "./asserts/custom.css";
+
+import { pinia } from "$elpisStore"; // 引入pinia
+import { createRouter, createWebHistory } from "vue-router";
+/**
+ * vue 页面主入口，用于启动 vue
+ * @param pageComponent vue 入口组件
+ * @param routes 路由列表
+ * @param libs 页面使用的依赖的第三方包列表
+ */
+
+export default (pageComponent, { routes, libs } = {}) => {
+  const app = createApp(pageComponent);
+  // 挂载element-plus
+  app.use(ElementPlus);
+  // 引入pinia
+  app.use(pinia);
+  // 挂载第三方包
+  if (libs && libs.length) {
+    for (let i = 0; i < libs.length; ++i) {
+      app.use(libs[i]);
+    }
+  }
+  // 页面路由
+  if (routes && routes.length) {
+    const router = createRouter({
+      history: createWebHistory(), // 历史记录模式
+      routes,
+    });
+    // 挂载路由
+    app.use(router);
+    router.isReady().then(() => {
+      // 挂载到页面根元素
+      app.mount("#root");
+    });
+  } else {
+    app.mount("#root");
+  }
+};