Vue+Webpack开发可复用的单页面富应用教程(配置篇)

本文首发于TalkingCoder,一个有逼格的程序员社区。转载请注明出处和作者。

写在前面

本文为系列文章,总共分四节:

《Vue+Webpack使用规范》

《Vue+Webpack开发可复用的单页面富应用教程(配置篇)》

《Vue+Webpack开发可复用的单页面富应用教程(组件篇)》

《Vue+Webpack开发可复用的单页面富应用教程(技巧篇)》


7月16日在斗鱼直播了一场关于Vue+Webpack的技术分享,对基于vue的组件化开发有了一个初步的在线demo演示,点击查看直播录像。本文则会在此基础上,对Webpack的安装和基础配置进行较全面的讲解。

本系列文章所讲解内容,依赖于https://github.com/icarusion/vue-vueRouter-webpack这套架构,开发者可以前往进行clone或下载(记得star哦)。在使用中有疑问或更好的优化方案,可在https://github.com/icarusion/vue-vueRouter-webpack/issues这里提交。

关于vue+vueRouter+webpack

本项目可以帮你快速搭建一个基于Vue的单页面富应用,目前已将开发环境和生产环境进行单独配置(webpack.dev.config.js和webpack.prod.config.js),当然也可根据需要自行添加灰度配置文件。目前的开发环境文件名使用默认命名(比如1.chunk.js),生产环境使用带hash值的命名(比如1.0891dcfed66cf89e6e98.chunk.js),可根据自己需要修改,但不建议修改本地环境为带hash的。 入口的html文件由webpack生成,模板在src/template/index.html内,可自行修改。默认已将dist目录、生成的两个index文件加入忽略列表,使用者可根据自己项目来修改。

本项目默认将组件(components)、路由(routers)、自定义过滤器(filters)、自定义指令(directives)等单独拆成目录。在数据获取方面用户可以根据自己需要使用vue-resource或者jQuery等,如果是大型项目,还可以使用vuex来维护状态和数据。当然,这并不意味着本项目是最佳实践,所有的目录结构和webpack配置都可以根据自己需要来修改。

先把项目跑起来

准备工作

使用前需要确保你安装了最新版的Node.jsnpm

全局安装webpack和webpack-dev-server

npm install webpack -g
npm install webpack-dev-server -g

安装成功后,再安装所有依赖

npm install

运行

开发环境:

首次运行需要执行init命令生成html入口文件,以后不用再执行

npm run init

然后执行dev,本地环境就可以跑起来了,默认端口是8080,如果有冲突请先kill

npm run dev

在浏览器访问http://127.0.0.1:8080,如果现实下图就说明已经成功了:


生产环境:

直接执行build方法即可编译打包:

npm run build

生产环境默认使用hash模式的路由,开发环境是History模式。直接打开index_prod.html即可访问生产环境。

Webpack配置详解

webpack.base.config.js为开发和生产环境通用的配置,webpack.dev.config.jswebpack.prod.config.js分别是开发和生产环境的单独配置。下面一一介绍每个配置的作用。

entry: {
    main: './src/main',
    vendors: ['vue', 'vue-router']
}

entry是入口的配置项,这里我们使用数组来定义了两个入口,main是我们的主入口,主要是引入vue-router路由和app.vue入口组件。其中app.vue提供了路由的挂载元素,以及通用的组件,比如header和footer什么的。其实vue的路由也是组件了,跟普通的组件并没有什么特殊。

output: {
    path: path.join(__dirname, './dist'),
    publicPath: '/dist/',
    filename: '[name].js',
    chunkFilename: '[name].[hash].js'
}

output是输出配置,在本项目中将其分发到了不同的环境里。path是文件输出到本地的路径,publicPath是文件的引用路径,比如开发环境可将其配置为cdn路径,filename是主入口的文件名,chunkFilename是每个路由编译后的文件名,其中[hash]是用来唯一标识文件,主要用来防止缓存。

module: {
    loaders: [
        { test: /\.vue$/, loader: 'vue' },
        { test: /\.js$/, loader: 'babel', exclude: /node_modules/ },
        { test: /\.css$/, loader: 'style!css!autoprefixer'},
        { test: /\.scss$/, loader: 'style!css!sass?sourceMap'},
        { test: /\.(gif|jpg|png|woff|svg|eot|ttf)\??.*$/, loader: 'url-loader?limit=8192'},
        { test: /\.(html|tpl)$/, loader: 'html-loader' }
    ]
}

loaders就是webpack最强大的地方了,不同的loaders通过正则来对不同模块文件进行处理,比如我们的vue-loader来处理.vue格式的模块。需要特殊说明的是url-loader,它会将小于8kb的图片、iconfont字体都转为base64,超过8kb的才会生成具体文件,当然这个参数我们也是可以配置的。另外需要说明的就是webpack编译完,最终我们需要的其实就是一个入口html和一个dist文件夹,所有的css、js、图片、iconfont字体以及入口js都会重命名后存在dist里,这也是为什么webpack特别擅长做SPA。

下面的配置就是单独对不同的loader的设置,比如vue的可以提取写在<style>里的css为单独的css文件,webpack默认是以js方式动态创建style标签或link标签的形式引入css的,这样做css也是可以按需加载了,但其实项目中我们还是喜欢把css独立出来,所以需要单独配置,下文也有具体说明。

babel很熟悉了吧,就是将ES6转ES5。

resolve.extensions是对模块后缀名的简写,配置后,原本是require('./components/app.vue') 可以简写为require('./components/app')。

resolve.alias是别名,配置后,比如原本是require('moment/min/moment-with-locales.min.js') 可以简写为require('moment')。

plugins是一些插件,webpack本身也自带了很多插件。在本项目中,我们在开发和生产环境中使用了不同的插件:

new ExtractTextPlugin("[name].css",{ allChunks : true,resolve : ['modules'] })  // 开发
new ExtractTextPlugin("[name].[hash].css",{ allChunks : true,resolve : ['modules'] })  // 生产

这两个插件就是用来提取css的,目前只能提取使用@import形式和.vue里面style内的css。

new webpack.optimize.CommonsChunkPlugin('vendors', 'vendors.js')  // 开发
new webpack.optimize.CommonsChunkPlugin('vendors', 'vendors.[hash].js')  // 生产

这两个插件是提取js公共组件的,比如vue,vue-router,jquery,echarts等,我们可以在入口的vendors里进行配置。

// 开发
new HtmlWebpackPlugin({
    filename: '../index.html',
    template: './src/template/index.html',
    inject: 'body'
})
// 生产
new HtmlWebpackPlugin({
    filename: '../index_prod.html',
    template: './src/template/index.html',
    inject: 'body'
})

这两个插件依赖html-webpack-plugin,是用来生产html的,其中filename是生产的文件路径和名称,template是使用的模板,inject是指将js放在body还是head里。生成的index.html是开发环境用的,index_prod.html是生产环境用的,生产环境里引用的css和js都是使用hash命名的,而且进行了压缩。

// 生产
new webpack.optimize.UglifyJsPlugin({
    compress: {
        warnings: false
    }
})

这个插件在生产时使用,是将代码进行压缩。

// 开发
fs.open('./src/config/env.js', 'w', function (err, fd) {
    var buf = 'module.exports = "development";';
    fs.write(fd,buf,0,buf.length,0,function(err,written,buffer){});
});

// 生产
fs.open('./src/config/env.js', 'w', function (err, fd) {
    var buf = 'module.exports = "production";';
    fs.write(fd,buf,0,buf.length,0,function(err,written,buffer){});
});

这两个跟webpack无关了,主要是在编译前用node生成一个env.js的文件用来标明当前是开发还是生产环境。这样我们在一些config.js可以通过它来配置ajax的API地址和参数等等。

webpack的配置就是这些,基本已经满足我们开发大型项目的需求了,当然这只是一些最基本的配置,如果你使用babel可以进一步对其进行配置,使用单元测试可以再配置Karma等等。

下一篇中,我讲重点介绍关于vue组件化的一些内容。

讨论区 (请尽量讨论和主题相关的话题)
##comment.user.name## (作者) ##comment.user.company + comment.user.job##
  • 删除
  • ##comment.comment.content##
    ##reply.reply.content##
  • 删除
  • 回复##comment.add_reply.user_name## (作者)
    发表回复

    添加标签,便于归类
    取消
    收藏
    写点推荐理由,选填
    取消
    推荐

    TalkingCoder

    寻找灵感 发现精彩

    登录 · 注册 · 忘记密码
    意见反馈