声明:此文章为转载,非本人原创
搭建 webpack + React 开发环境
我在实际工作中用百度 fis3 搭建 React 开发环境,但是放在整个前端社区中,webpack 肯定更适合大家,这里就用 webpack。如果之前未听说或者未用过 webpack 的同学,一定此机会恶补一下,也可以查阅官网
开始之前
- 我目前使用的系统是 mac os 系统,使用 windows 的同学建议在执行本课程的命令行时,使用一个模拟 linux 命令的工具,例如
xshell
- 能科学上网最好,否则就需要你在某些过程中耐心等待
初始化 npm 环境并安装插件
当前的 web 前端开发,基本使用 npm 管理第三方依赖(插件),不熟悉的同学这里抓紧补一下。
初始化 npm 环境
首先保证有 node 和 npm 环境,运行node -v
和npm -v
查看
进入项目目录,运行npm init
按照步骤填写最终生成package.json
文件,所有使用 npm 做依赖管理的项目,根目录下都会有一个这个文件,该文件描述了项目的基本信息以及一些第三方依赖项(插件)。详细的使用说明可查阅官网文档,不过是英文的。
安装插件
已知我们将使用 webpack 作为构建工具,那么就需要安装相应插件,运行 npm install webpack webpack-dev-server --save-dev
来安装两个插件。
又已知我们将使用 React ,也需要安装相应插件,运行 npm i react react-dom --save
来安装两个插件。其中i
是install
的简写形式。
安装完成之后,查看package.json
可看到多了devDependencies
和dependencies
两项,根目录也多了一个node_modules
文件夹。
--save
和 --save-dev
的区别
npm i
时使用--save
和--save-dev
,可分别将依赖(插件)记录到package.json
中的dependencies
和devDependencies
下面。
dependencies
下记录的是项目在运行时必须依赖的插件,常见的例如react
jquery
等,即及时项目打包好了、上线了,这些也是需要用的,否则程序无法正常执行。
devDependencies
下记录的是项目在开发过程中使用的插件,例如这里我们开发过程中需要使用webpack
打包,而我在工作中使用fis3
打包,但是一旦项目打包发布、上线了之后,webpack
和fis3
就都没有用了,可卸磨杀驴。
延伸一下,我们的项目有package.json
,其他我们用的项目如webpack
也有package.json
,见./node_modules/webpack/package.json
,其中也有devDependencies
和dependencies
。当我们使用npm i webpack
时,./node_modules/webpack/package.json
中的dependencies
会被 npm 安装上,而devDependencies
也没必要安装。
配置 webpack.config.js
为了提高学习效率,webpack 最最基础的用法,就不再挨个演示了(推荐一个非常好的入门文章,以及更多资料)这里我们把项目中的webpack.config.js
这个配置文件详细的讲解一下,过程中也会照顾 0 基础的同学。
文件格式
webpack.config.js 就是一个普通的 js 文件,符合 commonJS 规范。最后输出一个对象,即module.exports = {...}
输入 & 输出
这个比较基础,不过需要新建./app/index.jsx
作为入口文件,目前项目中只有这一个入口文件。不过 webpack 支持多个入口文件,可查阅文档。
输出就是一个bundle.js
,js 和 css 都在里面,不过只有在开发环境下才用,发布代码的时候,肯定不能只有这么一个文件,接下来会讲到。
module
针对不同类型的文件,使用不同的loader
,当然使用之前要安装,例如npm i style-loader css-loader --save-dev
。该项目代码中,我们用到的文件格式有:js/jsx 代码、css/less 代码、图片、字体文件。
less 是 css 的语法糖,可以更高效低冗余的写 css,不熟悉的朋友可去官网看看,非常简单。
在加载 css/less 时用到了postcss
,主要使用autoprefixer
功能,帮助自动加 css3 的浏览器前缀,非常好用。
编译 es6 和 jsx 语法时,用到家喻户晓的babel
,另外还需增加一个.babelrc
的配置文件。
plugins
使用 html 模板(需要npm i html-webpack-plugin --save-dev
),这样可以将输出的文件名(如./bundle.js
)自动注入到 html 中,不用我们自己手写。手写的话,一旦修改就需要改两个地方。
使用热加载和自动打开浏览器插件
devServer
对 webpack-dev-server 的配置
npm start
在 package.json 中,输入以下代码,将这一串命令封装为npm start
,这样就可以运行项目代码了。
"scripts": {
"start": "NODE_ENV=dev webpack-dev-server --progress --colors"
}
代码中NODE_ENV=dev
代表当前是开发环境下,这里的"dev"
可被 js 代码中的process.env.NODE_ENV
得到并做一些其他处理。
定义环境全局变量
以下定义,可使得代码通过__DEV__
得到当前是不是开发模式。
new webpack.DefinePlugin({
__DEV__: JSON.stringify(JSON.parse((process.env.NODE_ENV == 'dev') || 'false'))
})
打开./app/util/localStore.js
可以看到if (__DEV__) { console.error('localStorage.getItem报错, ', ex.message) }
,即只有开发环境下才提示error,发布之后就不会提示了。(因为发布的命令中用到NODE_ENV=production
)
配置 webpack.production.config.js
开发环境下,可以不用考虑系统的性能,更多考虑的是如何增加开发效率。而发布系统时,就需要考虑发布之后的系统的性能,包括加载速度、缓存等。下面介绍发布用配置代码和开发用的不一样的地方。
发布到 ./build
文件夹中
path: __dirname + "/build",
vendor
将第三方依赖单独打包。即将 node_modules 文件夹中的代码打包为 vendor.js 将我们自己写的业务代码打包为 app.js。这样有助于缓存,因为在项目维护过程中,第三方依赖不经常变化,而业务代码会经常变化。
md5后缀
为每个打包出来的文件都加md5后缀,例如"/js/[name].[chunkhash:8].js"
,可使文件强缓存。
分目录
打包出来的不同类型的文件,放在不同目录下,例如图片文件将放在img/
目录下
Copyright
自动为打包出来的代码增加 copyright 内容
分模块
new webpack.optimize.OccurenceOrderPlugin(),
压缩代码
使用 Uglify 压缩代码,其中warnings: false
是去掉代码中的 warning
分离 css 和 js 文件
开发环境下,css 代码是放在整个打包出来的那个 bundle.js 文件中的,发布环境下当然不能混淆在一起,使用new ExtractTextPlugin('/css/[name].[chunkhash:8].css'),
将 css 代码分离出来。
npm run build
打开package.json
,查看以下代码。npm start
和npm run build
分别是运行代码和打包项目。另外,"start"、"test"
可以不用run
。
"scripts": {
"start": "NODE_ENV=dev webpack-dev-server --progress --colors",
"build": "rm -rf ./build && NODE_ENV=production webpack --config ./webpack.production.config.js --progress --colors"
},
这两个命令主要有以下区别:
- 前者中默认使用 webpack.config.js 作为配置文件,而后者中强制使用 webpack.production.config.js 作为配置文件
- 前者
NODE_ENV=dev
而后者NODE_ENV=production
,标识不同的环境。而这个"dev" "production"
可以在代码中通过process.env.NODE_ENV
获取。
最小化压缩 React
以下配置可以告诉 React 当前是生产环境,请最小化压缩 js ,即把开发环境中的一些提示、警告、判断通通去掉,直流以下发布之后可用的代码。
new webpack.DefinePlugin({
'process.env':{
'NODE_ENV': JSON.stringify(process.env.NODE_ENV)
}
}),