Rails 使用 Sprockets Processor 剔除 CSS 中的 Google Font

greatghoul · 2016年05月27日 · 最后由 bianjp 回复于 2016年06月01日 · 3405 次阅读

使用 Rails 做 Web 应用时，基本上都会遇到使用第三方前端组件的情况，相比于自己手动 Copy 组件的文件到 Assets 中，使用一些别人封装好的 Gem，或者借助 bower-rails 等工具，可以更省心的管理这些依赖文件。

一些组件的 CSS 中可能通过一些 CDN @import 引入一些依赖，比如 Google Fonts。这对开发者来说，本来是件极便利的事，但因为一些众所周知的原因，一些通过 URL 引入的样式文件无法访问或者访问很慢，而样式一般是在网页头部引入，这导致整个网页加载异常缓慢，因为无法访问的样式表请求一直 Block 在那里，直到出错或者加载完成。

@import url('https://fonts.googleapis.com/css?family=Open+Sans');

以前我的做法是 Fork 组件的代码，从中去除这些影响访问的资源引入，然后通过 GIT 地址引入到项目中，但这样做非常不优雅：

一个项目用的第三方组件可能很多，一个个 Fork 很费事
通过 Git 引入的依赖在安装时一般很慢，这一定程度上影响了部署的速度
不能及时更新组件的新版本

怎么办呢？在查阅了 Sprockets 的资料后，发现有个叫 Processor 的东西，似乎能派上用场。Processor 的 call 方法可以返回一个包含 :data 的 Hash，用于传递处理过的 Asset 内容到下一个 Processor。

def self.call(input)
  input[:cache].fetch("my:cache:key:v1") do
    # Remove all semicolons from source
    input[:data].gsub(";", "")
  end
end

注：直接返回字符串相当于返回 { data: str }

这下有得玩了！

class ChinaSprocketsProcessor
  GOOGLE_FONT_PAT = /@import\s+url\(.*?googleapis.*?\);?/
  BOOTCDN_PAT = /@import\s+url\(.*?bootstrapcdn.*?\);?/

  def self.call(input)
    data = input[:data].gsub(GOOGLE_FONT_PAT, '').gsub(BOOTCDN_PAT, '')

    { data: data }
  end
end

Sprockets.register_postprocessor 'text/css', ChinaSprocketsProcessor

将这段代码添加到 config/initializers/assets.rb 中，这样 CSS 文件中 googleapis 的引用和 bootstrapcdn 的引用都会被干掉了，既不用自己修改组件的代码，还符合了国情，真是太好了👏🏻。

9 个赞

mizuhashi #1 2016年05月27日

挺赞的，之前用 semantic-ui 的时候也是要这样搞

kgen #2 2016年05月27日

一个众所周知的原因引发的血案

这个 patch 很有用

darkbaby123 #3 2016年05月27日

有意思的思路。刚好前几天看 RailsConf 2016 的 How Sprocket Works 也讲了自定义 processor，对照一下感觉不错。

bianjp #4 2016年05月27日

我们使用 npm 管理前端依赖，遇到过类似问题（bootstrap 等库的字体文件加载失败），解决方案是通过 npm 的 postinstall 钩子进行相关处理（复制字体文件到 public 目录下、修改源文件中的字体加载路径等）。

1 个赞

greatghoul #5 2016年05月28日

#4 楼 @bianjp 你们这种方法好做更通用一些，能否介绍一下，我的这个方法只支持 Rails，所以挺有局限性。

bianjp #6 2016年05月30日

#5 楼 @greatghoul 在 package.json 中指定 postinstall 要执行的脚本：

"scripts": {
    "postinstall": "./npm_postinstall.sh"
},

在 package.json 同级创建 npm_postinstall.sh 文件，内容如下：

#!/bin/bash

mkdir -p public/fonts
rm -rf public/fonts/*

if [ -d "node_modules/bootstrap" ]; then
  rm -rf public/fonts/bootstrap
  cp -r node_modules/bootstrap/dist/fonts/* public/fonts/
fi

if [ -d "node_modules/font-awesome" ]; then
  rm -rf public/fonts/font-awesome
  cp -r node_modules/font-awesome/fonts/* public/fonts/
fi

说明：

postinstall 可指定任何可执行的脚本（Shell Script, Python, Ruby 等）或命令。我们开发、部署都使用 Linux 系统，而我对 Shell Script 又很熟悉，因此就使用了最简单方便的 Shell Script。Shell Script 中可以使用 sed 命令进行字符串处理。
每次执行 npm install 后都会自动执行 postinstall 脚本（不管有没有安装新的包），且在脚本中无法得知本次执行中安装了哪些包，因此只能通过目录是否存在判断，并且要保证重复执行脚本不会导致问题。
需要修改插件的源文件时，建议修改非压缩版本（便于查看、处理），并确保 application.js 等文件中引用的是非压缩版。

1 个赞

greatghoul #7 2016年05月30日

#6 楼 @bianjp 非常感谢，我在项目中用的 bower，查了下，原来 bower 也有类似的 hook 可以用。

用 npm 或者 bower 解决感觉比使用 postprocessor 方便多了，更加通用，原来这种事大家各有妙招，JavaScript 不熟悉，还得继续努力。

bianjp #8 2016年06月01日

#7 楼 @greatghoul 我们原先也使用 bower, 现在都改用 npm 了。使用 bower 要注意 postinstalll 只在真的安装了包时才会触发，测试起来不太方便。不过也有一个优点是会将新安装的包名称传给脚本。

bianjp 在如何在 Asset Pipeline 中引入第三方 font 资源提及了此话题。 12月09日 09:05

需要登录后方可回复, 如果你还没有账号请注册新账号