29、Rails 开发中的调试、测试与日志记录技巧

Rails 开发中的调试、测试与日志记录技巧

1. 调试技巧

1.1 使用 byebug 设置断点

在 Rails 开发中，byebug 是一个强大的调试工具。可以使用 break 命令手动设置断点，例如：

(byebug) break app/controllers/votes_controller.rb:7
Successfully created breakpoint with id 1

这里指定了文件和行号来创建断点。若在当前文件内设置断点，指定文件并非必需，但为完整性考虑可加上。设置好断点后，在 byebug shell 中输入 continue 命令可继续执行，直到到达断点处程序会再次暂停。使用 info breakpoints 命令可获取活动断点列表。

1.2 Rails 日志记录工具

Rails 自带内部日志记录工具，可将自定义事件触发的条目写入应用程序的日志文件。日志记录不仅有助于调试，特别是在生产环境中避免用户看到调试代码输出，还能揭示应用程序的使用模式，如维护作业的开始和结束时间、外部服务的访问频率等。

要实现访问日志（记录已登录用户请求的页面），需完成以下步骤：
1. 调用 Rails 内部日志记录系统。
2. 将该调用放在应用程序代码的合适位置，确保每次页面请求时都能执行，且该位置能判断用户是否已登录。

合适的位置是 ApplicationController 类中的 current_user 前置过滤器。使用 Rails.logger 对象将新条目写入特定环境的日志文件，默认在开发环境下，新条目会写入 log/development.log 文件底部。

Rails 日志记录支持多种严重级别，常见的有 debug 、 info 、 warn 和 error ，可根据需要选择使用。以下是添加了 Rails.logger 语句的 current_user 方法：

def current_user
  return unless session[:user_id]
  @current_user = User.where(session[:user_id]).first

  Rails.logger.info "#{@current_user.name} requested #{request.fullpath} on #{Time.now}"
end

日志字符串由三部分组成：当前用户的名称、用户请求的 URL（不含主机和端口）以及当前日期和时间。只有已登录用户的页面请求才会记录到日志文件中，也可根据需求自定义日志输出格式。

1.3 调试问题解决

在开发过程中，即使添加了大量测试代码，也难以覆盖应用程序的所有方面。遇到问题时，可采用以下两种方法：
- 修复问题后，添加测试用例验证问题是否已解决，避免再次收到相同的错误报告。
- 在尝试修复问题前编写测试用例，确保测试失败时问题仍然存在。

总之，在解决问题后，应向测试套件中添加新测试用例，再继续处理其他问题。

2. 集成测试

2.1 集成测试概述

之前编写的测试代码主要针对控制器动作和模型功能进行孤立测试。为测试涉及多个控制器和模型的场景，Rails 提供了集成测试功能。集成测试验证多个控制器和模型在用户与应用程序交互时的行为，讲述了一个虚构用户的使用故事，包括登录过程、点击链接和执行操作等。从 Rails 5 开始，所有控制器测试默认都是集成测试。

以下是一些集成测试的示例场景：
- 访客尝试提交故事，因未登录被重定向到登录表单，登录后提交故事。
- 用户为特定故事投票，达到首页显示阈值后，访问首页查看该故事是否显示。
- 用户提交带有标签的新故事，提交后访问特定标签页面，检查故事是否在列表中。

2.2 创建集成测试

以创建一个名为 StoriesTest 的集成测试为例，使用 Rails 生成器命令：

$ rails g integration_test stories
Running via Spring preloader in process 74846
      invoke  test_unit
      create    test/integration/stories_test.rb

生成的测试文件为 test/integration/stories_test.rb ，以下是实现“未登录用户尝试提交故事”场景的测试代码：

require "test_helper"
class StoriesTest < ActionController::IntegrationTest
  test "story submission with login" do
    get new_story_path
    assert_response :redirect
    follow_redirect!
    assert_response :success
    post session_path, params: {
      email: 'glenn.goodrich@sitepoint.com', password: 'sekrit'
    }
    follow_redirect!
    assert_response :success
    post stories_path, params: {
      story: {
        name: 'Submission from Integration Test',
        link: 'http://test.com/'
      }
    }
    assert_response :redirect
    follow_redirect!
    assert_response :success
  end
end

集成测试与普通功能测试类似，先执行操作，再验证操作结果是否符合预期。不同之处在于，集成测试使用标准 URL 进行页面请求，将应用程序视为一个整体，测试路由和控制器之间的控制权转移等元素。测试代码中的 follow_redirect! 语句用于跟进重定向。

2.3 运行集成测试

使用 rails test:integration 命令运行集成测试，该命令会与单元测试和功能测试一起执行。以下是测试运行结果示例：

$ rails test:integration
Running via Spring preloader in process 84542
Run options: --seed 59044

# Running:
.
Finished in 0.395582s, 2.5279 runs/s, 20.2234 assertions/s.
1 runs, 5 assertions, 0 failures, 0 errors, 0 skips

集成测试能确保应用程序在功能测试和单元测试之外独立运行，且所有组件都能自动通过测试。

2.4 测试中使用断点

在测试中使用断点与在开发模式中类似，在需要暂停执行的位置添加 byebug 语句。例如，在 stories_test.rb 中添加断点：

class StoriesTest < ActionController::IntegrationTest
  test "story submission with login"
    get new_story_path
    byebug
    # 测试方法主体...
  end
end

使用断点可以方便地探索测试环境，避免在测试中添加大量 puts 语句来输出调试信息，减少重复运行测试的工作量。例如，在断点处可以查看用户的会话和 cookie 信息，执行登录操作等。

2.5 重访 Rails 控制台

Rails 控制台可用于在无头模式下与应用程序交互，就像浏览器与应用程序交互一样。集成测试引入后，控制台默认提供了 app 对象，可将其视为一个空的集成测试。以下是在控制台中使用 app 对象的示例：

>> app.class
=> ActionDispatch::Integration::Session
>> app.get '/'
...Lots of output...
=> 200
>> app.controller
=> StoriesController
>> app.controller.view_assigns["stories"].size
=> 2
>> app.get 'storiesnew'
=> 302
>> app.response.redirect_url
=> "http://www.example.comsessionnew"
>> app.follow_redirect!
=> 200

在使用 app.post 方法登录时，由于 Rails 的安全限制，需要先关闭“请求伪造保护”：

>> ApplicationController.allow_forgery_protection = false
=> false
>> app.post '/session', params: { email: 'glenn.goodrich@sitepoint.com', password: 'sekrit'}
=> 302
>> app.follow_redirect!
=> 200

2.6 总结

通过使用 byebug 调试、Rails 日志记录、集成测试和 Rails 控制台等工具和技术，能更高效地开发和测试 Rails 应用程序，确保应用程序的稳定性和可靠性。在开发过程中，合理运用这些技巧可提高开发效率，减少错误和调试时间。

3. 技术要点总结与流程梳理

3.1 关键技术点总结

技术点	作用	操作示例
byebug 断点调试	暂停程序执行，方便查看变量和调试	(byebug) break app/controllers/votes_controller.rb:7
Rails 日志记录	记录应用程序事件，辅助调试和分析使用模式	Rails.logger.info "#{@current_user.name} requested #{request.fullpath} on #{Time.now}"
集成测试	测试多个控制器和模型交互的场景	编写 StoriesTest 集成测试类
Rails 控制台 app 对象	在无头模式下模拟集成测试	app.get '/'

3.2 操作流程梳理

3.2.1 集成测试创建流程

graph LR
    A[生成集成测试文件] --> B[编写测试代码]
    B --> C[运行测试]
    C --> D{测试是否通过}
    D -- 通过 --> E[完成测试]
    D -- 未通过 --> F[调试代码]
    F --> B

具体步骤如下：
1. 生成集成测试文件：使用 rails g integration_test <test_name> 命令，如 rails g integration_test stories 。
2. 编写测试代码：在生成的测试文件中编写测试用例，如 StoriesTest 类中的 test "story submission with login" 方法。
3. 运行测试：使用 rails test:integration 命令运行集成测试。
4. 判断测试结果：若测试通过，则完成测试；若未通过，需调试代码后重新编写测试。

3.2.2 日志记录实现流程

graph LR
    A[确定日志记录位置] --> B[调用 Rails 日志系统]
    B --> C[设置日志级别和内容]
    C --> D[日志写入文件]

具体步骤如下：
1. 确定日志记录位置：选择 ApplicationController 类中的 current_user 前置过滤器。
2. 调用 Rails 日志系统：使用 Rails.logger 对象。
3. 设置日志级别和内容：如使用 info 级别记录用户请求信息。
4. 日志写入文件：默认在开发环境下，日志会写入 log/development.log 文件底部。

3.3 调试与测试的最佳实践

• 调试方面 ：
  • 合理使用 byebug 断点，在关键位置设置断点，方便查看变量和程序执行流程。
  • 结合日志记录，记录关键事件和变量值，便于后续分析问题。
• 测试方面 ：
  • 编写全面的集成测试用例，覆盖多个控制器和模型的交互场景。
  • 在测试中使用断点，方便调试测试代码，提高测试效率。

3.4 未来应用拓展

• 日志分析 ：可以使用日志分析工具对日志文件进行分析，挖掘用户行为模式和应用程序性能瓶颈。
• 自动化测试 ：结合持续集成工具，实现自动化测试，确保每次代码变更后应用程序的稳定性。

通过以上对 Rails 开发中调试、测试和日志记录技术的深入探讨和总结，我们可以更系统地运用这些技术，提高开发效率和应用程序的质量。在实际开发中，不断实践和优化这些方法，将有助于打造出更加稳定、可靠的 Rails 应用程序。