@lixianwei/elpis 1.0.0

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

@@ -0,0 +1,118 @@
+const path = require('path');
+const merge = require('webpack-merge');
+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 ={
+    debug: false,
+    threadPool:HappyPack.ThreadPool({size:os.cpus().length}),
+}
+// 基础类
+const baseConfig = require('./webpack.base.js');
+
+// 生产环境webpack配置
+const webpackConfig = merge.smart(baseConfig, {
+    // 指定生产环境
+    mode: 'production',
+    cache:{
+        type: 'filesystem',
+    }, //跳过重复解析/编译
+    // 生产环境的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:/\.js$/,
+                include:[
+                    // 处理elpis 目录
+                    path.resolve(__dirname, '../../pages'),
+                    // 处理业务目录
+                    path.resolve(process.cwd(), './app/pages'),
+                ],
+                use:[`${require.resolve('happypack/loader')}?id=js`]
+            }
+        ]
+    },
+    // webpack 不会有大量 hints 信息，默认为waring
+    performance: {
+        hints: false,
+    },
+    plugins: [
+        // 每次build前，都要先清空public/dist 目录
+        new CleanWebpackPlugin(['public/dist'],{
+            root:path.resolve(process.cwd(),'./app/'),
+            exclude:[],
+            verbose:true,
+            dry:false
+        }),
+        //提起css公共部分，有效利用缓存
+        new MiniCssExtractPlugin({
+            chunkFilename: 'css/[name]_[chunkhash:8].bundle.css',
+        }),
+        // 优化并压缩css资源
+        new CssMinimizerPlugin(),
+        // 多线程打包js，加快打包速度
+        new HappyPack({
+            ...happyPackCommonConfig,
+            id:'js',
+            loaders:[`${require.resolve('babel-loader')}?${JSON.stringify({
+                presets: [require.resolve('@babel/preset-env')],
+                plugins: [
+                    require.resolve('@babel/plugin-transform-runtime'),
+                ],
+                cacheDirectory: true,  //加快第二次编译的速度
+            })}`]
+        }),
+        // 多线程打包css，加快打包速度
+        new HappyPack({
+            ...happyPackCommonConfig,
+            id:'css',
+            loaders:[{
+                path:require.resolve('css-loader'),
+                options:{
+                    importLoaders: 1,
+                }
+            }]
+        }),
+        // 浏览器在请求资源时不发送用户的身份凭证
+        new HtmlWebpackInjectAttributesPlugin({
+            crossorigin: 'anonymous',
+        })
+    ],
+    optimization: {
+        // 使用TerserPlugin 的并发和缓存，提升压缩阶段的性能
+        // 清楚console.log
+        minimize:true,
+        minimizer: [
+            new TerserWebpackPlugin({
+                parallel: true, //利用多核cpu 的优势来加快压缩速度
+                terserOptions: {
+                    compress: {
+                        drop_console: true,//去掉console.log 打印
+                    }
+                }
+            })
+        ]
+    }
+
+})
+module.exports = webpackConfig;

package/app/webpack/dev.js

@@ -0,0 +1,52 @@
+// 本地开发启动
+const express = require('express');
+const path = require('path');
+const webpack = require('webpack');
+const consoler = require('consoler');
+const devMiddleware = require('webpack-dev-middleware');
+const hotMiddleware = require('webpack-hot-middleware');
+
+module.exports = () => {
+// 从webpack.dev.js获取webpack配置和devServer配置
+    const {webpackConfig,DEV_SERVER_CONFIG} = require('./config/webpack.dev.js');
+
+    console.log('9999',webpackConfig)
+
+    const app = express();
+
+    const compiler = webpack(webpackConfig);
+// 指定静态文件目录
+    app.use(express.static(path.join(__dirname, '../public/dist')));
+// 引用devMiddleware 中间件（监控文件改动）
+    app.use(devMiddleware(compiler, {
+        // 落地文件
+        writeToDisk: (filePath)=>filePath.endsWith('.tpl'),
+        // 资源路径
+        publicPath: webpackConfig.output.publicPath,
+        headers: {
+            'Access-Control-Allow-Origin': '*',
+            'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS,PATCH',
+            '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初次构建完成提示....')
+
+// 启动dev服务
+    const port = DEV_SERVER_CONFIG.PORT
+    app.listen(port, () => {
+        console.log('app listening on port ' + port);
+    })
+}

package/app/webpack/libs/blank.js

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

package/app/webpack/prod.js

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

package/config/config.default.js

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

package/elpis-core/env.js

@@ -0,0 +1,20 @@
+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,92 @@
+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 serviceLoader = require('./loader/service')
+const configLoader = require('./loader/config')
+const controllerLoader = require('./loader/controller')
+const extendLoader = require('./loader/extend')
+
+module.exports ={
+    /**
+     * 启动项目
+     * @params options 项目配置
+     * options ={
+     *     name //项目名称
+     *     homePath //项目首页
+     * }
+     * */
+    start(options = {}){
+        //koa实例
+        const app = new koa();
+
+        // 应用配置
+        app.options= options
+
+        // 基础路径
+        app.baseDir = process.cwd();
+
+        // 业务文件路径
+        app.businessPath = path.resolve(app.baseDir, `.${sep}app`);
+
+        // 初始化环境配置
+        app.env = env();
+        console.log(`----${app.env.get()}---`);
+        // 加载config
+        configLoader(app)
+        console.log(`----start config-----`);
+
+        // 加载extend
+        extendLoader(app)
+        console.log(`----start extend-----`);
+
+        // 加载routerSchema
+        routerSchemaLoader(app)
+        console.log(`----start routerSchema-----`);
+
+        // 加载 service
+        serviceLoader(app)
+        console.log(`----start service-----`);
+
+        // 加载 controller
+        controllerLoader(app)
+
+        console.log(`----start controller-----`);
+
+        // 加载middleware
+        middlewareLoader(app)
+        console.log(`----start middleware-----`);
+
+        // 注册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 loader middleware done-----`);
+        }catch(e){
+            console.log('there is no global business middleware file')
+        }
+        // 注册路由
+        routerLoader(app)
+        console.log(`----start router-----`);
+        // 启动服务
+        try{
+            const port = process.env.PORT || 8080;
+            const host = process.env.IP || '0.0.0.0';
+            app.listen(port, host)
+            console.log('Listening on port ' + port);
+        } catch(e){
+            console.error(e);
+        }
+
+        return app;
+    }
+}

package/elpis-core/loader/config.js

@@ -0,0 +1,54 @@
+const  path = require('path');
+const {sep} = path
+/*
+* config loader
+* @parame {object} app koa 实例
+* 配置区分 本地/测试/生产 ， 通过env 环境读取不同文件配置 evn.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(process.cwd(),`.${sep}config`);
+    console.log(businessConfigPath)
+
+    // 获取default.config
+    try{
+        defaultConfig={
+            ...defaultConfig,
+            ...require(path.resolve(businessConfigPath,`.${sep}config.default.js`))
+        }
+    }catch(e){
+        console.log('there is no default.config file')
+    }
+
+    // 获取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`));
+            console.log(envConfig,'_ENV')
+        }
+    }catch(e){
+        console.log('there is no config file')
+    }
+    // 覆盖并加载config配置
+    app.config = Object.assign({},defaultConfig,envConfig);
+    console.log('app.config:',app.config);
+};

package/elpis-core/loader/controller.js

@@ -0,0 +1,61 @@
+const glob =  require('glob');
+const path = require('path');
+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/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) {
+        //提取文件名称
+        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('.'));
+
+        //把'-' 统一改成驼峰命名
+        name = name.replace(/[_-][a-z]/ig,(s)=>s.substring(1).toUpperCase());
+
+        //挂载controller到内存app对象中
+        let temController = controller;
+        const names = name.split(sep) //[customModule(目录),customController(文件)]
+        for(let i =0,len = names.length;i<len; ++i ){
+            if(i===len - 1){
+                const ControllerMoule = require(path.resolve(file))(app)
+                temController[names[i]] = new ControllerMoule();
+            }else{
+                if(!temController[names[i]]){
+                    temController[names[i]] = {};
+                }
+                temController = temController[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 => {
+        handelFile(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 => {
+        handelFile(file)
+    })
+
+    //把内容加载到app.extend 下
+    function handelFile(file){
+        //提取文件名称
+        let name = path.resolve(file)
+
+        // 截取路径 app/extend/custom-extend.js =>custom-extend
+        name = name.substring(name.lastIndexOf(`extend${sep}`)+`extend${sep}`.length,name.lastIndexOf('.'));
+
+        //把'-' 统一改成驼峰命名
+        name = name.replace(/[_-][a-z]/ig,(s)=>s.substring(1).toUpperCase());
+        // 过滤app 已经存在的key
+        for(const key in app){
+            if(key === name){
+                console.log(`${name} is already in  app`);
+                return
+            }
+        }
+
+        // 挂载extend 到app上
+        app[name] = require(path.resolve(file))(app);
+    }
+
+};
+

package/elpis-core/loader/middleware.js

@@ -0,0 +1,61 @@
+const glob =  require('glob');
+const path = require('path');
+const {sep} = path
+/*
+* middleware loader
+* @param{object} app Koa 实例
+* 加载所有minddleware，可通过 'app.minddlewares.${目录}.${文件}' 访问
+* 例子
+* app/middleware
+*  |
+*  | --custom-module
+*        |
+*        | --custom-middleware.js
+*   => app.middleware.customModule.customMiddleware
+* */
+
+module.exports = (app) => {
+    const middleware = {}
+    // 读取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/middleware/custom-module/custom-middleware =>custom-module/custom-middleware
+        name = name.substring(name.lastIndexOf(`middleware${sep}`)+`middleware${sep}`.length,name.lastIndexOf('.'));
+
+        //把'-' 统一改成驼峰命名
+        name = name.replace(/[_-][a-z]/ig,(s)=>s.substring(1).toUpperCase());
+
+        //挂载middleware到内存app对象中
+        let tempMiddleware = middleware;
+        const names = name.split(sep)
+        for(let i =0,len = names.length;i<len; ++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 = middleware;
+};
+

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

@@ -0,0 +1,39 @@
+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.rouSchema ={
+ '${api1}':${jsonSchema},
+ '${api2}':${jsonSchema}
+}
+* */
+module.exports = (app) => {
+    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)
+    })
+    // 注册所有的routerSchema，使得可以 app.routerSchema 这样访问
+    function handleFile(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 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`);
+    // 注册所有路由
+    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?.homePath ?? '/'}`)
+    })
+    // 路由注册到app上
+    app.use(router.routes());
+    app.use(router.allowedMethods());
+
+};