@misstalor17/elpis 1.0.0

package/docs/dashboard-model.js

@@ -0,0 +1,143 @@
+const { ElButton } = require("element-plus");
+
+const document = {
+    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: '', // ifema路径
+        },
+        //当 moduleType === custom 时
+        customConfig: {
+            path: '',//自定义路由路径
+        },
+        //当 moduleType === schema 时
+        schemaConfig: {
+            api: '',//数据源API（遵循 RESTFUL 规范）
+            schema: {//板块数据结构
+                type: 'object',
+                properties: {
+                    key: {
+                        ...schema,//标准 scheam 配置
+                        type: '',//字段类型
+                        label: '',//字段中文名
+                        //字段在 table-bar 中的配置
+                        tableOption: {
+                            ...elTableColumnConfig,//标准 el-table-column 配置
+                            toFixed: 0,//保留几位小数
+                            visible: true,//默认为true(false时，表示不再表单中显示)
+                        },//字段在 table中的相关配置
+                        //字段在 search-bar 中的配置
+                        searchOption: {
+                            ...elComponentConfig,//标准 el-form 配置
+                            comType: '',//配置组件类型
+                            default: '',//默认值
+
+                            //comType === 'select'
+                            enumList: [],
+                            //comType === 'dynamicSelect'
+                            api: ''
+                        },
+                        //字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
+                        //如 componConfig。createForm，这里对应createFormOption
+                        //字段在 createForm 中的相关配置
+                        createFormOption: {
+                            ...elTableColumnConfig,//标准 el-component 配置
+                            comType: '',//控件类型 input/select
+                            visible: true,//是否展示
+                            disabled: false,//是否禁用
+                            default: '',//默认值
+
+                            //comType === 'select'
+                            enumList: [],
+                        },
+                        //字段在 editForm 中的相关配置
+                        editFormOption: {
+                            ...elTableColumnConfig,//标准 el-component 配置
+                            comType: '',//控件类型 input/select
+                            visible: true,//是否展示
+                            disabled: false,//是否禁用
+                            default: '',//默认值
+                            //comType === 'select'
+                            enumList: [],
+                        },
+                        detailPanelOption:{
+                            ...elTableColumnConfig,//标准 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配置
+                }, {}],//可以多个配置
+            },//table 相关配置
+            searchConfig: {},//search-bar相关配置
+            //动态组件相关配置
+            componentConfig: {
+                // create-form 表单相关配置
+                createForm: {
+                    title: '',// 表单标题
+                    saveBtnText: '',//保存按钮文案
+                },
+                // edit-form 表单相关配置
+                editForm: {
+                    mainKey: '',//表单主键，用于唯一标识要修改的数据对象
+                    title: '',// 表单标题
+                    saveBtnText: '',//保存按钮文案
+                },
+                // detaul-panel表单相关配置
+                detailPanel: {
+                    mainKey: '',//表单主键，用于唯一标识要修改的数据对象
+                    title: '',// 表单标题
+                }
+                //...支持用户动态扩展
+            }
+        }
+    }]
+}

package/elpis-core/env.js

@@ -0,0 +1,23 @@
+module.exports = (app) => {
+    return {
+        //判断是否本地环境
+        isLocal(){
+            return process.env._ENV === 'local'
+        },
+
+        //判读是否测试环境
+        isBeta(){
+            return process.env._ENV === 'beta'
+        },
+
+        //判断是否生产环境
+        isProduction(){
+            return process.env._ENV === 'production'
+        },
+
+        //获取当前环境
+        get(){
+            return process.env._ENV ?? 'local'
+        }
+    }
+}

package/elpis-core/index.js

@@ -0,0 +1,93 @@
+const Koa = require('koa')
+const path = require('path');
+const { sep } = path //兼容不同操作系统的斜杠
+
+const env = require('./env')
+
+//引入中间件
+const middlewareLoader = require('./loader/middleware')
+const routerSchemaLoader = require('./loader/router-schema')
+const routerLoader = require('./loader/router')
+const controllerLoader = require('./loader/controller')
+const serviceLoader = require('./loader/service')
+const configLoader = require('./loader/config')
+const extendLoader = require('./loader/extend')
+
+module.exports = {
+    /**
+     * 启动项目
+     * @params options 项目配置
+     * 
+     * options = {
+     *     name //项目名称
+     * }   homePath //项目首页
+     */
+    start(options = {}) {
+        //创建 koa实例
+        const app = new Koa();
+
+
+        //应用配置
+        app.options = options
+
+        //基础路径
+        app.baseDir = process.cwd()
+
+        //业务文件路径
+        app.businessPath = path.resolve(app.baseDir, `.${sep}app`) //此处.{sep}app代表./app,为了兼容不同操作系统
+
+        //初始化环境设置
+        app.env = env()
+        console.log(`-- [start] env: ${app.env.get()} --`); //打印当前环境
+
+        //加载middleware
+        middlewareLoader(app)
+        console.log(`-- [start] loader middleware done --`);
+        //加载mrouterSchema
+        routerSchemaLoader(app)
+        console.log(`-- [start] loader routerSchema done --`);
+        //加载controller
+        controllerLoader(app)
+        console.log(`-- [start] loader controller done --`);
+        //加载service
+        serviceLoader(app)
+        console.log(`-- [start] loader service done --`);
+        //加载config
+        configLoader(app)
+        console.log(`-- [start] loader config done --`);
+        //加载extend
+        extendLoader(app)
+        console.log(`-- [start] loader extend done --`);
+
+        //注册elpis中间件
+        const elpisMiddlewarePath = path.resolve(__dirname,`..${sep}app${sep}middleware.js`)
+        const elpisMiddleware = require(elpisMiddlewarePath)
+        elpisMiddleware(app)
+        console.log(`-- [start] loader global elpis middleware done --`);
+        //注册全局中间件
+        try {
+            require(`${app.businessPath}${sep}middleware.js`)(app)
+            console.log(`-- [start] loader global business middleware done --`);
+        } catch (error) {
+            console.log('[exception] there is no global business middleware file.');
+        }
+
+        //注册路由
+        routerLoader(app)
+        console.log(`-- [start] loader router done --`);
+
+
+        //启动服务(node index.js)
+        try {
+            const port = process.env.PORT || 8080;
+            const host = process.env.IP || '0.0.0.0'
+            app.listen(port, host)
+            console.log(`Server runnin on port: ${port}`);
+        } catch (e) {
+            console.error(e);
+        }
+
+        return app;
+    }
+}
+

package/elpis-core/loader/config.js

@@ -0,0 +1,52 @@
+const path = require('path');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * config loader
+ * @param {object} app koa 实例
+ * 
+ * 配置区分 本地/测试/生产，通过env环境读取不同文件配置 env.config
+ * 通过env.config 覆盖 default.config 加载到 app。config中
+ * 
+ * 目录下对应的 config 配置
+ * 默认配置 config/config.default.js
+ * 默认配置 config/config.local.js
+ * 默认配置 config/config.beta.js
+ * 默认配置 config/config.prod.js
+ */
+
+
+
+module.exports = (app) => {
+    //elpis config 目录及相关文件
+    const elpisConfigPath = path.resolve(__dirname,`..${sep}..${sep}config`)
+    let defaultConfig = require(path.resolve(elpisConfigPath,`.${sep}config.default.js`))
+    //业务 config 目录及相关文件
+    const businessConfigPath = path.resolve(process.cwd(), `.${sep}config`)
+    try {
+        defaultConfig = {
+            ...defaultConfig,
+            ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`))
+        }
+    } catch (e) {
+        console.log('[exception] there is no default.config file');
+    }
+
+    //获取 env.config
+    let envConfig = {}
+    try {
+        if (app.env.isLocal()) { //本地环境
+            envConfig = require(path.resolve(businessConfigPath, `.${sep}config.local.js`))
+        } else if (app.env.isBeta()) { //测试环境
+            envConfig = require(path.resolve(businessConfigPath, `.${sep}config.beta.js`))
+        } else if (app.env.isProduction()) { //生产环境
+            envConfig = require(path.resolve(businessConfigPath, `.${sep}config.prod.js`))
+        }
+    } catch (e) {
+        console.log('[exception] there is no env.config file');
+    }
+
+    //覆盖并加载 config 配置
+    app.config = Object.assign({}, defaultConfig, envConfig);
+
+}

package/elpis-core/loader/controller.js

@@ -0,0 +1,61 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * controller loader
+ * @param {object} app Koa 实例 
+ * 
+ * 加载所有 controller，可通过‘app。controller.${目录}.${文件}’ 访问
+ * 
+ * 举例：
+ * app/controller
+ *  |
+ *  | -- custom-module
+ *         |
+ *         | -- custom-controller.js
+ * => app.controller.customModule.customcCntroller
+ */
+
+module.exports = (app) => {
+    const controller = {}
+    //读取 elpis/app/controller/**/**.js 下所有的文件
+    const elpisControllerPath = path.resolve(__dirname,`..${sep}..${sep}app${sep}controller`)
+    const elpisFileList = glob.sync(path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        handleFile(file)
+    });
+    //读取 业务app/controller/**/**.js 下所有的文件
+    const businessControllerPath = path.resolve(app.businessPath, `.${sep}controller`)
+    const businessFileList = glob.sync(path.resolve(businessControllerPath, `.${sep}**${sep}**.js`))
+    businessFileList.forEach(file => {
+        handleFile(file)
+    });
+    //把内容加载到 app.controller 下
+    function handleFile (file) {
+        // 提取文件名称
+        let name = path.resolve(file)
+        //街区路径 app/controller/custom-module/custom-controller.js => custom-module/custom-controller
+        name = name.substring(name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length, name.lastIndexOf('.'))
+        // 把 '-'统一替换成驼峰 ustom-module/custom-controller.js => custommodule.customController
+        name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase())
+
+        // 挂载 controller 到内存app对象中
+        let tempController = controller;
+        const names = name.split(sep);
+
+        for (let i = 0, len = names.length; i < len; i++) {
+            if (i === len - 1) {
+                const controllerMoule = require(path.resolve(file))(app)
+                tempController[names[i]] = new controllerMoule()
+            } else {
+                if (!tempController[names[i]]) {
+                    tempController[names[i]] = {}
+                }
+                tempController = tempController[names[i]]
+            }
+        }
+    }
+
+    app.controller = controller
+}

package/elpis-core/loader/extend.js

@@ -0,0 +1,52 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * extend loader
+ * @param {object} app Koa 实例 
+ * 
+ * 加载所有 extend，可通过‘app.extend.${文件}’ 访问
+ * 
+ * 举例：
+ * app/extend
+ *  |
+ *  | -- custom-extend.js
+ * => app.extend.customExtend 访问
+ */
+
+module.exports = (app) => {
+    //读取 elpis/app/extend/**.js 下所有的文件
+    const elpisExtendPath = path.resolve(__dirname,`..${sep}..${sep}app${sep}extend`)
+    const elpisFileList = glob.sync(path.resolve(elpisExtendPath, `.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        handleFile(file)
+    });
+
+    //读取 业务app/extend/**.js 下所有的文件
+    const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`)
+    const bussinessFileList = glob.sync(path.resolve(businessExtendPath, `.${sep}**${sep}**.js`))
+    bussinessFileList.forEach(file => {
+        handleFile(file)
+    });
+    //把内容加载到 app.extend 下
+    function handleFile (file) {
+        // 提取文件名称
+        let name = path.resolve(file)
+        //街区路径 app/extend/custom-extend.js => custom-extend
+        name = name.substring(name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length, name.lastIndexOf('.'))
+        // 把 '-'统一替换成驼峰 custom-extend.js => customExtend
+        name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase())
+
+        for (const key in app) {
+            if (key === name) {
+                console.log(`[extend load error] name:${name} is already in app`);
+                return;
+            }
+        }
+        //挂载 extend 到 app 上
+        app[name] = require(path.resolve(file))(app)
+
+    }
+    // app.extend = fileList
+}

package/elpis-core/loader/middleware.js

@@ -0,0 +1,61 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * middleware loader
+ * @param {object} app Koa 实例 
+ * 
+ * 加载所有 middleware，可通过‘app。middlewares.${目录}.${文件}’ 访问
+ * 
+ * 举例：
+ * app/middleware
+ *  |
+ *  | -- custom-module
+ *         |
+ *         | -- custom-middleware.js
+ * => app.middlewares.customModule.customMiddleware
+ */
+
+module.exports = (app) => {
+    const middlewares = {}
+    //读取 /elpis/app/middleware/**/**.js 下所有的文件
+    const elpisMiddlewarePath = path.resolve(__dirname,`..${sep}..${sep}app${sep}middleware`)
+    const elpisFileList = glob.sync(path.resolve(elpisMiddlewarePath,`.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        handleFile(file)
+    });
+
+//读取 业务根目录/app/middleware/**/**.js 下所有的文件
+const businessMiddlewarePath = path.resolve(app.businessPath,`.${sep}middleware`)
+const bussinessFileList = glob.sync(path.resolve(businessMiddlewarePath,`.${sep}**${sep}**.js`))
+bussinessFileList.forEach(file => {
+    handleFile(file)
+});
+
+    //把内容加载到 app.middlewares 下
+
+    function handleFile(file){
+            // 提取文件名称
+            let name = path.resolve(file)
+            //街区路径 app/middleware/custom-module/custom-middleware.js => custom-module/custom-middleware
+            name = name.substring(name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length,name.lastIndexOf('.'))
+            // 把 '-'统一替换成驼峰 ustom-module/custom-middleware.js => custommodule.customMiddleware
+            name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase())
+    
+            // 挂载 middleware 到内存app对象中
+            let tempMiddleware = middlewares;
+            const names = name.split(sep);
+            for(let i = 0,len = names.length; i < len; i++){
+                if(i === len - 1){ //文件
+                    tempMiddleware[names[i]] = require(path.resolve(file))(app)
+                }else{ // 文件夹
+                    if(!tempMiddleware[name[i]]){
+                        tempMiddleware[name[i]] = {}
+                    }
+                    tempMiddleware = tempMiddleware[name[i]]
+                }
+            }
+    }
+    app.middlewares = middlewares
+}

package/elpis-core/loader/router-schema.js

@@ -0,0 +1,46 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * router-schema loader
+ * @param {object} app koa 实例 
+ * 
+ * 通过‘json-schema & ajv 对 API 规则进行约束，配合 api-params-verify’
+ * 
+ * app/router-schema/**.js
+ * 
+ * 输出：
+ * app.routerSchema = {
+ *   '${app1}':${jsonSchema},
+ *   '${app2}':${jsonSchema},
+ *   '${app3}':${jsonSchema},
+ *   '${app4}':${jsonSchema},
+ * }
+ */
+
+module.exports = (app) => {
+    let routerSchema = {}
+    //读取 elpis/app/router-schema/**/**.js 下所有的文件
+    const elpisRouterSchemaPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}router-schema`)
+    const elpisFileList = glob.sync(path.resolve(elpisRouterSchemaPath, `.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        handleFile(file)
+    })
+    //读取 业务app/router-schema/**/**.js 下所有的文件
+    const bussinessRouterSchemaPath = path.resolve(app.businessPath, `.${sep}router-schema`)
+    const bussinessFileList = glob.sync(path.resolve(bussinessRouterSchemaPath, `.${sep}**${sep}**.js`))
+    bussinessFileList.forEach(file => {
+        handleFile(file)
+    })
+    //注册所有 routerSchema，使得可以 ‘app.routerSchema’ 这样访问
+    function handleFile(file) {
+        routerSchema = {
+            ...routerSchema,
+            ...require(path.resolve(file))
+        }
+    }
+
+    app.routerSchema = routerSchema
+
+}

package/elpis-core/loader/router.js

@@ -0,0 +1,43 @@
+const glob = require('glob')
+const path = require('path');
+const { sep } = path //兼容不同操作系统的斜杠
+const KoaRouter = require('koa-router')
+/**
+ * router loader
+ * @param {object} app koa 实例
+ * 
+ * 解析所有 app/router 下所有 js 文件，加载到 KoaRouter 下
+ */
+
+
+module.exports = (app) => {
+    //实例化 KoaRouter
+    const router = new KoaRouter()
+
+    // 找到epis路由文件路径
+    const elpisRouterPath = path.resolve(__dirname,`..${sep}..${sep}app${sep}router`)
+    //注册所有路由
+    const elpisFileList = glob.sync(path.resolve(elpisRouterPath, `.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        require(path.resolve(file))(app, router)
+    })
+
+    // 找到业务路由文件路径
+    const businessRouterPath = path.resolve(app.businessPath, `.${sep}router`)
+    //注册所有路由
+    const businessFileList = glob.sync(path.resolve(businessRouterPath, `.${sep}**${sep}**.js`))
+    businessFileList.forEach(file => {
+        require(path.resolve(file))(app, router)
+    })
+
+    //路由兜底（健壮性考虑）
+    router.get('*', async (ctx, next) => {
+        ctx.status = 302 //临时重定向
+        ctx.redirect(`${app?.options?.homePage ?? '/'}`)
+    })
+
+    //路由注册到 app 上
+    app.use(router.routes())
+    app.use(router.allowedMethods())
+
+}

package/elpis-core/loader/service.js

@@ -0,0 +1,61 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path //兼容不同操作系统的斜杠
+
+/**
+ * service loader
+ * @param {object} app Koa 实例 
+ * 
+ * 加载所有 service，可通过‘app。service.${目录}.${文件}’ 访问
+ * 
+ * 举例：
+ * app/service
+ *  |
+ *  | -- custom-module
+ *         |
+ *         | -- custom-service.js
+ * => app.service.customModule.customcService
+ */
+
+module.exports = (app) => {
+    const service = {}
+    //读取 elpis/app/service/**/**.js 下所有的文件
+    const elpisServicePath = path.resolve(__dirname,`..${sep}..${sep}app${sep}service`)
+    const elpisFileList = glob.sync(path.resolve(elpisServicePath, `.${sep}**${sep}**.js`))
+    elpisFileList.forEach(file => {
+        handleFile(file)
+    });
+    //读取 业务app/service/**/**.js 下所有的文件
+    const businessServicePath = path.resolve(app.businessPath, `.${sep}service`)
+    const businessFileList = glob.sync(path.resolve(businessServicePath, `.${sep}**${sep}**.js`))
+    businessFileList.forEach(file => {
+        handleFile(file)
+    });
+    //把内容加载到 app.service 下
+    function handleFile (file) {
+        // 提取文件名称
+        let name = path.resolve(file)
+        //街区路径 app/service/custom-module/custom-service.js => custom-module/custom-service
+        name = name.substring(name.lastIndexOf(`service${sep}`) + `service${sep}`.length, name.lastIndexOf('.'))
+        // 把 '-'统一替换成驼峰 ustom-module/custom-service.js => custommodule.customService
+        name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase())
+
+        // 挂载 service 到内存app对象中
+        let tempService = service;
+        const names = name.split(sep);
+
+        for (let i = 0, len = names.length; i < len; i++) {
+            if (i === len - 1) {
+                const serviceMoule = require(path.resolve(file))(app)
+                tempService[names[i]] = new serviceMoule()
+            } else {
+                if (!tempService[names[i]]) {
+                    tempService[names[i]] = {}
+                }
+                tempService = tempService[names[i]]
+            }
+        }
+    }
+
+    app.service = service
+}

package/index.js

@@ -0,0 +1,38 @@
+//引入 eplis-core
+const ElpisCore = require('./elpis-core')
+//引入前端工程化构建方法
+const FEBuildDev = require('./app/webpack/dev')
+const FEBuildProd = require('./app/webpack/prod')
+
+module.exports = {
+    /**
+     * 服务端基础
+     */
+    Controller: {
+        Base: require('./app/controller/base')
+    },
+    Service: {
+        Base: require('./app/service/base')
+    },
+
+/**
+ * 编译构建前端工程
+ * @params env 环境变量 local/production
+ */
+frontendBuild(env) {
+        if (env === 'local') {
+            FEBuildDev()
+        } else if (env === 'production') {
+            FEBuildProd()
+        }
+    },
+    /**
+     * 启动 elpis
+     * @param options 项目配置，透传到 elpis-core
+     */
+    serverStart(options = {}) {
+        const app = ElpisCore.start(options)
+        return app;
+    }
+}
+