@maomao101/elpis

v1.0.1

Published

4 months ago

Elpis 是一个基于 Node.js + Koa2 + Vue3 的全栈低代码开发平台，旨在通过配置化的方式快速构建企业级管理系统。项目采用模块化架构设计，支持多项目管理。

0High
0Medium
0Low

maomao101

Elpis

一个企业级应用框架，通过全栈实现。

项目概况

技术栈

后端技术栈

框架: Koa2 模板引擎: Nunjucks 测试框架: Mocha + Supertest 工具库: Lodash, MD5, Glob

前端技术栈

框架: Vue 3 (Composition API) UI 组件库: Element Plus 状态管理: Vuex 4 路由: Vue Router 4 构建工具: Webpack 5 样式预处理: Less

项目架构

核心架构设计

项目采用分层架构模式，主要包含以下几个层次：

Elpis 架构ect ├── 表现层 (Presentation Layer) │ ├── Vue3 组件 │ ├── Vue3 组件 │ └── 路由管理 ├── 业务逻辑层 (Business Logic Layer) │ ├── Controller 控制器 │ ├── Service 服务层 │ └── 中间件系统 ├── 数据访问层 (Data Access Layer) │ ├── Model 数据模型 │ └── Schema 配置 └── 基础设施层 (Infrastructure Layer) ├── Elpis-Core 核心框架 ├── 自动加载器 └── 配置管理

目录结构

Elpis/ ├── app/ # 应用主目录 │ ├── controller/ # 控制器层 │ ├── middleware/ # 中间件 │ ├── pages/ # 前端页面 │ ├── public/ # 静态资源 │ ├── router/ # 路由配置 │ ├── router-schema/ # 路由参数校验 │ ├── service/ # 服务层 │ ├── view/ # 模板文件 ├── config/ # 配置文件 ├── elpis-core/ # 核心框架 ├── model/ # 数据模型 └── doc/ # 配置文档

model配置

{
  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: {
              // 继承 el-table-column 配置
              ...elTableColumnConfig, // 标准 el-table-column 配置
              toFixed: 0, // 保留小数后几位
              visible: true, // 默认为 true ，（false时，表示不在表单中显示）
            },
            // 字段在 search-bar 中的相关配置
            searchOption: {
              ...eleComponentConfig, // 标准 el-component-column 配置
              comType: '', // 配置控件(组件)类型 input/selete/...
              default: '', // 默认值
              // comType === 'select' 时
              enumList: [], // 下拉框可选项
              // comType === 'dynamicSelect' 时
              api: '' // 下拉框可选项请求 api
            },
            // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
            // 如： componentConfig.createForm 这里对应 createFormOption
            // 字段在 createForm 中相关配置
            createFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number
              visible: true, // 是否展示；默认为 true ，（false时，表示不在表单中显示）
              disabled: false, // 是否禁用 （true/false），默认为false
              default: '', // 默认值
              // comType === 'select' 时生效
              enumList: [] // 枚举列表
            },
            // 字段在 editForm 表单中相关配置
            editFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number
              visible: true, // 是否展示；默认为 true ，（false时，表示不在表单中显示）
              disabled: false, // 是否禁用 （true/false），默认为false
              default: '', // 默认值
              // comType === 'select' 时生效
              enumList: [] // 枚举列表
            },
            detailPanelOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/input-number
            },
          },
          ...
        },
        required: [], // 标记哪些字段是必填项
      },
      // table 相关配置
      tableConfig: {
        headerButtons: [{
          label: '', // 按钮中文名
          eventKey: '', // 按钮事件名
          // 按钮事件具体配置
          eventOption: {
            // 当 eventKey === 'showComponent'
            comName: '' // 组件名称
          },
          ...elButtonConfig // 标准 el-button 配置
        }, ...],
        rowButtons: [{
          label: '', // 按钮中文名
          eventKey: '', // 按钮事件名
          eventOption: {
            // 当 eventKey === 'remove'
            params: {
              // paramKey = 参数的键值
              // rowValueKey = 参数值（格式为 schema::tableKey ,到 table 中找到响应的字段）
              paramKey: rowValueKey
            }
          }, // 按钮事件具体配置
          ...elButtonConfig // 标准 el-button 配置
        }, ...],
      }, // table 相关配置
      searchConfig: {}, // search-bar 相关配置
      // 动态组件 相关配置
      componentConfig: {
        // create-form 表单相关配置
        createForm: {
          title: '', // 表单标题
          saveBtnText: '', // 保存按钮文案
        },
        editForm: {
          mainKey: '', // 表单主键，用于要修改数据的唯一标识
          title: '',// 表单标题
          saveBtnText: '', // 保存按钮文案
        },
        detailPanel: {
          mainKey: '', // 表单主键，用于要修改数据的唯一标识
          title: '',// 表单标题
        }
        // ...支持用户动态扩展
      }
    },
  }, ...]
}

服务端启动

const { serverStart } = require('@maomao101/elpis')
const app = serverStart({})

自定义服务端

- router-schema
- router
- controller
- service
- extend
- extendconfig

前端构建启动方法

const { frontendBuild } = require('@maomao101/elpis')

// 编译构建前端工程
frontendBuild(process.env._ENV)

自定义页面扩展

在 app/pages/ 目录下写入口 entry.xxx.js 例如: app/pages/home/home.vue && app/pages/home/entry.home.js

dashboard / custom-view 自定义页面扩展

在 app/pages/dashboard/xxx 写下页面

dashboard / schema-view / components 动态组件扩展

在 app/pages/dashboard/complex-view/schema-view/components 写下组件
配置到在 app/pages/dashboard/complex-view/schema-view/components/component-config.js

schema-form 控件扩展

在 app/pages/widgets/schema-form/complex-view 写下控件
配置到在 app/pages/widgets/schema-form/form-item-config.js

schema-search 控件扩展

在 app/pages/widgets/schema-search-bar/complex-view 写下控件
配置到在 app/pages/widgets/schema-search-bar/search-item-config.js