Action View 辅助方法

阅读本指南后，您将了解

如何格式化日期、字符串和数字。
如何处理文本和标签。
如何链接到图像、视频、样式表等。
如何在视图中处理 Atom 提要和 JavaScript。
如何缓存、捕获、调试和清理内容。

以下是 Action View 中一些最常用的辅助方法 的概述。它是一个良好的起点，但建议您也查看完整的 API 文档，因为它更详细地介绍了所有辅助方法。

2 表单

与仅使用标准 HTML 元素相比，表单辅助方法简化了对模型的操作。它们提供了一系列方法，专门用于根据您的模型生成表单。一些方法对应于特定类型的输入，例如文本字段、密码字段、选择下拉菜单等等。当表单提交时，表单中的输入被分组到 params 对象中并发送回控制器。

您可以在 Action View 表单辅助方法指南中了解更多有关表单辅助方法的信息。

一组用于构建依赖于路由子系统的链接和 URL 的方法。

3.5 url_for

返回为提供的options集生成的 URL。

url_for @profile
# => /profiles/1

url_for [ @hotel, @booking, page: 2, line: 3 ]
# => /hotels/1/bookings/1?line=3&page=2

url_for @post # given a composite primary key [:blog_id, :id]
# => /posts/1_2

5 资产

一组用于生成 HTML 的方法，这些 HTML 将视图链接到资产，例如图像、JavaScript 文件、样式表和提要。

默认情况下，Rails 将这些资产链接到公共文件夹中的当前主机，但是您可以通过在应用程序配置（通常在config/environments/production.rb中）中设置config.asset_host来指示 Rails 将资产链接到专用资产服务器。

例如，假设您的资产主机是assets.example.com

config.asset_host = "assets.example.com"

那么image_tag的相应 URL 将是

image_tag("rails.png")
# => <img src="//assets.example.com/images/rails.png" />

5.1 audio_tag

生成一个包含源的 HTML 音频标签，可以是字符串源的单个标签，也可以是在数组中嵌套的源标签以用于多个源。sources可以是完整路径、公共音频目录中的文件或Active Storage 附件。

audio_tag("sound")
# => <audio src="/audios/sound"></audio>

audio_tag("sound.wav", "sound.mid")
# => <audio><source src="/audios/sound.wav" /><source src="/audios/sound.mid" /></audio>

audio_tag("sound", controls: true)
# => <audio controls="controls" src="/audios/sound"></audio>

在内部，audio_tag使用AssetUrlHelpers中的audio_path来构建音频路径。

有关更多信息，请参阅audio_tag API 文档。

5.2 auto_discovery_link_tag

返回一个链接标签，浏览器和提要阅读器可以使用它自动检测 RSS、Atom 或 JSON 提要。

auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", { title: "RSS Feed" })
# => <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="http://www.example.com/feed.rss" />

有关更多信息，请参阅auto_discovery_link_tag API 文档。

5.4 image_tag

返回源的 HTML 图像标签。source可以是完整路径或app/assets/images目录中存在的文件。

image_tag("icon.png")
# => <img src="/assets/icon.png" />

image_tag("icon.png", size: "16x10", alt: "Edit Article")
# => <img src="/assets/icon.png" width="16" height="10" alt="Edit Article" />

在内部，image_tag使用AssetUrlHelpers中的image_path来构建图像路径。

有关更多信息，请参阅image_tag API 文档。

5.5 javascript_include_tag

返回每个提供的源的 HTML 脚本标签。您可以传入app/assets/javascripts目录中存在的 JavaScript 文件的文件名（.js扩展名是可选的）以包含到当前页面中，或者您可以传入相对于文档根目录的完整路径。

javascript_include_tag("common")
# => <script src="/assets/common.js"></script>

javascript_include_tag("common", async: true)
# => <script src="/assets/common.js" async="async"></script>

一些最常见的属性是async和defer，其中async将允许脚本并行加载，以便尽快解析和评估，而defer将指示脚本应在解析文档后执行。

在内部，javascript_include_tag使用AssetUrlHelpers中的javascript_path来构建脚本路径。

有关更多信息，请参阅javascript_include_tag API 文档。

5.8 stylesheet_link_tag

返回为指定为参数的源生成的样式表链接标签。如果您没有指定扩展名，则会自动追加.css。

stylesheet_link_tag("application")
# => <link href="/assets/application.css" rel="stylesheet" />

stylesheet_link_tag("application", media: "all")
# => <link href="/assets/application.css" media="all" rel="stylesheet" />

media用于指定链接的媒体类型。最常见的媒体类型是all、screen、print和speech。

在内部，stylesheet_link_tag使用AssetUrlHelpers中的stylesheet_path来构建样式表路径。

有关更多信息，请参阅stylesheet_link_tag API 文档。

5.9 video_tag

生成一个包含源的 HTML 视频标签，可以是字符串源的单个标签，也可以是在数组中嵌套的源标签以用于多个源。sources可以是完整路径、公共视频目录中的文件或 Active Storage 附件。

video_tag("trailer")
# => <video src="/videos/trailer"></video>

video_tag(["trailer.ogg", "trailer.flv"])
# => <video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>

video_tag("trailer", controls: true)
# => <video controls="controls" src="/videos/trailer"></video>

在内部，video_tag使用AssetUrlHelpers中的video_path来构建视频路径。

有关更多信息，请参阅video_tag API 文档。

7 替代标签

一组用于以编程方式生成 HTML 标签的方法。

7.2 token_list

返回从提供的参数构建的令牌字符串。此方法也称为class_names。

token_list("cats", "dogs")
# => "cats dogs"

token_list(nil, false, 123, "", "foo", { bar: true })
# => "123 foo bar"

mobile, alignment = true, "center"
token_list("flex items-#{alignment}", "flex-col": mobile)
# => "flex items-center flex-col"
class_names("flex items-#{alignment}", "flex-col": mobile) # using the alias
# => "flex items-center flex-col"

8 捕获块

一组方法，让您可以提取生成的标记，这些标记可以在模板或布局文件的其他部分使用。

它提供了一种通过capture将块捕获到变量中的方法，以及一种通过content_for捕获标记块以在布局中使用的方法。

8.2 content_for

调用 content_for 会将一段标记存储在一个标识符中，以便以后使用。您可以通过将标识符作为参数传递给 yield，在其他模板、辅助模块或布局中对存储的内容进行后续调用。

一个常见的用例是在 content_for 块中设置页面的标题。

您在特殊的页面视图中定义一个 content_for 块，然后在布局中对其进行 yield。对于其他页面，如果未使用 content_for 块，它将保持为空，导致不会产生任何内容。

<%# app/views/users/special_page.html.erb %>
<% content_for(:html_title) { "Special Page Title" } %>

<%# app/views/layouts/application.html.erb %>
<html>
  <head>
    <title><%= content_for?(:html_title) ? yield(:html_title) : "Default Title" %></title>
  </head>
</html>

您会注意到，在上面的示例中，我们使用 content_for? 谓词方法来有条件地渲染标题。此方法检查是否已使用 content_for 捕获任何内容，使您能够根据视图中的内容调整布局的某些部分。

此外，您可以在辅助模块中使用 content_for。

# app/helpers/title_helper.rb
module TitleHelper
  def html_title
    content_for(:html_title) || "Default Title"
  end
end

现在，您可以在布局中调用 html_title 以检索存储在 content_for 块中的内容。如果在正在渲染的页面上设置了 content_for 块（例如在 special_page 的情况下），它将显示标题。否则，它将显示默认文本“Default Title”。

content_for 在缓存中被忽略。因此，您不应将其用于将被片段缓存的元素。

您可能在想，capture 和 content_for 之间的区别是什么？

capture 用于将一段标记捕获到一个变量中，而 content_for 用于将一段标记存储在一个标识符中，以便以后使用。在内部，content_for 实际上会调用 capture。但是，关键区别在于它们在多次调用时的行为。

content_for 可以被反复调用，将它接收到的块按提供顺序连接到特定标识符中。每次后续调用都只是添加到已经存储的内容中。相比之下，capture 只返回块的内容，而不跟踪任何先前的调用。

有关更多信息，请参阅 content_for API 文档。

9 性能

9.1 benchmark

将一个 benchmark 块包裹在昂贵的操作或可能的瓶颈周围，以获取操作的时间读数。

<% benchmark "Process data files" do %>
  <%= expensive_files_operation %>
<% end %>

这将向日志添加类似于 Process data files (0.34523) 的内容，然后您可以使用它在优化代码时比较时间。

此辅助方法是 Active Support 的一部分，它也适用于控制器、辅助方法、模型等。

有关更多信息，请参阅 benchmark API 文档。

9.2 cache

您可以缓存视图的片段，而不是整个操作或页面。此技术对于缓存菜单、新闻主题列表、静态 HTML 片段等内容非常有用。它允许将视图逻辑的一部分包装在缓存块中，并在下次请求到来时从缓存存储中提供服务。

cache 方法接受一个包含您要缓存的内容的块。

例如，您可以通过将应用程序布局的页脚包装在 cache 块中来缓存它。

<% cache do %>
  <%= render "application/footer" %>
<% end %>

您还可以根据模型实例进行缓存，例如，您可以通过将 article 对象传递给 cache 方法来缓存页面上的每篇文章。这将单独缓存每篇文章。

<% @articles.each do |article| %>
  <% cache article do %>
    <%= render article %>
  <% end %>
<% end %>

当您的应用程序收到对此页面的第一个请求时，Rails 将使用一个唯一的键写入一个新的缓存条目。一个键看起来像这样

views/articles/index:bea67108094918eeba32cd4a6f786301/articles/1

有关更多信息，请参阅 片段缓存 和 cache API 文档。

10 杂项

10.1 atom_feed

Atom Feed 是基于 XML 的文件格式，用于联合内容，用户可以使用 Feed 阅读器浏览内容，搜索引擎可以使用它来帮助发现有关您网站的更多信息。

此辅助方法使构建 Atom Feed 变得容易，主要用于 Builder 模板中创建 XML。以下是一个完整的用法示例

# config/routes.rb
resources :articles

# app/controllers/articles_controller.rb
def index
  @articles = Article.all

  respond_to do |format|
    format.html
    format.atom
  end
end

# app/views/articles/index.atom.builder
atom_feed do |feed|
  feed.title("Articles Index")
  feed.updated(@articles.first.created_at)

  @articles.each do |article|
    feed.entry(article) do |entry|
      entry.title(article.title)
      entry.content(article.body, type: "html")

      entry.author do |author|
        author.name(article.author_name)
      end
    end
  end
end

有关更多信息，请参阅 atom_feed API 文档。

10.2 debug

返回一个用 pre 标签包装的对象的 YAML 表示形式。这创建了一个非常易于阅读的检查对象的方式。

my_hash = { "first" => 1, "second" => "two", "third" => [1, 2, 3] }
debug(my_hash)

<pre class="debug_dump">---
first: 1
second: two
third:
- 1
- 2
- 3
</pre>

有关更多信息，请参阅 debug API 文档。