vue中 默認的 config/index.js:配置的詳細理解 -【以及webpack配置的理解】-config配置的目的都是為了服務(wù)webpack的配置鸡岗,給不同的編譯條件提供配置
當(dāng)我們需要和后臺分離部署的時候舟奠,必須配置config/index.js:
用vue-cli 自動構(gòu)建的目錄里面 (環(huán)境變量及其基本變量的配置)
var path = require('path')
module.exports = {
build: {
index: path.resolve(__dirname, 'dist/index.html'),
assetsRoot: path.resolve(__dirname, 'dist'),
assetsSubDirectory: 'static',
assetsPublicPath: '/',
productionSourceMap: true
},
dev: {
port: 8080,
proxyTable: {}
}
}
在'build'部分,我們有以下選項:
build.index
必須是本地文件系統(tǒng)上的絕對路徑满败。
index.html (帶著插入的資源路徑) 會被生成藏雏。
如果你在后臺框架中使用此模板鹤啡,你可以編輯index.html路徑指定到你的后臺程序生成的文件。例如Rails程序清蚀,可以是app/views/layouts/application.html.erb匕荸,或者Laravel程序,可以是resources/views/index.blade.php枷邪。
build.assetsRoot
必須是本地文件系統(tǒng)上的絕對路徑榛搔。
應(yīng)該指向包含應(yīng)用程序的所有靜態(tài)資產(chǎn)的根目錄。public/ 對應(yīng)Rails/Laravel东揣。
build.assetsSubDirectory
被webpack編譯處理過的資源文件都會在這個build.assetsRoot目錄下践惑,所以它不可以混有其它可能在build.assetsRoot里面有的文件。例如嘶卧,假如build.assetsRoot參數(shù)是/path/to/dist尔觉,build.assetsSubDirectory 參數(shù)是 static, 那么所以webpack資源會被編譯到path/to/dist/static目錄。
每次編譯前芥吟,這個目錄會被清空侦铜,所以這個只能放編譯出來的資源文件专甩。
static/目錄的文件會直接被在構(gòu)建過程中,直接拷貝到這個目錄钉稍。這意味著是如果你改變這個規(guī)則涤躲,所有你依賴于static/中文件的絕對地址,都需要改變贡未。
build.assetsPublicPath【資源的根目錄】
這個是通過http服務(wù)器運行的url路徑种樱。在大多數(shù)情況下,這個是根目錄(/)俊卤。如果你的后臺框架對靜態(tài)資源url前綴要求缸托,你僅需要改變這個參數(shù)。在內(nèi)部瘾蛋,這個是被webpack當(dāng)做output.publicPath來處理的俐镐。
后臺有要求的話一般要加上./ 或者根據(jù)具體目錄添加,不然引用不到靜態(tài)資源
build.productionSourceMap
在構(gòu)建生產(chǎn)環(huán)境版本時是否開啟source map哺哼。
dev.port
開發(fā)服務(wù)器監(jiān)聽的特定端口
dev.proxyTable
定義開發(fā)服務(wù)器的代理規(guī)則佩抹。
項目中配置的config/index.js,有dev和production兩種環(huán)境的配置 以下介紹的是production環(huán)境下的webpack配置的理解
var path = require('path')
module.exports = {
build: { // production 環(huán)境
env: require('./prod.env'), // 使用 config/prod.env.js 中定義的編譯環(huán)境
index: path.resolve(__dirname, '../dist/index.html'), // 編譯輸入的 index.html 文件
assetsRoot: path.resolve(__dirname, '../dist'), // 編譯輸出的靜態(tài)資源路徑
assetsSubDirectory: 'static', // 編譯輸出的二級目錄
assetsPublicPath: '/', // 編譯發(fā)布的根目錄取董,可配置為資源服務(wù)器域名或 CDN 域名
productionSourceMap: true, // 是否開啟 cssSourceMap
// Gzip off by default as many popular static hosts such as
// Surge or Netlify already gzip all static assets for you.
// Before setting to `true`, make sure to:
// npm install --save-dev compression-webpack-plugin
productionGzip: false, // 是否開啟 gzip
productionGzipExtensions: ['js', 'css'] // 需要使用 gzip 壓縮的文件擴展名
},
dev: { // dev 環(huán)境
env: require('./dev.env'), // 使用 config/dev.env.js 中定義的編譯環(huán)境
port: 8080, // 運行測試頁面的端口
assetsSubDirectory: 'static', // 編譯輸出的二級目錄
assetsPublicPath: '/', // 編譯發(fā)布的根目錄棍苹,可配置為資源服務(wù)器域名或 CDN 域名
proxyTable: {}, // 需要 proxyTable 代理的接口(可跨域)
// CSS Sourcemaps off by default because relative paths are "buggy"
// with this option, according to the CSS-Loader README
// (https://github.com/webpack/css-loader#sourcemaps)
// In our experience, they generally work as expected,
// just be aware of this issue when enabling this option.
cssSourceMap: false // 是否開啟 cssSourceMap
}
}
下面是vue中的build/webpack.base.conf.js
//引入依賴模塊
var path = require('path')
var config = require('../config') // 獲取配置
var utils = require('./utils')
var projectRoot = path.resolve(__dirname, '../')
var env = process.env.NODE_ENV
// check env & config/index.js to decide weither to enable CSS Sourcemaps for the
// various preprocessor loaders added to vue-loader at the end of this file
var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap)/* 是否在 dev 環(huán)境下開啟 cssSourceMap ,在 config/index.js 中可配置 */
var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap)/* 是否在 production 環(huán)境下開啟 cssSourceMap 茵汰,在 config/index.js 中可配置 */
var useCssSourceMap = cssSourceMapDev || cssSourceMapProd /* 最終是否使用 cssSourceMap */
module.exports = {
entry: { // 配置webpack編譯入口
app: './src/main.js'
},
output: { // 配置webpack輸出路徑和命名規(guī)則
path: config.build.assetsRoot, // webpack輸出的目標文件夾路徑(例如:/dist)
publicPath: process.env.NODE_ENV === 'production' ? config.build.assetsPublicPath : config.dev.assetsPublicPath, // webpack編譯輸出的發(fā)布路徑(判斷是正式環(huán)境或者開發(fā)環(huán)境等)
filename: '[name].js' // webpack輸出bundle文件命名格式枢里,基于文件的md5生成Hash名稱的script來防止緩存
},
resolve: {
extensions: ['', '.js', '.vue', '.scss'], //自動解析確定的拓展名,使導(dǎo)入模塊時不帶拓展名
fallback: [path.join(__dirname, '../node_modules')],
alias: { // 創(chuàng)建import或require的別名,一些常用的蹂午,路徑長的都可以用別名
'vue$': 'vue/dist/vue',
'src': path.resolve(__dirname, '../src'),
'assets': path.resolve(__dirname, '../src/assets'),
'components': path.resolve(__dirname, '../src/components'),
'scss_vars': path.resolve(__dirname, '../src/styles/vars.scss')
}
},
resolveLoader: {
fallback: [path.join(__dirname, '../node_modules')]
},
module: {
loaders: [
{
test: /\.vue$/, // vue文件后綴
loader: 'vue' //使用vue-loader處理
},
{
test: /\.js$/,
loader: 'babel',
include: projectRoot,
exclude: /node_modules/
},
{
test: /\.json$/,
loader: 'json'
},
{
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
loader: 'url',
query: {
limit: 10000,
name: utils.assetsPath('img/[name].[hash:7].[ext]')
}
},
{
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
loader: 'url',
query: {
limit: 10000,
name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
}
}
]
},
vue: { // .vue 文件配置 loader 及工具 (autoprefixer)
loaders: utils.cssLoaders({ sourceMap: useCssSourceMap }), //// 調(diào)用cssLoaders方法返回各類型的樣式對象(css: loader)
postcss: [
require('autoprefixer')({
browsers: ['last 2 versions']
})
]
}
}
webpack.prod.conf.js 生產(chǎn)環(huán)境下的配置文件
var path = require('path')
var config = require('../config')
var utils = require('./utils')
var webpack = require('webpack')
var merge = require('webpack-merge')// 一個可以合并數(shù)組和對象的插件
var baseWebpackConfig = require('./webpack.base.conf')
// 用于從webpack生成的bundle中提取文本到特定文件中的插件
// 可以抽取出css栏豺,js文件將其與webpack輸出的bundle分離
var ExtractTextPlugin = require('extract-text-webpack-plugin') //如果我們想用webpack打包成一個文件,css js分離開豆胸,需要這個插件
var HtmlWebpackPlugin = require('html-webpack-plugin')// 一個用于生成HTML文件并自動注入依賴文件(link/script)的webpack插件
var env = config.build.env
// 合并基礎(chǔ)的webpack配置
var webpackConfig = merge(baseWebpackConfig, {
// 配置樣式文件的處理規(guī)則奥洼,使用styleLoaders
module: {
loaders: utils.styleLoaders({ sourceMap: config.build.productionSourceMap, extract: true })
},
devtool: config.build.productionSourceMap ? '#source-map' : false, // 開啟source-map,生產(chǎn)環(huán)境下推薦使用cheap-source-map或source-map晚胡,后者得到的.map文件體積比較大灵奖,但是能夠完全還原以前的js代碼
output: {
path: config.build.assetsRoot,// 編譯輸出目錄
filename: utils.assetsPath('js/[name].[chunkhash].js'), // 編譯輸出文件名格式
chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') // 沒有指定輸出名的文件輸出的文件名格式
},
vue: { // vue里的css也要單獨提取出來
loaders: utils.cssLoaders({ // css加載器,調(diào)用了utils文件中的cssLoaders方法,用來返回針對各類型的樣式文件的處理方式,
sourceMap: config.build.productionSourceMap,
extract: true
})
},
// 重新配置插件項
plugins: [
// http://vuejs.github.io/vue-loader/en/workflow/production.html
// 位于開發(fā)環(huán)境下
new webpack.DefinePlugin({
'process.env': env
}),
new webpack.optimize.UglifyJsPlugin({// 丑化壓縮代碼
compress: {
warnings: false
}
}),
new webpack.optimize.OccurenceOrderPlugin(),
// extract css into its own file
new ExtractTextPlugin(utils.assetsPath('css/[name].[contenthash].css')), // 抽離css文件
// generate dist index.html with correct asset hash for caching.
// you can customize output by editing /index.html
// see https://github.com/ampedandwired/html-webpack-plugin
// filename 生成網(wǎng)頁的HTML名字估盘,可以使用/來控制文件文件的目錄結(jié)構(gòu)瓷患,最
// 終生成的路徑是基于webpac配置的output.path的
new HtmlWebpackPlugin({
// 生成html文件的名字,路徑和生產(chǎn)環(huán)境下的不同遣妥,要與修改后的publickPath相結(jié)合擅编,否則開啟服務(wù)器后頁面空白
filename: config.build.index,
// 源文件,路徑相對于本文件所在的位置
template: 'index.html',
inject: true,// 要把<script>標簽插入到頁面哪個標簽里(body|true|head|false)
minify: {
removeComments: true,
collapseWhitespace: true,
removeAttributeQuotes: true
// more options:
// https://github.com/kangax/html-minifier#options-quick-reference
},
// necessary to consistently work with multiple chunks via CommonsChunkPlugin
chunksSortMode: 'dependency'
}),
// 如果文件是多入口的文件燥透,可能存在沙咏,重復(fù)代碼辨图,把公共代碼提取出來,又不會重復(fù)下載公共代碼了
// (多個頁面間會共享此文件的緩存)
// CommonsChunkPlugin的初始化常用參數(shù)有解析肢藐?
// name: 這個給公共代碼的chunk唯一的標識
// filename故河,如何命名打包后生產(chǎn)的js文件,也是可以用上[name]吆豹、[hash]鱼的、[chunkhash]
// minChunks,公共代碼的判斷標準:某個js模塊被多少個chunk加載了才算是公共代碼
// split vendor js into its own file
new webpack.optimize.CommonsChunkPlugin({
name: 'vendor',
minChunks: function (module, count) {
// any required modules inside node_modules are extracted to vendor
return (
module.resource &&
/\.js$/.test(module.resource) &&
module.resource.indexOf(
path.join(__dirname, '../node_modules')
) === 0
)
}
}),
// extract webpack runtime and module manifest to its own file in order to
// prevent vendor hash from being updated whenever app bundle is updated
new webpack.optimize.CommonsChunkPlugin({ // 為組件分配ID痘煤,通過這個插件webpack可以分析和優(yōu)先考慮使用最多的模塊凑阶,并為它們分配最小的ID
name: 'manifest',
chunks: ['vendor']
})
]
})
// gzip模式下需要引入compression插件進行壓縮
if (config.build.productionGzip) {
var CompressionWebpackPlugin = require('compression-webpack-plugin')
webpackConfig.plugins.push(
new CompressionWebpackPlugin({
asset: '[path].gz[query]',
algorithm: 'gzip',
test: new RegExp(
'\\.(' +
config.build.productionGzipExtensions.join('|') +
')$'
),
threshold: 10240,
minRatio: 0.8
})
)
}
module.exports = webpackConfig
vue 中build/build.js頁面
// https://github.com/shelljs/shelljs
require('./check-versions')() // 檢查 Node 和 npm 版本
require('shelljs/global') // 使用了 shelljs 插件,可以讓我們在 node 環(huán)境的 js 中使用 shell
env.NODE_ENV = 'production'
var path = require('path')
var config = require('../config') // 加載 config.js
var ora = require('ora') // 一個很好看的 loading 插件
var webpack = require('webpack') // 加載 webpack
var webpackConfig = require('./webpack.prod.conf') // 加載 webpack.prod.conf
console.log( // 輸出提示信息 ~ 提示用戶請在 http 服務(wù)下查看本頁面衷快,否則為空白頁
' Tip:\n' +
' Built files are meant to be served over an HTTP server.\n' +
' Opening index.html over file:// won\'t work.\n'
)
var spinner = ora('building for production...') // 使用 ora 打印出 loading + log
spinner.start() // 開始 loading 動畫
/* 拼接編譯輸出文件路徑 */
var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory)
rm('-rf', assetsPath) /* 刪除這個文件夾 (遞歸刪除) */
mkdir('-p', assetsPath) /* 創(chuàng)建此文件夾 */
cp('-R', 'static/*', assetsPath) /* 復(fù)制 static 文件夾到我們的編譯輸出目錄 */
webpack(webpackConfig, function (err, stats) { // 開始 webpack 的編譯
// 編譯成功的回調(diào)函數(shù)
spinner.stop()
if (err) throw err
process.stdout.write(stats.toString({
colors: true,
modules: false,
children: false,
chunks: false,
chunkModules: false
}) + '\n')
})
項目入口宙橱,由package.json 文件可以看出
"scripts": {
"dev": "node build/dev-server.js",
"build": "node build/build.js",
"watch": "node build/build-watch.js"
},
當(dāng)我們執(zhí)行 npm run dev / npm run build / npm run watch時運行的是 node build/dev-server.js 或 node build/build.js 或node build/build-watch.js
node build/build-watch.js 是我配置的載production環(huán)境的配置基礎(chǔ)上在webpack的配置模塊加上 watch:true 便可實現(xiàn)代碼的實時編譯