管控平台(scorpio)
相对于旧版本,本项目做了以下升级改造:
编译速度优化,旧版本编译一次需要
210秒
以上,改造后编译50秒
左右,仍然有优化空间node-server框架从express升级到koa,使得书写代码更简洁
node-server修复旧版一些书写不合理的地方(比如在try-catch里边运行异步代码),打印日志以便调试使用
node-server集成webpack动态编译js并打印更多有用log,使得开发阶段少启动一个命令行窗口
本地环境搭建:
1.安装软件(如已安装可跳过)
Node.js 6.0+:https://nodejs.org/dist/v6.9.4/node-v6.9.4-x64.msi
npm i -g gulp webpack
2.安装本项目第三方依赖(如果已经安装过并且无包更新可以跳过此步)
$ npm i
3.启动nginx:双击cmd/start.bat
注:nginx进程启动之后,不需要重复启动,node-server有改动之后只需执行下面的步骤重启node-server即可。
4.启动node-server:
$ npm run start:dev
或者cmd运行:双击cmd/start.bat
注:node-server已经集成动态编译js和hotload功能,所以只需启动一个窗口即可。
5.编译
运行npm run build
或者双击cmd/build.bat
可执行文件,编译结果存放在和旧项目同位置。
6.编译并将编译结果同步到测试环境
运行npm run deploy
或者双击cmd/build-and-deploy.bat
======================= 开发请接着看 ==============================
开发指引
发布说明
推荐将原review上面node仓库下所有的子业务拆开,独立成一个git,这样开发只需要关注自己负责的项目即可,也无需担心公用pom文件带来的代码冲突等问题,项目目录参考本项目。拆开后node-server将可以直接走容器平台发布,静态资源分开部署。
如果实在不想从review迁移出来又想对旧项目进行改造升级,可以直接拷贝到review上面node仓库的project/scorpio
下面替换旧项目(先做好备份),然后copy旧的pom.xml过去即可,最后修改gulpfile.js
的outpath
配置项,改成'../../output/scorpio'
。接着就可以按照原来的方式打包(jenkins)、发布等。
目录说明
./
├── README.md # 文档
├── cmd
│ ├── build-and-deploy.bat # 编译打包并上传到开发机
│ ├── build.bat # 启动编译
│ ├── nginx/
│ ├── startOrRestart-nginx.bat # 启动nginx,如果没有改动nginx配置,无需每次都重启nginx
│ ├── start-node.bat # 启动node server
│ └── stop-nginx.bat # 停止nginx(杀进程)
├── configs
│ ├── extract.js # 批量提取旧模板里的入口、css依赖表,项目改造时可以使用用
│ ├── make-webpack.js
│ ├── scorpio-prod-test-nginx.conf # 正式环境部署参考配置
│ ├── webpack.dev.config.js # 开发环境build配置
│ ├── webpack.dll.config.js # 将常用的第三方库提取成dll,在代码里可以直接require
│ └── webpack.prod.config.js # 生产环境build配置
├── gulpfile.js # 执行一些常规任务
├── node-server
│ └── scorpio
│ ├── Dockerfile # 在容器平台运行规范
│ ├── docker-build.sh # 生成docker镜像脚本示例,修改版本号之后在服务器执行`sh docker-build.sh`
│ ├── app.js # server入口
│ ├── config.js # server配置,包括开发|测试|正式环境host配置,以及路由配置
│ ├── favicon.ico
│ ├── pm2-deploy.json # 非docker环境部署配置,可直接使用`pm2 startOrRestart pm2-deploy.json`命令启动或重启
│ ├── routes.js # 解析配置并挂载路由,一般无需改动此文件
│ └── view/ # 项目模板,请按需添加
├── package.json # 整个项目配置文件
└── resources
└── scorpio
├── assets # 编译产出文件,因node项目结构特殊,编译完成后会同步到根目录的output文件夹下
│ ├── css/
│ ├── images/
│ ├── js/
│ └── lib/ # 一些第三方库(压缩后),放到这里并在模板里直接link,不占用编译时间
├── config.js # 前端配置,主要是页面入口配置,即旧版使用requirejs时的入口
├── css/
├── images/
├── js/
├── lib/ # 存放第三方库的开发版,用于debug
└── utils/
node-server 运行指引
只需要关注server配置文件node-server/scorpio/config.js
文件即可,里边包含三种环境的host映射、路由配置等,其他文件一般无需改动。
本地运行
$ npm install && npm run start:dev
测试环境运行
$ npm install --production && pm2 startOrRestart pm2-deploy.json
传统方式部署(生产环境)
同测试环境部署,采用pm2
,上传到机器之后执行npm install --production && pm2 startOrRestart pm2-deploy.json