@slice_cy/mint 1.2.0

package/app/webpack/config/webpack.dev.js

@@ -0,0 +1,53 @@
+const webpackConfig = require("./webpack.base");
+const { mergeWithRules } = require("webpack-merge");
+const path = require("path");
+const webpack = require("webpack");
+const DEV_SERVER_CONFIG = {
+  HOST: "127.0.0.1",
+  PORT: 9003,
+  TIMEOUT: 20000,
+  HMR_PATH: "__webpack_hmr",
+};
+
+/**
+ * 基于webapck.base.js的entry入口配置，给每一个入口的添加一个指定hmr代码的文件
+ * HMR 客户端模块作为 entry 的一部分打进 bundl
+ * 这段代码应该就是利用EventSource或者webstock与指定的目标服务器之间建立双向通信连接
+ */
+const { HOST, PORT, TIMEOUT, HMR_PATH } = DEV_SERVER_CONFIG;
+const entryObj = {};
+Object.entries(webpackConfig.entry).forEach(([key, value]) => {
+  if (key === "vendor") return;
+  entryObj[key] = [
+    value,
+    `${require.resolve("webpack-hot-middleware/client")}?path=http://${HOST}:${PORT}/${HMR_PATH}&timeout=${TIMEOUT}&reload=true`,
+  ];
+});
+
+const webapckDevConfig = mergeWithRules({
+  module: {
+    rules: {
+      test: "match",
+      use: "replace",
+    },
+  },
+})(webpackConfig, {
+  mode: "development",
+  entry: entryObj,
+  output: {
+    // 产物输出的目标目录
+    path: path.resolve(process.cwd(), "./app/public/dist/dev"),
+    // 打包的js文件的命名
+    filename: "js/[name].bundle.js",
+    publicPath: `http://${HOST}:${PORT}/public/dist/dev/`,
+    // 异步模块的命名
+    chunkFilename: "js/async.[name].chunk.js",
+    clean: true,
+  },
+  plugins: [new webpack.HotModuleReplacementPlugin({})],
+});
+
+module.exports = {
+  webapckDevConfig,
+  DEV_SERVER_CONFIG,
+};

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

@@ -0,0 +1,106 @@
+/**
+ * 生产环境构建配置：
+ * 1. 在基础配置上合并生产配置，产物输出到 app/public/dist/prod，并在构建前清理旧文件。
+ * 2. JS、CSS 和异步 chunk 使用 contenthash 命名，配合浏览器长期缓存，只在内容变化时更新资源 URL。
+ * 3. 抽离并压缩 CSS，压缩 JS，同时移除 console、debugger 和注释，减少生产包体积。
+ * 4. CSS/LESS/JS loader 以及 JS/CSS 压缩启用多进程，降低构建和压缩耗时。
+ * 5. 给注入到页面的静态资源添加 crossorigin="anonymous"，避免跨源资源请求携带用户凭证。
+ * 6. 关闭 sourcemap，避免生产环境暴露源码、源码路径和调试信息。
+ */
+const webpackConfig = require("./webpack.base");
+const { mergeWithRules } = require("webpack-merge");
+const path = require("path");
+const os = require("os");
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const CssMinimizer = require("css-minimizer-webpack-plugin");
+const HtmlWebpackInjectAttributesPlugin = require("html-webpack-inject-attributes-plugin");
+const TerserPlugin = require("terser-webpack-plugin");
+
+module.exports = mergeWithRules({
+  module: {
+    rules: {
+      test: "match",
+      use: "replace",
+    },
+  },
+})(webpackConfig, {
+  mode: "production",
+  devtool: false,
+  output: {
+    // 产物输出的目标目录
+    path: path.resolve(process.cwd(), "./app/public/dist/prod"),
+    // 打包的js文件的命名
+    filename: "js/[name].[contenthash:8].bundle.js",
+    publicPath: "/dist/prod/",
+    clean: true,
+  },
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        use: [
+          MiniCssExtractPlugin.loader,
+          {
+            loader: require.resolve("thread-loader"),
+            options: {
+              workers: os.cpus().length,
+            },
+          },
+
+          require.resolve("css-loader"),
+        ],
+      },
+      {
+        test: /\.less$/i,
+        use: [
+          MiniCssExtractPlugin.loader,
+          {
+            loader: require.resolve("thread-loader"),
+            options: {
+              workers: os.cpus().length,
+            },
+          },
+          require.resolve("css-loader"),
+          require.resolve("less-loader"),
+        ],
+      },
+      {
+        test: /\.js$/i,
+        use: [
+          {
+            loader: require.resolve("thread-loader"),
+            options: {
+              workers: os.cpus().length,
+            },
+          },
+          require.resolve("babel-loader"),
+        ],
+      },
+    ],
+  },
+  plugins: [
+    // 抽离css成独立文件
+    new MiniCssExtractPlugin({
+      filename: "css/[name].[contenthash:8].css",
+      chunkFilename: "css/async.[name].[contenthash:8].css",
+    }),
+    new HtmlWebpackInjectAttributesPlugin({
+      crossorigin: "anonymous",
+    }),
+  ],
+  optimization: {
+    minimize: true,
+    minimizer: [
+      // 压缩js
+      new TerserPlugin({
+        // 多进程压缩
+        parallel: true,
+        // 提取注释到单独文件（生产关闭）
+        extractComments: false,
+      }),
+      new CssMinimizer({
+        parallel: true,
+      }),
+    ],
+  },
+});

package/app/webpack/dev.js

@@ -0,0 +1,34 @@
+const express = require("express");
+const { webapckDevConfig, DEV_SERVER_CONFIG } = require("./config/webpack.dev");
+const webpackDevMiddleware = require("webpack-dev-middleware");
+const webpack = require("webpack");
+const webpackHotMiddleware = require("webpack-hot-middleware");
+const compiler = webpack(webapckDevConfig);
+const cors = require("cors");
+
+module.exports = () => {
+  const app = express();
+  // 跨域中间件
+  app.use(cors());
+
+  // 负责监听文件系统的改动，根据webpack配置重新编译，将tpl文件落地到磁盘，其他文件落地到内存中
+  // 配置publicPath，可以拦截对应的文件请求，从内存中返回出去
+  app.use(
+    webpackDevMiddleware(compiler, {
+      writeToDisk: (filePath) => /.tpl$/.test(filePath),
+      publicPath: webapckDevConfig.output.publicPath,
+    }),
+  );
+
+  // webpack编译完成，webpack-hot-middleware中间件会监听到done钩子，通过sse或者webstock通知客户端，重新请求资源清单进行热更新
+  app.use(
+    webpackHotMiddleware(compiler, {
+      path: `/${DEV_SERVER_CONFIG.HMR_PATH}`,
+    }),
+  );
+
+  // 服务启动
+  app.listen(DEV_SERVER_CONFIG.PORT, DEV_SERVER_CONFIG.HOST, () => {
+    console.log(`listening on http://${DEV_SERVER_CONFIG.HOST}:${DEV_SERVER_CONFIG.PORT}`);
+  });
+};

package/app/webpack/libs/block.js

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

package/app/webpack/prod.js

@@ -0,0 +1,21 @@
+const webpack = require("webpack");
+const webpackConfig = require("./config/webpack.prod");
+
+module.exports = () => {
+  webpack(webpackConfig, (err, stats) => {
+    if (err) {
+      console.log(err);
+    } else {
+      console.log(
+        stats.toString({
+          colors: true,
+          modules: false, // 关闭打印单个module文件明细（解决日志刷屏）
+          children: false, // 关闭HtmlWebpackPlugin子编译明细
+          chunks: true,
+          chunkModules: false,
+          timing: true, // 保留总耗时
+        }),
+      );
+    }
+  });
+};

package/config/config.default.js

@@ -0,0 +1,5 @@
+module.exports = (app) => {
+  return {
+    name: "mint",
+  };
+};

package/index.js

@@ -0,0 +1,37 @@
+const mintCore = require("./mint-core");
+// 引入前端工程化构建方法
+const FEBuildDev = require("./app/webpack/dev");
+const FEBuildProd = require("./app/webpack/prod");
+/**
+ * 对外启动暴露的方法
+ * @param {object} options
+ * @returns
+ */
+const start = (options = {}) => {
+  const app = mintCore.start(options);
+  return app;
+};
+
+/**
+ * 编译构建前端工程
+ * @param {stirng} env development / production
+ */
+const frontendBuild = (env = "development") => {
+  if (env === "development") {
+    FEBuildDev();
+  } else {
+    FEBuildProd();
+  }
+};
+
+module.exports = {
+  start,
+  frontendBuild,
+  Controller: {
+    Base: require("./app/controller/base"),
+  },
+  Service: {
+    Base: require("./app/service/base"),
+  },
+  BaseResponse: require("./app/common/base-response"),
+};

package/mint-core/env.js

@@ -0,0 +1,23 @@
+module.exports = (app) => {
+  return {
+    // 判断当前环境是否开发环境
+    isDevelopment() {
+      return process.env.NODE_ENV === "development";
+    },
+
+    // 判断当前环境是否测试环境
+    isTest() {
+      return process.env.NODE_ENV === "test";
+    },
+
+    // 判断当前环境是否生产环境
+    isProduction() {
+      return process.env.NODE_ENV === "production";
+    },
+
+    // 获取当前环境
+    get() {
+      return process.env.NODE_ENV ?? "development";
+    },
+  };
+};

package/mint-core/index.js

@@ -0,0 +1,101 @@
+const Koa = require("koa");
+const path = require("path");
+const env = require("./env");
+const { sep } = path;
+
+const middlewareLoader = require("./loader/middleware");
+const routerLoader = require("./loader/router");
+const routerSchema = 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 {object} options 项目配置
+   * @param {string} options.name 项目名
+   */
+  start(options = {}) {
+    const app = new Koa();
+
+    // 项目配置
+    app.options = options;
+
+    // 基础路径
+    app.baseDir = process.cwd();
+
+    // 应用路径
+    app.businessPath = path.resolve(app.baseDir, `.${sep}app`);
+
+    // 环境变量加载器
+    app.$env = env(app);
+    console.log(`-- [start] env: ${app.$env.get()}`);
+
+    // 配置加载器
+    configLoader(app);
+    console.log(`-- [start] config loader done--`);
+
+    // 拓展加载器
+    extendLoader(app);
+    console.log(`-- [start] extend loader done--`);
+
+    // 服务加载器
+    serviceLoader(app);
+    console.log(`-- [start] service loader done--`);
+
+    // middleware加载器
+    middlewareLoader(app);
+    console.log(`-- [start] middleware loader done--`);
+
+    // 路由参数配置加载器
+    routerSchema(app);
+    console.log(`-- [start] router schema loader done--`);
+
+    // 控制器加载器
+    controllerLoader(app);
+    console.log(`-- [start] controller loader done--`);
+
+    // 前置中间件注册
+    try {
+      require(path.resolve(__dirname, `..${sep}app${sep}pre-middleware.js`))(app);
+      console.log(`-- [start] mint pre middleware loader done--`);
+    } catch (err) {
+      console.error(`-- [exception] mint pre middleware load error ] ${err.message} --`);
+    }
+
+    try {
+      require(path.resolve(app.businessPath, `.${sep}pre-middleware.js`))(app);
+      console.log(`-- [start] business pre middleware loader done--`);
+    } catch (err) {
+      console.error(`-- [exception] business pre middleware load error ] ${err.message} --`);
+    }
+
+    // 路由加载器
+    try {
+      routerLoader(app, require(path.join(__dirname, `..${sep}app${sep}post-router.js`)));
+      console.log(`-- [start] business post router loader done--`);
+    } catch (err) {
+      console.error(`-- [exception] business post router loader error] ${err.message}--`);
+    }
+
+    try {
+      routerLoader(app, require(path.join(app.businessPath, `post-router.js`)));
+      console.log(`-- [start] business post router loader done--`);
+    } catch (err) {
+      console.error(`-- [exception] business post router loader error] ${err.message}--`);
+    }
+
+    // 启动服务
+    try {
+      const port = process.env.PORT || 8080;
+      const host = process.env.HOST || "0.0.0.0";
+      app.listen(port, host);
+      console.log(`${app.options.name} Server listening on ${host}:${port}`);
+    } catch (error) {
+      console.error(error);
+    }
+    return app;
+  },
+};

package/mint-core/loader/config.js

@@ -0,0 +1,59 @@
+const path = require("path");
+const { sep } = path;
+/**
+ * 把多个config合并成一个
+ * @param {object} app koa 实例
+ *
+ * 文件系统：config
+ *           | config.development.js
+ *           | config.default.js
+ *           | config.test.js
+ *           | config.production.js
+ *
+ * 结果： app.config = { ...config.default, ...config.[env] }
+ */
+
+module.exports = (app) => {
+  // 获取business config目录路径
+  const businessConfigPath = path.join(app.baseDir, `config`);
+  // mint 内部的config目录路径
+  const mintConfigPath = path.join(__dirname, `..${sep}..${sep}config`);
+
+  // 获取默认的config配置
+  let defaultConfig = {};
+  try {
+    defaultConfig = require(path.join(mintConfigPath, "config.default.js"))(app);
+  } catch (err) {
+    console.error(`mint default config load exception] ${err.message}`);
+  }
+
+  try {
+    const applicationDefaultConfig = require(path.join(businessConfigPath, "config.default.js"))(
+      app,
+    );
+    defaultConfig = Object.assign(defaultConfig, applicationDefaultConfig);
+  } catch (err) {
+    console.error(`application default config load exception] ${err.message}`);
+  }
+
+  // 获取环境配置
+  let envConfig = {};
+  const { isDevelopment, isTest, isProduction } = app.$env;
+  try {
+    if (isDevelopment()) {
+      envConfig = require(path.join(businessConfigPath, `config.development.js`))(app);
+    } else if (isTest()) {
+      envConfig = require(path.join(businessConfigPath, `config.test.js`))(app);
+    } else if (isProduction()) {
+      envConfig = require(path.join(businessConfigPath, `config.production.js`))(app);
+    }
+  } catch (err) {
+    console.error(`[env config load exception] ${err.message}`);
+  }
+
+  // 合并配置
+  app.config = {
+    ...defaultConfig,
+    ...envConfig,
+  };
+};

package/mint-core/loader/controller.js

@@ -0,0 +1,59 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * 把多个中间件函数注册到app.controller
+ * @param {object} app koa 实例
+ *
+ * 文件系统：app/controller
+ *              | custom-model
+ *                     |  xxxx.js
+ *                     |  custom-controller.js
+ * 结果： app.controller.customModel.customController
+ */
+
+module.exports = (app) => {
+  // 获取business app/controller目录
+  const businessControllerPath = path.join(app.businessPath, `controller`);
+  // 获取mint app/controller目录
+  const mintControllerPath = path.join(__dirname, `..${sep}..${sep}app${sep}controller`);
+
+  // 获取所有文件
+  const businessFileList = glob.sync(path.join(businessControllerPath, "**", "*.js"));
+  const mintFileList = glob.sync(path.join(mintControllerPath, "**", "*.js"));
+
+  const controller = {};
+
+  const handleFile = (filePath, controllerPath) => {
+    let tempController = controller;
+    // 从路径中截取合法的子路径
+    let relPath = path.relative(controllerPath, filePath);
+    // 将 - 或者 _ 转换成驼峰
+    relPath = relPath.replace(/[-_](\w)/gi, (_, letter) => letter.toUpperCase());
+    const parts = relPath.split(sep);
+    let filename = parts.pop();
+    filename = path.parse(filename).name;
+    const names = [...parts, filename];
+
+    // 创建嵌套对象指向
+
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i == len - 1) {
+        const Controller = require(filePath)(app);
+        tempController[names[i]] = new Controller();
+      } else {
+        if (!tempController[names[i]]) {
+          tempController[names[i]] = {};
+        }
+        tempController = tempController[names[i]];
+      }
+    }
+  };
+
+  // 遍历所有文件
+  mintFileList.forEach((filePath) => handleFile(filePath, mintControllerPath));
+  businessFileList.forEach((filePath) => handleFile(filePath, businessControllerPath));
+
+  // 挂载到app.controller中
+  app.controller = controller;
+};

package/mint-core/loader/extend.js

@@ -0,0 +1,42 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * 把每个extend文件名当做key，合并到app实例中
+ * @param {object} app koa 实例
+ *
+ * 文件系统：app/extend
+ *           | xxx.js
+ *           | xxx.js
+ *
+ * 结果： 拓展app字段
+ */
+
+module.exports = (app) => {
+  // 读取app/extend目录下的所有文件
+  const businessExtendPath = path.join(app.businessPath, `extend`);
+  // 读取mint内部 app/extend目录下的所有文件
+  const mintExtendPath = path.join(__dirname, `..${sep}..${sep}app${sep}extend`);
+  // 获取所有文件
+  const mintFileList = glob.sync(path.join(mintExtendPath, `*.js`));
+  const businessFileList = glob.sync(path.join(businessExtendPath, `*.js`));
+  const handleFile = (filePath) => {
+    // 截取有效文件名
+    let name = path.relative(businessExtendPath, filePath);
+    // 去掉文件名后缀
+    name = path.basename(name, ".js");
+    // 将 - 或者 _ 转换成驼峰
+    name = name.replace(/[-_](\w)/gi, (_, letter) => letter.toUpperCase());
+    // 给app添加字段
+    for (const key in app) {
+      if (key === name) {
+        console.log(`[extend loader exception] ${name} is exist`);
+        return;
+      }
+    }
+    app[name] = require(filePath)(app);
+  };
+  // 遍历所有文件
+  mintFileList.forEach((filePath) => handleFile(filePath));
+  businessFileList.forEach((filePath) => handleFile);
+};

package/mint-core/loader/middleware.js

@@ -0,0 +1,54 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * 把多个中间件函数注册到app.middlewares中
+ * @param {object} app koa 实例
+ *
+ * 文件系统：app/middleware
+ *              | custom-model
+ *                     |  xxxx.js
+ *                     |  custom-middleware.js
+ *
+ * 结果： app.middlewares.customModel.customMiddleware
+ */
+
+module.exports = (app) => {
+  // 获取business app/middleware目录路径
+  const businessMiddlewarePath = path.resolve(app.businessPath, `.${sep}middleware`);
+  // 获取mint app/middleware目录路径
+  const mintMiddlewarePath = path.resolve(__dirname, `..${sep}..${sep}app${sep}middleware`);
+  // 获取所有文件
+  const businessFileList = glob.sync(path.resolve(businessMiddlewarePath, `.${sep}**${sep}*.js`));
+  const mintFileList = glob.sync(path.resolve(mintMiddlewarePath, `.${sep}**${sep}*.js`));
+
+  const middlewares = {};
+  const handleFile = (filePath, middlewaresPath) => {
+    let tempMiddleware = middlewares;
+    // 从路径中截取合法的子路径
+    let relPath = path.relative(middlewaresPath, filePath);
+    // 将 - 或者 _ 转换成驼峰
+    relPath = relPath.replace(/[-_](\w)/gi, (_, letter) => letter.toUpperCase());
+    const parts = relPath.split(sep);
+    let filename = parts.pop();
+    filename = path.parse(filename).name;
+    const names = [...parts, filename];
+    // 创建嵌套对象指向
+    for (let i = 0, len = names.length; i < len; ++i) {
+      if (i == len - 1) {
+        tempMiddleware[names[i]] = require(filePath)(app);
+      } else {
+        if (!tempMiddleware[names[i]]) {
+          tempMiddleware[names[i]] = {};
+        }
+        tempMiddleware = tempMiddleware[names[i]];
+      }
+    }
+  };
+  // 遍历所有文件
+  mintFileList.forEach((file) => handleFile(file, mintMiddlewarePath));
+  businessFileList.forEach((file) => handleFile(file, businessMiddlewarePath));
+
+  // 挂载到app.middlewares中
+  app.middlewares = middlewares;
+};

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

@@ -0,0 +1,39 @@
+const path = require("path");
+const glob = require("glob");
+const { sep } = path;
+/**
+ * 把router-schema目录下的js文件合并成一个obj对象
+ * @param {object} app koa 实例
+ *
+ * 目标：app/router-schema目录下的js文件的内容合并成一份schema配置
+ * 文件系统：app/router-schema
+ *           |
+ *           | xxx.js
+ *           | xxx.js
+ * 结果：app.routerSchema = {
+ *    [schemaName1]: schemaConfig,
+ *    [schemaName2]: schemaConfig
+ * }
+ */
+
+module.exports = (app) => {
+  // 获取business router-schema的目录路径
+  const businessRouterSchemaPath = path.join(app.businessPath, "router-schema");
+  // 获取mint router-schema的目录路径
+  const eplisSchemaPath = path.join(__dirname, `..${sep}..${sep}app${sep}router-schema`);
+
+  // 获取router-schema目录下的所有文件
+  const businessFileList = glob.sync(path.join(businessRouterSchemaPath, `*.js`));
+  const mintFileList = glob.sync(path.join(eplisSchemaPath, `*.js`));
+  // 遍历文件
+  const routerSchema = {};
+
+  const handleFile = (filePath) => {
+    Object.assign(routerSchema, require(filePath));
+  };
+  mintFileList.forEach(handleFile);
+  businessFileList.forEach(handleFile);
+
+  // 得到最终的schema配置
+  app.routerSchema = routerSchema;
+};

package/mint-core/loader/router.js

@@ -0,0 +1,36 @@
+const path = require("path");
+const glob = require("glob");
+const KoaRouter = require("koa-router");
+const { sep } = path;
+/**
+ * 注册到app.router
+ * @param {object} app koa 实例
+ *
+ * 文件系统：app/router
+ *            | user
+ *               | xxx.js
+ */
+
+module.exports = (app, callback) => {
+  // 读取business app/router目录路径
+  const businessRouterPath = path.join(app.businessPath, `router`);
+  // 获取mint app/router目录路径
+  const mintRouterPath = path.join(__dirname, `..${sep}..${sep}app${sep}router`);
+
+  // 获取router目录下的所有文件
+  const businessFileList = glob.sync(path.join(businessRouterPath, "**", "*.js"));
+  const mintFileList = glob.sync(path.join(mintRouterPath, "**", "*.js"));
+
+  const router = new KoaRouter();
+
+  // 遍历所有文件
+  [...mintFileList, ...businessFileList].forEach((filePath) => {
+    require(filePath)(app, router);
+  });
+
+  callback && callback(app, router);
+
+  // 注册
+  app.use(router.routes());
+  app.use(router.allowedMethods());
+};