@dmqweb/elpis 1.0.0

package/app/webpack/config/webpack.prod.js

@@ -0,0 +1,149 @@
+const  merge  = require('webpack-merge')
+const path = require('path')
+const os = require('os')
+const HappyPack = require('happypack')
+
+const MiniCssExtractPlugin = require('mini-css-extract-plugin')
+const CleanWebpackPlugin = require('clean-webpack-plugin')
+const CssMinimizerPlugin = require('css-minimizer-webpack-plugin')
+const HtmlWebpackInjectAttributesPlugin = require('html-webpack-inject-attributes-plugin')    
+const TerserWebpackPlugin = require('terser-webpack-plugin')
+
+// 多线程 build 配置
+const happypackCommonConfig = {
+    // 是否开启调试模式，设为false表示不输出调试信息
+  debug: false,
+  // 创建一个线程池，大小为CPU核心数，用于并行处理任务
+  threadPool: HappyPack.ThreadPool({ size: os.cpus().length }),
+}
+
+
+// 基类配置
+const baseConfig = require('./webpack.base.js')
+
+// 生产环境配置
+const webpackProdConfig = merge(baseConfig, {
+  mode: 'production',
+
+  output: {
+    // 定义输出文件名格式：在 js 目录下生成 [入口名称]_[8位chunkhash].bundle.js
+    filename: 'js/[name]_[chunkhash:8].bundle.js',
+    // 定义输出文件的绝对路径：当前工作目录下的 ./app/public/dist/prod
+    path: path.join(process.cwd(), './app/public/dist/prod/'),
+    // 指定浏览器访问资源的公共路径前缀
+    publicPath: '/dist/prod/',
+    // 设置跨域加载脚本时的 credentials 标志为 anonymous（不发送 cookies 等）
+    crossOriginLoading: 'anonymous'
+  },
+
+  module: {
+    rules: [{
+      test: /\.css$/,
+      use: [
+        // 1. 提取 loader（负责提取 CSS）
+        MiniCssExtractPlugin.loader,
+        // 2. CSS loader（负责解析 CSS）
+        `${require.resolve('happypack/loader')}?id=css`
+      ]
+    }, {
+      test: /\.js$/,
+      include: [
+        // 处理elpis目录中的文件
+        path.resolve(__dirname, '../../pages'),
+        // 处理业务目录文件
+        path.resolve(process.cwd(), './app/pages'),
+      ],
+      use: [
+        `${require.resolve('happypack/loader')}?id=js`,
+      ]
+    }]
+  },
+  // webpack 不会有大量 hits 信息， 默认为 warning
+  performance: {
+    hints: false
+  },
+
+  plugins: [
+    // 每次build前 ， 清空 public/dist 目录
+    new CleanWebpackPlugin(['public/dist'], {
+      // 设置清理操作的根目录为 ./app 目录
+      root: path.resolve(process.cwd(),'./app'),
+      // 指定不需要删除的文件或目录（空数组表示全部删除）
+      exclude: [],
+      // 启用详细日志输出，显示删除过程
+      verbose: true,
+      // 设置为 false 表示执行实际删除操作（true 为模拟删除）
+      dry: false
+    }),
+
+    // 提取 css 公共部分，有效利用缓存 （非公共部分使用 inline ）
+    new MiniCssExtractPlugin({
+      // 异步加载的CSS文件
+      chunkFilename: 'css/[name].[contenthash:8].bundle.css',
+    }),
+
+    // 优化并压缩css资源
+    new CssMinimizerPlugin(),
+    
+    // 多线程打包 js ，加快打包速度 
+    new HappyPack({
+     // 展开通用配置，包含调试设置和线程池配置
+      ...happypackCommonConfig,
+
+      // 指定loader的ID，用于在rules中引用
+      id: 'js',
+
+      // 配置需要使用的loader
+      loaders: [`${require.resolve('babel-loader')}?${JSON.stringify({
+        // Babel预设配置，用于转换ES6+语法到兼容性更好的ES5
+        presets: [require.resolve('@babel/preset-env')],
+        // Babel插件配置
+        plugins: [
+          // 优化Babel生成的代码，减少重复的帮助函数代码
+          require.resolve('@babel/plugin-transform-runtime')
+        ]
+      })}`]
+    }),
+
+    // 多线程打包 css 
+      new HappyPack({
+      ...happypackCommonConfig,
+      id: 'css',
+      loaders: [{
+        path: require.resolve('css-loader'),
+        options: {
+          importLoaders: 1
+        }
+      }]
+    }),
+
+    // 浏览器在请求资源时，不会发送用户的身份凭证
+    new HtmlWebpackInjectAttributesPlugin({
+      // 确保加载外部资源时不携带身份凭证
+      crossorigin: 'anonymous'
+    })
+  ],
+  
+  optimization: {
+    // 使用 TerserPlugin 的并发和缓存，提升压缩阶段的性能 
+
+    // 启用代码压缩功能
+    minimize: true,
+
+    // 定义用于执行代码压缩的插件
+    minimizer: [
+      new TerserWebpackPlugin({  
+        parallel: true, // 启用缓存来加速构建过程
+        cache: true, // 利用多核 CPU 的优势来提升构建速度
+        terserOptions: { 
+          compress: {
+            drop_console: true, // 删除所有 console.* 语句
+            drop_debugger: true // 删除所有 debugger 语句
+          }
+        }
+      })
+    ]
+  }
+})
+
+module.exports = webpackProdConfig

package/app/webpack/dev.js

@@ -0,0 +1,58 @@
+// 本地开发启动 deserver
+const express = require('express');
+const consoler = require('consoler');
+const webpack = require('webpack');
+const path = require('path');
+const devMiddleware = require('webpack-dev-middleware');
+const hotMiddleware = require('webpack-hot-middleware');
+
+module.exports = ()=>{
+  const {
+    webpackDevConfig,
+    DEV_SERVER_CONFIG
+  } = require('./config/webpack.dev.js');
+  
+  const app = express();
+
+  const compiler = webpack(webpackDevConfig);
+  
+  // 构建静态文件目录
+  app.use(express.static(path.join(__dirname, '../public/dist')))
+  
+  // 引用 devMiddleware 中间件 监控文件改动
+  app.use(devMiddleware(compiler, {
+    // 落地文件
+    writeToDisk: (filePath) => {
+      // 只有以.tpl结尾的文件才写入磁盘，其余文件存储在内存中
+      return  filePath.endsWith('.tpl')
+    },
+    // 资源路径
+    publicPath: webpackDevConfig.output.publicPath,
+  
+    // headers 配置
+    headers: {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, PATCH, OPTIONS',
+      'Access-Control-Allow-Headers': 'X-Requested-With, content-type, Authorization'
+    },
+    stats:{
+      colors: true
+    }
+  }))
+  
+  // 引用 hotMiddleware 中间件 实现热更新通讯
+  app.use(hotMiddleware(compiler, {
+    path: `${DEV_SERVER_CONFIG.HMR_PATH}`,
+    log: () => {
+    }
+  }))
+  
+  consoler.info('请等待webpack初次构建完成提示......')
+  
+  // 启动devserver服务
+  const post = DEV_SERVER_CONFIG.PORT;
+  app.listen(post, () => {
+    consoler.info(`webpack-dev-server is listening on port ${post}`)
+  });
+  
+}

package/app/webpack/prod.js

@@ -0,0 +1,21 @@
+const webpack = require('webpack');
+const webpackProdConfig = require('./config/webpack.prod.js')
+
+console.log('\n 开始构建... \n')
+
+module.exports = ()=>{
+  webpack(webpackProdConfig, (err, stats) => { 
+    if (err) {
+      console.log(err)
+      return  
+    }
+
+    process.stdout.write(`${stats.toString({
+      colors: true, // 在控制台输出色彩信息
+      modules: false, // 不显示模块信息
+      children: false, // 不显示子模块信息
+      chunks: false, // 不显示 chunk 信息
+      chunkModules: true // 显示代码块中模块信息
+    })}\n`)
+ })
+}

package/config/config.default.js

@@ -0,0 +1,3 @@
+module.exports = {
+    name:"elpis"
+}

package/elpis-core/env.js

@@ -0,0 +1,22 @@
+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,99 @@
+// 引入koa框架
+const Koa = require('koa');
+// 引入路径处理模块
+const path = require('path');
+const { sep } = path; // 处理不同操作系统的斜杠
+
+// 引入环境配置
+const env = require('./env');
+
+// 引入加载器
+const configLoader = require('./loader/config');
+const extendLoader = require('./loader/extend'); 
+const middlewareLoader = require('./loader/middleware');
+const routerSchemaLoader = require('./loader/router-schema');
+const serviceLoader = require('./loader/service');
+const controllerLoader = require('./loader/controller');
+const routerLoader = require('./loader/router');
+
+module.exports = {
+  /**
+   * 启动项目
+   * @params options 项目配置
+   * options{
+   *    name // 项目名称
+   *    homePath // 项目首页
+   * }
+   */
+  start (options = {}) {
+    // 创建koa实例
+    const app = new Koa();
+    // 应用配置
+    app.options = options;
+    
+    // 设置基础路径为当前工作目录 = 根目录 
+    app.baseDir = process.cwd();
+    
+    // 业务文件路径的绝对路径 = 根目录 + app目录 的绝对路径
+    app.businessPath = path.resolve(app.baseDir,`.${sep}app`);
+
+    // 初始化环境配置
+    app.env = env();
+    console.log(`-- [start] env: ${app.env.get()} --`);
+
+    // 加载配置
+    configLoader(app);
+    console.log(`-- [start] config done --`);
+        
+    // 加载扩展
+    extendLoader(app);
+    console.log(`-- [start] extend done --`);
+    
+    // 加载中间件
+    middlewareLoader(app);
+    console.log(`-- [start] middleware done --`);
+    
+    // 加载路由配置
+    routerSchemaLoader(app);
+    console.log(`-- [start] routerSchema done --`);
+
+    // 加载服务 
+    serviceLoader(app);
+    console.log(`-- [start] service done --`);
+
+    // 加载控制器
+    controllerLoader(app);
+    console.log(`-- [start] controller done --`);
+
+    // 注册elpis全局中间件
+    const elpisMiddlewarePath = path.resolve(__dirname,`..${sep}app${sep}middleware.js`);
+    const elpisMiddleware = require(elpisMiddlewarePath);
+    elpisMiddleware(app);
+    console.log(`-- [start] load global elpis middleware done --`);
+
+    // 注册业务全局中间件
+    try {
+      require(`${app.businessPath}${sep}middleware.js`)(app);
+      console.log(`-- [start] load global business middleware done --`);
+    } catch (e) {
+      console.log(`-- [exception] there is no global business middleware file --`);
+    }
+
+    // 加载路由
+    routerLoader(app);
+    console.log(`-- [start] router done --`);
+
+    
+    // 启动服务
+    try {
+      const port = process.env.PORT || 8080;
+      const host = process.env.HOST || '0.0.0.0';
+      app.listen(port, host);
+      console.log(`Server running on port:${port}`);
+    } catch(e) {
+      console.error(e);
+    }
+
+    return app;
+  }
+}

package/elpis-core/loader/config.js

@@ -0,0 +1,51 @@
+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内部的默认配置文件（内部只有一个默认配置）
+  const elpisConfigPath = path.resolve(__dirname, `..${sep}..${sep}config`);
+  let defaultConfig = require(path.resolve(elpisConfigPath,`.${sep}config.default.js`));
+  // 找到config目录
+  const businessConfigPath = path.resolve(app.baseDir, `.${sep}config`);
+  // 业务配置、并且集成elpis默认配置
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`))
+    };
+  } catch (e) {
+    console.log(`[exception] 未配置 default.config.js)`);
+    // console.log(`[exception] there is no default.config.js:${e.message})`);
+    // console.debug(`[exception] Stack trace: ${e.stack}`); 
+  }
+  // 获取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) {
+      const envName = app.env.isLocal() ? 'local' : app.env.isBeta() ? 'beta' : 'prod';
+      console.log(`[exception] Failed to load config.${envName}.js: ${e.message}`);
+      console.debug(`[exception] Stack trace: ${e.stack}`);
+  }
+  // 覆盖并加载 config 配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+}

package/elpis-core/loader/controller.js

@@ -0,0 +1,75 @@
+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.customController
+ */
+
+module.exports = (app) => {
+  const controller = {};
+
+  // elpis中的controller的加载
+  const elpisControllerPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}controller`);
+  // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const elpisControllerFileList = glob.sync(path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`));
+  elpisControllerFileList.forEach(handleFile);
+  
+  // 拼接控制器文件所在目录的完整路径 (如: D:\Elpis\app\controller)
+  const businessControllerPath = path.resolve(app.businessPath, `.${sep}controller`);
+  // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const businessControllerFileList = glob.sync(path.resolve(businessControllerPath, `.${sep}**${sep}**.js`));
+
+  // 遍历所有文件目录，把内容加载到app.controller 下
+  businessControllerFileList.forEach(handleFile);
+
+  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('.'))
+
+    // 把'-'统一成驼峰式,custom-module/custom-controller => customModule/customController
+    name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase());
+
+    // 挂载 controller 到内容 app 对象中
+
+    // 创建临时引用指向控制器容器，用于构建嵌套结构
+    let tempController = controller
+    // 将控制器路径按分隔符分割成数组，例如 'user/auth' => ['user'(目录), 'auth'(文件)]
+    const names = name.split(sep);
+    // 遍历路径数组，构建层次化的对象结构
+    for (let i = 0; i < names.length; i++){
+       // 判断是否为最后一层
+      if (i === names.length - 1){
+        // 创建控制器实例对象
+        // 1. 加载控制器模块并传入app实例，获取返回的控制器类
+        const ControllerModule = require(path.resolve(file))(app);
+        // 2. 实例化控制器类，创建具体的控制器对象实例
+        tempController[names[i]] = new ControllerModule();
+      }else{
+        // 处理控制器目录结构
+        // 如果当前层级的对象不存在，则创建空对象
+        if (!tempController[names[i]]){
+          tempController[names[i]] = {}
+        }
+        // 将临时引用指向下一层级，继续构建更深层的结构
+        tempController = tempController[names[i]]
+      }
+    }
+  };
+  // 挂载 middlewares 到内容 app 对象中
+  app.controller = controller;
+}

package/elpis-core/loader/extend.js

@@ -0,0 +1,54 @@
+  const path = require("path")
+  const glob = require("glob")
+  const {sep} = path
+/**
+ * entend loader
+ * @param {object} app Koa 实例
+ * 
+ * 加载所有 extend, 可通过 'app.extend.${文件}访问'
+ * 
+ * 例子:
+ * app/extend
+ *    |
+ *    | -- custom-extend.js
+ * => app.extend.customExtend 访问
+ */
+module.exports = (app) => {
+
+  // 拼接elpis内部的extend
+  const elpisExtendPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}extend`)
+  // 使用glob模式匹配查找extend目录下的所有.js文件
+  const elpisExtendFileList = glob.sync(path.resolve(elpisExtendPath, `.${sep}**${sep}**.js`))
+  elpisExtendFileList.forEach(handleFileList);
+  
+   // 拼接extend目录的完整路径 (如: D:\Elpis\app\extend)
+  const businessExtendPath = path.resolve(app.businessPath, `.${sep}extend`)
+  // 使用glob模式匹配查找extend目录下的所有.js文件
+  const businessExtendFileList = glob.sync(path.resolve(businessExtendPath, `.${sep}**${sep}**.js`))
+
+  // 遍历所有找到的扩展文件
+  businessExtendFileList.forEach(handleFileList);
+  function handleFileList(file) {
+    //  提取文件的完整路径
+    let name = path.resolve(file)
+
+    // 截取路径 => app/extend/custom-extend.js => custom-extend
+    name = name.substring(name.indexOf(`extend${sep}`) + `extend${sep}`.length, name.indexOf('.'))
+
+    // 把'-'换成驼峰式,custom-extend => customExtend
+    name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase())
+
+    // 检查app中是否已存在同名属性，避免覆盖
+    for(const key in app){
+      if(key === name){
+        console.log(`[extend load error] name: ${name} is already  in app `)
+        return;
+      }
+    } 
+    // 加载扩展模块并传入app实例，将返回结果挂载到app上
+    // 例如: app.customExtend = require('custom-extend.js')(app)
+    app[name] = require(path.resolve(file))(app)
+
+  };
+  
+}

package/elpis-core/loader/middleware.js

@@ -0,0 +1,69 @@
+const path = require('path')
+const glob = require('glob')
+const { sep } = path
+
+/**
+ * middleware loader
+ * @param {object} app Koa 实例
+ * 
+ * 加载所有 middleware 可通过 'app.middlewares.${目录}.${文件名}' 访问' 
+ * 
+ * 例如
+ * app/middleware
+ *    |
+ *    | -- custom-moudle
+ *               |
+ *               | -- costom-middleware.js 
+ * => app.middlewares.customMoudle.costomMiddleware
+ */ 
+
+module.exports = (app) => {
+  const middlewares = {}; 
+  // 读取/elpis/app/middleware/**/**.js下的所有文件
+  const elpisMiddlePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}middleware`);
+  // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const elpisFileList = glob.sync(path.resolve(elpisMiddlePath, `.${sep}**${sep}**.js`));
+  elpisFileList.forEach(handleFile)
+
+  const businessMiddleWarePath = path.resolve(app.businessPath, `.${sep}middleware`);
+  // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const businessFileList = glob.sync(path.resolve(businessMiddleWarePath, `.${sep}**${sep}**.js`));
+
+  // 遍历所有文件目录，把内容加载到app.middlewares下
+  businessFileList.forEach(handleFile);
+  function handleFile(file) {
+    // 提取文件名
+    let name = path.resolve(file);
+
+    // 截取路径 => app/middleware/custom-moudle/costom-middleware.js => custom-moudle/costom-middleware
+    name = name.substring(name.lastIndexOf(`middleware${sep}`) + `middleware${sep}`.length, name.lastIndexOf('.'))
+
+    // 把'-'统一成驼峰式,custom-moudle/costom-middleware => customMoudle/costomMiddleware
+    name = name.replace(/[_-][a-z]/ig, (s) => s.substring(1).toUpperCase());
+
+    // 挂载 middlewares 到内容 app 对象中
+
+    // 创建临时引用指向中间件容器，用于构建嵌套结构
+    let tempMiddleware = middlewares
+    // 将中间件路径按分隔符分割成数组，例如 'user/auth' => ['user', 'auth']
+    const names = name.split(sep);
+    // 遍历路径数组，构建层次化的对象结构
+    for (let i = 0; i < names.length; i++){
+       // 判断是否为最后一层
+      if (i === names.length - 1){
+        // 创建中间件对象
+        tempMiddleware[names[i]] = require(path.resolve(file))(app);      
+      }else{
+        // 处理中间层目录结构
+        // 如果当前层级的对象不存在，则创建空对象
+        if (!tempMiddleware[names[i]]){
+          tempMiddleware[names[i]] = {}
+        }
+        // 将临时引用指向下一层级，继续构建更深层的结构
+        tempMiddleware = tempMiddleware[names[i]]
+      }
+    }
+  }
+  // 挂载 middlewares 到内容 app 对象中
+  app.middlewares = middlewares;
+} 

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

@@ -0,0 +1,50 @@
+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.rouSchema = {
+ *    '${api1}': ${jsonSschema},
+ *    '${api2}': ${jsonSschema},
+ *    '${api3}': ${jsonSschema},
+ * }
+ */
+module.exports = (app) => {
+  // 注册所有 router-schema, 使得可以 'app.routerSchema' 这样访问
+  // 初始化空对象，用于存储所有路由规则
+  let routerSchema = {}
+
+  // 拼接中间件文件所在目录的完整路径
+  const elpisRouterPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}router-schema`);
+    // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const elpisRouterFileList = glob.sync(path.resolve(elpisRouterPath, `.${sep}**${sep}*.js`))
+  elpisRouterFileList.forEach(handleFile);
+    // 拼接中间件文件所在目录的完整路径
+  const businessRouterSchemaPath = path.resolve(app.businessPath, `.${sep}router-schema`)
+  // 使用glob模式匹配查找所有嵌套目录下的.js文件 (**表示任意层级子目录)
+  const businessFileList = glob.sync(path.resolve(businessRouterSchemaPath, `.${sep}**${sep}*.js`))
+
+  // 遍历所有找到的路由规则文件
+  businessFileList.forEach(handleFile);
+  function handleFile(file) {
+      if(!file) return;
+      // 将当前文件中的路由规则合并到 routerSchema 对象中
+      routerSchema = {
+        // 展开已有的路由规则（保持之前文件中已加载的规则）
+        ...routerSchema,
+        
+        // 展开当前文件导出的路由规则（添加新规则）
+        ...require(path.resolve(file))
+      }
+  }
+
+  app.routerSchema = routerSchema
+}