#esf

一个企业级系统应用框架

model配置

{
    mode: "dashboard", // 模板类型，不同模板类型对应不一样的模板数据结构
    name: "", // 模板名称
    desc: "",
    icon: "", // 模板图标
    homePage: "", // 模板首页
    // 头部菜单
    menu: [{
        key: "",
        name: "",
        menuType: "", //菜单类型，分为：module（链接）和 group（下拉菜单）

        // 当menuType == group时，才有subMenu属性
        subMenu: [{
            // 可递归 menuItem
        }, ...],
        
        // 当menuType == module时
        moduleType: "", // 枚举值 sider/iframe/custom/schema

        // 当moduleType == iframe时
        iframeConfig: {
            path: "", //iframe路径
        },

        // 当moduleType == custom时
        customConfig: {
            path: "", // 自定义路由路径
        },

        // 当moduleType == schema时
        schemaConfig: {
            api: "", // 数据源API （遵循 RESTFUL 规范）,
            schema: { // 板块数据结构
            type: "object",
            properties: {
                key: {
                    ...schema, // 标准 schema
                    label: "", //字段中文名
                    type: "", //字段类型
                    // table相关配置
                    tableOption: {
                        ...elTbaleColumnConfig, //标准el-table-column配置
                        toFixed: 0, //保留几位小数
                        visible: true, // 默认true （false 时表示不在表单中显示）
                    },
                    // 字段在search-bar中的配置项
                    searchOption: {
                        ...eleComponentConfig, // 标准el组件配置
                        comType: "", //组件类型，如input/select等
                        default: "", //默认值

                        // comType === select时，才有enumList属性
                        enumList: [{}],

                        // comType === dynamicSelect时，才有api属性
                        api: "" //动态数据源API，要求返回数据格式为[{label: "", value: ""}]
                    },
                    // component相关配置项

                    // 字段在不同动态组件中的相关配置 对应componentConfig中的组件
                    // 如: componentConfig.createForm 就是createFormOption
                    createFormOption: {
                        ...eleComponentConfig, // 标准el组件配置
                        comType: "", //组件类型，如input/select等
                        default: "", //默认值
                        visible: true, // 默认true （false 时表示不在表单中显示）
                        disabled: false, // 默认false （true时表示表单项禁用）
                        // comType === select时，才有enumList属性
                        enumList: [{}],
                        // comType === dynamicSelect时，才有api属性
                        api: "" //动态数据源API，要求返回数据格式为[{label: "", value: ""}]
                    },
                    editFormOption: {
                        ...eleComponentConfig, // 标准el组件配置
                        comType: "", //组件类型，如input/select等
                        default: "", //默认值
                        visible: true, // 默认true （false 时表示不在表单中显示）
                        disabled: false, // 默认false （true时表示表单项禁用）
                        // comType === select时，才有enumList属性
                        enumList: [{}],
                        // comType === dynamicSelect时，才有api属性
                        api: "" //动态数据源API，要求返回数据格式为[{label: "", value: ""}]
                    },
                    detailPanelOption: {
                        ...eleComponentConfig, // 标准el组件配置
                    },
                    comBOption: {
                        ...eleComponentConfig, // 标准el组件配置
                    },
                    comCOption: {
                        ...eleComponentConfig, // 标准el组件配置
                    }

                }
            },
            required: [], //标记必填字段
            // table组件相关配置
            tableConfig: {
                headerButtons: [{
                    label: "",
                    eventKey: "", //按钮事件名
                    eventOption: {
                        // 当eventKey === "showComponent"
                        comName: "" // 组件名称，对应componentConfig中的组件
                    }, //按钮具体配置
                    ...elButtonConfig // 标准el-button配置
                },...],
                rowButtons: [{
                    label: "",
                    eventKey: "", //按钮事件名
                    eventOption: {
                        // 当eventKey === "showComponent"
                        comName: "", // 组件名称，对应componentConfig中的组件
                        // 当eventKey === "remove"
                        params: {
                            // paramKey 参数的键值 rowValueKey 参数值来源于表格行数据
                            // 当格式为schema::tableKey 到table中找响应字段
                            paramKey: rowValueKey
                        }
                    }, //按钮具体配置
                    ...elButtonConfig // 标准el-button配置
                },...],
            },    
            // search-bar相关配置
            searchConfig: {}, 
            // 动态组件 相关配置
            componentConfig: {
                // create-form 表单相关配置
                createForm: {
                    title: "",
                    saveBtnText: "",
                },
                editForm: {
                    mainKey: "", //表单主键
                    title: "",
                    saveBtnText: "",
                },
                // 详情
                detailPanel: {
                    mainKey: "", //表单主键
                    title: "",
                },
                // 支持扩展
                comB: {},
                comC: {},
            } 
        },

        // 当moduleType == sider时
        siderConfig: {
            menu: [{
                // 可递归 menuItem(除 moduleType === sider)
            }, ...]
        },
        
    }, ...]
}

服务端启动

const {
    serverStart
} = require(@bmsherry/esf);

// 启动 elpis 服务
const app = serverStart({})

自定义服务端

• router-schema
• router
• controller
• service
• extend
• config

前端构建

const { frontendBuild } = require("@bmsherry/esf");

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

自定义页面扩展

• 在 app/pages/ 目录下写入 entry.xxx.js

dsahboard / 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/widgets/schema-form/complex-view 下写控件
• 配置到 app/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

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