一小时包教会——webpack入门指南
什么是webpack?
webpack是近期最火的一款模块加载器兼打包工具,它能把各种资源,例如JS(含JSX)、coffee、样式(含less/sass)、图片等都作为模块来使用和处理。
我们可以直接使用require(XXX)的形式来引入各模块,即使它们可能需要经过编译(比如JSX和sass),但我们无须在上面花费太多心思,因为webpack有着各种健全的加载器(loader)在默默处理这些事情,这块我们后续会提到。
你可以不打算将其用在你的项目上,但没有理由不去掌握它,因为以近期Github上各大主流的(React相关)项目来说,它们仓库上所展示的示例已经是基于webpack来开发的,比如React-Boostrap和Redux。
webpack的官网是
http://webpack.github.io/,文档地址是http://webpack.github.io/docs/,想对其进行更详细了解的可以点进去瞧一瞧。
webpack的优势
其优势主要可以归类为如下几个:
1.webpack是以commonJS的形式来书写脚本滴,但对AMD/CMD的支持也很全面,方便旧项目进行代码迁移。
2.能被模块化的不仅仅是JS了。
3.开发便捷,能替代部分grunt/gulp的工作,比如打包、压缩混淆、图片转base64等。
4.扩展性强,插件机制完善,特别是支持React热插拔(见react-hot-loader)的功能让人眼前一亮。
我们谈谈第一点。以AMD/CMD模式来说,鉴于模块是异步加载的,所以我们常规需要使用define函数来帮我们搞回调:
1 2 3 4 5 6 7 8
| define(['package/lib'],function(lib){ functionfoo(){ lib.log('helloworld!'); } return{ foo:foo }; });
|
另外为了可以兼容commonJS的写法,我们也可以将define这么写:
1 2 3 4 5 6 7 8 9 10 11 12
| define(function(require,exports,module){ varsomeModule=require("someModule"); varanotherModule=require("anotherModule");
someModule.doTehAwesome(); anotherModule.doMoarAwesome();
exports.asplode=function(){ someModule.doTehAwesome(); anotherModule.doMoarAwesome(); }; });
|
然而对webpack来说,我们可以直接在上面书写commonJS形式的语法,无须任何define(毕竟最终模块都打包在一起,webpack也会最终自动加上自己的加载器):
1 2 3 4 5 6 7 8 9 10
| varsomeModule=require("someModule"); varanotherModule=require("anotherModule");
someModule.doTehAwesome(); anotherModule.doMoarAwesome();
exports.asplode=function(){ someModule.doTehAwesome(); anotherModule.doMoarAwesome(); };
|
这样撸码自然更简单,跟回调神马的说byebye~
不过即使你保留了之前define的写法也是可以滴,毕竟webpack的兼容性相当出色,方便你旧项目的模块直接迁移过来。
安装和配置
一.安装
我们常规直接使用npm的形式来安装:
$npminstallwebpack-g
当然如果常规项目还是把依赖写入package.json包去更人性化:
$npminit
$npminstallwebpack--save-dev
二.配置
每个项目下都必须配置有一个webpack.config.js,它的作用如同常规的gulpfile.js/Gruntfile.js,就是一个配置项,告诉webpack它需要做什么。
我们看看下方的示例:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
| varwebpack=require('webpack'); varcommonsPlugin=newwebpack.optimize.CommonsChunkPlugin('common.js');
module.exports={ //插件项 plugins:[commonsPlugin], //页面入口文件配置 entry:{ index:'./src/js/page/index.js' }, //入口文件输出配置 output:{ path:'dist/js/page', filename:'[name].js' }, module:{ //加载器配置 loaders:[ {test:/\.css$/,loader:'style-loader!css-loader'}, {test:/\.js$/,loader:'jsx-loader?harmony'}, {test:/\.scss$/,loader:'style!css!sass?sourceMap'}, {test:/\.(png|jpg)$/,loader:'url-loader?limit=8192'} ] }, //其它解决方案配置 resolve:{ root:'E:/github/flux-example/src',//绝对路径 extensions:['','.js','.json','.scss'], alias:{ AppStore:'js/stores/AppStores.js', ActionType:'js/actions/ActionType.js', AppAction:'js/actions/AppAction.js' } } };
|
⑴plugins是插件项,这里我们使用了一个CommonsChunkPlugin的插件,它用于提取多个入口文件的公共脚本部分,然后生成一个common.js来方便多页面之间进行复用。
⑵entry是页面入口文件配置,output是对应输出项配置(即入口文件最终要生成什么名字的文件、存放到哪里),其语法大致为:
1 2 3 4 5 6 7 8 9 10 11
| { entry:{ page1:"./page1", //支持数组形式,将加载数组中的所有模块,但以最后一个模块作为输出 page2:["./entry1","./entry2"] }, output:{ path:"dist/js/page", filename:"[name].bundle.js" } }
|
该段代码最终会生成一个page1.bundle.js和page2.bundle.js,并存放到./dist/js/page文件夹下。
⑶module.loaders是最关键的一块配置。它告知webpack每一种文件都需要使用什么加载器来处理:
1 2 3 4 5 6 7 8 9 10 11 12 13
| module:{ //加载器配置 loaders:[ //.css文件使用style-loader和css-loader来处理 {test:/\.css$/,loader:'style-loader!css-loader'}, //.js文件使用jsx-loader来编译处理 {test:/\.js$/,loader:'jsx-loader?harmony'}, //.scss文件使用style-loader、css-loader和sass-loader来编译处理 {test:/\.scss$/,loader:'style!css!sass?sourceMap'}, //图片文件使用url-loader来处理,小于8kb的直接转为base64 {test:/\.(png|jpg)$/,loader:'url-loader?limit=8192'} ] }
|
如上,"-loader"其实是可以省略不写的,多个loader之间用“!”连接起来。
注意所有的加载器都需要通过npm来加载,并建议查阅它们对应的readme来看看如何使用。
拿最后一个url-loader来说,它会将样式中引用到的图片转为模块来处理,使用该加载器需要先进行安装:
npminstallurl-loader-save-dev
配置信息的参数“?limit=8192”表示将所有小于8kb的图片都转为base64形式(其实应该说超过8kb的才使用url-loader来映射到文件,否则转为dataurl形式)。
⑷最后是resolve配置,这块很好理解,直接写注释了:
1 2 3 4 5 6 7 8 9 10 11 12
| resolve:{ //查找module的话从这里开始查找 root:'E:/github/flux-example/src',//绝对路径 //自动扩展文件后缀名,意味着我们require模块可以省略不写后缀名 extensions:['','.js','.json','.scss'], //模块别名定义,方便后续直接引用别名,无须多写长长的地址 alias:{ AppStore:'js/stores/AppStores.js',//后续直接require('AppStore')即可 ActionType:'js/actions/ActionType.js', AppAction:'js/actions/AppAction.js' } }
|
关于webpack.config.js更详尽的配置可以参考这里。
运行webpack
webpack的执行也很简单,直接执行
$webpack--display-error-details
即可,后面的参数“--display-error-details”是推荐加上的,方便出错时能查阅更详尽的信息(比如webpack寻找模块的过程),从而更好定位到问题。
其他主要的参数有:
1 2 3 4 5 6 7
| $webpack--configXXX.js//使用另一份配置文件(比如webpack.config2.js)来打包
$webpack--watch//监听变动并自动打包
$webpack-p//压缩混淆脚本,这个非常非常重要!
$webpack-d//生成map映射文件,告知哪些模块被最终打包到哪里了
|
其中的-p是很重要的参数,曾经一个未压缩的700kb的文件,压缩后直接降到180kb(主要是样式这块一句就独占一行脚本,导致未压缩脚本变得很大)。
模块引入
上面唠嗑了那么多配置和执行方法,下面开始说说寻常页面和脚本怎么使用呗。
一.HTML
直接在页面引入webpack最终生成的页面脚本即可,不用再写什么data-main或seajs.use了:
1 2 3 4 5 6 7 8 9 10 11
| <!DOCTYPEhtml> <html> <headlang="en"> <metacharset="UTF-8"> <title>demo</title> </head> <body> <scriptsrc="dist/js/page/common.js"></script> <scriptsrc="dist/js/page/index.js"></script> </body> </html>
|
可以看到我们连样式都不用引入,毕竟脚本执行时会动态生成<style>并标签打到head里。
二.JS
各脚本模块可以直接使用commonJS来书写,并可以直接引入未经编译的模块,比如JSX、sass、coffee等(只要你在webpack.config.js里配置好了对应的加载器)。
我们再看看编译前的页面入口文件(index.js):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
| require('../../css/reset.scss');//加载初始化样式 require('../../css/allComponent.scss');//加载组件样式 varReact=require('react'); varAppWrap=require('../component/AppWrap');//加载组件 varcreateRedux=require('redux').createRedux; varProvider=require('redux/react').Provider; varstores=require('AppStore');
varredux=createRedux(stores);
varApp=React.createClass({ render:function(){ return( <Providerredux={redux}> {function(){return<AppWrap/>;}} </Provider> ); } });
React.render( <App/>,document.body );
|
一切就是这么简单么么哒~后续各种有的没的,webpack都会帮你进行处理。
其他
至此我们已经基本上手了webpack的使用,下面是补充一些有用的技巧。
一.shimming
在AMD/CMD中,我们需要对不符合规范的模块(比如一些直接返回全局变量的插件)进行shim处理,这时候我们需要使用exports-loader来帮忙:
{test:require.resolve("./src/js/tool/swipe.js"),loader:"exports?swipe"}
之后在脚本中需要引用该模块的时候,这么简单地来使用就可以了:
require('./tool/swipe.js');
swipe();
二.自定义公共模块提取
在文章开始我们使用了CommonsChunkPlugin插件来提取多个页面之间的公共模块,并将该模块打包为common.js。
但有时候我们希望能更加个性化一些,我们可以这样配置:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
| varCommonsChunkPlugin=require("webpack/lib/optimize/CommonsChunkPlugin"); module.exports={ entry:{ p1:"./page1", p2:"./page2", p3:"./page3", ap1:"./admin/page1", ap2:"./admin/page2" }, output:{ filename:"[name].js" }, plugins:[ newCommonsChunkPlugin("admin-commons.js",["ap1","ap2"]), newCommonsChunkPlugin("commons.js",["p1","p2","admin-commons.js"]) ] }; //<script>srequired: //page1.html:commons.js,p1.js //page2.html:commons.js,p2.js //page3.html:p3.js //admin-page1.html:commons.js,admin-commons.js,ap1.js //admin-page2.html:commons.js,admin-commons.js,ap2.js
|
三.独立打包样式文件
有时候可能希望项目的样式能不要被打包到脚本中,而是独立出来作为.css,然后在页面中以<link>标签引入。这时候我们需要extract-text-webpack-plugin来帮忙:
1 2 3 4 5 6 7 8
| varwebpack=require('webpack'); varcommonsPlugin=newwebpack.optimize.CommonsChunkPlugin('common.js'); varExtractTextPlugin=require("extract-text-webpack-plugin");
module.exports={ plugins:[commonsPlugin,newExtractTextPlugin("[name].css")], entry:{ //...省略其它配置
|
最终webpack执行后会乖乖地把样式文件提取出来:
四.使用CDN/远程文件
有时候我们希望某些模块走CDN并以<script>的形式挂载到页面上来加载,但又希望能在webpack的模块中使用上。
这时候我们可以在配置文件里使用externals属性来帮忙:
1 2 3 4 5 6 7
| { externals:{ //require("jquery")是引用自外部模块的 //对应全局变量jQuery "jquery":"jQuery" } }
|
需要留意的是,得确保CDN文件必须在webpack打包文件引入之前先引入。
我们倒也可以使用script.js在脚本中来加载我们的模块:
1 2 3 4
| var$script=require("scriptjs"); $script("//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js",function(){ $('body').html('Itworks!') });
|
五.与grunt/gulp配合
以gulp为示例,我们可以这样混搭:
1 2 3 4 5 6 7 8 9 10 11 12
| gulp.task("webpack",function(callback){ //runwebpack webpack({ //configuration },function(err,stats){ if(err)thrownewgutil.PluginError("webpack",err); gutil.log("[webpack]",stats.toString({ //outputoptions })); callback(); }); });
|
当然我们只需要把配置写到webpack({...})中去即可,无须再写webpack.config.js了。
更多参照信息请参阅:grunt配置/gulp配置。
六.React相关
⑴推荐使用npminstallreact的形式来安装并引用React模块,而不是直接使用编译后的react.js,这样最终编译出来的React部分的脚本会减少10-20kb左右的大小。
⑵react-hot-loader是一款非常好用的React热插拔的加载插件,通过它可以实现修改-运行同步的效果,配合webpack-dev-server使用更佳!
基于webpack的入门指引就到这里,希望本文能对你有所帮助,你也可以参考下述的文章来入门:
webpack入门指谜
webpack-howto
共勉~