webpack打包時如何修改文件名的實現示例

Posted on by

在使用webpack進行項目打包的時候，我們可通過以下方式對不同類型的資源，進行文件名或文件路徑的修改

1、使用copy-webpack-plugin插件復制的文件，這個就是配置from和to

new CopyPlugin({
  patterns: [
    {
      from: "**/**.txt",
      to: "xx/xx.ext"
    },
  ],
})

2、修改js文件的文件名

在webpack中有一個output的配置項，可以在這裡配置js文件的文件路徑和文件名

修改入口文件的文件名通過配置output的filename屬性，可以動態的改變入口文件的文件路徑和文件名，通常的我們會這樣設置filename: "[name].[chunkhash].js"，而其中的name就是文件名修改的關鍵，這個name我們可以在entry入口中進行定義

entry：{
    index: path.resolve(__dirname, './src/index.js'),
    youindex: path.resolve(__dirname, './src/index.js')
}

在entry中也可以配置某一個庫/組件的文件進行打包

entry：{
    ol: path.resolve(__dirname, './static/ol/ol_me.js'),
}

filename除瞭可以設置類似占位符格式的字符串，還可以是一個函數，函數第一個參數中包含瞭打包文件的一系列信息，根據這些信息，可以去自定義打包文件的輸出名稱

output：{
    filename: (pathData) => {
        return pathData.chunk.name === 'main' ? utils.assetsPath('js/youfilename.js') : utils.assetsPath('js/[name].[chunkhash].js');
    }
}

filename占位符字符串對應的結果可以由以下參數拼接或者返回

修改非入口（按需引入）文件的文件名通過配置output的chunkFilename 屬性，可以動態的改變非入口文件的文件路徑和文件名，通常的我們會這樣設置chunkFilename: "[name].[chunkhash].js"，而其中的name就是文件名修改的關鍵。

chunkFilename 指未被列在 entry 中，卻又需要被打包出來的 chunk 文件的名稱，output.chunkFilename 默認使用[id].js或從 output.filename 中推斷出的值，id是輸出文件的塊id，一般是從1開始疊加的數字，除瞭[id]還可以配置占位符[name]，[name]是文件按需引入時配置的chunkName值，如果沒有配置chunkName，[name] 會被預先替換為 [id]。

配置好chunkFilename後，還需要在文件按需引入時配置chunkName值，早期的按需引入使用require.ensure()，這就不說瞭，現在按需引入基本都是使用import()，在import()中我們加入chunkFilename 的配置，就可以修改打包後的文件路徑和文件名，配置以/* webpackChunkName: “xxx” */的形式存在

const Login = () => import(/* webpackChunkName: "myLogin" */ '../components/login.vue')

在webpack 4的版本中chunkFilename必須是一個字符串，但是在webpack 5中，他也可以像filename一樣設置一個函數，去自定義文件路徑和文件名。

chunkFilename字符串占位符對應的結果和filename一樣，可以由以下參數拼接或者返回

3、修改css文件的文件名

webpack對css文件的打包需要用到插件，之前的webpack使用extract-text-webpack-plugin進行css文件打包，這裡不講瞭，現在的webpack使用mini-css-extract-plugin進行css文件打包。

在mini-css-extract-plugin的配置中，同樣有關於filename和chunkFilename的配置，具體用法和修改js文件名的配置一樣。

const MiniCssExtractPlugin = require('mini-css-extract-plugin')
new MiniCssExtractPlugin({
    // Options similar to the same options in webpackOptions.output
    // both options are optional
    // filename: utils.assetsPath('css/[name].[contenthash].css'),
    filename: (pathData) => {
      return pathData.chunk.name == 'main' ? utils.assetsPath('css/youfilename.[hash].css') : utils.assetsPath('css/[name].[hash].css')
    },
    chunkFilename: (pathData) => {
      return utils.assetsPath('css/[id].[hash].css')
    },
})

4、修改其他資源文件（圖片、視頻等）的文件名

webpack對圖片等資源文件的打包需要用到url-loader 或者 file-loader 去合理地處理它們，而url-loader內部也是封裝瞭file-loader去處理

webpack中對圖片等資源的打包配置在module.rules中，rules中可以通過options屬性值，把配置傳遞給url-loader或者file-loader。file-loader的配置項中有一個屬性name，我們可以通過配置這個name屬性來修改打包文件的文件路徑和文件名，name的配置同樣支持字符串占位符和函數兩種形式，通常我們像下面一樣配置字符串的形式

{
    test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
    loader: 'url-loader',
    options: {
      // 10000字節以下的圖片會被轉換為base64編碼
      limit: 10000,
      // 生成 name+7位hash+ext格式的文件名
      name: utils.assetsPath('img/[name].[hash:7].[ext]')
    }
  }

其中[name]、[hash]等占位符都和filename的占位符一樣
除瞭字符串形式，還可以像下面一樣配置更靈活的函數形式

{
  test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
  loader: 'url-loader',
  options: {
    // 10000字節以下的圖片會被轉換為base64編碼
    limit: 10000,
    // 生成 name+7位hash+ext格式的文件名
    name: function(filepath){
        let filename = filepath.split('\\').pop()
        return process.env.NODE_ENV !== 'development' && filename == 'xxx.png' ? utils.assetsPath('img/youfilename.[ext]') : utils.assetsPath('img/[name].[hash:7].[ext]')
    }
  }
},

 到此這篇關於webpack打包時如何修改文件名的實現示例的文章就介紹到這瞭,更多相關webpack打包時修改文件名內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：