@mangjuxiong/elpis 1.0.2

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

@@ -0,0 +1,120 @@
+const path = require('path');
+const mrege = require('webpack-merge');
+const HappyPackPlugin = require('happypack');
+const os = require('os');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+const CleanWebpackPlugin = require('clean-webpack-plugin');
+const TerserPlugin = require('terser-webpack-plugin');
+const CSSMinimizerPlugin = require('css-minimizer-webpack-plugin');
+const HtmlWebpackInjectAttributesPlugin = require('html-webpack-inject-attributes-plugin');
+
+// 多线程 build 设置
+const happypackCommonConfig = {
+  threadPool: HappyPackPlugin.ThreadPool({
+    size: os.cpus().length,
+  }),
+  debug: false,
+};
+
+// 基类配置
+const baseConfig = require('./webpack.base.js');
+
+// 生产环境 webpack 配置
+const webpackConfig = mrege(baseConfig, {
+  // 指定生产环境
+  mode: 'production',
+  // 生产环境的 output 配置
+  output: {
+    filename: 'js/[name]_[chunkhash:8].bundle.js',
+    path: path.join(process.cwd(), './app/public/dist/prod/'),
+    publicPath: '/dist/prod/',
+    crossOriginLoading: 'anonymous',
+  },
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: [MiniCssExtractPlugin.loader, `${require.resolve('happypack/loader')}?id=css`],
+      },
+      {
+        test: /\.less$/,
+        use: [MiniCssExtractPlugin.loader, `${require.resolve('happypack/loader')}?id=css`],
+      },
+      {
+        test: /\.js$/,
+        // 只对app/pages目录下的js文件进行babel-loader处理，加快打包速度
+        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'], {
+      root: path.join(process.cwd(), './app/'),
+      exclude: [],
+      verbose: true,
+      dry: false,
+    }),
+    // 提取css公共部分，有效利用缓存
+    new MiniCssExtractPlugin({
+      filename: 'css/[name]_[contenthash:8].css',
+      chunkFilename: 'css/[name]_[contenthash:8].chunk.css',
+    }),
+    // 优化并压缩css资源
+    new CSSMinimizerPlugin({
+      minimizerOptions: {
+        preset: ['default', { discardComments: { removeAll: true } }],
+      },
+    }),
+    // 多进程打包js，加快打包速度
+    new HappyPackPlugin({
+      ...happypackCommonConfig,
+      id: 'js',
+      loaders: [`${require.resolve('babel-loader')}?${JSON.stringify(require('./babel.config.js'))}`],
+    }),
+    // 多进程打包css，加快打包速度
+    new HappyPackPlugin({
+      ...happypackCommonConfig,
+      id: 'css',
+      loaders: [
+        {
+          path: require.resolve('css-loader'),
+          options: {
+            importLoaders: 1,
+          },
+        },
+      ],
+    }),
+    // 浏览器在请求资源时不发送用户的身份凭证
+    new HtmlWebpackInjectAttributesPlugin({
+      crossorigin: 'anonymous',
+    }),
+  ],
+  optimization: {
+    // 使用 TersePlugin 的并发和缓存，提升压缩阶段的性能
+    // 清除 console.log
+    minimize: true,
+    minimizer: [
+      new TerserPlugin({
+        parallel: true, // 利用多核CPU的优势来加快压缩速度
+        terserOptions: {
+          compress: {
+            drop_console: true, //去掉console.log
+          },
+        },
+      }),
+    ],
+  },
+});
+
+module.exports = webpackConfig;

package/app/webpack/libs/blank.js

@@ -0,0 +1 @@
+module.exports = {};

package/app/webpack/libs/dev.js

@@ -0,0 +1,53 @@
+// 本地开发启动 devServer 命令
+const express = require('express');
+const path = require('path');
+const webpack = require('webpack');
+const devMiddleware = require('webpack-dev-middleware');
+const hotMiddleware = require('webpack-hot-middleware');
+const consoler = require('consoler');
+
+module.exports = () => {
+  // 从	webpack.dev.config.js 中获取配置信息
+  const { webpackConfig, DEV_SERVER_CONFIG } = require('../config/webpack.dev.js');
+
+  const app = express();
+
+  const compiler = webpack(webpackConfig);
+
+  // 指定静态文件目录
+  app.use(express.static(path.join(process.cwd(), './app/public/dist')));
+  // 引入 webpack-dev-middleware 监控文件改动
+  app.use(
+    devMiddleware(compiler, {
+      // 落地文件
+      writeToDisk: (filePath) => filePath.endsWith('.tpl'),
+      // 资源路径
+      publicPath: webpackConfig.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',
+        'Referrer-Policy': 'no-referrer-when-downgrade',
+      },
+      stats: {
+        colors: true,
+      },
+    })
+  );
+  // 引入 webpack-hot-middleware 实现热通信
+  app.use(
+    hotMiddleware(compiler, {
+      path: `/${DEV_SERVER_CONFIG.hmrPath}`,
+      log: () => {},
+    })
+  );
+
+  consoler.info('请等待webpack初次构建完成提示。。。');
+
+  // 启动 devServer
+  const port = DEV_SERVER_CONFIG.port;
+  app.listen(port, () => {
+    consoler.success(`webpack-dev-server is running at http://localhost:${port}`);
+  });
+};

package/app/webpack/libs/prod.js

@@ -0,0 +1,22 @@
+const webpack = require('webpack');
+const webpackProdConfig = require('../config/webpack.prod.js');
+
+module.exports = () => {
+  console.log('\nbuilding... \n');
+
+  webpack(webpackProdConfig, (err, stats) => {
+    if (err) {
+      console.log('🚀 ~ webpack ~ err:', err);
+      return;
+    }
+    process.stdout.write(
+      stats.toString({
+        colors: true, // 在控制台输出色彩信息
+        modules: false, // 不显示每个模块的打包信息
+        children: false, // 不显示子编译任务的信息
+        chunks: false, // 不显示每个代码块的信息
+        chunkModules: true, // 显示代码块中模块的信息
+      }) + '\n\n'
+    );
+  });
+};

package/config/config.default.js

@@ -0,0 +1,4 @@
+module.exports = {
+    name: 'elpis',
+    version: '1.0.0',
+};

package/elpis-core/env.js

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

package/elpis-core/index.js

@@ -0,0 +1,81 @@
+const Koa = require('koa');
+const path = require('path');
+const { sep } = path; //为了兼容不同操作系统的斜杠
+
+const env = require('./env');
+
+const middlewareLoader = require('./loader/middleware');
+const routerLoader = require('./loader/router');
+const routerSchemaLoader = require('./loader/router-schema');
+const controllerLoader = require('./loader/controller');
+const serviceLoader = require('./loader/service');
+const configLoader = require('./loader/config');
+const extendLoader = require('./loader/extend');
+
+module.exports = {
+  /**
+   * 启动项目
+   * @param {} options 项目配置
+   * options = {
+   *  name,
+   *  homePage
+   * }
+   */
+  start(options = {}) {
+    // koa实例
+    const app = new Koa();
+    // 应用配置
+    app.options = options;
+    // 基础路径
+    app.baseDir = process.cwd();
+    // 业务文件路径
+    app.businessDir = path.resolve(app.baseDir, `.${sep}app`);
+    // 初始化配置环境
+    app.env = env();
+    // 加载middleware
+    middlewareLoader(app);
+    console.log('-- {start} load middleware done --');
+    // 加载routerSchema
+    routerSchemaLoader(app);
+    console.log('-- {start} load routerSchemaLoader done --');
+    // 加载controller
+    controllerLoader(app);
+    console.log('-- {start} load controllerLoader done --');
+    // 加载service
+    serviceLoader(app);
+    console.log('-- {start} load serviceLoader done --');
+    // 加载config
+    configLoader(app);
+    console.log('-- {start} load configLoader done --');
+    // 加载extend
+    extendLoader(app);
+    console.log('-- {start} load extendLoader 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(path.resolve(app.businessDir, `.${sep}middleware`))(app);
+      console.log('-- {start} load global business middleware done --');
+    } catch (err) {
+      console.log('[exception] there is global business middleware file exception');
+    }
+    //注册路由,路由分发需要经过所有中间件处理后再执行
+    routerLoader(app);
+    console.log('-- {start} load routerLoader done --');
+
+    // 启动服务
+    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 (err) {
+      console.log(err);
+    }
+    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(app.baseDir, `.${sep}config`);
+
+  try {
+    defaultConfig = {
+      ...defaultConfig,
+      ...require(path.resolve(businessConfigPath, `.${sep}config.default.js`)),
+    };
+  } catch (err) {
+    console.log('[exception] there is default config file exception');
+  }
+  //获取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 (err) {
+    console.log('[exception] there is env config file exception');
+  }
+  //覆盖并加载config配置
+  app.config = Object.assign({}, defaultConfig, envConfig);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,59 @@
+const path = require('path');
+const glob = require('glob');
+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) => {
+  //读取 elpis/app/controller/**/**.js 下所有文件
+  const elpisControllerPath = path.resolve(__dirname, `..${sep}..${sep}app${sep}controller`);
+  const elpisFileList = glob.sync(path.resolve(elpisControllerPath, `.${sep}**${sep}**.js`));
+
+  // 读取业务的 app/controller/**/**.js 下所有文件
+  const businessControllerPath = path.resolve(app.businessDir, `.${sep}controller`);
+  const businessFileList = glob.sync(path.resolve(businessControllerPath, `.${sep}**${sep}**.js`));
+
+  // 合并所有controller文件
+  const fileList = elpisFileList.concat(businessFileList);
+
+  // 把内容加载到 app.controller 下
+  const controllers = {};
+  fileList.forEach((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 => cunstomModule.customController
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+    //挂载controller到内存app对象中
+    let tempController = controllers;
+    const names = name.split(sep);
+    for (let i = 0, len = names.length; i < names.length; i++) {
+      if (i == len - 1) {
+        //文件
+        const ControllerModule = require(path.resolve(file))(app);
+        //因为controller都是些class，所以需要new一下
+        tempController[names[i]] = new ControllerModule();
+      } else {
+        //文件夹
+        if (!tempController[names[i]]) {
+          tempController[names[i]] = {};
+        }
+        tempController = tempController[names[i]];
+      }
+    }
+  });
+  app.controllers = controllers;
+};

package/elpis-core/loader/extend.js

@@ -0,0 +1,47 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path;
+
+/**
+ * extend loader
+ * @param {object} app Koa 实例
+ *
+ * 加载所有extend, 可通过'app.extends.${文件}'访问
+ *
+  例子:
+  app/extend
+      |
+      | -- custom-extend.js
+   => app.extend.customModule.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}**.js`));
+
+  // 读取业务 app/extend/**.js 下所有文件
+  const businessExtendPath = path.resolve(app.businessDir, `.${sep}extend`);
+  const businessFileList = glob.sync(path.resolve(businessExtendPath, `.${sep}**.js`));
+  
+  // 合并extend 文件
+  const fileList = elpisFileList.concat(businessFileList);
+
+  // 把内容加载到 app 下
+  fileList.forEach((file) => {
+    //提取文件名称
+    let name = path.resolve(file);
+    //截取路径 app/extend/custom-extend.js => custom-extend.js
+    name = name.substring(name.lastIndexOf(`extend${sep}`) + `extend${sep}`.length, name.lastIndexOf('.'));
+    //把'-'统一改为驼峰式，custom-extend.js => customExtend
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+    //过滤app已存在的key
+    for (const key in app) {
+      if (key === name) {
+        console.log(`[extend load error] app.${name} is exist, please change file name or rename app.${name}]`);
+        return;
+      }
+    }
+    //挂载extend到app对象中
+    app[name] = require(path.resolve(file))(app);
+  });
+};

package/elpis-core/loader/middleware.js

@@ -0,0 +1,57 @@
+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 = {};
+
+  // 读取app/middleware/**/**.js 下所有文件
+  const elpisMiddlewarePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}middleware`);
+  const elpisFileList = glob.sync(path.resolve(elpisMiddlewarePath, `.${sep}**${sep}**.js`));
+
+  // 读取业务根目录 app/middleware/**/**.js 下所有文件
+  const businessMiddlewarePath = path.resolve(app.businessDir, `.${sep}middleware`);
+  const businessFileList = glob.sync(path.resolve(businessMiddlewarePath, `.${sep}**${sep}**.js`));
+  
+  // 合并middleware 所有文件
+  const fileList = elpisFileList.concat(businessFileList);
+
+  //遍历所有文件目录，把内容加载到 app.middlewares 下
+  fileList.forEach((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('.'));
+    //吧'-'统一改为驼峰式，custom-module/custom-middleware => cunstomModule.customMiddleware
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+    //挂载middleware到内存app对象中
+    let tempMiddleware = middlewares;
+    const names = name.split(sep);
+    for (let i = 0, len = names.length; i < names.length; i++) {
+      if (i == len - 1) {
+        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,41 @@
+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/xxx.js
+ 
+   输出：
+	 app.routerSchema = {
+		'${api1}': ${jsonSchema},
+		'${api2}': ${jsonSchema},
+	 }
+ */
+module.exports = (app) => {
+  // 读取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`));
+
+  // 读取 业务的app/router-schema/**/**.js 下所有文件
+  const businessRouterSchemaPath = path.resolve(app.businessDir, `.${sep}router-schema`);
+  const businessFileList = glob.sync(path.resolve(businessRouterSchemaPath, `.${sep}**${sep}**.js`));
+
+  // 合并所有的 router-schema 文件
+  const fileList = elpisFileList.concat(businessFileList);
+  
+  //注册所有 routerSchema, 使得'app.routerSchema' 访问
+  let routerSchema = {};
+  fileList.forEach((file) => {
+    routerSchema = {
+      ...routerSchema,
+      ...require(path.resolve(file)),
+    };
+  });
+  
+  app.routerSchema = routerSchema;
+};

package/elpis-core/loader/router.js

@@ -0,0 +1,42 @@
+const KoaRouter = require('koa-router');
+const path = require('path');
+const glob = require('glob');
+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`);
+  // 注册所有路由
+  const elpisFileList = glob.sync(path.resolve(elpisRouterPath, `.${sep}**${sep}**.js`));
+
+  // 找到业务路由文件路径
+  const businessRouterPath = path.resolve(app.businessDir, `.${sep}router`);
+  // 注册所有业务路由
+  const businessFileList = glob.sync(path.resolve(businessRouterPath, `.${sep}**${sep}**.js`));
+
+  // 合并所有路由文件
+  const fileList = elpisFileList.concat(businessFileList);
+
+  fileList.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,59 @@
+const path = require('path');
+const glob = require('glob');
+const { sep } = path;
+
+/**
+ * service loader
+ * @param {object} app Koa 实例
+ *
+ * 加载所有service, 可通过'app.services.${目录}.${文件}'访问
+ *
+  例子:
+  app/service
+    	|
+  		| -- custom-module
+         |
+         | -- custom-service.js
+   => app.service.customModule.customService
+ */
+module.exports = (app) => {
+  //读取 elpis/app/service/**/**.js 下所有文件
+  const elpisServicePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}service`);
+  const elpisFileList = glob.sync(path.resolve(elpisServicePath, `.${sep}**${sep}**.js`));
+
+   //读取业务的app/service/**/**.js 下所有文件
+  const businessServicePath = path.resolve(app.businessDir, `.${sep}service`);
+  const businessFileList = glob.sync(path.resolve(businessServicePath, `.${sep}**${sep}**.js`));
+
+  // 合并所有service 文件
+  const fileList = elpisFileList.concat(businessFileList);
+
+  // 把内容加载到 app.service 下
+  const services = {};
+  fileList.forEach((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('.'));
+    //把'-'统一改为驼峰式，custom-module/custom-service => cunstomModule.customService
+    name = name.replace(/[_-][a-z]/gi, (s) => s.substring(1).toUpperCase());
+    //挂载service到内存app对象中
+    let tempService = services;
+    const names = name.split(sep);
+    for (let i = 0, len = names.length; i < names.length; i++) {
+      if (i == len - 1) {
+        //文件
+        const ServiceModule = require(path.resolve(file))(app);
+        //因为service都是些class，所以需要new一下
+        tempService[names[i]] = new ServiceModule();
+      } else {
+        //文件夹
+        if (!tempService[names[i]]) {
+          tempService[names[i]] = {};
+        }
+        tempService = tempService[names[i]];
+      }
+    }
+  });
+  app.services = services;
+};