# 从导入的 Rails 项目入门

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/zh-cn/help/idea/llms.txt).

> **TL;DR**
> 必需插件： [Ruby](ruby-plugin.html)

IntelliJ IDEA 是一个  集成开发环境 (IDE) ，可以在 Ruby/Rails 项目的各个开发阶段帮助您提高效率——从编写和调试代码到测试和部署完整的应用程序。 IntelliJ IDEA 可用于不同的平台，包括 macOS、Windows 和 Linux。

在本教程中，我们将向您展示主要的 IntelliJ IDEA 功能，通过一个为 [fork](https://github.com/JetBrains/sample_rails_app) 创建的示例应用程序，该应用程序是为 [Ruby on Rails Tutorial](https://www.railstutorial.org) 创建的。 在开始本教程之前，请执行以下操作：

* 安装 [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)。

* 为您的平台安装 [Ruby distribution](https://www.jetbrains.com/zh-cn/help/ruby/set-up-a-ruby-development-environment.html#ruby)。

* 安装 [Node.js](https://nodejs.org/en/download/) 和 [Yarn](https://yarnpkg.com/en/docs/install)。

我们将使用安装在 macOS 上的 IntelliJ IDEA 执行所有步骤。

## 克隆项目

首先，我们需要克隆包含示例应用程序的存储库：

Procedure:

1. 运行 IntelliJ IDEA，然后在 [欢迎界面](null) 上点击   克隆存储库  。

![欢迎界面 / 克隆仓库](https://resources.jetbrains.com/help/img/idea/2026.3/ij_welcome_screen_get_from_vcs.png)

2. 在   克隆存储库  对话框中，执行以下操作：

![克隆仓库对话框](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_get_from_version_control_dialog.png)

* 确保在 Git 中选择 版本控制 字段。

* 请在 URL 字段中插入以下地址： `https://github.com/JetBrains/sample_rails_app_8th_ed.git`

点击   克隆   按钮。 IntelliJ IDEA 将显示一个进度条，指示克隆过程。

3. 克隆仓库后，IntelliJ IDEA 会打开项目并开始项目分析过程。 您可以在 [状态栏](null)中查看进度。

![项目分析](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_project_analysis_progress.png)

IntelliJ IDEA 会分析项目以检查其源代码，并收集有关可用文件、类和方法定义等的信息。 这是代码洞察功能（如代码补全和导航）所需的。

> **Tip:**
> 在首次打开项目、安装依赖项、向项目添加新文件、从版本控制系统获取更新或切换分支时，会触发项目分析。

## 选择 Ruby 解释器并安装 gem

打开项目后，需要确保已配置所需的 Ruby 解释器，并安装项目的  `Gemfile`  中指定的依赖项。

IDE 会检测所有已安装的 Ruby 解释器，并根据项目选择适当的选项。 如果自动选择的 Ruby 解释器与项目设置之间存在冲突，或者未检测到解释器，可以 [手动配置](configuring-language-interpreter.html)。

Procedure: 安装 gem

1. 安装  `Gemfile`  中指定的 gem。 IntelliJ IDEA 允许您使用 [Bundler](https://bundler.io) 来管理 gems。 按 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS)) 两次，然后开始输入  bundle install 。 然后，从列表中选择  `bundle install`  命令并按下 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![运行 Anything / bundle install](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_run_any_bundle_install.png)

2. 请等待 IntelliJ IDEA 安装所有 gems。

![运行工具窗口／安装 gems](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_gems_installation_output.png)

## 运行迁移

运行 Rails 应用程序之前，需要迁移数据库。

Procedure:

1. 请按两次 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS)) 并输入  `db:migrate` 。 在下拉菜单中选择   rake db:migrate   并按下 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。 请按 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS)) 两次，输入  `db :migrate` ，然后按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![随处运行 / rake db:migrate](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_run_any_db_migrate.png)

2. 保持被调用的   执行 'db:migrate'   对话框中的默认设置，然后点击   OK  。

![执行 db:migrate](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_execute_db_migrate_dialog.png)

这将在  `development.sqlite3` 数据库创建在  `db` 文件夹中。

3. 请再次按照第一步中描述的运行  `rake db:migrate` 。 这次，请在   执行 'db:migrate'  对话框中将   环境  选项设置为  test ，然后点击   OK  。 创建的  `test.sqlite3` 数据库将用于运行测试。

## 浏览项目

IntelliJ IDEA 提供丰富的导航功能，能够探索任何规模的项目。 您可以在文件之间导航、转到声明、搜索任何类型的实体等。

### 项目视图

IDE 左侧的项目视图( `Alt+1` (Windows), `⌘ 1` (macOS), `⌘ 1` (IntelliJ IDEA Classic (macOS)), `⌘ 1` (macOS System Shortcuts), `Alt+1` (XWin), `Alt+1` (GNOME), `Alt+1` (KDE), `Alt+1` (Emacs), `Alt+1` (Sublime Text), `⌘ 1` (Sublime Text (macOS)), `Ctrl+Alt+L` (Visual Studio), `⌘ ⌥ L` (Visual Studio (macOS)), `Ctrl+1` (NetBeans), `Alt+1` (Eclipse), `Alt+1` (Eclipse (macOS)))显示项目结构。 您可以使用它打开项目中的任何文件、新建文件等。

![项目视图](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_navigate_project_view.png)

### 转到声明

Go to declaration  允许您从任意符号用法导航到符号的声明。 要查看此功能，请按 `Ctrl+Shift+N` (Windows), `⌘ ⇧ O` (macOS), `⌘ ⇧ N` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ O` (macOS System Shortcuts), `Ctrl+Shift+N` (XWin), `Ctrl+Shift+N` (GNOME), `Ctrl+Shift+N` (KDE), `Ctrl+X, Ctrl+F` (Emacs), `Ctrl+P` (Sublime Text), `⌘ P` (Sublime Text (macOS)), `Ctrl+Shift+T` (Visual Studio), `⌘ ⇧ T` (Visual Studio (macOS)), `Alt+Shift+O` (NetBeans), `Ctrl+Shift+R` (Eclipse), `⌘ ⇧ R` (Eclipse (macOS))，开始输入  `users_controller` ，选择  `users_controller.rb`  文件并按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![转到文件](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_get_started_go_to_file.png)

在打开的  `users_controller.rb` 文件中，将文本光标放在  `用户` 类旁边，然后按 `Ctrl+B` (Windows), `⌘ B` (macOS), `⌘ B` (IntelliJ IDEA Classic (macOS)), `⌘ B` (macOS System Shortcuts), `Ctrl+B` (XWin), `Ctrl+B` (GNOME), `Ctrl+B` (KDE), `Ctrl+Alt+G` (Emacs), `F12` (Sublime Text), `F12` (Sublime Text (macOS)), `F12` (Visual Studio), `F12` (Visual Studio (macOS)), `Ctrl+B` (NetBeans), `F3` (Eclipse), `F3` (Eclipse (macOS))。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_navigate_go_declaration.mp4)

您将跳转到  `user.rb`  文件中的类声明。

请注意，您不仅可以跳转到项目实体，还可以跳转到外部库（在我们的例子中是 gems）中的定义。 例如，按住 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS))不放，将鼠标悬停在  `has_many` 方法上。 当方法变成超链接时，按住键点击它。

IntelliJ IDEA 将在  ActiveRecord  Rails 模块内打开方法定义。

### 查找用法

让我们试试  查找用法  操作。 在  `users_controller.rb` 文件中，向下滚动到  `编辑` 方法，在其旁边放置文本光标并按下 `Alt+F7` (Windows), `⌥ F7` (macOS), `⌥ F7` (IntelliJ IDEA Classic (macOS)), `⌃ U` (macOS System Shortcuts), `Alt+F7` (XWin), `Alt+Shift+7` (GNOME), `Alt+Shift+7` (KDE), `Alt+F7` (Emacs), `Alt+F7` (Sublime Text), `⌥ F7` (Sublime Text (macOS)), `Shift+F12` (Visual Studio), `⇧ F12` (Visual Studio (macOS)), `Alt+F7` (NetBeans), `Ctrl+G` (Eclipse), `⌘ ⇧ G` (Eclipse (macOS))。 在   查找   窗口中，您可以查看此操作使用的位置。

![查找用法](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_find_usages.png)

### 在 Rails 实体之间导航

在处理特定的 Rails 实体（如 controller）时，您可以导航到相关的 view、model、test 或 helper。 将文本光标置于  `编辑`  方法旁边，按 `Ctrl+Alt+Home` (Windows), `⌘ ⌃ ↑` (macOS), `⌘ ⌥ Home` (IntelliJ IDEA Classic (macOS)), `⌘ ⌃ ↓` (macOS System Shortcuts), `Ctrl+Alt+Home` (XWin), `Ctrl+Alt+Home` (GNOME), `Ctrl+Alt+Home` (KDE), `Ctrl+Alt+Home` (Emacs), `Ctrl+Alt+Home` (Sublime Text), `Ctrl+Alt+Home` (Sublime Text (macOS)), `Ctrl+Alt+F7` (Visual Studio), `⌘ ⇧ F7` (Visual Studio (macOS)), `Ctrl+Alt+Home` (NetBeans), `Ctrl+Alt+Home` (Eclipse), `⌘ ⌃ ↑` (Eclipse (macOS))，然后点击   视图  。 IntelliJ IDEA 将打开包含相应视图的  `edit.html.erb`  文件。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_navigate_open_view_from_controller.mp4)

在视图中，您可以使用相同的快捷键，或者使用编辑器边栏中的 ![从视图导航到操作](https://resources.jetbrains.com/help/img/idea/2026.3/ruby.icons.expui.rails.actionMethod%4014x14.svg) 图标快速转到相应的操作。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_navigate_open_controller_from_view.mp4)

### 随处搜索

下一个 IntelliJ IDEA 功能允许您搜索文件、类、符号或选项并跳转到所需的实体。

让我们尝试在  `destroy`  操作中找到  `UsersController` 。 按两次 `Shift` (Windows), `Shift` (macOS), `Shift` (IntelliJ IDEA Classic (macOS)), `Shift` (macOS System Shortcuts), `Shift` (XWin), `Shift` (GNOME), `Shift` (KDE), `Shift` (Emacs), `Shift` (Sublime Text), `Shift` (Sublime Text (macOS)), `Shift` (Visual Studio), `Shift` (Visual Studio (macOS)), `Shift` (NetBeans), `Shift` (Eclipse), `Shift` (Eclipse (macOS))并开始输入  destroy 。 IntelliJ IDEA 列出了查询结果中找到的所有结果。 请从   destroy  操作中选择   UsersController  并按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![随处搜索](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_get_started_search_everywhere.png)

将打开  `users_controller.rb` 文件并将文本光标放置在  `destroy` 操作的定义上。

## 编辑代码

IntelliJ IDEA 提供多种可在编辑器中使用的代码编辑功能，能够加快开发过程。 这些包括 [代码补全](auto-completing-code.html)、 [重构](refactoring-source-code.html)、 [代码检查](code-inspection.html)等。

### 代码补全

IntelliJ IDEA 可以帮助您完成类、方法、关键字等的名称。 当您调用代码补全时，IntelliJ IDEA 会分析上下文并建议适用于当前文本光标位置的选项。

例如，打开  `users_controller.rb`  文件并转到  `index`  方法，该方法声明在  `UsersController`  类中。 在方法内输入以下代码，然后输入点号。

```RUBY
@user = User

```

由于  `用户`  类继承自  `ApplicationRecord`  模块，编辑器将显示所有继承的成员。

之后，开始输入  `first`  以筛选列表并找到来自  `查询`  模块的相应成员，然后按下 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![代码补全](https://resources.jetbrains.com/help/img/idea/2026.3/ruby_get_started_completion.png)

> **Note:**
> 您也可以通过按 `Ctrl+Space` (Windows), `⌃ Space` (macOS), `⌃ Space` (IntelliJ IDEA Classic (macOS)), `⌃ Space` (macOS System Shortcuts), `Ctrl+Space` (XWin), `Ctrl+Space` (GNOME), `Ctrl+Space` (KDE), `Alt+/` (Emacs), `Ctrl+Space` (Sublime Text), `⌃ Space` (Sublime Text (macOS)), `Ctrl+Space` (Visual Studio), `⌃ Space` (Visual Studio (macOS)), `Ctrl+Space` (NetBeans), `Ctrl+Space` (Eclipse), `⌃ Space` (Eclipse (macOS)) 手动调用代码补全。

### 意图

意图可以帮助您快速应用各种代码更改：优化语句以获得更好的代码风格，将字符串添加到语言环境词典，使用语言注入，等等。

要查看意图的实际效果，打开  `user.rb`  文件并向下滚动到  `User.digest`  方法，该方法使用多行三元运算符  `?:` 。 根据 [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide)，建议用  `if/then/else/end`  块替换此类运算符。 要做到这一点，请将文本光标放置在这个三元表达式处（例如，ActiveModel 旁边），然后按 `Alt+Enter` (Windows), `⌥ ⏎` (macOS), `⌥ ⏎` (IntelliJ IDEA Classic (macOS)), `⌥ ⏎` (macOS System Shortcuts), `Alt+Enter` (XWin), `Alt+Enter` (GNOME), `Alt+Enter` (KDE), `Alt+Enter` (Emacs), `Alt+Enter` (Sublime Text), `⌥ ⏎` (Sublime Text (macOS)), `Alt+Enter` (Visual Studio), `⌥ ⏎` (Visual Studio (macOS)), `Alt+Enter` (NetBeans), `Ctrl+1` (Eclipse), `⌘ 1` (Eclipse (macOS))。 按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))将三元运算符转换为  `if/then/else/end` 代码块。

![意图](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_intentions.png)

> **Tip:**
> 您可以使用 [检查](#inspections)来检查您的代码并检测可能的问题。

### 重构代码

代码重构是修改源代码以使其更易于维护和扩展的过程，但不会改变其行为。 让我们看看 IntelliJ IDEA 中提供的一些重构功能。

Rename  重构允许您重命名类、方法、文件、变量和参数，并相应地更正代码中所有对它们的引用。 打开  `user.rb`  文件并向下滚动到  `downcase_email`  方法，该方法在  `before_save`  回调中被调用。 将文本光标放在此方法旁边，然后按 `Ctrl+Shift+I` (Windows), `⌥ Space` (macOS), `⌘ ⇧ I` (IntelliJ IDEA Classic (macOS)), `⌘ Y` (macOS System Shortcuts), `Ctrl+Shift+I` (XWin), `Ctrl+Shift+I` (GNOME), `Ctrl+Shift+I` (KDE), `Ctrl+Shift+I` (Emacs), `Ctrl+Shift+I` (Sublime Text), `⌥ Space` (Sublime Text (macOS)), `Alt+F12` (Visual Studio), `⌥ Space` (Visual Studio (macOS)), `Ctrl+Shift+I` (NetBeans), `Ctrl+Shift+I` (Eclipse), `⌥ Space` (Eclipse (macOS)) 查看其定义。

![快速定义](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_quick_definition.png)

按 `Escape` (Windows), `⎋` (macOS), `⎋` (IntelliJ IDEA Classic (macOS)), `⎋` (macOS System Shortcuts), `Escape` (XWin), `Escape` (GNOME), `Escape` (KDE), `Escape, Escape` (Emacs), `Escape` (Sublime Text), `⎋` (Sublime Text (macOS)), `Escape` (Visual Studio), `⎋` (Visual Studio (macOS)), `Escape` (NetBeans), `Escape` (Eclipse), `⎋` (Eclipse (macOS))，然后按 `Ctrl+Alt+Shift+T` (Windows), `⌃ T` (macOS), `⌘ ⌥ ⇧ T` (IntelliJ IDEA Classic (macOS)), `⌃ S` (macOS System Shortcuts), `Ctrl+Alt+Shift+T` (XWin), `Ctrl+Alt+Shift+T` (GNOME), `Ctrl+Alt+Shift+T` (KDE), `Ctrl+Alt+Shift+T` (Emacs), `Ctrl+Alt+Shift+T` (Sublime Text), `⌃ T` (Sublime Text (macOS)), `Ctrl+Shift+R` (Visual Studio), `⌘ ⇧ R` (Visual Studio (macOS)), `Ctrl+Alt+Shift+T` (NetBeans), `Ctrl+Alt+Shift+T` (Eclipse), `⌃ T` (Eclipse (macOS))。 选择   重命名   在   对此进行重构   弹出窗口中，该窗口建议多种重构操作。

![重构此弹出窗口](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_refactor_this.png)

在   重命名   对话框中，指定一个新的方法名称（在本例中为  lowercase_email ），然后点击   执行重构  。

![重命名对话框](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_get_started_refactor_rename_method_dialog.png)

重构预览   窗口将显示所有对重命名方法的引用。

![重构](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_get_started_do_refactor_dialog.png)

点击   重构   在所有地方重命名该方法。

### 重新格式化代码

IntelliJ IDEA 允许您重新格式化源代码以满足您的 [代码风格](configuring-code-style.html)要求。

让我们重新格式化  `user.rb`  文件的代码。 打开此文件并按 `Ctrl+Alt+L` (Windows), `⌘ ⌥ L` (macOS), `⌘ ⌥ L` (IntelliJ IDEA Classic (macOS)), `⌘ ⌥ L` (macOS System Shortcuts), `Ctrl+Alt+L` (XWin), `Ctrl+Alt+L` (GNOME), `Alt+Shift+L` (KDE), `Ctrl+Alt+L` (Emacs), `Ctrl+Alt+L` (Sublime Text), `⌘ ⌥ L` (Sublime Text (macOS)), `Ctrl+Alt+Enter` (Visual Studio), `⌘ ⌥ ⏎` (Visual Studio (macOS)), `Alt+Shift+F` (NetBeans), `Ctrl+Alt+L` (Eclipse), `⌘ ⇧ F` (Eclipse (macOS))。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_reformat_code.mp4)

IntelliJ IDEA 将重新格式化整个文件，并显示更改的行数。

## 分析代码

在本部分中，您将进行静态代码分析并检测问题。

IntelliJ IDEA 支持多种检查类型，并且允许在 IDE 内显示 [RuboCop](http://rubocop.readthedocs.io/) 违规。 RuboCop 检查在 IntelliJ IDEA 中默认启用，并且需要将 [RuboCop gem](https://docs.rubocop.org/rubocop/installation.html) 添加到。 模块 SDK。

Procedure: 添加并安装 RuboCop gem

1. 打开包含应用程序使用的 gem 列表的  `Gemfile` 。

2. 在  `group :development do`  中添加  `gem 'rubocop', require: false` 。

3. 将鼠标悬停在添加的行上，然后点击   使用 'bundler' 安装缺失的 gems  。

Procedure: 使用 RuboCop

1. 在  `Gemfile`  文件中，将鼠标悬停在  `active_storage_validations`  gem 上。

![Rubocop 警告](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_inspection_gemfile_tooltip.png)

IntelliJ IDEA 会显示一条 Rubocop 通知，建议按字母顺序排列 gem（请参阅 [OrderedGems](https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Bundler/OrderedGems)）。

2. 在通知中，点击   修复 [Bundler/Ordered Gems] 违规问题。  。

3. 您还可以检查整个项目，并在一个报告中显示所有警告。 要执行此操作，请在主菜单中选择  `代码 | 检查代码` 。 在调用的对话框中，您可以指定所需的检查范围。

![检查作用域](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_inspection_scope.png)

4. 请保留   整个项目   选项并点击   分析  。 检查结果窗口将显示整个项目的警告。

![检查结果](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_inspection_result.png)

您可以浏览此报告并修复或忽略特定警告。

## 运行测试

IntelliJ IDEA 使您能够使用不同的 [测试框架](testing-frameworks.html)，例如 Minitest、RSpec 或 Cucumber。

### 运行所有测试

我们的项目在  `test` 文件夹中包含 Minitest 测试。 要运行所有测试，请按 `Alt+1` (Windows), `⌘ 1` (macOS), `⌘ 1` (IntelliJ IDEA Classic (macOS)), `⌘ 1` (macOS System Shortcuts), `Alt+1` (XWin), `Alt+1` (GNOME), `Alt+1` (KDE), `Alt+1` (Emacs), `Alt+1` (Sublime Text), `⌘ 1` (Sublime Text (macOS)), `Ctrl+Alt+L` (Visual Studio), `⌘ ⌥ L` (Visual Studio (macOS)), `Ctrl+1` (NetBeans), `Alt+1` (Eclipse), `Alt+1` (Eclipse (macOS)) 打开项目视图。 然后，右键点击  `test`  文件夹，并从上下文菜单中选择  `运行“test 中的所有测试”` 。

![运行目录中的所有测试](https://resources.jetbrains.com/help/img/idea/2026.3/ruby_runAllTests.png)

IntelliJ IDEA 将运行并在   运行   工具窗口中显示测试结果。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_tests_result.mp4)

### 运行特定测试

现在让我们看看如何运行特定测试。 打开  `users_controller_test.rb`  文件，向下滚动到  `should redirect index when not logged in`  测试，并点击该测试旁边左侧边距中的   运行   按钮。

![运行特定测试](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_tests_run_specific.png)

在调用的菜单中选择   运行‘Minitest: test_should_...’  。 IntelliJ IDEA 将显示此测试的结果。

![测试结果](https://resources.jetbrains.com/help/img/idea/2026.3/ruby_get_started_tests_result_specific.png)

### 重新运行失败的测试

现在让我们回到  `users_controller_test.rb`  并破坏两个测试。 对于  `should get new`  和  `should redirect index when not logged in`  测试，注释掉  `get signup_path`  和  `get users_path`  行。 要执行此操作，请选择这些行并使用 `Ctrl+/` (Windows), `⌘ /` (macOS), `⌘ /` (IntelliJ IDEA Classic (macOS)), `⌘ /` (macOS System Shortcuts), `Ctrl+/` (XWin), `Ctrl+/` (GNOME), `Ctrl+/` (KDE), `Alt+;` (Emacs), `Ctrl+/` (Sublime Text), `⌘ /` (Sublime Text (macOS)), `Ctrl+Alt+/` (Visual Studio), `⌘ ⌥ /` (Visual Studio (macOS)), `Ctrl+/` (NetBeans), `Ctrl+/` (Eclipse), `⌘ /` (Eclipse (macOS)) 快捷键。

![失败的测试](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_tests_break.png)

再次运行 [运行所有测试](#all_tests) 中描述的所有测试。 您现在可以看到这些测试失败了。

![失败的测试](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_tests_rerun_failed.png)

让我们通过取消注释相同的行：  `get signup_path`  和  `get users_path` ，来修复当前打开的  `users_controller_test.rb`  文件中的这些测试。 使用相同的 `Ctrl+/` (Windows), `⌘ /` (macOS), `⌘ /` (IntelliJ IDEA Classic (macOS)), `⌘ /` (macOS System Shortcuts), `Ctrl+/` (XWin), `Ctrl+/` (GNOME), `Ctrl+/` (KDE), `Alt+;` (Emacs), `Ctrl+/` (Sublime Text), `⌘ /` (Sublime Text (macOS)), `Ctrl+Alt+/` (Visual Studio), `⌘ ⌥ /` (Visual Studio (macOS)), `Ctrl+/` (NetBeans), `Ctrl+/` (Eclipse), `⌘ /` (Eclipse (macOS)) 快捷键。 我们现在可以使用 ![重新运行失败的测试](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.restartFailedTests.svg) 按钮仅重新运行这些失败的测试。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_tests_result_success.mp4)

现在我们准备运行应用程序。

## 创建运行/调试配置

要运行和调试我们的 Rails 应用程序，我们需要创建一个相应的   Rails   配置。 按 `Ctrl+Shift+A` (Windows), `⌘ ⇧ A` (macOS), `⌘ ⇧ A` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ P` (macOS System Shortcuts), `Ctrl+Shift+A` (XWin), `Ctrl+Shift+A` (GNOME), `Ctrl+Shift+A` (KDE), `Escape, X` (Emacs), `Ctrl+Shift+P` (Sublime Text), `⌘ ⇧ P` (Sublime Text (macOS)), `Ctrl+Shift+A` (Visual Studio), `⌘ ⇧ A` (Visual Studio (macOS)), `Ctrl+I` (NetBeans), `Ctrl+Shift+A` (Eclipse), `⌘ 3` (Eclipse (macOS)) 并开始输入  编辑配置 。 选择   编辑配置   并按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![查找操作](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_find_action_edit_config.png)

在调用的   运行/调试配置  对话框中，点击 ![添加新配置](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg)，开始输入  Rails 并从列表中选择它。

![运行/调试配置对话框](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_run_debug_config_create.png)

将创建的配置名称更改为  Development: sample_rails_app 并点击   OK  。

![运行/调试配置对话框](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_run_debug_config_setup.png)

有关 Rails 运行/调试配置的更多详细信息，请参阅 [RubyMine 文档](https://www.jetbrains.com/zh-cn/help/ruby/run-debug-configuration-rails.html)。

## 运行应用程序

要运行我们的 Rails 应用程序，请按两次 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS))并开始输入  `sample_rails_app` 。 从列表中选择   sample_rails_应用_第8版  配置，然后按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

![运行任何内容 / 运行配置](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_run_any_run_config.png)

IntelliJ IDEA 将显示准备运行应用程序的过程。

![运行工具窗口/运行 Rails 应用程序](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_run_app_output.png)

在浏览器中通过  `http://127.0.0.1:3000`  (或  `http://localhost:3000` ) 打开您的应用，以查看我们正在运行的应用。

![浏览器中的 Rails 应用程序](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_browser.png)

## 调试应用程序

IntelliJ IDEA 的一项关键功能是调试支持。 调试器提供了多种方法来检查运行中应用程序的状态。 您可以单步执行代码并检查变量值，对变量设置观察以查看值何时变化，等等。

> **Tip:**
> 我们的示例应用程序使用  puma  网络服务器，其默认工作超时时间为 60 秒。 为了调试目的，将此超时设置为更大的值可能会很有用。 为此，请打开  `config/puma.rb` 文件并指定   worker_timeout  选项。

### 设置断点并开始调试

首先，打开  `users_controller.rb` 文件。 在创建新用户的行旁边为  `创建`  方法设置一个断点。

![设置断点](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_breakpoint.png)

要开始调试，请按两次 `Ctrl` (Windows), `Ctrl` (macOS), `Ctrl` (IntelliJ IDEA Classic (macOS)), `Ctrl` (macOS System Shortcuts), `Ctrl` (XWin), `Ctrl` (GNOME), `Ctrl` (KDE), `Ctrl` (Emacs), `Ctrl` (Sublime Text), `Ctrl` (Sublime Text (macOS)), `Ctrl` (Visual Studio), `Ctrl` (Visual Studio (macOS)), `Ctrl` (NetBeans), `Ctrl` (Eclipse), `Ctrl` (Eclipse (macOS))并开始输入  `sample_rails_app` 。 请从列表中选择   sample_rails_应用_第8版   配置，按住 `Shift` (Windows), `Shift` (macOS), `Shift` (IntelliJ IDEA Classic (macOS)), `Shift` (macOS System Shortcuts), `Shift` (XWin), `Shift` (GNOME), `Shift` (KDE), `Shift` (Emacs), `Shift` (Sublime Text), `Shift` (Sublime Text (macOS)), `Shift` (Visual Studio), `Shift` (Visual Studio (macOS)), `Shift` (NetBeans), `Shift` (Eclipse), `Shift` (Eclipse (macOS)) 键（对话框标题将更改为   调试  ），然后按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

调试   工具窗口将显示应用程序输出。

![调试控制台输出](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_console_output.png)

在您的本地计算机上打开 Web 浏览器，并导航到  `http://127.0 .0.1:3000` 。

![浏览器中的 Rails 应用程序](https://resources.jetbrains.com/help/img/idea/2026.3/ij_ruby_browser.png)

点击   立即注册！   按钮。 在   注册  页面，输入您的凭证并点击   创建我的帐户  。

![用户凭据](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_enter_credentials.png)

程序将在到达断点时停止。

### 检查变量

您现在可以检查应用程序状态和变量的值。

![在断点处停止](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_stop.png)

线程与变量   面板显示应用程序线程及相应的调用栈。 在我们的例子中，该  `创建` 方法在  Thread 1 中被调用。 在窗格的右侧部分，您可以检查当前上下文中可用的变量。

> **Tip:**
> 使用 ![过滤器](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.filter.svg) 按钮显示或隐藏来自外部库的方法调用。

让我们将  `user_params`  变量添加到列表中。 在窗格的右侧，在搜索字段中输入  `user_params`  并点击 ![添加](https://resources.jetbrains.com/help/img/idea/2026.3/app.debugger.addToWatch.svg)。

然后，点击此变量旁边的 ![展开](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.arrowExpand.svg) 图标，然后以相同的方式展开   @parameters   变量。 您将看到在   注册   表单中指定的用户凭据。

一旦断点被触发，您可以逐步执行代码。

### 步过

Step over  在当前作用域内继续到下一行（例如，转到下一行），而不会进入任何方法调用。

`用户`  对象尚未创建，并且  `@user`  变量尚未初始化（等于  `nil` ）。

![断点。](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_before_step_over.png)

请按 `F8` (Windows), `F8` (macOS), `F8` (IntelliJ IDEA Classic (macOS)), `⌘ Quote` (macOS System Shortcuts), `F8` (XWin), `F8` (GNOME), `F8` (KDE), `F8` (Emacs), `F8` (Sublime Text), `F8` (Sublime Text (macOS)), `F10` (Visual Studio), `F10` (Visual Studio (macOS)), `F8` (NetBeans), `F6` (Eclipse), `F6` (Eclipse (macOS)) 或点击 ![步过](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.stepOver.svg) 在   调试   工具窗口工具栏中。 调试器将跳转到下一行——  `if` 语句，然后  `@user` 变量将被初始化。

![步过](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_after_step_over.png)

使用 ![展开](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.arrowExpand.svg)图标来展开并检查   @user  属性。

### 步入

单步执行 将导致调试器进入当前行的方法调用或代码块并跟踪它们。 如果有多个方法调用或块，您可以选择所需的目标。

点击 ![恢复程序](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.resume.svg) 继续程序执行。 再次打开浏览器，并在   注册  表单中创建另一个用户。 脚本将在到达创建用户的那一行时停止。

按 `F7` (Windows), `F7` (macOS), `F7` (IntelliJ IDEA Classic (macOS)), `⌘ ;` (macOS System Shortcuts), `F7` (XWin), `F7` (GNOME), `F7` (KDE), `F7` (Emacs), `F7` (Sublime Text), `F7` (Sublime Text (macOS)), `F11` (Visual Studio), `⌘ F11` (Visual Studio (macOS)), `F7` (NetBeans), `F5` (Eclipse), `F5` (Eclipse (macOS)) 或点击 ![步入](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.traceInto.svg) 按钮。

![断点。](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_before_step_into.png)

编辑器将设置焦点于  `user_params`  方法。 可以使用箭头键或 `Tab` (Windows), `Tab` (macOS), `Tab` (IntelliJ IDEA Classic (macOS)), `Tab` (macOS System Shortcuts), `Tab` (XWin), `Tab` (GNOME), `Tab` (KDE), `Tab` (Emacs), `Tab` (Sublime Text), `Tab` (Sublime Text (macOS)), `Tab` (Visual Studio), `Tab` (Visual Studio (macOS)), `Tab` (NetBeans), `Tab` (Eclipse), `Tab` (Eclipse (macOS)) 选择需要步入的方法（在本例中为  `new`  或  `user_params` ）。 选择  `user_params`  并按 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。 程序执行将跳转到  `user_params`  方法定义。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_step_into_1.mp4)

如果您再按一次 `F7` (Windows), `F7` (macOS), `F7` (IntelliJ IDEA Classic (macOS)), `⌘ ;` (macOS System Shortcuts), `F7` (XWin), `F7` (GNOME), `F7` (KDE), `F7` (Emacs), `F7` (Sublime Text), `F7` (Sublime Text (macOS)), `F11` (Visual Studio), `⌘ F11` (Visual Studio (macOS)), `F7` (NetBeans), `F5` (Eclipse), `F5` (Eclipse (macOS))，调试器将建议在  `params` 和  `require` 方法之间进行选择，这些方法来自 [StrongParameters](https://api.rubyonrails.org/classes/ActionController/StrongParameters.html)模块。

### 在控制台中调试

调试器具有   控制台  选项卡，使您能够通过类似 IRB 的控制台与被调试的应用程序进行交互。

在控制台中开始输入  `user_params` ，选择相应的变量，然后按下 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS))。

[Video](https://resources.jetbrains.com/help/img/idea/2026.3/rm_get_started_debug_console.mp4)

控制台   窗口将显示变量的值。

## See also

### 过程

[配置 Ruby 解释器](configuring-language-interpreter.html) [项目分析](project-analysis.html) [运行应用程序](running-applications.html) [调试代码](debugging-code.html)

