@dmqweb/elpis 1.0.0

package/.eslintignore

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

package/.eslintrc

@@ -0,0 +1,59 @@
+{
+  "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",
+    "requireConfigFile": false, 
+    "babelOptions": {
+      "presets": ["@babel/preset-env"] // 确保与项目 Babel 预设一致
+    }
+  },
+  "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/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "oxc.enable": true,
+  "cSpell.words": [
+    "获取和modelitem里的key值相同的projectitem",
+    "chunkhash",
+    "daterange",
+    "elpis",
+    "happypack",
+    "mlist",
+    "sider",
+    "taobao",
+    "validata"
+  ],
+  "liveServer.settings.port": 5501
+}

package/README.md

@@ -0,0 +1,198 @@
+# Elpis
+## 企业级全栈框架
+## model配置
+```js
+
+
+// dsl dashboard 模板配置
+export default {
+  mode: 'dashboard', // 模板类型， 不同模板类型对应不一样的模板数据结构
+  name: '', // 名称;
+  desc: '', // 描述
+  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 配置（占位）
+            type: '', // 字段类型
+            label: '', // 字段名称
+            // 字段在 table 中的相关配置
+            tableOption: {
+              // 标准 el-table-column 配置（占位）
+              toFixes: 2, // 数字类字段保留小数位数
+              visible: true // 是否在 表单 中显示
+            },
+            searchOption: {
+              // 标准 el-component-column 配置（占位）
+              comType: '', // 配置组件类型 input/select....
+              default: '', // 默认值
+
+              // 当 comType 为 select时
+              enumList: [], // 下拉框可选值
+
+              // 当 comType 为 dynamicSelect时
+              api: '',
+            },
+            // 字段在不同动态 component 中的相关配置， 前缀对应 componentConfig 中的键值
+            // 比如 componentConfig.createForm 这里就对应 createFormOption 的配置
+            // 字段在 createForm 中相关配置
+            createFormOption: { 
+              // 标准 el-component-column 配置（占位）
+              comType: '', // 控件类型 input/select....
+              visible: true, // 是否在 表单 中显示 默认true
+              disabled: false, // 是否禁用
+              default: '', // 默认值
+
+              // 当 comType 为 select时
+              enumList: [], // 下拉框可选值
+            },
+            // 字段在 editForm 中相关配置
+            editFormOption: {
+              // 标准 el-component-column 配置（占位）
+              comType: '', // 控件类型 input/select....
+              visible: true, // 是否在 表单 中显示 默认true
+              disabled: false, // 是否禁用
+              default: '', // 默认值
+            },
+            // 字段在 detailPanel 中相关配置
+            detailPanelOption: {
+              // 标准 el-component-column 配置（占位）
+              comType: '', // 控件类型 input/select....
+              visible: true, // 是否在 表单 中显示 默认true
+              disabled: false, // 是否禁用
+              default: '', // 默认值
+            },
+          },
+          // ... 用户可扩展
+        },
+        required: [],
+      },
+      // 表单配置
+      tableConfig: {
+        headerButtons: [{ // 头部按钮组
+          label: '', // 按钮名称
+          eventKey: '', // 按钮事件名
+          eventOption: {
+            // 当eventKey === 'showComponent' 时，可填
+            conName: '', // 组件名称
+          }, // 按钮配置
+          // 标准 el-button 配置（占位）
+        }], // ... 更多按钮项
+        rowButtons: [{ // 行为按钮组
+          label: '',
+          eventKey: '',
+          eventOption: {
+            // 当eventKey === 'showComponent' 时，可填
+            conName: '', // 组件名称
+
+            // 当eventKey === 'remove' 时，可填
+            params: {
+              // paramKey = 参数键名
+              // rowValueKey = 参数值 当格式为 schema::tableKey 的时候，到 table中找到响应的字段
+              paramKey: 'rowValueKey'
+            }
+          },
+          // 标准 el-button 配置（占位）
+        }]
+      }, // table 配置
+      searchConfig: {}, // search-bar 配置
+      // 动态组件 相关配置
+      componentConfig: {
+        // create-form 表单相关配置
+        createForm: {
+          title: '', // 创建表单标题
+          saveBtnText: '', // 保存按钮名称
+        },
+        // edit-form 表单相关配置
+        editForm: {
+          mainKey: '', // 主键字段
+          title: '', // 编辑表单标题
+          saveBtnText: '', // 保存按钮名称
+        },
+        // detail-panel 表单相关配置
+        detailPanel: {
+          mainKey: '', // 主键字段
+          title: '', // 详情表单标题
+        },
+      }
+      // ... 支持用户动态扩展
+    }
+  }] // ... 更多菜单
+}
+```
+
+## 服务端启动
+```js
+const { serverStart } = require("@dmqweb/elpis");
+const app = serverStart({
+    name:"名称",
+    homePage:"/home"
+});
+```
+## 自定义服务器
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+## 前端构建
+```js
+const {frontendBuild} = require("@dmqweb/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`
+
+## 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/complext-view` 下写控件
+2. 配置到 `app/widgets/schema-search-bar/search-item-config.js`

package/app/controller/base.js

@@ -0,0 +1,41 @@
+module.exports = (app) => class BaseController {
+/**
+ * controller 基类
+ * 统一收拢 controller 相关的公共方法
+*/
+constructor() {
+  this.app = app;
+  this.config = app.config;
+}
+
+/**
+ * API 处理成功时统一返回结构 
+ * @param {object} ctx 上下文
+ * @param {object} data 核心数据
+ * @param {object} metadata 附加数据
+ */
+  success(ctx, data = {}, metadata = {}) {
+    ctx.status = 200; // 设置HTTP响应状态码为200，表示请求成功
+    // 设置响应体，返回统一格式的JSON数据
+    ctx.body = {
+      success: true,
+      data,
+      metadata
+    }
+  }
+
+/**
+ * API 处理失败时统一返回结构
+ * @param {object} ctx 上下文
+ * @param {object} message 错误信息
+ * @param {object} code 错误码
+ */
+  fail(ctx, message, code) {
+    // 设置响应体，返回统一格式的JSON数据
+    ctx.body = {
+      success: false,
+      message,
+      code
+    }
+  }
+}

package/app/controller/project.js

@@ -0,0 +1,98 @@
+module.exports = (app) => { 
+  // 引入基础控制器类，用于继承基础方法如success、error等
+  const BaseController = require('./base')(app);
+  
+  // 导出并创建项目控制器类，继承基础控制器
+  return class projectController extends BaseController {
+
+    /**
+     * 获取项目配置
+     * @param {object} ctx 上下文对象，包含请求和响应相关信息
+     * @param {string} ctx.request.query.proj_key 项目键值，用于指定要获取的项目配置
+     */
+    async get(ctx) {
+      const { 
+        proj_key: projKey
+      } = ctx.request.query;
+
+      const { project: projectService} = app.service;
+      const projConfig = await projectService.get(projKey);
+
+      if(!projConfig) {
+        this.fail(ctx, '项目获取异常', 5000);
+        return;
+      }
+
+      // 调用基础控制器的success方法，返回成功响应和项目配置数据
+      this.success(ctx,projConfig) 
+    }
+
+
+    /**
+     * 获取项目列表
+     * 获取当前 projectKey 对应模型下的项目列表 （如果无 projectKey， 则获取所有项目列表）
+     */
+    async getProjectList(ctx) {
+      const { 
+        proj_key: projectKey
+      } = ctx.request.query;
+
+      // 从app.service中解构出project服务模块
+      const  { project: projectService } = app.service
+      const projectList = await projectService.getProjectList({projectKey});
+
+      // 构造返回结果，只返回关键数据
+      const dtoProjectList = projectList.map(item => {
+        const { name, desc, homePage, key, modelKey} = item;
+        return {
+          name,
+          desc,
+          homePage,
+          key,
+          modelKey
+        }
+      })
+
+      // 调用基础控制器的success方法，返回成功响应和项目列表数据
+      this.success(ctx,dtoProjectList) 
+    }
+
+
+
+    /**
+     * 获取所有模型与项目的结构化数据
+     * @param {object} ctx 上下文对象，包含请求和响应相关信息
+     */
+    async getModelList(ctx) {
+      // 从app.service中解构出project服务模块
+      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((pre, projKey) => {
+          const {key, name, desc, homePage} = project[projKey]
+          pre[projKey] = {key, name, desc, homePage}
+          return pre
+        }, {})
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject
+        })
+
+        return preList
+      }, [])
+
+      // 调用基础控制器的success方法，返回成功响应和项目列表数据
+      this.success(ctx,dtoModelList) 
+    }
+  }
+}

package/app/controller/view.js

@@ -0,0 +1,24 @@
+// 这个函数返回一个控制器类
+module.exports = (app) => { 
+   // 返回一个名为 viewController 的类
+    return class viewController {
+    /**
+     * 渲染页面
+     * @param {object} ctx 上下文
+     */
+    async renderPage(ctx) {
+      app.logger.info(`[viewController] query: ${JSON.stringify(ctx.query)} `)
+      app.logger.info(`[viewController] params: ${JSON.stringify(ctx.params)} `)
+      // ctx.render() 是模板引擎提供的方法，用于渲染模板
+      // ctx.params.page 获取路由中的 :page 参数值
+      // 例如：如果访问 /view/page1，那么 ctx.params.page 就是 "page1"
+      // 最终会渲染 output/entry.page1 模板
+      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,43 @@
+const log4js = require('log4js');
+
+/**
+ * 日志工具
+ * 外部调用 app.logger.info app.logger.error
+ */
+module.exports = (app) => { 
+  let logger;
+
+  // 根据运行环境选择不同的日志记录方式
+  if (app.env.isLocal()){
+    // 本地开发环境：直接使用控制台输出日志
+    logger = console;
+  }else {
+     // 生产或测试环境：使用 log4js 记录日志并保存到磁盘文件中
+    log4js.configure({  
+      // 配置日志输出方式（追加器）
+      appenders: {
+        // 控制台输出                             
+        console:{
+          type: 'console'
+        },
+        // 文件输出，按日期切分日志文件
+        dateFile: {
+          type: 'dateFile',
+          filename: './logs/applocation.log', // 日志文件路径和基本名称
+          pattern: 'yyyy-MM-dd' // 按天切分文件的模式
+        }
+      },
+       // 配置日志分类和级别
+      categories: {
+        default: {
+          appenders: ['console', 'dateFile'],// 同时输出到控制台和文件
+          level: 'trace'  // 记录所有级别的日志（trace 是最低级别）
+        }
+      }
+    });
+    // 获取默认分类的日志记录器实例
+    logger = log4js.getLogger();
+  }
+  // 返回配置好的日志记录器
+  return logger;
+}

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

@@ -0,0 +1,89 @@
+const Ajv = require('ajv')
+const ajv = new Ajv()
+
+/**
+ * API参数验证中间件
+ * 用于验证API请求的参数是否符合预定义的JSON Schema规范
+ */
+
+module.exports = (app) => {
+
+  // JSON Schema标准版本定义
+  const $schema = "http://json-schema.org/draft-07/schema#"
+
+  // 返回中间件函数，处理每个请求
+  return async (ctx, next) => {
+    // 只对API请求进行参数验证，非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}] 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)}]`)
+
+    // 从应用的路由Schema配置中获取当前路径和方法对应的参数验证规则
+    const schema = app.routerSchema[path]?.[method.toLowerCase()]
+
+    // 如果没有定义验证规则，则跳过验证
+    if (!schema) {
+      return await next();
+    }
+
+    // 验证结果标志，默认为true
+    let valid = true
+
+    // 用于存储ajv验证器实例
+    let validate;
+
+    // 按优先级顺序验证各部分参数: headers -> body -> query -> params
+
+    // 验证请求头(headers)参数
+    if (valid && headers && schema.headers) {
+      schema.headers.$schema = $schema           // 设置JSON 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;                          // HTTP状态码设为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,47 @@
+const md5 = require("md5");
+
+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;
+
+    // 如果是浏览器直接访问（没有签名信息），则跳过验证
+    if (!sSign && !st) {
+      await next();
+      return;
+    }
+
+    // 服务端预设的签名密钥
+    const signKey = 'elpis-sign-key'
+    // 根据时间戳和密钥生成签名
+    const signature = md5(`${signKey}_${st}`)
+    app.logger.info(`[${method} ${path}] signature: ${signature}`)
+
+    // 验证签名的合法性
+    // 条件包括：
+    // 1. 必须提供签名(sSign)
+    // 2. 必须提供时间戳(st)
+    // 3. 生成的签名必须与客户端提供的签名一致
+    // 4. 时间戳不能超过10分钟（600 * 1000毫秒）
+    if (!sSign || !st || signature !== sSign.toLowerCase() || Date.now() - st > 600 * 1000 ) {
+      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,41 @@
+/**
+ *  运行时异常错误处理，兜底使用异常
+ * @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);
+
+      // 特殊处理：如果错误信息中包含"template not found"（模板未找到）
+      // 则重定向到配置的主页
+      if (message && message.indexOf('template not found') > -1){
+        ctx.status = 302;
+        ctx.redirect(`${app.options?.homePage}`);
+        return;
+      }
+      
+      // 默认的错误响应结构
+      const resBody = {
+        success: false,
+        code: 500,
+        message:  '服务器异常',
+      }
+
+      // 设置响应状态码为200（即使出现错误也返回200，错误信息放在body中
+      ctx.status = 200;
+      // 设置响应体，返回统一格式的错误信息 
+      ctx.body = resBody;
+
+    }
+  }
+}