【Web技术】1033- 如何优雅的在微信小程序使用 SVG 字体图标

Bertha 。 2022-09-02 04:05 222阅读 0赞

![e8681ddcae76ecbffc901b95db734edc.png][]

> 本文思路来自实际项目的重构总结，欢迎纠正和交流。如果对你有帮助，还请点赞????收藏支持一下啦。

最近在重构一个项目，主要是做 H5 端和小程序端，这次打算开始多做总结啦，之前已经总结一篇[《如何优雅的管理 HTTP 请求和响应拦截器？》][HTTP] 。

如果大家还有其他方案，欢迎一起探讨哈~ 喜欢本文的朋友给个赞????鼓励一下哈~

## 一、需求思考和方案设计 ##

本文介绍的项目是使用 Taro框架进行多端开发，目前主要适配 H5 端和微信小程序端。项目使用的字体图标库内部维护，目前托管在 iconfont 上。

### 1. 问题分析 ###

最近在重构的项目比较古老（其实也就去年的），项目中使用到的图标早已更新 N 个迭代了，已经由**「单色图标」**更新到**「多色图标」**！![a7e7238fbe1a26bfda96d0fb17f84a11.png][]很明显好看多了。

这里先按照 iconfont 的规则看看单色图标和多色图标使用上的区别：

#### 单色图标的使用 ####

单色图标使用起来比较简单（以 font-class 引用为例），只需要 2 个步骤：

*  第一步：拷贝项目下面生成的fontclass代码：

//at.alicdn.com/t/font_8d5l8fzk5b87iudi.css

*  第二步：挑选相应图标并获取类名，应用于页面：

<i class="iconfont icon-xxx"></i>

#### 多色图标的使用 ####

多色图标使用起来也很简单（以 symbol 引用为例），只需要 3 个步骤：

*  第一步：拷贝项目下面生成的symbol代码：

//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js

*  第二步：加入通用css代码（引入一次就行）：

*  第三步：挑选相应图标并获取类名，应用于页面：

这两种图标在使用上都非常方便，那大家是不是会好奇，我们写本文的目的？

原因是，**「微信小程序上不支持 SVG 字体图标！???? 而多色图标，是需要借助 SVG 标签来实现。」**

于是我在小程序文档找了好久，也只看到了 `<Image>` 组件能够使用 SVG，介绍如下：

> image图片。支持 JPG、PNG、SVG、WEBP、GIF 等格式，2.3.0 起支持云文件ID。

其属性 `src` 的值为图片资源地址，这就意味着，不能使用 SVG 字体图标了。因此我们需要想想变通的办法。

（这里不讨论将 iconfont 上图标下载为图片来引用的情况）

### 2. 方案设计 ###

既然我们了解了单色图标和多色图标的使用方式：

*  单色图标：任意标签（如 `div` 标签） + 对应字体图标 class 名称
 *  多色图标：使用 `svg` 标签 + `use` 标签设置 `xlink:href` 属性

首先马上想到的是，能不能集合两者使用方式，实现任意标签通过 class 名称来使用多色图标？

答案是可以的，只需要对图标文件进行格式转换，即 **「将多色字体图标转换为能通过class名称来引用的字体图标文件」** 。

那接下来只要看看如何实现格式转换即可。

## 二、重构后的效果 ##

这边我以其中一个页面进行重构，最后将单色图标全都换成新的多色 SVG 字体图标，效果如下：

![e9e59cd011b3216a8b243da8adbafe9e.png][]

## 三、方案一：手动转换图标文件 ##

目前我尝试了两套方案，并且都顺利实现效果，这边先分享一下这两种方案，然后再补充说明我选择哪个方案和原因：

该方案实现的是手动将字体图标库文件转换成能通过 class 名称来引用的图标库。使用到的工具有：

1.  icomoon：https://icomoon.io/ 用来打包图标。
2.  transfonter：https://transfonter.org/ 用来生成 base64 格式的图标。

接下来开始试试：

### 步骤一：通过 iconfont 下载需要的 SVG 格式的图标 ###

![68ba4f5c6efdba8791762e05dd906605.png][]

这边多下载了几个，都是 svg 格式的文件，如下图：

![88216999946f2ce3548a3f283a23e863.png][]

### 步骤二：打包字体图标 ###

这一步是将零散个多个 SVG 多色图标打包成一个字体图标文件，这一步需要使用 https://icomoon.io/：

![873464888defdda6a18d0635f901fccd.png][] ![1b6bf124df689ba48d7ac8a21739ceb5.png][] ![fcd63123f943e9df0962edfdae46a5a8.png][] ![cdd99a86d90e3334596daa1dc01ce4b1.png][]

### 步骤三：字体图标进行 Base64 编码 ###

接下来就需要将打好的字体图标进行 base64 压缩，这边使用https://transfonter.org/来操作。

第一步选择前面打好的包里面的 `.ttf` 文件：

![66671ee05b4e9a652976765504c72d61.png][]

设置参数，并导出文件：

![8e25a07a4802a2d9d5e8b1ed7c867176.png][]

### 步骤四：合并字体图标 ###

经过前面几个步骤，我们现在已经有 2 个包：

*  第一个包：icomoon 生成的包

![46f64ef8869fcc24708812bf929ae3b4.png][]

*  第二个包：transfonter 生成的包

![504d07330ba3e1252b586d25df8fe899.png][]

接下来我们开始将两个包合并：将第一个包 style.css 文件除 `@font-face` 的内容复制到第二个包 stylesheet.css 文件后面。

![748da69a72f3ce55957bed2a81f48fcd.png][]

这样就获得一份新的字体图标文件，其实也可以拷贝到一份新的 css 文件中。

### 使用字体图标 ###

我们将前面修改后的文件改名为 `icon.scss` 并引入到项目：

// app.scss
    
    @import "./style/icon.scss";

代码中使用图标：

<View className="icon-exe-knowledge-ppt">
      <View className='path1'></View>
      <View className='path2'></View>
      <View className='path3'></View>
      <View className='path4'></View>
      <View className='path5'></View>
      <View className='path6'></View>
    </View>

最后效果如下：

![916ea6dd95b66a50730d9c7ce8a6e9be.png][]

### 踩坑记录 ###

在使用方案一的时候，踩了好几个坑，这边挑两个来说：

*  使用时，需要手动添加几个 `<View classname="path*"></View>` 元素

刚开始使用，图标一直没有出来，后面观察字体图标，它是在容器元素下很多个 `path1` 、 `path2` 等元素的伪类中去渲染图标内容：

![d09a086ff602ba7da6391dd5abbfe91e.png][]

所以使用时需要手动添加一下。

*  默认图标会是一个大的块级元素，导致图标显示有问题

这是因为手动加的 class 为 `path*` 的 `View` 标签本身是块级元素，所以这里只要简单加个 `display: flex` 即可。

![9304834b4d4c23b3747e0bdd515ebedd.png][]

并且其字体大小，也是可以使用 `font-size` 来设置：

display: flex;
    font-size: 100px;

### 抽取组件 ###

考虑到复用性，我将这些抽成一个 `exe-svg-icon` 组件：

import Taro from '@tarojs/taro';
    import { View, Text } from '@tarojs/components';
    import classNames from 'classnames';
    
    function EXESvgIcon(params) {
      const { icon = 'exe-none' } = params;
      const containerStyle = {
        display: 'inline-block'
      }
      return (
        <View className={classNames('svg', icon)} style={containerStyle}>
          <View className='path1' style={containerStyle}></View>
          <View className='path2' style={containerStyle}></View>
          <View className='path3' style={containerStyle}></View>
          {/* 一般图标 3 层，这边多预留几层，防止不够用 */}
          <View className='path4' style={containerStyle}></View>
          <View className='path5' style={containerStyle}></View>
          <View className='path6' style={containerStyle}></View>
          <View className='path7' style={containerStyle}></View>
          <View className='path8' style={containerStyle}></View>
          <View className='path9' style={containerStyle}></View>
        </View>
      )
    }
    export default EXESvgIcon;

到这边，方案一实现完成。

## 四、方案二：借助第三方库实现 ##

由于第一个方案使用起来比较繁琐，于是我又再研究其他简单点的方案。

直到我看到 taro-iconfont-cli 这个库。

> 在Taro框架中使用iconfont图标，不依赖字体，支持多色彩。

目前支持平台包括：

*  微信小程序
 *  支付宝小程序
 *  百度小程序
 *  头条小程序
 *  QQ小程序
 *  H5

有以下特性：

*  一键生成标准组件，多端支持
 *  使用方便，import即可
 *  支持多色彩
 *  支持自定义颜色
 *  支持 ES6 和 TypeScript 两种模式

按照文档描述，只需要 3 个步骤，那么试试看：

### 步骤一：安装 taro-iconfont-cli ###

# Yarn
    yarn add taro-iconfont-cli --dev
    
    # Npm
    npm install taro-iconfont-cli --save-dev

需要注意的是，如果使用的是 Taro 2.x，请安装 **「`taro-iconfont-cli@2.1.0`」**，并阅读旧版的README.md。

### 步骤二：生成配置文件 ###

通过命令生成 iconfont.json 配置文件：

npx iconfont-init
    
    # 可传入配置输出路径
    # npx iconfont-init --output iconfont.json

此时项目根目录会生成一个`iconfont.json`的文件，内容如下：

{
      "symbol_url": "请参考README.md，复制 http://iconfont.cn 官网提供的JS链接",
      "save_dir": "./src/components/iconfont",
      "use_typescript": false,
      "platforms": "*",
      "use_rpx": true,
      "trim_icon_prefix": "icon",
      "default_icon_size": 18,
      "design_width": 750
    }

`symbol_url` 值需要在 iconfont 中复制

![9f792fb354fc0f7f220aa2b9c9c56fd8.png][]

### 步骤三：生成 Taro 标准组件 ###

通过命令，生成 Taro 标准组件：

npx iconfont-taro
    
    # 可传入配置文件路径
    # npx iconfont-taro --config iconfont.json

通过控制台，我们可以看到 taro-iconfont-cli 为每个图标单独生成一个 Taro 组件：

![6b61d1b1e0131008b26f054f7a2cd2cc.png][] ![82456f0dbd53efe7dc8594e291249577.png][]

### 使用字体图标 ###

按照文档使用方法，使用的时候，只需要引入 `IconFont` 组件，通过 `name` 名称来选择对应图标即可：

// 省略其他代码
    
    import IconFont from '@components/Iconfont/index';
    
    <IconFont name="exe-knowledge-ppt"></IconFont>

按照文档提示，还有更多使用方法：

// 原色彩
    <IconFont name="alipay" />
    
    // 单色：红色
    <IconFont name="alipay" color="red" />
    
    // 多色：红色+橘色
    <IconFont name="alipay" color={['red', 'orange']} size={300} />
    
    // 不同格式的颜色写法
    <IconFont name="alipay" color={['#333', 'rgb(50, 124, 39)']} />
    
    // 与文字对齐
    <View style={
        { display: 'flex', alignItems: 'center' }}>
      <Text>Hello</text>
      <IconFont name="alipay" />
    </View>

### 踩坑记录 ###

1.  字体大小设置问题

由于通过这种方式导出的图标，是个单独组件，使用时如果需要设置图标大小，需要通过设置其 `width`和`height`属性进行设置。

![6a095e030b35f99b539d15c804f291e0.png][]

通过 `font-size`属性无法设置字体图标的大小。

## 五、方案对比和选择 ##

这次只尝试了这两种方案，都能顺利完成需求。如果大家有其他方案，欢迎一起评论区讨论~

接下来**「以生成下面相同 20 个多色图标为标准，分析这两种方案：」**

![c33e6a97cefeb4b6d1fc644fd0d2343a.png][]

先看看对比结果：

<table> 
 <thead> 
  <tr> 
   <th><br></th> 
   <th><strong>手动转换图标文件</strong></th> 
   <th><strong>借助 taro-iconfont-cli 库实现</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>生成难易程度</strong></td> 
   <td>复杂</td> 
   <td>简单</td> 
  </tr> 
  <tr> 
   <td><strong>使用难易程度</strong></td> 
   <td>简单</td> 
   <td>简单</td> 
  </tr> 
  <tr> 
   <td><strong>资源占用程度</strong></td> 
   <td>27kb</td> 
   <td>420kb（项目未打包前）</td> 
  </tr> 
 </tbody> 
</table>

分析每个项目：

### 1. 对比生成难易程度 ###

*  「手动转换图标文件」需要每次将图标单独下载，再进行打包，当图标数量较多，其工作量就较大。
 *  「taro-iconfont-cli」只需设置字体图标库地址，自动下载并生成组件，较为方便。

### 2. 对比使用难易程度 ###

两者使用起来都比较简单：

*  「手动转换图标文件」为元素添加 class 名称即可。
 *  「taro-iconfont-cli」为元素添加 name 属性。

### 3. 对比资源占用情况 ###

资源占用差异就很大了，分析下原因：

*  「手动转换图标文件」是将图标重新打包，最后生成的都是 base64 编码的内容，相对较小。
 *  「taro-iconfont-cli」是为每个图标生成一个组件，单独一个文件，还有附加各个平台的文件，因此较大。

### 4. 选择方案 ###

考虑到目前项目所使用的字体图标比较少（20 个以内），后续开发人员上手难度问题，我最终使用「taro-iconfont-cli」这套方案。虽然这个方案生成的组件资源占用会稍大，但是目前使用图标较少，并且可以通过打包工具、CDN 等常用优化方式进行优化。

## 六、本文总结 ##

本文通过一次简单的项目重构，总结项目中小程序使用 SVG 多色图标的方案，目的是为了实现在小程序中能够正常使用 SVG 多色图标，并且也为内容越来越多独立站点的项目积累经验，毕竟各个项目具有相关性。

最后，「taro-iconfont-cli」方案目前已经在内部 npm 仓库维护，采用版本控制，方便不同项目使用时减少冲突。

当然，本文是基于我的经验总结，欢迎大家有更好的方案，一起讨论学习~~

## 参考文章 ##

*  微信小程序中使用svg字体图标教程 ——图解三步，很清晰 （https://blog.csdn.net/Originally\_M/article/details/106473475）
 *  Taro-Iconfont （https://gitee.com/mirrors/Taro-Iconfont）

![5ed9c01c084c5f1d8195f122df44ce57.gif][]

[1. JavaScript 重温系列（22篇全）][1. JavaScript _22]

[2. ECMAScript 重温系列（10篇全）][2. ECMAScript _10]

[3. JavaScript设计模式 重温系列（9篇全）][3. JavaScript_ _9]

4. [正则 / 框架 / 算法等 重温系列（16篇全）][_ _ _ _ _16]

5. [Webpack4 入门（上）][Webpack4]|| [Webpack4 入门（下）][Webpack4 1]

6. [MobX 入门（上）][MobX] || [MobX 入门（下）][MobX 1]

7. 120[\+篇原创系列汇总][Link 1]

![c8cd9cd41d0d1981312f75b5dca0e360.gif][]

回复“**加群**”与大佬们一起交流学习~

点击“**阅读原文**”查看 120+ 篇原创文章

[e8681ddcae76ecbffc901b95db734edc.png]: /images/20220829/2044cf03e771412f890419827acf7a83.png
[HTTP]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c2099586b58083f982df0c3cdfe46609452d1350728846d04532c7b3307398a750bec9902b&idx=2&mid=2458462652&scene=21&sn=f856b0ae69470747e8b90dc6edd8f250#wechat_redirect
[a7e7238fbe1a26bfda96d0fb17f84a11.png]: /images/20220829/e2ed3f60e3d742829c71250828aaf6b1.png
[e9e59cd011b3216a8b243da8adbafe9e.png]: /images/20220829/de849711ea25433b9493ae02c2662615.png
[68ba4f5c6efdba8791762e05dd906605.png]: /images/20220829/8c498cd4440e4b279050c9c99ac1bf9d.png
[88216999946f2ce3548a3f283a23e863.png]: /images/20220829/4564b9bf24f44b469efc3a020e69f9a0.png
[873464888defdda6a18d0635f901fccd.png]: https://img-blog.csdnimg.cn/img_convert/873464888defdda6a18d0635f901fccd.png
[1b6bf124df689ba48d7ac8a21739ceb5.png]: https://img-blog.csdnimg.cn/img_convert/1b6bf124df689ba48d7ac8a21739ceb5.png
[fcd63123f943e9df0962edfdae46a5a8.png]: https://img-blog.csdnimg.cn/img_convert/fcd63123f943e9df0962edfdae46a5a8.png
[cdd99a86d90e3334596daa1dc01ce4b1.png]: /images/20220829/5318fe97bfd147c79facc7eb0bc7d188.png
[66671ee05b4e9a652976765504c72d61.png]: /images/20220829/7c288eaac7f64d7bb7d71025fce2db80.png
[8e25a07a4802a2d9d5e8b1ed7c867176.png]: /images/20220829/dca5a84d56464b06a2b625e2a7c48d40.png
[46f64ef8869fcc24708812bf929ae3b4.png]: /images/20220829/f4e8080753aa4e4d8009e61e24921638.png
[504d07330ba3e1252b586d25df8fe899.png]: /images/20220829/c2e17f33a75f45f68a1752eea6d93a8e.png
[748da69a72f3ce55957bed2a81f48fcd.png]: /images/20220829/7f453a762ce54851a9f03d785188811a.png
[916ea6dd95b66a50730d9c7ce8a6e9be.png]: /images/20220829/d7d4aab6cc3541b5a71c9d49a81d9681.png
[d09a086ff602ba7da6391dd5abbfe91e.png]: /images/20220829/dd19efccef3142c58dc60bf5fdf0d7a1.png
[9304834b4d4c23b3747e0bdd515ebedd.png]: /images/20220829/6df1082893cf4f5d8e028a71bdda145f.png
[9f792fb354fc0f7f220aa2b9c9c56fd8.png]: /images/20220829/af23ad7cee2c4e1a92207483c873db1e.png
[6b61d1b1e0131008b26f054f7a2cd2cc.png]: https://img-blog.csdnimg.cn/img_convert/6b61d1b1e0131008b26f054f7a2cd2cc.png
[82456f0dbd53efe7dc8594e291249577.png]: /images/20220829/ed840d0779fc47ea8128f4b3bd41c7a2.png
[6a095e030b35f99b539d15c804f291e0.png]: /images/20220829/41a5f106502947c7a0d1f65835188e05.png
[c33e6a97cefeb4b6d1fc644fd0d2343a.png]: /images/20220829/1e41a93b20f94f7881c7a402044657c3.png
[5ed9c01c084c5f1d8195f122df44ce57.gif]: /images/20220829/e2f7a63a48704805a75e6ed997087ef9.png
[1. JavaScript _22]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c224ea86b5adfc10c3aa1841be3879b9360d671e98cc73391c2490246f1348857b9821d32c&idx=1&mid=2458453187&scene=21&sn=a69b4d7d991867a07a933f86e66b9f55#wechat_redirect
[2. ECMAScript _10]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c224e086b5adf6dad41a0d36b77a9bfb4bc9f0d29a816266b3e28c892e54274967dbce380b&idx=1&mid=2458453193&scene=21&sn=e5392cb77bc17c9e94b6c826b5f52a83#wechat_redirect
[3. JavaScript_ _9]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c224e386b5adf554ab928cdeaf7ee16dbb2d895be17f2a12a59054a75b913470ca7649bbc7&idx=1&mid=2458453194&scene=21&sn=e7f0734b04484bee5e10a85a7cbb85c1#wechat_redirect
[_ _ _ _ _16]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c224e286b5adf432850f82db18cc8647d639836798cf16b478d9a6f7c81df87c6da5257684&idx=1&mid=2458453195&scene=21&sn=1e0c8b7ea8ddc207b523ec0a636a5254#wechat_redirect
[Webpack4]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c2251f86b5ac09dbbbb7c8e1d80c6cbd793a523cdfa690f8734def57812e616b9906aeec79&idx=1&mid=2458453302&scene=21&sn=904e40a421024ea0d394e9850b674012#wechat_redirect
[Webpack4 1]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c2251e86b5ac08464872cd880811423e0d1bbcebbe11dcac9d99fa38c5332c089c06d65d95&idx=1&mid=2458453303&scene=21&sn=422f2b5e22c3b0e91a8353ee7e53fed9#wechat_redirect
[MobX]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c2264c86b5af5aa7300a04d55efead6223e310d68e10222cd3577a25c783d3429f00767960&idx=1&mid=2458453605&scene=21&sn=0a506769d5eeb7953f676e93fb4d18eb#wechat_redirect
[MobX 1]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c2264086b5af5611524eedb0d409afe86d859dce6ceff1c17ddab49d353c385e45611a73fa&idx=1&mid=2458453609&scene=21&sn=f0c22e82f2537204d9b173161bae6b82#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MjM5MDc4MzgxNA%3D%3D&chksm=b1c224dd86b5adcbd98189315e60de6a0106993690b69927cc1c1f19fd8f591fefce4e3db51f&idx=2&mid=2458453236&scene=21&sn=daf00392f960c115463c5aaf980620b4#wechat_redirect
[c8cd9cd41d0d1981312f75b5dca0e360.gif]: /images/20220829/9015e66137ec4713adeeadbc925c684f.png