Webpack中使用webpack-spritesmith生成雪碧图的实践与进阶配置

作者：构建工坊时间：2026-10-23 04:57:20浏览：360

本文介绍在Webpack项目中利用webpack-spritesmith插件自动生成CSS雪碧图的方法。涵盖基础安装、配置文件编写、Glob模式匹配以及多目录独立生成雪碧图的进阶技巧，旨在通过合并图片减少HTTP请求，优化前端加载性能。

雪碧图概念与Webpack集成基础

一、什么是雪碧图？

CSS雪碧（CSS Sprite），也被称为CSS精灵，是一种将多个小图标和背景图像合并到单张图片中的CSS技术。通过CSS背景定位属性，可以精确显示图片中所需的特定部分。

二：为什么要用雪碧图

以公司内部项目为例，由于组件众多，每个组件下包含约50张图片，若每张图片单独请求，将产生超过300个HTTP请求。为优化性能并减少网络请求次数，决定采用雪碧图方案。

雪碧图的核心原理是将多张所需图片整合为一张大图，随后利用CSS的background-*属性进行识别与定位，从而还原原始图片显示效果。

三：如何使用雪碧图

以往生成雪碧图常借助Photoshop等工具，而在Webpack生态中，最佳实践是使用webpack-spritesmith插件。

以下列出具体使用方法及在Webpack配置中可能遇到的问题。

1.安装

执行命令行：npm install --save-dev webpack-spritesmith

2.在webpack.config.js中写入


 var path = require('path')

 var SpritesmithPlugin = require('webpack-spritesmith')

 //自定义样式
 var templateFunction = function (data) {
  var shared = '.ico { background-size: TWpx THpx }'
    .replace('TW', data.sprites[0].total_width / 2)
    .replace('TH', data.sprites[0].total_height / 2)

  var perSprite = data.sprites.map(function (sprite) {
    return '&.element-N {\n width: Wpx;\n height: Hpx;\n background-position: Xpx Ypx;\n}'
      .replace('N', sprite.name)
      .replace('W', sprite.width / 2)
      .replace('H', sprite.height / 2)
      .replace('X', sprite.offset_x / 2)
      .replace('Y', sprite.offset_y / 2)
      .replace('TW', sprite.total_width / 2)
      .replace('TH', sprite.total_height / 2)
  }).join('\n')

  return shared + '\n' + perSprite
 }

 module.exports = {
   ...
   module: {
     rules: [
       {test: /\.styl$/, use: [
         'style-loader',
         'css-loader',
         'stylus-loader'
       ]},
       {test: /\.png$/, use: [
         'file-loader?name=i/[hash].[ext]'
       ]}
     ]
   },
   resolve: {
     modules: ['node_modules', 'spritesmith-generated']
   },
   plugins: [
     new SpritesmithPlugin({
       src: { //引入路径
         cwd: path.resolve(__dirname, 'src/images/ios/'),
         glob: '*.png'
       },
       target: { //输出路径
         image: path.resolve(__dirname, 'src/spritesmith-generated/ios.png'),
         css: [
          [path.resolve(__dirname, 'src/spritesmith-generated/sprite-1.css'), {
            format: 'function_based_template'
          }],
          [path.resolve(__dirname, 'src/spritesmith-generated/sprite-2.css'), {
            format: 'handlebars_based_template'
          }]
         ]
       },
       customTemplates: {
        'function_based_template': templateFunction, //自定义输出什么样的css样式
       },
       apiOptions: {
         cssImageRef: 'ios.png'
       }
     })
   ]
 }

3.根据地址更改后执行命令

wbpack

上述配置已满足大部分常规需求。根据实际项目情况，修改输入图片路径和输出CSS路径即可。支持自定义CSS样式（如style-components、stylus等），生成后可直接复制到项目CSS文件中，具有较高的灵活性。

Webpack-spritesmith配置与Glob模式应用

四：需要注意的点

有时需要将不同文件夹下的图片合并为一张雪碧图，该如何配置？

例如我的需求是:

resources
- ios
  - images
- ant
  - images
- ios
  - images
...

结构说明：resources目录下包含多个子文件夹（如ios、ant、element等），各子文件夹下的images目录存放对应的图片资源。

需要注意的是，该插件支持Glob模式匹配。


src: { 
 //引入路径
 cwd: path.resolve(__dirname, 'src/images/ios/'),
 glob: '*.png' //这里进行更改
},

具体配置可参考Glob测试工具：http://www.globtester.com/

将Glob表达式修改为


@(wechat|element|ios)/images/*.png

效果

多目录独立生成雪碧图的进阶实现

五：更深层次的需求

若希望每个子文件夹下的图片分别生成独立的雪碧图和对应的CSS文件，该如何实现？作者已编写部分代码，虽未完全写完且遇到技术难点，但先展示现有代码，后续将继续优化实现。


var path = require('path')
var SpritesmithPlugin = require('webpack-spritesmith')

var platforms = ['android', 'ant', 'element', 'ios', 'wechat']//, 'windows']

// var url = 'ant'
const TARGET = process.env.TARGET

console.log({ TARGET })

module.exports = [TARGET].map(l => {
 console.log(l)
 const url = l

 const fn = (data) => {
  console.log(url)
  var shared = 'background-size: TWpx THpx\n'
    .replace('TW', data.sprites[0].total_width / 2)
    .replace('TH', data.sprites[0].total_height / 2)

  var perSprite = data.sprites.map(function (sprite) {
    return `&.${url}-N {\n width: Wpx;\n height: Hpx;\n background-position: Xpx Ypx;\n}\n`
      .replace('N', sprite.name)
      .replace('W', sprite.width / 2)
      .replace('H', sprite.height / 2)
      .replace('X', sprite.offset_x / 2)
      .replace('Y', sprite.offset_y / 2)
      .replace('TW', sprite.total_width / 2)
      .replace('TH', sprite.total_height / 2)
  }).join('\n')

  return shared + '\n' + perSprite
 }

 return {
  module: {
    rules: [
      {test: /\.styl$/, use: [
        'style-loader',
        'css-loader',
        'stylus-loader'
      ]},
      {test: /\.png$/, use: [
        'file-loader?name=i/[hash].[ext]'
      ]}
    ]
  },
  entry: {
   [url]: path.join(__dirname, url),
  },
  output: {
   path: path.join(__dirname, '../parsed/', url),
   filename: '[name].css'
  },
  resolve: {
    modules: ['node_modules', 'spritesmith-generated']
  },
  plugins: [
    new SpritesmithPlugin({
      src: {
        cwd: path.resolve(__dirname, 'images/'+url+'/'),
        glob: '*.png' // '@(android|ant|element|ios|wechat|windows)/*.png'
      },
      target: {
        image: path.resolve(__dirname, '../parsed/'+url+'/'+url+'.png'),
        css: [
          [path.resolve(__dirname, '../parsed/'+url+'/'+url+'.css'), {
            format: 'function_based_template'
          }]
        ]
      },
      customTemplates: {
        'function_based_template': fn
      }
    })
  ]
 }
})

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。

作者最新文章

JavaScript插件版本冲突怎么解决？npm安装报错排查

2026-11-03 23:58:39

怎么指定版本下载 pdf.js 旧版资源

2026-11-03 20:56:02

NW.js 应用打包指南：使用 nw-builder 生成多平台安装包

2026-11-03 20:07:02

JS控制台打印样式美化：使用%c自定义日志颜色

2026-11-02 10:29:52

Vue3 + Vite 项目创建与配置指南

2026-11-01 04:02:02