Rollup基础知识
Vue.js通过rollup构建工具进行构建,它是一个类似于webpack的打包工具,区别于webpack它更适合一个Library库的打包。在学习Vue.js源码之前,我们有必要知道Vue.js是如何构建不同版本的。
核心概念
同webpack一样,rollup也有以下几大核心概念:
input:入口文件,类比于webpack的entry,它指明了我们库文件入口位置。output:输出位置,它指明了打包后的输出信息,包括:输出目录,打包文件名等。plugins:插件,rollup在构建过程中,插件可提供一些辅助功能,例如:alias别名解析、转义ES6等。external:当我们的库依赖于其它第三方库时,我们不需要把这些第三方库一起打包,而是应该把依赖写在external里面。
rollup同样适合使用配置文件的做法来配置打包的选项,例如:
// rollup.config.js
export default {
input: 'src/main.js',
output: [
{ file: 'dist/vue.js', format: 'umd', name: 'Vue' },
{ file: 'dist/vue.common.js', format: 'cjs', name: 'Vue' },
{ file: 'dist/vue.esm.js', format: 'es', name: 'Vue' }
],
...
}
构建版本说明:
umd:此选项构建出来的库文件是一个通用模式,可以通过不同的方式去使用:script标签引入,ES Module规范引入和CommonJs规范引入等。cjs: 此选项构建出来的库文件主要为CommonJs规范,可在Node环境中使用。es:此版本构建出来的库文件主要为ES Module规范,可在支持ES Module也就是import/export的环境中使用。
有了以上配置文件,我们可以在package.json中进行如下修改:
{
"name": "Vue",
"version": "1.0.0",
"scripts": {
"dev": "rollup -w -c scripts/rollup.config.dev.js",
"build": "rollup -c scripts/rollup.config.prod.js"
}
}
参数说明:
-c:为--config的缩写,表示设置rollup打包的配置。-w:为--watch的缩写,在本地开发环境添加-w参数可以监控源文件的变化,自动重新打包。
常用插件
rollup并不像webpack那样强大,它需要和其它插件配合使用才能完成特定的功能,常用的插件有:
@rollup/plugin-json: 支持从.json读取信息,配合rollup的Tree Shaking可只打包.json文件中我们用到的部分。@rollup/plugin-commonjs:将CommonJs规范的模块转换为ESM规范,提供rollup使用。@rollup/plugin-node-resolve:与@rollup/plugin-commonjs插件一起使用,配合以后就可以使用node_modules下的第三方模块代码了。@rollup/plugin-babel:把ES6代码转义成ES5代码,需要同时安装@babel/core和@babel/preset-env插件。注意:如果使用了高于ES6标准的语法,例如async/await,则需要进行额外的配置。rollup-plugin-terser:代码压缩插件,另外一种方案是rollup-plugin-uglify+uglify-es进行代码压缩,不过更推荐第一种方案。
以上插件使用方式如下:
// rollup.config.js
import commonjs from '@rollup/plugin-commonjs'
import json from '@rollup/plugin-json'
import resolve from '@rollup/plugin-node-resolve'
import babel from '@rollup/plugin-babel'
import { terser } from 'rollup-plugin-terser'
const config = {
input: 'src/index.js',
output: [
{ file: 'dist/vue.js', format: 'umd', name: 'Vue' },
{ file: 'dist/vue.common.js', format: 'cjs', name: 'Vue', exports: 'auto' },
{ file: 'dist/vue.esm.js', format: 'es', name: 'Vue', exports: 'auto' }
],
plugins: [
json(),
resolve(),
babel(),
commonjs(),
terser()
]
}
export default config
区分生产环境和开发环境
正如你在上面看到的那样,我们可以像webpack一样进行开发环境和生产环境的配置区分,我们把和rollup构建相关的文件都放在scripts目录下:
|-- scripts
| |-- rollup.config.base.js # 公共配置
| |-- rollup.config.dev.js # 开发环境配置
| |-- rollup.config.prod.js # 生产环境配置
根据我们的拆分逻辑,rollup.config.base.js代码如下:
import commonjs from '@rollup/plugin-commonjs'
import json from '@rollup/plugin-json'
import resolve from '@rollup/plugin-node-resolve'
import babel from '@rollup/plugin-babel'
const config = {
input: 'src/index.js',
plugins: [
json(),
resolve(),
babel(),
commonjs()
]
}
export default config
rollup.config.dev.js代码如下:
import baseConfig from './rollup.config.base.js'
import serve from 'rollup-plugin-serve'
import { name } from '../package.json'
const config = {
...baseConfig,
output: [
{ file: 'dist/vue.js', format: 'umd', name },
{ file: 'dist/vue.common.js', format: 'cjs', name, exports: 'auto' },
{ file: 'dist/vue.esm.js', format: 'es', name, exports: 'default' }
],
plugins: [
...baseConfig.plugins,
serve({
open: true,
port: '4300',
openPage: '/example/index.html',
contentBase: ''
})
]
}
export default config
配置说明:本地开发环境下,我们可以有选择的添加rollup-plugin-serve插件,它类似于webpack-dev-server,能在开发环境下起一个服务方便我们进行开发和代码调试。
rollup.config.prod.js代码如下:
import baseConfig from './rollup.config.base.js'
import { terser } from 'rollup-plugin-terser'
import { name } from '../package.json'
const config = {
...baseConfig,
output: [
{ file: 'dist/vue.min.js', format: 'umd', name },
{ file: 'dist/vue.common.min.js', format: 'cjs', name, exports: 'auto' },
{ file: 'dist/vue.esm.min.js', format: 'es', name, exports: 'default' }
],
plugins: [
...baseConfig.plugins,
terser()
]
}
export default config
配置说明:生产环境下,我们需要对代码进行压缩处理,对ES Module,CommonJs和UMD等规范分别生成其对应的压缩文件。
分别运行npm run dev和npm run build之后,我们可以得到如下的目录:
|-- dist
| |-- vue.js # UMD未压缩版本
| |-- vue.min.js # UMD压缩版本
| |-- vue.esm.js # ES Module未压缩版本
| |-- vue.esm.min.js # ES Module压缩版本
| |-- vue.common.js # CommonJs未压缩版本
| |-- vue.common.min.js # CommonJs压缩版本
最后,如果我们像Vue.js一样构建的是一个库文件,那么我们还需要在package.json进行如下配置:
{
"main": "dist/vue.common.js",
"module": "dist/vue.esm.js"
}