@james-zhang/elpis 1.0.0

package/.eslintignore

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

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/.tmp-check.js

@@ -0,0 +1,47 @@
+const { JSDOM } = require('C:/Users/孤夜~/AppData/Local/Temp/jsdom-test/node_modules/jsdom');
+
+(async () => {
+  const url = 'http://127.0.0.1:8080/view/project';
+  const dom = await JSDOM.fromURL(url, {
+    runScripts: 'dangerously',
+    resources: 'usable',
+    pretendToBeVisual: true,
+    beforeParse(window) {
+      window.EventSource = class FakeEventSource {
+        constructor() { console.log('EventSource stub created'); }
+        set onopen(fn) {}
+        set onmessage(fn) {}
+        set onerror(fn) {}
+        close() {}
+      };
+      const orig = window.document.createElement;
+      window.document.createElement = function(tag) {
+        const el = orig.call(this, tag);
+        if (tag.toLowerCase() === 'style') {
+          console.log('STYLE element created');
+          const append = el.appendChild.bind(el);
+          el.appendChild = function(child) {
+            if (child && child.data && child.data.length > 0) {
+              console.log('STYLE content length', child.data.length, 'starts:', child.data.slice(0, 80));
+            }
+            return append(child);
+          };
+        }
+        return el;
+      };
+    },
+  });
+
+  await new Promise(r => setTimeout(r, 5000));
+  const doc = dom.window.document;
+  console.log('--- head style tags ---');
+  const styles = doc.querySelectorAll('style');
+  console.log('style count:', styles.length);
+  styles.forEach((s, i) => {
+    console.log(`style #${i} length:`, s.textContent.length, 'starts:', s.textContent.slice(0, 60));
+  });
+  console.log('--- root content ---');
+  const root = doc.getElementById('root');
+  console.log('root innerHTML:', root.innerHTML);
+  dom.window.close();
+})().catch(e => { console.error(e); process.exit(1); });

package/README.md

@@ -0,0 +1,287 @@
+# elpis
+
+## 一个企业级全栈应用框架。
+
+### model配置
+
+javascript
+
+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 路径
+}
+}
+]
+
+// 当 menuType == module 时，可
+moduleType: '', // 枚举值: sider/frame/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: {
+elTableColumnConfig, // 标准 el-table-column 配置
+toFixed: 0, // 保留小数点后几位
+visible: true, // 默认为 true (false 时，表示不在表单中显示)
+},
+},
+},
+},
+},
+
+schema, // 标准 schema 配置
+type: '', // 字段类型
+label: '', // 字段的中文名
+// 字段在 table 中的相关配置
+tableOption: {
+elTableColumnConfig, // 标准 el-table-column 配置
+toFixed: 0, // 保留小数点后几位
+visible: true, // 默认为 true (false 时，表示不在表单中显示)
+},
+// 字段在 search-bar 中的相关配置
+searchOption: {
+eleComponentConfig, // 标准 el-component-column 配置
+comType: '', // 配置组件类型 input/select/......
+default: '', // 默认值
+},
+// comType === 'select'
+enumList: [], // 下拉框可选项
+
+// comType === 'dynamicSelect'
+api: ''
+},
+// 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
+// 如：componentConfig.createForm, 这里对应 createFormOption
+// 字段在 createForm 中相关配置
+createFormOption: {
+eleComponentConfig, // 标准 el-component 配置
+comType: '', // 组件类型 input/select/input-number
+visible: true, // 是否展示 (true/false), 默认为 true
+disabled: false, // 是否禁用 (true/false), 默认为 false
+default: '', // 默认值
+
+// comType === 'select' 时生效
+enumList: [] // 枚举列表
+},
+// 字段在 editForm 表单中的相关配置
+editFormOption: {
+
+visible: true, // 是否展示 (true/false)，默认为 true
+disabled: false, // 是否禁用 (true/false)，默认为 false
+default: '', // 默认值
+
+// comType === 'select' 时生效
+enumList: [] // 枚举列表
+detailPanelOption: {
+eleComponentConfig // 标准 el-component 配置
+}
+
+required: [], // 标记哪些字段是必填项
+
+// table 相关配置
+tableConfig: {
+headerButtons: {
+label: '', // 按钮中文名
+eventKey: '', // 按钮事件名
+// 按钮事件具体配置
+eventOption: {
+// 当 eventKey === 'showComponent'
+comName: '' // 组件名称
+},
+elButtonConfig // 标准 el-button 配置
+},
+rowButtons: {
+label: '', // 按钮中文名
+eventKey: '', // 按钮事件名
+eventOption: {
+// 当 eventKey === 'showComponent'
+comName: '' // 组件名称
+},
+// 当 eventKey === 'remove'
+params: {
+}
+}
+}
+
+paramKey: rowValueKey
+}, // 按钮事件具体配置
+elButtonConfig // 标准 el-button 配置
+}, ...]
+
+// search-bar 相关配置
+searchConfig: {},
+// 动态组件 相关配置
+componentConfig: {
+// create-form 表单相关配置
+createForm: {
+title: '', // 表单标题
+saveBtnText: '', // 保存按钮文案
+},
+// edit-form 表单相关配置
+editForm: {
+mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+title: '', // 表单标题
+saveBtnText: '', // 保存按钮文案
+},
+// detail-page 相关配置
+detailPanel: {
+mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+title: '', // 表单标题
+},
+// ...支持用户动态扩展
+},
+}, ...]
+
+### 服务端启动
+
+// javascript
+const {
+serverStart
+}
+
+# 服务端启动
+
+const {
+serverStart
+} = require('@fsiaonma/elpis');
+
+// 启动 elpis 服务
+const app = serverStart({});
+
+# 自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+# 前端构建
+
+const { frontendBuild } = require('@fsiaonma/elpis');
+
+// 编译构建前端工程
+frontendBuild(process.env.\_ENV);
+
+# 自定义页面扩展
+
+服务端启动
+javascript
+const {
+serverStart
+} = require('@fsiaonna/elpis');
+
+// 启动 elpis 服务
+const app = serverStart({});
+
+自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+前端构建
+javascript
+const { frontendBuild } = require('@fsiaonna/elpis');
+
+// 编译构建前端工程
+frontendBuild(process.env.\_ENV);
+
+自定义页面扩展
+
+- 在 `app/pages/` 目录下写入 `entry.xxx.js`
+
+dashboard / custom-view 自定义页面扩展
+
+- 在 `app/pages/dashboard/xxxx` 下写页面
+
+dashboard / schema-ui / commonites 动态组件扩展
+
+### 自定义服务端
+
+- router-schema
+- router
+- controller
+- service
+- extend
+- config
+
+### 前端构建
+
+const { frontendBuild } = require('@fsiaonna/elpis');
+
+// 编译构建前端工程
+frontendBuild(process.env.\_ENV);
+
+### 自定义页面扩展
+
+- 在 `app/pages/` 目录下写入 `entry.xxx.js`
+
+### dashboard / custom-view 自定义页面扩展
+
+- 在 `app/pages/dashboard/xxxx` 下写页面
+
+### 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/complex-view` 下写控件
+2. 配置 `app/widgets/schema-search/bar/search-item-config.js`

package/app/controller/base.js

@@ -0,0 +1,37 @@
+module.exports = (app) => class BaseController {
+  //controller基类，统一收拢controller的公共方法
+  constructor() {
+    this.app = app
+    this.config = app.config
+  }
+  /**
+   * 成功响应
+   * @param {object} ctx上下文 
+   * @param {object} data 核心数据
+   * @param {object} metadata 附加 数据
+   */
+
+  success(ctx,data={},metadata={}){
+    ctx.status=200
+    ctx.body={
+      success:true,
+      data,
+      metadata
+    }
+  }
+
+  /**
+   * 失败响应
+   * @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,76 @@
+module.exports=(app)=>{
+  const BaseController=require('./base')(app)
+  const modelList=require('../../model/index')(app)
+  // console.log(JSON.stringify(modelList))
+  //项目控制器
+  return class ProjectController extends BaseController{
+     /**
+      * 根据proj_key获取项目配置
+      */
+     async get(ctx){
+      const {proj_key}=ctx.request.query
+
+      const {project:projectService}=app.service
+      const projectConfig=await projectService.get({proj_key})
+
+      if(!projectConfig){
+        this.fail(ctx,'网络异常 请稍后重试',50000)
+        return
+      }
+      this.success(ctx,projectConfig)
+      app.logger.info('项目配置请求成功')
+    }
+    
+     /**
+     * 获取当前projectKey 对应模型下的项目列表（如果无 projectKey 则返回所有项目）
+     */
+     async getList(ctx){
+      const {
+        proj_key:projKey,
+      }=ctx.request.query
+      const { project:projectService}=app.service
+      const projectList=await projectService.getList({projKey})
+      const dtoProjectList=projectList.map((item)=>{
+        const {modelKey,key,name,desc,homePage}=item
+        return {modelKey,key,name,desc,homePage}
+      })
+      
+
+      this.success(ctx,dtoProjectList)
+      app.logger.info('项目列表请求成功')
+     } 
+    
+    /**
+     * 获取所有模型项目的结构化数据
+     */
+    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,desc}=model
+        const dtoModel={key,name,desc}
+
+        //构造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)
+      app.logger.info('项目模型列表请求成功')
+    }
+    
+  }
+  
+}

package/app/controller/view.js

@@ -0,0 +1,17 @@
+module.exports=(app)=>{
+  return class ViewController{
+    //渲染页面
+    async renderPage(ctx){
+      const {params,query}=ctx;
+      app.logger.info(`[ViewController] params:${JSON.stringify(params)}`)
+      app.logger.info(`[ViewController] query:${JSON.stringify(query)}`)
+      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,36 @@
+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,78 @@
+/**
+ * API参数验证合法性中间件
+ */ 
+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} body:${JSON.stringify(body)}`)
+   app.logger.info(`[${method}] ${path} params:${JSON.stringify(params)}`)
+   app.logger.info(`[${method}] ${path} query:${JSON.stringify(query)}`)
+   app.logger.info(`[${method}] ${path} headers:${JSON.stringify(headers)}`)
+
+   const schema=app.routerSchemas[path]?.[method.toLowerCase()]
+   if(!schema){
+     return await next()
+   }
+   let valid=true
+
+   //ajv校验器
+   let validate
+
+   //校验params
+   if(valid && params &&schema.params){
+    schema.params.$schema=$schema
+    validate=ajv.compile(schema.params) //编译校验器
+    valid=validate(params)
+   }
+  
+
+   //校验headers
+   if(valid && headers &&schema.headers){
+    schema.headers.$schema=$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)
+   }
+
+   if(!valid){
+    ctx.status=200
+    const firstError=validate.errors[0]
+    let errorText
+    if(firstError && firstError.keyword==='required' && firstError.params && firstError.params.missingProperty){
+      errorText=`data ${firstError.params.missingProperty} is required`
+    }else{
+      errorText=ajv.errorsText(validate.errors)
+    }
+    ctx.body={
+      code:442,
+      message:`request validate failed:${errorText}`,
+      success:false,
+    }
+    return
+   }
+
+    await next()
+  };
+}

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

@@ -0,0 +1,31 @@
+/**
+ * API签名验证合法性中间件
+ */
+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
+
+    const signKey='fai3ihihfi43go53gjo53g53'
+    const signature=md5(`${signKey}_${st}`)
+    app.logger.info(`[${method} ${path}] signature:${signature}`)
+
+    if(!sSign || !st || signature!==sSign.toLowerCase() || Date.now()-st>1000*60){
+      ctx.status=200
+      ctx.body={
+        code:445,
+        msg:'签名不正确或请求超时',
+        success:false,
+      }
+      return
+    }
+    await next()
+  }
+}