@yukihong/schema-admin-x 1.0.0

package/elpis-core/loader/controller.js

@@ -0,0 +1,75 @@
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+
+/**
+ * controller loader
+ * @param {object} app Koa 实例
+ * 加载所有 controller，可通过 'app.controllers.${目录}.${文件}' 访问
+ * 
+	例子：
+	app/controller
+		|
+		| -- custom-module
+				|
+				| -- custom-controller.js
+	=> app.controller.customModule.customController
+ */
+module.exports = (app) => {
+	// 1. 初始化一个空对象，用来存放所有控制器的嵌套结构
+	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) {
+		// 2. 提取当前文件的完整路径（比如：/project/app/controller/custom-module/custom-controller.js）
+		let name = path.resolve(file);
+		
+		// 3. 截取路径 app/controller/custom-module.custom-controller.js => custom-module.custom-controller
+		name = name.substring( name.lastIndexOf(`controller${sep}`) + `controller${sep}`.length, name.lastIndexOf('.'));
+		
+		// 4. 把 '-' 统一改为驼峰式，custom-module/custom-controller.js => customModule.customController
+		name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase());
+		
+		// 5. 每次处理新文件时，重置 tempController 指向根对象 controller
+		// （tempController 是一个“移动指针”，用来一层层深入嵌套结构）
+		// 挂载 controller 到内存 app 对象中
+		let tempController = controller;
+		
+		// 6. 把处理后的路径按分隔符拆分成数组（比如： [customModule(目录), customController（文件）]）
+		const names = name.split(sep);
+		
+		// 7. 循环处理每一层目录/文件名
+		for( let i = 0, len = names.length; i < len; ++i) {
+			if( i === len - 1 ) { // 8. 文件
+				// 导入中间件文件并传入app初始化，挂载到当前层级
+				const ControllerMoule = require(path.resolve(file))(app);
+				tempController[names[i]] = new ControllerMoule();
+			} else { 
+				// 9. 如果是目录
+			    //    如果当前层级不存在这个目录对象，就创建一个空对象
+				if(!tempController[names[i]]) {
+					tempController[names[i]] = {};
+				}
+				// 10. 移动指针（动的探测手），让 tempController 指向刚创建的子目录对象
+			    //     （因为是引用类型，后续修改会同步到根对象 controller）
+				tempController = tempController[names[i]];
+			}
+		}
+	}
+	
+	app.controller = controller;
+}

package/elpis-core/loader/extend.js

@@ -0,0 +1,55 @@
+const glob = require('glob');
+const path = require('path');
+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 businessFileList = glob.sync(path.resolve(businessExtendPath, `.${sep}**${sep}**.js`));
+	businessFileList.forEach(file => {
+		handleFile(file);
+	});
+	
+	// 遍历所有文件目录，把内容加载到 app.extend 下
+	function handleFile(file) {
+		// 2. 提取当前文件的完整路径（比如：/project/app/extend/custom-extend.js）
+		let name = path.resolve(file);
+		
+		// 3. 截取路径 app/extend/custom-extend.js => custom-extend
+		name = name.substring( name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length, name.lastIndexOf('.'));
+		
+		// 4. 把 '-' 统一改为驼峰式，custom-extend.js => customExtend
+		name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase());
+		
+		// 过滤 app 已存在的 key
+		for( const key in app ) {
+			if( key === name ) {
+				console.log(`[exten load error] name:${name} is already in app`)
+				return;
+			}
+		}
+		
+		// 挂载 extend 到 app 上
+		app[name] = require(path.resolve(file))(app);
+	}
+	
+	
+}

package/elpis-core/loader/middleware.js

@@ -0,0 +1,64 @@
+const glob = require('glob');
+const path = require('path');
+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 businessFileList = glob.sync(path.resolve(businessMiddlewarePath, `.${sep}**${sep}**.js`));
+	businessFileList.forEach(file => {
+		handleFile(file);
+	});
+	
+	// 把内容加载到 app.middlewares 下
+	function handleFile(file){
+		// 提取文件名称
+		let name = path.resolve(file);
+		
+		// 截取路径 app/middlewares/custom-module.custom-middleware.js => custom-module.custom-middleware
+		name = name.substring( name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length, name.lastIndexOf('.'));
+		
+		// 把 '-' 统一改为驼峰式，custom-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 ) {
+				// 导入中间件文件并传入app初始化，挂载到当前层级
+				tempMiddleware[names[i]] = require(path.resolve(file))(app);
+			} else {
+				if(!tempMiddleware[names[i]]) {
+					tempMiddleware[names[i]] = {};
+				}
+				// 移动指针指向当前层级的子对象（引用类型，修改会同步到原对象）
+				tempMiddleware = tempMiddleware[names[i]];
+			}
+		}
+	}
+	
+	app.middlewares = middlewares;
+}

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

@@ -0,0 +1,47 @@
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+
+/**
+ * router-schema loader
+ * @param {object} app koa 实例
+ * 
+ * 通过 'json-schema & ajv' 对 API 规则进行约束，配合 api-params-verify 中间件使用
+ * 
+ * app/router-schema/**.js
+	输出：
+	app.routerSchema = {
+		'${api1}': ${jsonSchema},
+		'${api2}': ${jsonSchema},
+		'${api3}': ${jsonSchema},
+		'${api4}': ${jsonSchema},
+	}
+ */
+module.exports = (app) => {
+	// 注册所有 routerSchema， 使得可以 'app.routerSchema' 这样访问
+	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 businessRouterSchemaPath = path.resolve(app.businessPath, `.${sep}router-schema`);
+	const businessFileList = glob.sync(path.resolve(businessRouterSchemaPath, `.${sep}**${sep}**.js`));
+	businessFileList.forEach(file => {
+		handleFile(file);
+	});
+	
+	function handleFile(file){
+		routerSchema = {
+			...routerSchema,
+			...require(path.resolve(file))
+		}
+	}
+	
+	
+	app.routerSchema = routerSchema
+}

package/elpis-core/loader/router.js

@@ -0,0 +1,59 @@
+const KoaRouter = require('koa-router');
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+
+/**
+ * router loader
+ * @param {object} app koa 实例
+ * 
+ * 解析所有 app/router/ 下所有 js 文件，加载到 KoaRouter 下
+ */
+module.exports = (app) => {
+	// 实例化 KoaRouter
+	const router = new KoaRouter();
+	
+	// 找到 elpis 路由文件路径
+	const elpisRouterPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}router`);
+	// 注册所有 elpis 路由
+	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());
+}
+
+/**
+ * Koa路由匹配完整流程（核心注释版）
+ * 执行顺序：中间件 → 路由匹配 → 兜底处理
+ */
+// 1. 请求进入Koa应用，先执行前置中间件（静态文件/日志/跨域等）[使用了koa-static才会去找静态文件]
+//    - 若匹配静态文件（如/static/css/page1.css），直接返回文件，流程终止
+//    - 若未匹配，进入下一步路由匹配
+
+// 2. 执行router.routes()中间件（路由匹配核心）
+//    - 遍历所有已注册的具体路由（如/page1、/api/user）
+//    - 按注册顺序匹配请求路径+请求方法（GET/POST）
+//    - 匹配成功：执行对应路由处理函数，返回响应，流程终止
+//    - 匹配失败：进入兜底路由
+
+// 3. 执行兜底路由（router.get('*', ...)）
+//    - 匹配所有未被具体路由拦截的请求
+//    - 执行兜底逻辑（如重定向首页/返回404），流程终止

package/elpis-core/loader/service.js

@@ -0,0 +1,75 @@
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+
+/**
+ * service loader
+ * @param {object} app Koa 实例
+ * 加载所有 service，可通过 'app.service.${目录}.${文件}' 访问
+ * 
+	例子：
+	app/service
+		|
+		| -- custom-module
+				|
+				| -- custom-service.js
+	=> app.service.customModule.customService
+ */
+module.exports = (app) => {
+	// 1. 初始化一个空对象，用来存放所有控制器的嵌套结构
+	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) {
+		// 2. 提取当前文件的完整路径（比如：/project/app/service/custom-module/custom-service.js）
+		let name = path.resolve(file);
+		
+		// 3. 截取路径 app/service/custom-module.custom-service.js => custom-module.custom-service
+		name = name.substring( name.lastIndexOf(`service${sep}`) + `service${sep}`.length, name.lastIndexOf('.'));
+		
+		// 4. 把 '-' 统一改为驼峰式，custom-module/custom-service.js => customModule.customService
+		name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase());
+		
+		// 5. 每次处理新文件时，重置 tempService 指向根对象 service
+		// （tempService 是一个“移动指针”，用来一层层深入嵌套结构）
+		// 挂载 service 到内存 app 对象中
+		let tempService = service;
+		
+		// 6. 把处理后的路径按分隔符拆分成数组（比如： [customModule(目录), tempService（文件）]）
+		const names = name.split(sep);
+		
+		// 7. 循环处理每一层目录/文件名
+		for( let i = 0, len = names.length; i < len; ++i) {
+			if( i === len - 1 ) { // 8. 文件
+				// 导入中间件文件并传入app初始化，挂载到当前层级
+				const ServiceMoule = require(path.resolve(file))(app);
+				tempService[names[i]] = new ServiceMoule();
+			} else { 
+				// 9. 如果是目录
+			    //    如果当前层级不存在这个目录对象，就创建一个空对象
+				if(!tempService[names[i]]) {
+					tempService[names[i]] = {};
+				}
+				// 10. 移动指针（动的探测手），让 tempService 指向刚创建的子目录对象
+			    //     （因为是引用类型，后续修改会同步到根对象 service）
+				tempService = tempService[names[i]];
+			}
+		}
+	}
+	
+	app.service = service;
+}

package/index.js

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

package/model/index.js

@@ -0,0 +1,102 @@
+const _ = require('lodash');
+const glob = require('glob');
+const path = require('path');
+const { sep } = path;
+
+/**
+ * project 继承 model
+ */
+const projectExtendModel = (model, project) => {
+	return _.mergeWith({}, model, project, (modelValue, projValue) => {
+		// 处理数组合并的特殊情况
+		if (Array.isArray(modelValue) && Array.isArray(projValue)) {
+			let result = [];
+			
+			// 因为 project 继承 model,所以需要处理修改和新增内容的情况
+			// project 有的键值，model 也有 => 修改（重载）
+			// project 有的键值，model 没有 => 新增
+			// model 有的键值，project 没有 => 保留（继承）
+			
+			// 处理修改和保留
+			for(let i = 0; i < modelValue.length; ++i) {
+				let modelItem = modelValue[i];
+				const projItem = projValue.find(projItem => projItem.key === modelItem.key);
+				// project 有的键值，model 也有，则递归调用 projectExtendModel 方法修改
+				result.push(projItem ? projectExtendModel(modelItem, projItem) : modelItem);
+			}
+			
+			// 处理新增
+			for(let i = 0; i < projValue.length; ++i) {
+				const projItem = projValue[i];
+				const modelItem = modelValue.find(modelItem => modelItem.key === projItem.key);
+				
+				if(!modelItem) {
+					result.push(projItem);
+				}
+			}
+			
+			return result;
+		}
+	})
+}
+
+/**
+ * 解析 model 配置，并返回组织且继承后的数据结构
+	[{
+		model: ${model}
+		project: {
+			proj1Key: ${proj1},
+			proj2Key: ${proj2},
+		}
+	}, ...]
+ */
+module.exports = (app) => {
+	const modelList = [];
+	
+	// 遍历当前文件夹，构造模型数据结构，挂载到 modelList 上
+	const modelPath = path.resolve(process.cwd(), `.${sep}model`);
+	const fileList = glob.sync(path.resolve(modelPath, `.${sep}**${sep}**.js`));
+	fileList.forEach(file => {
+		if(file.indexOf('index.js') > -1) { return;}
+		
+		// 区分配置类型（model / project） 备注：之前使用`${sep}project${sep}`在windows系统下返回是\，而glob.sync分隔符不管什么平台都是/
+		const type = file.indexOf(`/project/`) > -1 ? 'project' : 'model';
+		if(type === 'project' ) {
+			const modelKey = file.match(/\/model\/(.*?)\/project/)?.[1];
+			const projKey = file.match(/\/project\/(.*?)\.js/)?.[1];
+			let modelItem = modelList.find(item => item.model?.key === modelKey);
+			if(!modelItem) { // 初始化 model 数据结构
+				modelItem = {};
+				modelList.push(modelItem);
+			}
+			if(!modelItem.project) { // 初始化 project 数据结构
+				modelItem.project = {};
+			}
+			modelItem.project[projKey] = require(path.resolve(file));
+			modelItem.project[projKey].key = projKey; // 注入 projectKey
+			modelItem.project[projKey].modelKey = modelKey; // 注入 modelKey
+		}
+		
+		if( type === 'model') {
+			const modelKey = file.match(/\/model\/(.*?)\/model\.js/)?.[1];
+			let modelItem = modelList.find(item => item.model?.key === modelKey);
+			if(!modelItem) {
+				modelItem = {};
+				modelList.push(modelItem);
+			}
+			modelItem.model = require(path.resolve(file));
+			modelItem.model.key = modelKey; // 注入 modelKey
+		}
+		
+	});
+	
+	// 数据进一步整理： project => 继承 model
+	modelList.forEach(item => {
+		const { model, project } = item;
+		for(const key in project) {
+			project[key] = projectExtendModel(model, project[key]);
+		}
+	})
+	
+	return modelList;
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@yukihong/schema-admin-x",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint --quiet --ext js,vue .",
+    "test": "_ENV='local mocha 'test/**/*.js'",
+    "test:win": "set _ENV=local&&mocha 'test/**/*.js'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git.code.tencent.com/yukiHong/Elpis.git"
+  },
+  "author": "Yuki",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/runtime": "^7.28.6",
+    "@element-plus/icons-vue": "^2.3.2",
+    "ajv": "^6.10.2",
+    "axios": "^0.19.2",
+    "echarts": "^5.5.0",
+    "element-plus": "^2.3.7",
+    "generate-password": "^1.7.1",
+    "glob": "^7.1.4",
+    "jsonwebtoken": "^9.0.2",
+    "knex": "^0.19.0",
+    "koa": "2.7.0",
+    "koa-bodyparser": "^4.2.1",
+    "koa-nunjucks-2": "^3.0.2",
+    "koa-router": "^7.4.0",
+    "koa-static": "^5.0.0",
+    "koa-useragent": "2.0.0",
+    "koa2-cors": "^2.0.6",
+    "less": "^3.8.1",
+    "lodash": "^4.17.21",
+    "log4js": "^6.9.1",
+    "md5": "^2.2.1",
+    "moment": "^2.29.4",
+    "mysql": "^2.18.1",
+    "node-schedule": "^2.1.1",
+    "nodemon": "^1.19.2",
+    "path": "^0.12.7",
+    "pinia": "^2.1.6",
+    "superagent": "^8.1.2",
+    "vue": "^3.3.4",
+    "vue-json-viewer": "^3.0.4",
+    "vue-router": "^4.2.4",
+    "vuex": "^4.1.0",
+    "@babel/plugin-transform-runtime": "^7.1.0",
+    "@babel/preset-env": "^7.4.5",
+    "babel-loader": "^8.0.4",
+    "clean-webpack-plugin": "^0.1.19",
+    "consoler": "^0.2.0",
+    "css-loader": "^0.23.1",
+    "css-minimizer-webpack-plugin": "^5.0.1",
+    "directory-named-webpack-plugin": "^4.0.1",
+    "express": "^4.18.2",
+    "file-loader": "^6.2.0",
+    "happypack": "^5.0.1",
+    "html-webpack-inject-attributes-plugin": "^1.0.1",
+    "html-webpack-plugin": "^5.5.3",
+    "less-loader": "^11.1.3",
+    "mini-css-extract-plugin": "^2.7.6",
+    "style-loader": "^0.14.1",
+    "terser-webpack-plugin": "latest",
+    "url-loader": "^4.1.1",
+    "vue-loader": "^17.2.2",
+    "vue-style-loader": "^4.1.2",
+    "webpack": "^5.88.1",
+    "webpack-dev-middleware": "^6.1.1",
+    "webpack-hot-middleware": "^2.25.4",
+    "webpack-merge": "^4.2.1"
+  },
+  "devDependencies": {
+    "assert": "^2.0.0",
+    "babel-eslint": "^10.0.2",
+    "eslint": "^7.32.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-vue": "^9.17.0",
+    "ghooks": "~1.0.3",
+    "mocha": "^6.1.4",
+    "supertest": "^4.0.2",
+    "validate-commit-msg": "~2.14.0"
+  },
+  "config": {
+    "ghooks": {
+      "commit-msg": "validate-commit-msg",
+      "pre-commit": "npm run lint"
+    }
+  }
+}