Gemfile中的'require:false'是什么意思?

问题描述 投票:397回答:5

做这个:

gem 'whenever', require: false

是指宝石需要安装,还是意味着它不是必需的?

ruby bundler gemfile
5个回答
450
投票

这意味着安装gem,但在启动Bundler时不要调用require。所以你需要手动调用

require "whenever"

如果你想使用这个库。

如果你这样做的话

gem "whenever", require: "whereever"

然后捆绑包会下载任何时候命名的宝石,但会打电话

require "whereever"

如果要求的库名称与gem的名称不同,则通常使用此方法。


69
投票

如果希望安装gem而不是“必需”,则使用:require => false

所以在你给出的例子中:gem 'whenever', :require => false当有人运行bundle install时,就像gem install whenever一样安装gem。每当用于通过运行rake任务来创建cron作业,但通常不在rails(或其他框架,如果不是rails)应用程序中使用。

因此,您可以将:require => false用于从命令行运行但在代码中不需要的任何内容。


55
投票

require: false告诉Bundler.require不要求特定的宝石:必须通过require 'gem'明确要求宝石。

此选项不会影响:

  • bundle install:无论如何都会安装gem
  • 由bundler设置的require搜索路径。 当您执行以下任一操作时,Bundler会向路径添加内容: Bundle.setup 这是由require bundler/setup调用的 这是由bundle exec调用的

的Gemfile

source 'https://rubygems.org'
gem 'haml'
gem 'faker', require: false

main.rb的

# Fail because we haven't done Bundler.require yet.
# bundle exec does not automatically require anything for us,
# it only puts them in the require path.
begin Haml; rescue NameError; else raise; end
begin Faker; rescue NameError; else raise; end

# The Bundler object is automatically required on `bundle exec`.
Bundler.require

Haml
# Not required because of the require: false on the Gemfile.
# THIS is what `require: false` does.
begin Faker; rescue NameError; else raise; end

# Faker is in the path because Bundle.setup is done automatically
# when we use `bundle exec`. This is not affected by `require: false`.
require 'faker'
Faker

那么以下内容不会引发异常:

bundle install --path=.bundle
bundle exec ruby main.rb

On GitHub让你玩它。

Rails用法

正如initialization tutorial中所解释的,默认的Rails模板在启动时运行:

  • config/boot.rb
  • config/application.rb

config/boot.rb包含:

ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

它做require 'bundler/setup'并设置require路径。

config/application.rb

Bundler.require(:default, Rails.env)

这实际上需要宝石。


8
投票

每当你在你的Gemfile和run bundle install中指定一个Gem时,bundler就会在你的应用程序中安装指定的gem和加载代码,方法是将require 'whenever'放入你的Rails应用程序中加载所有Gems的代码,你可以调用它任何Gem的任何方法都没有任何痛苦,就像你大部分时间一样。

但是whenever, faker or capistrano 这样的宝石是你需要的应用程序代码中不需要的东西,你需要schedule.rb 文件中的代码来管理deploy.rb 文件中的crons和capistrano代码以自定义部署配方,这样你就不需要在应用程序代码中加载这些宝石的代码了无论你想从这些宝石中调用任何方法,你都可以通过放置 require "whenever" 手动要求这些宝石。所以你把:require => false放在Gemfile中用于这些Gems,这样Bundler就会安装那个Gem而不是加载Gem本身的代码,你可以随时在你的情况下像需要'随时'那样做。


1
投票

为了在你的Gemfile中需要宝石,你需要调用Bundler.require

您可以阻止bundler使用require: false来获取gem,但它仍然会安装和维护gem。请查看this out以获取更详细的说明。

© www.soinside.com 2019 - 2024. All rights reserved.