v7.1.3.2
更多資訊請至 rubyonrails.org: 更多 Ruby on Rails

Ruby on Rails 指南 (v7.1.3.2)

以下是基於 v7.1.3.2 的 Rails 7.1 新指南。這些指南旨在讓您立即使用 Rails 提高工作效率,並幫助您了解所有部分如何組合在一起。

較早版本指南:Rails 7.0Rails 6.1Rails 6.0Rails 5.2Rails 5.1Rails 5.0Rails 4.2Rails 4.1Rails 4.0Rails 3.2Rails 3.1Rails 3.0Rails 2.3

Rails 指南也適用於 Kindle
標示有此圖示的指南目前正在編寫中,且不會出現在指南索引選單中。雖然仍然有用,但可能包含不完整資訊,甚至錯誤。您可以透過檢閱指南並張貼您的意見和更正來提供協助。

從這裡開始

開始使用 Rails

安裝 Rails 和建立您的第一個應用程式所需的一切知識。

模型

Active Record 基礎

Active Record 讓您的模型可以與應用程式的資料庫互動。本指南將讓您開始使用 Active Record 模型和資料庫持久性。

Active Record 遷移

遷移是 Active Record 的一項功能,讓您可以隨著時間演進您的資料庫結構。遷移讓您可以使用 Ruby DSL 來描述表格變更,而不是使用純 SQL 來撰寫結構修改。

Active Record 驗證

驗證用於確保只有有效資料儲存在您的資料庫中。本指南會教您如何使用 Active Record 的驗證功能,在物件進入資料庫之前驗證物件狀態。

Active Record 回呼

回呼讓您可以撰寫程式碼,在物件建立、更新、刪除等時執行。本指南會教您如何連結到 Active Record 物件的這個物件生命週期。

Active Record 關聯

在 Active Record 中,關聯是兩個 Active Record 模型之間的連線。本指南涵蓋 Active Record 提供的所有關聯。

Active Record 查詢介面

Active Record 提供更好的方法來執行相同的作業,而不是使用原始 SQL 來尋找資料庫記錄。本指南涵蓋使用 Active Record 從資料庫擷取資料的不同方法。

Active Model 基礎
進行中

Active Model 讓您可以建立與 Action Pack 整合的純 Ruby 物件,但不需要 Active Record 的資料庫持久性。Active Model 也協助建置自訂 ORM,以便在 Rails 架構之外使用。本指南提供您開始使用 Active Model 類別所需的一切。

檢視

Action View 概觀
進行中

Action View 負責為網頁回應產生 HTML。本指南提供 Action View 的簡介。

Rails 中的版面配置和呈現

本指南涵蓋 Action Controller 和 Action View 的基本版面功能,包括呈現和重新導向、使用 content_for 區塊,以及使用部分檢視。

Action View 輔助程式
進行中

Action View 有輔助程式可處理所有事情,從格式化日期和連結到圖片,到清除和在地化內容。本指南介紹一些較常見的 Action View 輔助程式。

Action View 表單輔助函式

HTML 表單可能很快會變得難以撰寫和維護,因為需要處理表單控制項命名及其眾多屬性。Rails 透過提供用於產生表單標記的檢視輔助程式來消除這種複雜性。

控制器

Action Controller 概觀

Action Controller 是 Rails 中網頁請求的核心。本指南涵蓋控制器如何運作,以及它們如何符合應用程式的請求週期。其中包含會話、篩選器、Cookie、資料串流,以及處理請求引發的例外狀況等主題。

Rails 路由由外而內

Rails 路由器識別 URL,並將它們傳送給控制器的動作。本指南涵蓋 Rails 路由使用者介面功能。如果您想了解如何在自己的 Rails 應用程式中使用路由,請從這裡開始。

其他元件

Active Support 核心擴充套件

Active Support 提供 Ruby 語言擴充和公用程式。它豐富了 Ruby 語言,用於開發 Rails 應用程式,以及 Ruby on Rails 本身的開發。

Action Mailer 基礎

本指南提供您開始從應用程式傳送電子郵件所需的一切,以及 Action Mailer 的許多內部結構。

Action Mailbox 基礎
進行中

本指南說明如何使用 Action Mailbox 接收電子郵件。

Action Text 概觀
進行中

本指南說明如何使用 Action Text 處理豐富文字內容。

Active Job 基礎

Active Job 是用於宣告背景工作,並讓它們在各種佇列後端上執行的架構。本指南提供您開始建立、加入佇列和執行背景工作所需的一切。

Active Storage 概觀

Active Storage 便於將檔案上傳到雲端儲存服務、轉換上傳內容和萃取元資料。本指南涵蓋如何將檔案附加到您的 Active Record 模型。

Action Cable 概觀

Action Cable 將 WebSockets 整合到 Rails 應用程式的其他部分。它允許使用 Ruby 以與 Rails 應用程式其他部分相同的樣式和格式撰寫即時功能。本指南說明 Action Cable 的運作方式,以及如何使用 WebSockets 建立即時功能。

深入探討

Rails 國際化 (I18n) API

本指南介紹如何將國際化功能新增到您的應用程式。您的應用程式將能夠將內容翻譯成不同的語言、變更複數形式規則、針對每個國家/地區使用正確的日期格式,等等。

測試 Rails 應用程式

這是一份關於 Rails 中各種測試功能的相當全面的指南。它涵蓋了從「什麼是測試?」到整合測試的所有內容。請享用。

保護 Rails 應用程式

本指南說明 Web 應用程式中常見的安全問題,以及如何使用 Rails 避免這些問題。

Rails 應用程式中的錯誤回報

本指南介紹管理 Ruby on Rails 應用程式中發生的例外情況的方法。

除錯 Rails 應用程式

本指南說明如何偵錯 Rails 應用程式。它涵蓋了達成此目的的不同方法,以及如何了解程式碼「幕後」發生的事情。

設定 Rails 應用程式

本指南涵蓋 Rails 應用程式的基本組態設定。

Rails 命令列

有幾個命令對您日常使用 Rails 至關重要。本指南涵蓋 Rails 提供的命令列工具。

資產管線

資產管線提供了一個架構,用於串接和縮小或壓縮 JavaScript、CSS 和影像資產。它還增加了使用其他語言和預處理器(例如 CoffeeScript、Sass 和 ERB)撰寫這些資產的功能。

在 Rails 中使用 JavaScript

本指南說明如何使用匯入對應或 jsbundling-rails 在 Rails 應用程式中包含 JavaScript,並涵蓋在 Rails 中使用 Turbo 的基礎知識。

Rails 初始化程序
進行中

本指南說明 Rails 初始化程序的內部運作。這是一份非常深入的指南,建議進階 Rails 開發人員閱讀。

自動載入和重新載入

本指南記錄自動載入和重新載入常數的運作方式。

從 Classic 遷移到 Zeitwerk

本指南記錄如何將 Rails 應用程式從「傳統」模式移轉到「zeitwerk」模式。

使用 Rails 進行快取:概觀

本指南介紹如何使用快取加速 Rails 應用程式。

Active Support 儀器
進行中

本指南說明如何使用 Active Support 內部的儀器 API 來測量 Rails 和其他 Ruby 程式碼中的事件。

使用 Rails 進行僅 API 的應用程式

本指南說明如何有效使用 Rails 開發 JSON API 應用程式。

Active Record 和 PostgreSQL
進行中

本指南涵蓋 Active Record 的 PostgreSQL 特定用法。

多個資料庫

本指南涵蓋在應用程式中使用多個資料庫。

Active Record 加密
進行中

本指南涵蓋使用 Active Record 加密資料庫資訊。

複合主鍵

本指南介紹資料庫表格的複合主鍵。

擴充 Rails

建立 Rails 外掛程式基礎
進行中

本指南涵蓋如何建立外掛程式來擴充 Rails 的功能。

Rails on Rack

本指南涵蓋 Rails 與 Rack 的整合,以及與其他 Rack 元件的介面。

建立和自訂 Rails 產生器和範本

本指南涵蓋將全新產生器新增到擴充程式,或提供內建 Rails 產生器元素的替代方案(例如提供 scaffold 產生器的替代測試 stub)的程序。

引擎入門
進行中

引擎可以視為小型應用程式,為其主機應用程式提供額外的功能。在本指南中,你將學習如何建立自己的引擎,並將其與主機應用程式整合。

Rails 應用程式範本
進行中

應用程式範本是包含 DSL 的簡單 Ruby 檔案,可用於將寶石、初始化程式等新增到新建立的 Rails 專案或現有的 Rails 專案。

Rails 中的執行緒和程式碼執行
進行中

本指南說明在 Rails 應用程式中直接處理並行處理時所需的考量事項和可用的工具。

貢獻

貢獻 Ruby on Rails

Rails 並非「別人的框架」。本指南涵蓋了多種參與 Rails 持續開發的方式。

API 文件指南

本指南記載了 Ruby on Rails API 文件編寫指南。

指南指南

本指南記載了 Ruby on Rails 指南指南。

安裝 Rails 核心開發相依性

本指南涵蓋如何為 Ruby on Rails 核心開發設定環境。

政策

維護政策

哪些版本的 Ruby on Rails 目前受支援,以及何時可以期待新版本。

版本說明

升級 Ruby on Rails

本指南提供在將應用程式升級到較新版本的 Ruby on Rails 時應遵循的步驟。

版本 7.1 - 2023 年 10 月

Rails 7.1 的發行說明。

7.0 版 - 2021 年 12 月

Rails 7.0 的發行說明。

6.1 版 - 2020 年 12 月

Rails 6.1 的發行說明。

6.0 版 - 2019 年 8 月

Rails 6.0 的發行說明。

5.2 版 - 2018 年 4 月

Rails 5.2 的發行說明。

5.1 版 - 2017 年 4 月

Rails 5.1 的發行說明。

5.0 版 - 2016 年 6 月

Rails 5.0 的發行說明。

4.2 版 - 2014 年 12 月

Rails 4.2 的發行說明。

4.1 版 - 2014 年 4 月

Rails 4.1 的發行說明。

4.0 版 - 2013 年 6 月

Rails 4.0 的發行說明。

3.2 版 - 2012 年 1 月

Rails 3.2 的發行說明。

3.1 版 - 2011 年 8 月

Rails 3.1 的發行說明。

3.0 版 - 2010 年 8 月

Rails 3.0 的發行說明。

2.3 版 - 2009 年 3 月

Rails 2.3 的發行說明。

2.2 版 - 2008 年 11 月

Rails 2.2 的發行說明。

回饋

我們鼓勵您協助提升本指南的品質。

如果您發現任何錯字或事實錯誤,請協助我們修正。首先,您可以閱讀我們的文件貢獻部分。

您也可能會發現不完整的內容或未更新的內容。請為 main 新增任何遺失的說明文件。請務必先查看 Edge Guides,以驗證問題是否已在 main 分支中修復。查看 Ruby on Rails Guides Guidelines 以了解風格和慣例。

如果您發現需要修復但無法自行修補的任何原因,請 開啟問題

最後但並非最不重要的一點是,在 官方 Ruby on Rails 論壇 上非常歡迎任何有關 Ruby on Rails 文件的討論。