v7.0.0
更多資訊請前往 rubyonrails.org: 更多在 Ruby on Rails

Ruby on Rails 指南 (v7.0.0)

這些是根據 v7.0.0 的 Rails 7.0 新指南。 這些指南的目標在於讓您立即使用 Rails 提高工作效率,並幫助您了解所有部分是如何組合在一起的。

早期版本的指南: Rails 6.1Rails 6.0Rails 5.2Rails 5.1Rails 5.0Rails 4.2Rails 4.1Rails 4.0Rails 3.2Rails 3.1Rails 3.0,以及 Rails 2.3

Rails 指南也可用於 Kindle.
標有此圖示的指南表示正在處理中,但在指南索引清單中依然能夠點選。雖然它依舊可點選,但它們可能包含不完整的訊息甚至錯誤資訊。您可以確認它們並留下您的評論和更正的內容來提供回饋。

從這裡開始

Rails 入門

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

Models

Active Record 基礎

使用 Active Record 可以讓您的 models 與資料庫進行互動。 本指南將幫助您開始使用 Active Record models 並持久化到資料庫。

Active Record 遷移 (Migrations)

Migration 是 Active Record 的一個特性,它允許您隨著時間的推移發展您的資料庫架構。 遷移允許您使用 Ruby DSL 來描述對資料庫的更改,而不是在純 SQL 的模式中編寫修改。

Active Record 驗證 (Validations)

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

Active Record 回呼 (Callbacks)

Callback 可以編寫當物件在建立、更新、刪除…等時可執行的程式碼。 本指南將教您如何掛鉤(hook) Active Record 物件的這個物件生命週期。

Active Record 關聯 (Associations)

在 Active Record 中,關聯是兩個 Active Record models 之間的連線。 本指南包含了 Active Record 提供的所有 associations。

Active Record 查詢介面

Active Record 不是使用原始 SQL 來查詢資料庫記錄,而是提供了可執行相同操作的更好方法。 本指南介紹了使用 Active Record 從資料庫檢索資料的不同方法。

Active Model 基礎知識
Work in progress

Active Model 允許您建立與 Action Pack 整合的普通 Ruby 物件,但不需要 Active Record 來實現資料庫持久化。 Active Model 還有助於構建在 Rails 框架之外使用的自定義 ORM。 本指南為您提供了開始使用 Active Model 類別所需的一切。

Views

Action View 概述
Work in progress

Action View 負責回應 Web 請求而產生 HTML。 本指南介紹了 Action View。

Rails 中的版面配置(Layouts)和算繪(Rendering)

本指南涵蓋了 Action Controller 和 Action View 的基本版面配置功能,包括算繪和轉址、使用 content_for 塊以及使用部分。

Action View Helpers
Work in progress

Action View 具有 helpers 用於處理從格式化日期和連結到影象到清理和本地化內容的所有內容。 本指南介紹了幾個比較常見的 Action View helpers。

Action View 表單 Helpers

由於需要處理表單控制元件命名及其眾多屬性,HTML 表單的編寫和維護很快就會變得乏味。 Rails 透過提供 view helpers 來產生表單標記來消除這種複雜性。

Controllers

Action Controller 概述

Action Controllers 是 Rails 中 Web 請求的核心。 本指南介紹了 controllers 如何工作以及它們如何適應您的應用程式的請求週期。 它包括 sessions、過濾器、cookies、資料流和處理請求引發的異常等主題。

Rails 從外到內路由

Rails 路由器識別 URL 並將它們分派到 controller 的 action。 本指南涵蓋了 Rails 路由的面向使用者的功能。 如果您想了解如何在您自己的 Rails 應用程式中使用路由,請從這裡開始。

其他元件

Active Support 核心擴充套件

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

Action Mailer 基礎知識

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

Action Mailbox 基礎知識
Work in progress

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

Action Text 概述
Work in progress

本指南介紹如何使用 Action Text 處理富文字內容。

Active Job 基礎

Active Job 是一個用於聲明後臺作業並使它們在各種排隊後端上執行的框架。本指南為您提供了開始建立、排隊和執行後臺作業所需的一切。

Active Storage 概述

Active Storage 有助於將檔案上傳到雲端儲存服務、轉換上傳和提取元資料。 本指南介紹瞭如何將檔案附加到 Active Record models。

Action Cable 概述

Action Cable 將 WebSockets 與 Rails 應用程式的其餘部分整合在一起。 它允許在 Ruby 中以與 Rails 應用程式的其餘部分相同的樣式和形式編寫實時功能。 本指南解釋了 Action Cable 的工作原理,以及如何使用 WebSockets 來建立實時功能。

Webpacker

本指南將向您展示如何安裝和使用 Webpacker 為 Rails 應用程式的客戶端打包 JavaScript、CSS 和其他資產。

深入研究

Rails 國際化 (I18n) API

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

測試 Rails 應用程式

這是關於 Rails 中各種測試設施的相當全面的指南。 它涵蓋了“什麼是測試?”的所有內容。到整合測試。享受。

保護 Rails 應用程式

本指南描述了 Web 應用程式中的常見安全問題以及如何透過 Rails 避免這些問題。

除錯 Rails 應用程式

本指南介紹瞭如何除錯 Rails 應用程式。 它涵蓋了實現這一目標的不同方法以及如何理解程式碼“幕後”發生的事情。

設定 Rails 應用程式

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

Rails 命令列

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

Asset Pipeline

asset pipeline 提供了一個框架來連線和縮小或壓縮 JavaScript、CSS 和影象資產。 它還增加了用其他語言和預處理器(如 CoffeeScript、Sass 和 ERB)編寫這些資產的能力。

在 Rails 中使用 JavaScript
Work in progress

本指南涵蓋了 Rails 的內建 Ajax/JavaScript 功能。

Rails 初始化過程
Work in progress

本指南解釋了 Rails 中初始化過程的內部結構。 這是一本非常深入的指南,推薦給高階 Rails 開發人員。

自動載入和重新載入常量

本指南記錄了自動載入和重新載入常量的工作原理(Zeitwerk 模式)。

使用 Rails 快取

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

Active Support 儀表 (instrumentation)
Work in progress

本指南解釋瞭如何使用 Active Support 內部的檢測 API 來測量 Rails 和其他 Ruby 程式碼內部的事件。

將 Rails 用於僅 API 的應用程式

本指南解釋瞭如何有效地使用 Rails 開發 JSON API 應用程式。

Active Record 和 PostgreSQL
Work in progress

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

具有 Active Record 的多個數據庫
Work in progress

本指南涵蓋在您的應用程式中使用多個數據庫。

Active Record 加密
Work in progress

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

擴充 rails

建立 Rails 外掛(plugin)的基礎知識
Work in progress

本指南介紹瞭如何構建外掛來擴充套件 Rails 的功能。

Rails on Rack

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

建立和自定義 Rails 產生器和模板

本指南涵蓋了向擴充套件新增全新產生器或為內建 Rails 產生器的元素提供替代方案的過程(例如為 scaffold 產生器提供替代測試存根)。

引擎(Engines)入門
Work in progress

引擎可以被認為是為其宿主應用程式提供附加功能的微型應用程式。 在本指南中,您將學習如何建立自己的引擎並將其與主機應用程式整合。

Rails 中的執行緒和程式碼執行
Work in progress

本指南描述了在 Rails 應用程式中直接處理平行計算時所需的注意事項和可用的工具。

貢獻

在 Rails 上為 Ruby 做貢獻

Rails 不是“別人的框架”。本指南涵蓋了您可以參與 Rails 持續開發的各種方式。

API 文件指南

本指南記錄了 Ruby on Rails API 文件指南。

指南指南

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

政策

維修政策

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

發行說明

在 Rails 上升級 Ruby

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

7.0 版 - 2021 年 12 月
Work in progress

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) 請先驗證問題是否已經在主分支上解決。 請前往 Ruby on Rails 指南寫作準則 查看寫作風格和慣例。

如果由於某種原因您發現要修復的內容但無法自行修補,請您 提出 issue

關於 Ruby on Rails 的任何類型的討論歡迎提供任何文件至 rubyonrails-docs 討論區