Docs header transparent bg

如何使用 Bundler 管理應用程式相依性

本指南最初是為 Bundler v1.12 編寫的。如果您使用的是不同版本，請記住輸出可能有所不同。若要檢查 Bundler 版本，只需執行 bundle -v。

內文

  1. 入門 - 安裝 Bundler 和 bundle init
  2. 編輯 Gemfile
    1. 來源
    2. 新增寶石
    3. Gemfile 語法
  3. 安裝寶石 - bundle install
    1. 開發
    2. 部署
  4. Gemfile.lock
  5. 執行指令 - bundle exec
  6. 更新寶石 - bundle outdated 和 bundle update
  7. 建議的工作流程
  8. 疑難排解
    1. 在使用 Bundler 的專案中執行 git bisect

入門 - 安裝 Bundler 和 bundle init

某些架構內建支援 Bundler，例如，當您執行 rails new app 時，它會自動初始化 Bundler。

首先，我們需要安裝 Bundler。

$ gem install bundler

此指令也會更新已安裝的 bundler。您應該會取得類似以下的輸出

$ gem install bundler
Successfully installed bundler-1.12.5
1 gem installed

若要手動初始化 Bundler，我們可以這樣做（bundler_example 將會是我們應用程式的資料夾）

$ mkdir bundler_example && cd bundler_example
$ bundle init

這會在 bundler_example 資料夾內建立 Gemfile

# frozen_string_literal: true
# A sample Gemfile
source "https://rubygems.org"

# gem "rails"

編輯 Gemfile

來源

自動產生的 Gemfile 包含 source "https://rubygems.org"。這表示 Bundler 會在 https://rubygems.org 中搜尋寶石。如果您想使用您自己的 RubyGems 伺服器或其他伺服器，請變更它

source "https://your_ruby_gem_server.url"

如果您有更多寶石來源，您可以使用區塊或 :source

source "https://your_ruby_gem_server.url" do
  # gems
end

gem "my_gem", source: "https://your_2_ruby_gem_server.url"

區塊內的寶石會從指定的來源擷取。

在此 處進一步了解 source。

新增寶石

現在讓我們新增一些相依性到專案中

# frozen_string_literal: true
# A sample Gemfile
source "https://rubygems.org"

gem "rails"

使用上述 Gemfile，bundler install 會安裝最新版本的 rails 寶石。

當我們想要安裝指定版本時該怎麼辦？只要在逗號後指定它

gem "rails", "3.0.0"

或使用此語法

gem "rails", "~> 4.0.0" # which is same as gem "rails", ">= 4.0.0", "< 4.1.0" 
gem "nokogiri", ">= 1.4.2"

在此 處進一步了解 Gemfile 中的寶石。

Gemfile 語法

從 gemfile 手冊頁 進一步了解 Gemfile 語法。

安裝寶石 - bundle install

開發

若要安裝開發用的寶石，只需執行 bundle install。

這應該會提供給您類似的輸出

Fetching gem metadata from https://rubygems.org/
Fetching version metadata from https://rubygems.org/
Fetching dependency metadata from https://rubygems.org/
Resolving dependencies...
Using mini_portile2 2.1.0
Using pkg-config 1.1.7
Using bundler 1.12.5
Using nokogiri 1.6.8
Bundle complete! 1 Gemfile dependency, 4 gems now installed.
Use `bundle show [gemname]` to see where a bundled gem is installed.

它也應該建立 Gemfile.lock 檔案

GEM
  remote: https://rubygems.org/
  specs:
    mini_portile2 (2.1.0)
    nokogiri (1.6.8)
      mini_portile2 (~> 2.1.0)
      pkg-config (~> 1.1.7)
    pkg-config (1.1.7)

PLATFORMS
  ruby

DEPENDENCIES
  nokogiri (>= 1.4.0)

BUNDLED WITH
   1.12.5

此 Gemfile.lock 在 下一章節 中說明。

部署

對於部署，您應該使用 --deployment 選項

$ bundle install --deployment

這會將所有相依性安裝到 ./vendor/bundle。

要執行此指令，有一些需求

  1. 需要有 Gemfile.lock 檔案。
  2. Gemfile.lock 必須是最新的。

要深入了解 bundle install 指令，請按一下 這裡。

Gemfile.lock

Bundler 使用這個檔案來儲存所有 gem 的名稱和版本。它保證您始終使用完全相同的程式碼，即使您的應用程式跨機器移動。在指定的 gem 首次安裝後，Bundler 會鎖定其版本。要更新它，您必須使用：bundler update 或/和在 Gemfile 中修改其版本。

當您使用 Bundler 的某些指令（例如 bundle install 或 bundle update）時，這個檔案會自動建立/更新，您應該將它檢查到版本控制中。

我們將使用前一章的 Gemfile.lock 作為範例。

GEM
  remote: https://rubygems.org/
  specs:
    mini_portile2 (2.1.0)
    nokogiri (1.6.8)
      mini_portile2 (~> 2.1.0)
      pkg-config (~> 1.1.7)
    pkg-config (1.1.7)

PLATFORMS
  ruby

DEPENDENCIES
  nokogiri (>= 1.4.0)

BUNDLED WITH
   1.12.5

讓我們來分解它

  • GEM
    • remote - gem 的來源
    • specs - 已安裝的 gem（含版本）。我們可以在這裡看到 mini_portile2 是 nokogiri 的相依性，因為它在下方且縮排
  • PLATFORMS - 在您的應用程式中使用的平台（在此處查看更多資訊）。
  • DEPENDENCIES - 在我們的 Gemfile 中定義的 gem。
  • BUNDLED WITH - 最後用於變更 Gemfile.lock 的 Bundler 版本

執行指令 - bundle exec

讓我們先看範例

$ bundle exec rspec

$ bundle exec rails s

這將允許您在目前的 bundle 環境中執行指令（這裡的 rspec 和 rails s），讓 Gemfile 中的所有 gem 都可以使用 require 並使用。

要深入了解 bundle exec 指令，請按一下 這裡。

更新寶石 - bundle outdated 和 bundle update

現在讓我們更新一些 gem。使用 bundle outdated，我們可以列出已安裝且有較新版本可用的 gem

$ bundle outdated
Fetching gem metadata from https://rubygems.org/
Fetching version metadata from https://rubygems.org/
Fetching dependency metadata from https://rubygems.org/
Resolving dependencies.......

Outdated gems included in the bundle:
  * nokogiri (newest 1.6.8, installed 1.6.7.2) in group "default"

您也可以指定 gem（bundle outdated *gems）。

我們已將 nokogiri 鎖定在版本 1.6.7.2。我們如何更新它？bundle install 因為它在 Gemfile.lock 檔案中被鎖定，所以不會安裝較新的版本。我們必須使用 bundle update。

$ bundle update
Fetching git://github.com/middleman/middleman-syntax.git
Fetching gem metadata from https://rubygems.org/
Fetching version metadata from https://rubygems.org/
Fetching dependency metadata from https://rubygems.org/
Resolving dependencies.....
Installing nokogiri 1.6.8 (was 1.6.7.2) with native extensions
Using i18n 0.7.0

... (and more)

Bundle updated!

在沒有任何參數的情況下使用 bundle update 將嘗試將每個 gem 更新到最新的可用版本（受 Gemfile 限制）。

要更新特定 gem，請使用 bundle update *gems

要深入了解 bundle outdated 指令，請按一下 這裡。

要深入了解 bundle update 指令，請按一下 這裡。

一般而言，在使用 bundler 管理應用程式時，您應該使用下列工作流程

  • 若要初始化 Bundler，請執行
$ bundle init
  • 在您第一次建立 Gemfile 之後，請執行
$ bundle install
  • 將產生的 Gemfile.lock 檢查進版本控制
$ git add Gemfile.lock
  • 在其他開發機器上簽出此儲存庫時，請執行
$ bundle install
  • 在部署機器上簽出此儲存庫時，請執行
$ bundle install --deployment
  • 在變更 Gemfile 以反映新的或更新的相依性後，請執行
$ bundle install
  • 務必將更新後的 Gemfile.lock 檢查進版本控制
$ git add Gemfile.lock
  • 如果 bundle install 報告衝突，請手動更新您在 Gemfile 中變更的特定 gem
$ bundle update rails thin
  • 如果您想要將所有 gem 更新為與 Gemfile(5) 中列出的 gem 仍相符的最新可能版本，請執行
$ bundle update

疑難排解

在使用 Bundler 的專案中執行 git bisect

請參閱 Git 二分搜尋指南。

指南

在 GitHub 上編輯此文件，如果您發現錯誤或注意到有遺漏之處。