@misstalor17/elpis 1.0.0

package/.eslintignore

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

package/.eslintrc

@@ -0,0 +1,56 @@
+{
+    "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/README.md

@@ -0,0 +1,6 @@
+//elpis
+##一个企业级应用框架，应用全栈能力实现
+
+//package.json
+window电脑下写法
+prod: set _ENV='production' && node ./index.js

package/app/controller/base.js

@@ -0,0 +1,43 @@
+module.exports = (app) => class BaseController {
+    /**
+     * controller 基类
+     * 统一收拢 controller 相关的公共方法
+     */
+
+    constructor() {
+        this.app = app;
+        this.config = app.config
+        // this.service = app.service;
+    }
+
+    /**
+     * API 处理成功时统一返回结构
+     * @params {onject} ctx 上下文
+     * @params {onject} data 核心数据
+     * @params {onject} metadata 附加数据
+     */
+
+    success(ctx, data = {}, metadata = {}) {
+        ctx.status = 200;
+        ctx.body = {
+            success: true,
+            data,
+            metadata
+        }
+    }
+
+    /**
+ * API 处理失败时统一返回结构
+ * @params {onject} ctx 上下文
+ * @params {onject} message 错误信息
+ * @params {onject} code 错误码
+ */
+
+    fail(ctx, message, code) {
+        ctx.body = {
+            success: false,
+            message, 
+            code
+        }
+    }
+}

package/app/controller/business.js

@@ -0,0 +1,121 @@
+module.exports = (app) => {
+    const sleep = async (time) => {
+        return new Promise(resolve => {
+            setTimeout(() => {
+                resolve()
+            }, time)
+        })
+    }
+    const baseController = require('./base')(app)
+
+    return class BusinessController extends baseController {
+        async update(ctx) {
+            const {
+                product_id: productId,
+                product_name: productName,
+                price,
+                inventory
+            } = ctx.request.body
+
+            await sleep(500)
+            this.success(ctx, {
+                product_id: productId,
+                product_name: productName,
+                price,
+                inventory
+            })
+        }
+
+
+
+        async create(ctx) {
+            const {
+                product_name: productName,
+                price,
+                inventory
+            } = ctx.request.body
+            await sleep(500)
+            this.success(ctx, {
+                product_id: Date.now(),
+                product_name: productName,
+                price,
+                inventory
+            })
+        }
+
+        async remove(ctx) {
+            const { product_id: productId } = ctx.request.body
+            await sleep(500)
+            this.success(ctx, {
+                proj_key: ctx.projKey,
+                product_id: productId
+            })
+        }
+
+        async get(ctx) {
+            const {
+                product_id: productId,
+            } = ctx.request.query
+            await sleep(500)
+            const productList = this.getProductList(ctx)
+
+            const productItem = productList.find(item => item.product_id === productId)
+
+            this.success(ctx,productItem)
+        }
+        async getList(ctx) {
+            const { page, size, product_name: productName } = ctx.request.query
+            await sleep(500)
+            
+            let productList = this.getProductList(ctx)
+
+            if (productName && productName !== 'all') {
+                productList = productList.filter(item => item.product_name === productName)
+            }
+            this.success(ctx, productList, {
+                total: 3,
+                page,
+                size
+            })
+        }
+
+         getProductEnumList(ctx) {
+            this.success(ctx, [{
+                label: '全部',
+                value: 'all',
+            }, {
+                label: `${ctx.projKey}-111`,
+                value: `${ctx.projKey}-111`,
+            }, {
+                label: `${ctx.projKey}-222`,
+                value: `${ctx.projKey}-222`,
+            }, {
+                label: `${ctx.projKey}-333`,
+                value: `${ctx.projKey}-333`,
+            }])
+        }
+
+         getProductList(ctx) {
+            return [{
+                product_id: '1',
+                product_name: `${ctx.projKey}-111`,
+                price: 999,
+                inventory: 111,
+                create_time: '2024-06-08 18:00:00'
+            }, {
+                product_id: '2',
+                product_name: `${ctx.projKey}-222`,
+                price: 888,
+                inventory: 222,
+                create_time: '2024-06-08 18:00:00'
+            }, {
+                product_id: '3',
+                product_name: `${ctx.projKey}-333`,
+                price: 777,
+                inventory: 333,
+                create_time: '2024-06-08 18:00:00'
+            }]
+        }
+
+    }
+}

package/app/controller/project.js

@@ -0,0 +1,75 @@
+module.exports = (app) => {
+  const BaseController = require('./base')(app)
+
+  return class ProjectController extends BaseController {
+    /**
+     * 根据 proj_key 获取项目配置 
+     */
+    get(ctx){
+      const {
+        proj_key:projKey
+      } = ctx.request.query
+
+      const { project:projectService } = app.service
+      const projConfig = projectService.get(projKey)
+
+      if(!projConfig) {
+        this.fail(ctx,'获取项目异常',50000);
+        return;
+      }
+      this.success(ctx,projConfig)
+    }
+    /**
+     * 获取当前 project 对应模型下的项目列表（如果无projectKey，全量获取）
+     * @param {object} ctx 
+     */
+    getList(ctx) {
+      const { proj_key: projKey } = ctx.request.query
+
+      const {project:projectService } = app.service;
+      const projectList = 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)
+    }
+    /**
+     * 获取所有模型与项目的结构化数据
+     * @param {object} ctx 
+     */
+    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)
+    }
+  }
+
+}

package/app/controller/view.js

@@ -0,0 +1,24 @@
+module.exports = (app) => {
+    // 返回一个控制器类：ViewController
+    return class ViewController {
+        /**
+         * 渲染页面
+         * @param {object} ctx 上下文
+         */
+        // 定义一个异步方法renderPage，接收ctx参数
+        async renderPage(ctx) {
+            // 核心逻辑：调用ctx.render()渲染模板
+            // 模板路径是动态拼接的：output/entry.${ctx.params.page}
+            const { query, params } = ctx.request
+            app.logger.info(`[ViewController] query: ${JSON.stringify(query)}`);
+            app.logger.info(`[ViewController] params: ${JSON.stringify(params)}`);
+            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,37 @@
+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: './log/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,70 @@
+const Ajv = require('ajv')
+const ajv = new Ajv()
+/**
+ * API 参数校验
+ */
+
+module.exports = (app) => {
+    const $schema = "http://json-schema.org/draft-07/schema#"
+    //仅对以/api开头的接口请求进行签名验证，非 API 请求直接放行。
+    return async (ctx, next) => {
+        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)}`);
+        //从app.routerSchema中，根据当前请求的路径（path）和请求方法（method），加载对应的 JSON Schema 校验规则；
+        const schema = app.routerSchema[path]?.[method.toLowerCase()]
+
+        if (!schema) {
+            return await next()
+        }
+
+        let valid = true
+
+        //ajv校验器
+        let validate;
+
+        //校验headers
+        if (valid && headers && schema.headers) {
+            schema.headers.$schema = $schema
+            validate = ajv.compile(schema.headers)
+            valid = validate(headers)
+        }
+        //校验query
+        if (valid && query && schema.query) {
+            schema.query.$schema = $schema
+            validate = ajv.compile(schema.query)
+            valid = validate(query)
+        }
+        //校验body
+        if (valid && body && schema.body) {
+            schema.body.$schema = $schema
+            validate = ajv.compile(schema.body)
+            valid = validate(body)
+        }
+        //校验params
+        if (valid && params && schema.params) {
+            schema.params.$schema = $schema
+            validate = ajv.compile(schema.params)
+            valid = validate(params)
+        }
+
+        if (!valid) {
+            ctx.status = 200
+            ctx.body = {
+                success: false,
+                message: `request vaildate fail: ${ajv.errorsText(validate.errors)}`,
+                code: 442
+            }
+            return;
+        }
+        await next()
+    }
+}

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

@@ -0,0 +1,31 @@
+const md5 = require('md5')
+/**
+ * API签名的合法性
+ */
+module.exports = (app) => {
+    return async (ctx, next) => {
+        //仅对以/api开头的接口请求进行签名验证，非 API 请求直接放行。
+        if (ctx.path.indexOf('/api') < 0) {
+            return await next()
+        }
+
+        const { path, method } = ctx
+        const headers = ctx.headers;
+        const { s_sign: sSign, s_t: st } = headers
+
+        const signKey = 'AShdahsdoahdsoanjsdoaiuhd13'// 前后端约定的「签名密钥」（需保密）
+        const signature = md5(`${signKey}_${st}`)// 服务端用「密钥+前端时间戳」生成MD5签名
+        app.logger.info(`[${method} ${path}] signature: ${signature}`)
+
+        if (!sSign || !st || signature !== sSign.toLowerCase() || Date.now() - st > 600000) {
+            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,32 @@
+/**
+ * 运行时异常错误处理，兜底所有异常
+ * @param {object} app koa 实例
+ */
+module.exports = (app) => {
+    return async (ctx, next) => {
+        try {
+            await next()
+        } catch (error) {
+            //异常处理
+            const { status, message, detail } = error
+            app.logger.info(JSON.stringify(error))
+            app.logger.error('[--exception--]:', error)
+            app.logger.error('[--exception--]:', status, message, detail)
+
+            if (message && message.indexOf('template not found') > -1) {
+                //页面重定向
+                ctx.status = 302
+                ctx.redirect(`${app.options?.homePage}`)
+                return;
+            }
+
+            const resBody = {
+                success:false,
+                code:50000,
+                message:'网络异常，请稍后重试'
+            }
+            ctx.status = 200
+            ctx.body = resBody
+        }
+    }
+}

package/app/middleware/project-handler.js

@@ -0,0 +1,28 @@
+/**
+ * projectHandler 相关项目处理内容
+ * @param {*} app 
+ */
+module.exports = (app) => {
+    return async (ctx, next) => {
+        //只对业务 API 进行 proj——key 处理
+        if (ctx.path.indexOf('/api/proj/') < 0) {
+            return await next()
+        }
+
+        //获取projKey 
+        const { proj_key: projKey } = ctx.request.headers;
+        if (!projKey) {
+            ctx.status = 200
+            ctx.body = {
+                success: false,
+                message: 'proj_key not found',
+                code: 446
+            }
+            return;
+        }
+
+        ctx.projKey = projKey
+        await next()
+    }
+
+}

package/app/middleware.js

@@ -0,0 +1,44 @@
+const path = require('path')
+
+// 导出一个函数，接收Koa的app实例作为参数
+module.exports = (app) => {
+    //配置静态根目录
+    const koaStatic = require('koa-static')
+    app.use(koaStatic(path.resolve(process.cwd(), './app/public')))
+    //渲染模版引擎
+    // 引入koa-nunjucks-2中间件（Nunjucks模板引擎的Koa适配插件）
+    const koaNunjucks = require('koa-nunjucks-2');
+    // 给Koa应用注册这个中间件，并配置参数
+    app.use(koaNunjucks({
+        ext: 'tpl',// 配置模板文件的后缀为.tpl（即识别app/public下的*.tpl文件为模板）
+        // 配置模板文件的存放目录：
+        // process.cwd()是当前项目的根目录，path.resolve拼接成：项目根目录/app/public
+        path: path.resolve(process.cwd(), './app/public'),
+        // Nunjucks模板引擎的额外配置
+        nunjucksConfig: {
+            // 渲染时自动去除模板中多余的空格/换行（让输出的HTML更整洁）
+            trimBlocks: true,
+            // 关闭模板缓存（开发环境用，修改模板后不用重启服务就能生效）
+            noCache: true
+        }
+    }));
+
+    //引入 ctx.body 解析中间件
+    const bodyParser = require('koa-bodyparser')
+    app.use(bodyParser({
+        formLimit: '1000mb',//设置表单数据的最大体积限制为 1000MB
+        enableTypes: ['form', 'json', 'text'] //指定中间件支持解析的请求体类型
+    }))
+
+    //引入异常捕获中间件
+    app.use(app.middlewares.errorHandler);
+
+    //引入签名合法性校验
+    app.use(app.middlewares.apiSignVerify)
+
+    //引入API参数校验
+    app.use(app.middlewares.apiParamsVerify)
+
+    //引入项目处理中间件
+    app.use(app.middlewares.projectHandler)
+}

package/app/pages/asserts/custom.css

@@ -0,0 +1,12 @@
+html,body {
+    height: 100%;
+}
+
+#root {
+    height: 100%;
+}
+
+input:-webkit-autofill {
+    /*覆盖自动填充背景颜色*/
+    -webkit-box-shadow:0 0 0px 1000px #121212 inset;
+}

package/app/pages/boot.js

@@ -0,0 +1,45 @@
+import { createApp } from "vue";
+
+//引入 element-plus
+import ElementUI from 'element-plus'
+import 'element-plus/dist/index.css'
+import './asserts/custom.css'
+import 'element-plus/theme-chalk/dark/css-vars.css'
+import 'element-plus/theme-chalk/index.css'
+
+import pinia from "$elpisStore";
+
+import { createRouter, createWebHistory } from "vue-router";
+/**
+ * vue 页面主入口，用于启动vue
+ * @params pageComponent vue 入口文件
+ * @params routes 路由列表
+ * @params libs 页面依赖的第三方包
+ */
+export default (pageComponent, { routes,libs } = {}) => {
+    const app = createApp(pageComponent)
+    //应用 ElementUI
+    app.use(ElementUI)
+    //引入pinia
+    app.use(pinia)
+    //引入第三方包
+    if(libs && libs.length){
+        for(let i = 0; i < libs.length;i++){
+            app.use(libs[i])
+        }
+    }
+    //页面路由
+    if (routes && routes.length) {
+        const router = createRouter({
+            history: createWebHistory(),// 采用 history 模式
+            routes
+        })
+        app.use(router)
+        router.isReady().then(() => {
+            app.mount('#root')
+        })
+    } else {
+        app.mount('#root')
+    }
+
+}