1 用於除錯的視圖輔助方法
一個常見的任務是檢查變數的內容。Rails 提供了三種不同的方式來執行此操作
debugto_yamlinspect
1.1 debug
debug 輔助方法將返回一個 <pre> 標籤，該標籤使用 YAML 格式呈現物件。這將從任何物件產生人類可讀取的資料。例如，如果您在視圖中有以下程式碼
<%= debug @article %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>
您將看到類似以下內容
--- !ruby/object Article
attributes:
updated_at: 2008-09-05 22:55:47
body: It's a very helpful guide for debugging your Rails app.
title: Rails debugging guide
published: t
id: "1"
created_at: 2008-09-05 22:55:47
attributes_cache: {}
Title: Rails debugging guide
1.2 to_yaml
或者，在任何物件上呼叫 to_yaml 都會將其轉換為 YAML。您可以將此轉換後的物件傳遞到 simple_format 輔助方法來格式化輸出。這就是 debug 發揮其魔力的方式。
<%= simple_format @article.to_yaml %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>
上述程式碼將呈現類似以下內容
--- !ruby/object Article
attributes:
updated_at: 2008-09-05 22:55:47
body: It's a very helpful guide for debugging your Rails app.
title: Rails debugging guide
published: t
id: "1"
created_at: 2008-09-05 22:55:47
attributes_cache: {}
Title: Rails debugging guide
1.3 inspect
另一個用於顯示物件值的有用方法是 inspect，尤其是在處理陣列或雜湊時。這將以字串形式列印物件值。例如
<%= [1, 2, 3, 4, 5].inspect %>
<p>
<b>Title:</b>
<%= @article.title %>
</p>
將呈現
[1, 2, 3, 4, 5]
Title: Rails debugging guide
2 記錄器
在執行時將資訊儲存到記錄檔也很有用。Rails 為每個執行時環境維護一個單獨的記錄檔。
2.1 什麼是記錄器？
Rails 使用 ActiveSupport::Logger 類別來寫入記錄資訊。也可以替換其他記錄器，例如 Log4r。
您可以在 config/application.rb 或任何其他環境檔案中指定替代記錄器，例如
config.logger = Logger.new(STDOUT)
config.logger = Log4r::Logger.new("Application Log")
或者在 Initializer 區段中，新增以下任何項目
Rails.logger = Logger.new(STDOUT)
Rails.logger = Log4r::Logger.new("Application Log")
預設情況下，每個記錄都會在 Rails.root/log/ 下建立，並且記錄檔會以應用程式執行所在的環境命名。
2.2 記錄層級
記錄某個內容時，如果訊息的記錄層級等於或高於設定的記錄層級，則會將其列印到對應的記錄中。如果您想知道目前的記錄層級，可以呼叫 Rails.logger.level 方法。
可用的記錄層級為：:debug、:info、:warn、:error、:fatal 和 :unknown，分別對應於從 0 到 5 的記錄層級編號。若要變更預設記錄層級，請使用
config.log_level = :warn # In any environment initializer, or
Rails.logger.level = 0 # at any time
當您想要在開發或預備環境下記錄，而不會讓您的生產記錄充斥著不必要的資訊時，這會很有用。
預設的 Rails 記錄層級為 :debug。但是，在預設產生的 config/environments/production.rb 中，生產環境會設定為 :info。
2.3 傳送訊息
若要在目前的記錄中寫入，請在控制器、模型或郵件程式中使用 logger.(debug|info|warn|error|fatal|unknown) 方法
logger.debug "Person attributes hash: #{@person.attributes.inspect}"
logger.info "Processing the request..."
logger.fatal "Terminating application, raised unrecoverable error!!!"
以下是一個使用額外記錄來儀器化的方法範例
class ArticlesController < ApplicationController
# ...
def create
@article = Article.new(article_params)
logger.debug "New article: #{@article.attributes.inspect}"
logger.debug "Article should be valid: #{@article.valid?}"
if @article.save
logger.debug "The article was saved and now the user is going to be redirected..."
redirect_to @article, notice: 'Article was successfully created.'
else
render :new, status: :unprocessable_entity
end
end
# ...
private
def article_params
params.expect(article: [:title, :body, :published])
end
end
以下是執行此控制器動作時產生的記錄範例
Started POST "/articles" for 127.0.0.1 at 2018-10-18 20:09:23 -0400
Processing by ArticlesController#create as HTML
Parameters: {"utf8"=>"✓", "authenticity_token"=>"XLveDrKzF1SwaiNRPTaMtkrsTzedtebPPkmxEFIU0ordLjICSnXsSNfrdMa4ccyBjuGwnnEiQhEoMN6H1Gtz3A==", "article"=>{"title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>"0"}, "commit"=>"Create Article"}
New article: {"id"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs.", "published"=>false, "created_at"=>nil, "updated_at"=>nil}
Article should be valid: true
(0.0ms) begin transaction
↳ app/controllers/articles_controller.rb:31
Article Create (0.5ms) INSERT INTO "articles" ("title", "body", "published", "created_at", "updated_at") VALUES (?, ?, ?, ?, ?) [["title", "Debugging Rails"], ["body", "I'm learning how to print in logs."], ["published", 0], ["created_at", "2018-10-19 00:09:23.216549"], ["updated_at", "2018-10-19 00:09:23.216549"]]
↳ app/controllers/articles_controller.rb:31
(2.3ms) commit transaction
↳ app/controllers/articles_controller.rb:31
The article was saved and now the user is going to be redirected...
Redirected to https://127.0.0.1:3000/articles/1
Completed 302 Found in 4ms (ActiveRecord: 0.8ms)
新增像這樣的額外記錄可讓您輕鬆地在記錄中搜尋意外或不尋常的行為。如果新增額外的記錄，請務必合理使用記錄層級，以避免讓生產記錄充滿無用的瑣事。
2.4 詳細查詢記錄
在記錄中查看資料庫查詢輸出時，可能無法立即清楚了解為什麼在呼叫單一方法時會觸發多個資料庫查詢
irb(main):001:0> Article.pamplemousse
Article Load (0.4ms) SELECT "articles".* FROM "articles"
Comment Load (0.2ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 1]]
Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 2]]
Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 3]]
=> #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10">
在 bin/rails console 會話中執行 ActiveRecord.verbose_query_logs = true 以啟用詳細查詢記錄，並再次執行該方法後，很明顯是哪一行程式碼正在產生所有這些離散的資料庫呼叫
irb(main):003:0> Article.pamplemousse
Article Load (0.2ms) SELECT "articles".* FROM "articles"
↳ app/models/article.rb:5
Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 1]]
↳ app/models/article.rb:6
Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 2]]
↳ app/models/article.rb:6
Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 3]]
↳ app/models/article.rb:6
=> #<Comment id: 2, author: "1", body: "Well, actually...", article_id: 1, created_at: "2018-10-19 00:56:10", updated_at: "2018-10-19 00:56:10">
在每個資料庫語句下方，您可以看到箭頭指向導致資料庫呼叫的方法的特定來源檔案名稱 (和行號)。這可以協助您識別並解決由 N+1 查詢所造成的效能問題：產生多個額外查詢的單一資料庫查詢。
在 Rails 5.2 之後，詳細查詢記錄在開發環境記錄中預設為啟用。
我們建議不要在生產環境中使用此設定。它依賴於 Ruby 的 Kernel#caller 方法，該方法往往會配置大量記憶體，以便產生方法呼叫的堆疊追蹤。請改用查詢記錄標籤 (請參閱下方)。
2.5 詳細佇列記錄
與上述「詳細查詢記錄」類似，允許列印將背景工作加入佇列的方法的來源位置。
它在開發中預設為啟用。若要在其他環境中啟用，請在 application.rb 或任何環境初始化程式中新增
config.active_job.verbose_enqueue_logs = true
與詳細查詢記錄一樣，不建議在生產環境中使用。
3 SQL 查詢註解
SQL 語句可以使用包含執行階段資訊 (例如控制器或工作的名稱) 的標籤進行註解，以便將有問題的查詢追溯到產生這些語句的應用程式區域。當您記錄緩慢查詢時 (例如 MySQL、PostgreSQL)、查看目前正在執行的查詢或用於端對端追蹤工具時，這會很有用。
若要啟用，請在 application.rb 或任何環境初始化程式中新增
config.active_record.query_log_tags_enabled = true
預設情況下，會記錄應用程式的名稱、控制器的名稱和動作或工作的名稱。預設格式為 SQLCommenter。例如
Article Load (0.2ms) SELECT "articles".* FROM "articles" /*application='Blog',controller='articles',action='index'*/
Article Update (0.3ms) UPDATE "articles" SET "title" = ?, "updated_at" = ? WHERE "posts"."id" = ? /*application='Blog',job='ImproveTitleJob'*/ [["title", "Improved Rails debugging guide"], ["updated_at", "2022-10-16 20:25:40.091371"], ["id", 1]]
ActiveRecord::QueryLogs 的行為可以修改為包含任何有助於將 SQL 查詢中的點連線起來的項目，例如應用程式記錄的要求和工作 ID、帳戶和租用戶識別碼等等。
3.1 標記記錄
在執行多用戶、多帳戶應用程式時，通常需要能夠使用某些自訂規則來篩選記錄。Active Support 中的 TaggedLogging 可協助您執行此操作，方法是在記錄行中標記子網域、請求 ID 以及其他任何有助於除錯此類應用程式的項目。
logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged("BCX") { logger.info "Stuff" } # Logs "[BCX] Stuff"
logger.tagged("BCX", "Jason") { logger.info "Stuff" } # Logs "[BCX] [Jason] Stuff"
logger.tagged("BCX") { logger.tagged("Jason") { logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff"
3.2 記錄對效能的影響
記錄始終會對 Rails 應用程式的效能產生輕微的影響，特別是當記錄到磁碟時。此外，還有一些細微之處
使用 :debug 等級會比 :fatal 等級產生更大的效能損耗，因為會有更多字串被評估並寫入日誌輸出（例如：磁碟）。
另一個潛在的陷阱是在程式碼中過度呼叫 Logger。
logger.debug "Person attributes hash: #{@person.attributes.inspect}"
在上面的例子中，即使允許的輸出等級不包含 debug，仍然會對效能產生影響。原因是 Ruby 必須評估這些字串，這包括實例化相對較重的 String 物件並插入變數。
因此，建議將區塊傳遞給 logger 方法，因為只有在輸出等級與允許等級相同或包含在允許等級中時，才會評估這些區塊（即延遲載入）。重新編寫的相同程式碼會是這樣：
logger.debug { "Person attributes hash: #{@person.attributes.inspect}" }
只有在啟用 debug 時，才會評估區塊的內容，以及字串插入。這種效能節省只有在大量記錄時才會真正顯著，但這是一個值得採用的好習慣。
本節由 Stack Overflow 上的 Jon Cairns 所撰寫，並根據 cc by-sa 4.0 授權。
4 使用 debug Gem 進行除錯
當你的程式碼行為異常時，你可以嘗試列印到日誌或主控台來診斷問題。不幸的是，有時這種錯誤追蹤方法並不能有效地找到問題的根本原因。當你真的需要深入運行中的原始碼時，除錯器是你最好的夥伴。
如果你想了解 Rails 原始碼但不知道從哪裡開始，除錯器也可以幫助你。只要除錯任何對你的應用程式的請求，並使用本指南來學習如何從你編寫的程式碼進入底層的 Rails 程式碼。
Rails 7 在由 CRuby 生成的新應用程式的 Gemfile 中包含 debug gem。預設情況下，它在 development 和 test 環境中已準備就緒。請查閱其 文件 以了解用法。
4.1 進入除錯會話
預設情況下，除錯會話會在需要 debug 函式庫之後開始，這會在你應用程式啟動時發生。但別擔心，這個會話不會干擾你的應用程式。
要進入除錯會話，你可以使用 binding.break 及其別名：binding.b 和 debugger。以下範例將使用 debugger
class PostsController < ApplicationController
before_action :set_post, only: %i[ show edit update destroy ]
# GET /posts or /posts.json
def index
@posts = Post.all
debugger
end
# ...
end
一旦你的應用程式評估了除錯陳述式，它就會進入除錯會話。
Processing by PostsController#index as HTML
[2, 11] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
2| before_action :set_post, only: %i[ show edit update destroy ]
3|
4| # GET /posts or /posts.json
5| def index
6| @posts = Post.all
=> 7| debugger
8| end
9|
10| # GET /posts/1 or /posts/1.json
11| def show
=>#0 PostsController#index at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:7
#1 ActionController::BasicImplicitRender#send_action(method="index", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-8.0.0.alpha/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg)
你可以隨時退出除錯會話，並使用 continue (或 c) 命令繼續執行你的應用程式。或者，要退出除錯會話和你的應用程式，請使用 quit (或 q) 命令。
4.2 上下文
進入除錯會話後，你可以輸入 Ruby 程式碼，就像你在 Rails 主控台或 IRB 中一樣。
(rdbg) @posts # ruby
[]
(rdbg) self
#<PostsController:0x0000000000aeb0>
(rdbg)
你也可以使用 p 或 pp 命令來評估 Ruby 表達式，當變數名稱與除錯器命令衝突時，這很有用。
(rdbg) p headers # command
=> {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"1; mode=block", "X-Content-Type-Options"=>"nosniff", "X-Download-Options"=>"noopen", "X-Permitted-Cross-Domain-Policies"=>"none", "Referrer-Policy"=>"strict-origin-when-cross-origin"}
(rdbg) pp headers # command
{"X-Frame-Options"=>"SAMEORIGIN",
"X-XSS-Protection"=>"1; mode=block",
"X-Content-Type-Options"=>"nosniff",
"X-Download-Options"=>"noopen",
"X-Permitted-Cross-Domain-Policies"=>"none",
"Referrer-Policy"=>"strict-origin-when-cross-origin"}
(rdbg)
除了直接評估之外，除錯器還透過不同的命令幫助你收集豐富的資訊，例如：
info(或i) - 關於目前框架的資訊。backtrace(或bt) - 回溯 (包含額外資訊)。outline(或o、ls) - 目前範圍中可用的方法、常數、區域變數和實例變數。
4.2.1 info 命令
info 提供從目前框架可見的區域變數和實例變數的值的概觀。
(rdbg) info # command
%self = #<PostsController:0x0000000000af78>
@_action_has_layout = true
@_action_name = "index"
@_config = {}
@_lookup_context = #<ActionView::LookupContext:0x00007fd91a037e38 @details_key=nil, @digest_cache=...
@_request = #<ActionDispatch::Request GET "https://127.0.0.1:3000/posts" for 127.0.0.1>
@_response = #<ActionDispatch::Response:0x00007fd91a03ea08 @mon_data=#<Monitor:0x00007fd91a03e8c8>...
@_response_body = nil
@_routes = nil
@marked_for_same_origin_verification = true
@posts = []
@rendered_format = nil
4.2.2 backtrace 命令
當不使用任何選項時，backtrace 會列出堆疊上的所有框架。
=>#0 PostsController#index at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:7
#1 ActionController::BasicImplicitRender#send_action(method="index", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-2.0.alpha/lib/action_controller/metal/basic_implicit_render.rb:6
#2 AbstractController::Base#process_action(method_name="index", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-8.0.0.alpha/lib/abstract_controller/base.rb:214
#3 ActionController::Rendering#process_action(#arg_rest=nil) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-8.0.0.alpha/lib/action_controller/metal/rendering.rb:53
#4 block in process_action at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-8.0.0.alpha/lib/abstract_controller/callbacks.rb:221
#5 block in run_callbacks at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activesupport-8.0.0.alpha/lib/active_support/callbacks.rb:118
#6 ActionText::Rendering::ClassMethods#with_renderer(renderer=#<PostsController:0x0000000000af78>) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actiontext-8.0.0.alpha/lib/action_text/rendering.rb:20
#7 block {|controller=#<PostsController:0x0000000000af78>, action=#<Proc:0x00007fd91985f1c0 /Users/st0012/...|} in <class:Engine> (4 levels) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actiontext-8.0.0.alpha/lib/action_text/engine.rb:69
#8 [C] BasicObject#instance_exec at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activesupport-8.0.0.alpha/lib/active_support/callbacks.rb:127
..... and more
每個框架都帶有：
- 框架識別碼
- 呼叫位置
- 額外資訊 (例如：區塊或方法參數)
這將讓你對你的應用程式中正在發生的事情有很好的了解。但是，你可能會注意到：
- 框架太多了 (在 Rails 應用程式中通常有 50 個以上)。
- 大多數框架來自 Rails 或你使用的其他函式庫。
backtrace 命令提供 2 個選項來幫助你篩選框架：
backtrace [num]- 僅顯示num個框架，例如backtrace 10。backtrace /pattern/- 僅顯示具有與模式匹配的識別碼或位置的框架，例如backtrace /MyModel/。
也可以一起使用這些選項：backtrace [num] /pattern/。
4.2.3 outline 命令
outline 類似於 pry 和 irb 的 ls 命令。它會顯示從目前範圍可以存取的所有內容，包括：
- 區域變數
- 實例變數
- 類別變數
- 方法及其來源
ActiveSupport::Configurable#methods: config
AbstractController::Base#methods:
action_methods action_name action_name= available_action? controller_path inspect
response_body
ActionController::Metal#methods:
content_type content_type= controller_name dispatch headers
location location= media_type middleware_stack middleware_stack=
middleware_stack? performed? request request= reset_session
response response= response_body= response_code session
set_request! set_response! status status= to_a
ActionView::ViewPaths#methods:
_prefixes any_templates? append_view_path details_for_lookup formats formats= locale
locale= lookup_context prepend_view_path template_exists? view_paths
AbstractController::Rendering#methods: view_assigns
# .....
PostsController#methods: create destroy edit index new show update
instance variables:
@_action_has_layout @_action_name @_config @_lookup_context @_request
@_response @_response_body @_routes @marked_for_same_origin_verification @posts
@rendered_format
class variables: @@raise_on_open_redirects
4.3 中斷點
有很多方法可以在除錯器中插入和觸發中斷點。除了直接在你的程式碼中新增除錯陳述式 (例如 debugger) 之外，你也可以使用命令插入中斷點：
break(或b)break- 列出所有中斷點break <num>- 在目前檔案的第num行設定中斷點break <file:num>- 在file的第num行設定中斷點break <Class#method>或break <Class.method>- 在Class#method或Class.method設定中斷點break <expr>.<method>- 在<expr>結果的<method>方法上設定中斷點。
catch <Exception>- 設定當Exception引發時會停止的中斷點watch <@ivar>- 設定當目前物件的@ivar結果變更時會停止的中斷點 (這很慢)
要移除它們，你可以使用：
delete(或del)delete- 刪除所有中斷點delete <num>- 刪除 ID 為num的中斷點
4.3.1 break 命令
在指定的行號設定中斷點 - 例如 b 28
[20, 29] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
20| end
21|
22| # POST /posts or /posts.json
23| def create
24| @post = Post.new(post_params)
=> 25| debugger
26|
27| respond_to do |format|
28| if @post.save
29| format.html { redirect_to @post, notice: "Post was successfully created." }
=>#0 PostsController#create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:25
#1 ActionController::BasicImplicitRender#send_action(method="create", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg) b 28 # break command
#0 BP - Line /Users/st0012/projects/rails-guide-example/app/controllers/posts_controller.rb:28 (line)
(rdbg) c # continue command
[23, 32] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
23| def create
24| @post = Post.new(post_params)
25| debugger
26|
27| respond_to do |format|
=> 28| if @post.save
29| format.html { redirect_to @post, notice: "Post was successfully created." }
30| format.json { render :show, status: :created, location: @post }
31| else
32| format.html { render :new, status: :unprocessable_entity }
=>#0 block {|format=#<ActionController::MimeResponds::Collec...|} in create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:28
#1 ActionController::MimeResponds#respond_to(mimes=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/mime_responds.rb:205
# and 74 frames (use `bt' command for all frames)
Stop by #0 BP - Line /Users/st0012/projects/rails-guide-example/app/controllers/posts_controller.rb:28 (line)
在給定的方法呼叫設定中斷點 - 例如 b @post.save。
[20, 29] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
20| end
21|
22| # POST /posts or /posts.json
23| def create
24| @post = Post.new(post_params)
=> 25| debugger
26|
27| respond_to do |format|
28| if @post.save
29| format.html { redirect_to @post, notice: "Post was successfully created." }
=>#0 PostsController#create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:25
#1 ActionController::BasicImplicitRender#send_action(method="create", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg) b @post.save # break command
#0 BP - Method @post.save at /Users/st0012/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/suppressor.rb:43
(rdbg) c # continue command
[39, 48] in ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/suppressor.rb
39| SuppressorRegistry.suppressed[name] = previous_state
40| end
41| end
42|
43| def save(**) # :nodoc:
=> 44| SuppressorRegistry.suppressed[self.class.name] ? true : super
45| end
46|
47| def save!(**) # :nodoc:
48| SuppressorRegistry.suppressed[self.class.name] ? true : super
=>#0 ActiveRecord::Suppressor#save(#arg_rest=nil) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/suppressor.rb:44
#1 block {|format=#<ActionController::MimeResponds::Collec...|} in create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:28
# and 75 frames (use `bt' command for all frames)
Stop by #0 BP - Method @post.save at /Users/st0012/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/suppressor.rb:43
4.3.2 catch 命令
當引發例外狀況時停止 - 例如 catch ActiveRecord::RecordInvalid。
[20, 29] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
20| end
21|
22| # POST /posts or /posts.json
23| def create
24| @post = Post.new(post_params)
=> 25| debugger
26|
27| respond_to do |format|
28| if @post.save!
29| format.html { redirect_to @post, notice: "Post was successfully created." }
=>#0 PostsController#create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:25
#1 ActionController::BasicImplicitRender#send_action(method="create", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg) catch ActiveRecord::RecordInvalid # command
#1 BP - Catch "ActiveRecord::RecordInvalid"
(rdbg) c # continue command
[75, 84] in ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb
75| def default_validation_context
76| new_record? ? :create : :update
77| end
78|
79| def raise_validation_error
=> 80| raise(RecordInvalid.new(self))
81| end
82|
83| def perform_validations(options = {})
84| options[:validate] == false || valid?(options[:context])
=>#0 ActiveRecord::Validations#raise_validation_error at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:80
#1 ActiveRecord::Validations#save!(options={}) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:53
# and 88 frames (use `bt' command for all frames)
Stop by #1 BP - Catch "ActiveRecord::RecordInvalid"
4.3.3 watch 命令
當實例變數變更時停止 - 例如 watch @_response_body。
[20, 29] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
20| end
21|
22| # POST /posts or /posts.json
23| def create
24| @post = Post.new(post_params)
=> 25| debugger
26|
27| respond_to do |format|
28| if @post.save!
29| format.html { redirect_to @post, notice: "Post was successfully created." }
=>#0 PostsController#create at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:25
#1 ActionController::BasicImplicitRender#send_action(method="create", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg) watch @_response_body # command
#0 BP - Watch #<PostsController:0x00007fce69ca5320> @_response_body =
(rdbg) c # continue command
[173, 182] in ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal.rb
173| body = [body] unless body.nil? || body.respond_to?(:each)
174| response.reset_body!
175| return unless body
176| response.body = body
177| super
=> 178| end
179|
180| # Tests if render or redirect has already happened.
181| def performed?
182| response_body || response.committed?
=>#0 ActionController::Metal#response_body=(body=["<html><body>You are being <a href=\"ht...) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal.rb:178 #=> ["<html><body>You are being <a href=\"ht...
#1 ActionController::Redirecting#redirect_to(options=#<Post id: 13, title: "qweqwe", content:..., response_options={:allow_other_host=>false}) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/redirecting.rb:74
# and 82 frames (use `bt' command for all frames)
Stop by #0 BP - Watch #<PostsController:0x00007fce69ca5320> @_response_body = -> ["<html><body>You are being <a href=\"https://127.0.0.1:3000/posts/13\">redirected</a>.</body></html>"]
(rdbg)
4.3.4 中斷點選項
除了不同類型中斷點之外，你還可以指定選項來實現更進階的除錯工作流程。目前，除錯器支援 4 個選項：
do: <cmd or expr>- 當觸發中斷點時，執行給定的命令/表達式並繼續程式break Foo#bar do: bt- 當呼叫Foo#bar時，列印堆疊框架。
pre: <cmd or expr>- 當觸發中斷點時，在停止之前執行給定的命令/表達式break Foo#bar pre: info- 當呼叫Foo#bar時，在停止之前列印其周圍的變數。
if: <expr>- 只有當<expr>的結果為 true 時，中斷點才會停止break Post#save if: params[:debug]- 如果params[:debug]也為 true，則在Post#save停止。
path: <path_regexp>- 只有當觸發中斷點的事件 (例如方法呼叫) 發生在給定的路徑時，中斷點才會停止break Post#save path: app/services/a_service- 如果方法呼叫發生在包含app/services/a_service的路徑中，則在Post#save停止。
另請注意，前 3 個選項：do:、pre: 和 if: 也適用於我們之前提到的除錯陳述式。例如：
[2, 11] in ~/projects/rails-guide-example/app/controllers/posts_controller.rb
2| before_action :set_post, only: %i[ show edit update destroy ]
3|
4| # GET /posts or /posts.json
5| def index
6| @posts = Post.all
=> 7| debugger(do: "info")
8| end
9|
10| # GET /posts/1 or /posts/1.json
11| def show
=>#0 PostsController#index at ~/projects/rails-guide-example/app/controllers/posts_controller.rb:7
#1 ActionController::BasicImplicitRender#send_action(method="index", args=[]) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/actionpack-7.0.0.alpha2/lib/action_controller/metal/basic_implicit_render.rb:6
# and 72 frames (use `bt' command for all frames)
(rdbg:binding.break) info
%self = #<PostsController:0x00000000017480>
@_action_has_layout = true
@_action_name = "index"
@_config = {}
@_lookup_context = #<ActionView::LookupContext:0x00007fce3ad336b8 @details_key=nil, @digest_cache=...
@_request = #<ActionDispatch::Request GET "https://127.0.0.1:3000/posts" for 127.0.0.1>
@_response = #<ActionDispatch::Response:0x00007fce3ad397e8 @mon_data=#<Monitor:0x00007fce3ad396a8>...
@_response_body = nil
@_routes = nil
@marked_for_same_origin_verification = true
@posts = #<ActiveRecord::Relation [#<Post id: 2, title: "qweqwe", content: "qweqwe", created_at: "...
@rendered_format = nil
4.3.5 編寫除錯工作流程程式
透過這些選項，你可以用一行程式碼編寫你的除錯工作流程，例如：
def create
debugger(do: "catch ActiveRecord::RecordInvalid do: bt 10")
# ...
end
然後除錯器將執行腳本命令並插入 catch 中斷點
(rdbg:binding.break) catch ActiveRecord::RecordInvalid do: bt 10
#0 BP - Catch "ActiveRecord::RecordInvalid"
[75, 84] in ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb
75| def default_validation_context
76| new_record? ? :create : :update
77| end
78|
79| def raise_validation_error
=> 80| raise(RecordInvalid.new(self))
81| end
82|
83| def perform_validations(options = {})
84| options[:validate] == false || valid?(options[:context])
=>#0 ActiveRecord::Validations#raise_validation_error at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:80
#1 ActiveRecord::Validations#save!(options={}) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:53
# and 88 frames (use `bt' command for all frames)
一旦觸發 catch 中斷點，它將列印堆疊框架
Stop by #0 BP - Catch "ActiveRecord::RecordInvalid"
(rdbg:catch) bt 10
=>#0 ActiveRecord::Validations#raise_validation_error at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:80
#1 ActiveRecord::Validations#save!(options={}) at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/validations.rb:53
#2 block in save! at ~/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/activerecord-7.0.0.alpha2/lib/active_record/transactions.rb:302
這種技術可以讓你免於重複手動輸入，並使除錯體驗更加順暢。
你可以在其 文件 中找到更多命令和組態選項。
5 使用 web-console Gem 進行除錯
Web Console 有點像 debug，但它在瀏覽器中執行。你可以在任何頁面上請求在視圖或控制器的上下文中開啟主控台。主控台會呈現在你的 HTML 內容旁邊。
5.1 主控台
在任何控制器動作或視圖中，你可以呼叫 console 方法來調用主控台。
例如，在控制器中：
class PostsController < ApplicationController
def new
console
@post = Post.new
end
end
或在視圖中：
<% console %>
<h2>New Post</h2>
這將在你的視圖內呈現一個主控台。你不需要關心 console 呼叫的位置；它不會在其調用的位置呈現，而是呈現在你的 HTML 內容旁邊。
主控台執行純 Ruby 程式碼：你可以定義和實例化自訂類別、建立新模型以及檢查變數。
每個請求只能呈現一個主控台。否則，web-console 會在第二次 console 調用時引發錯誤。
5.2 檢查變數
你可以調用 instance_variables 來列出你的上下文中可用的所有實例變數。如果你想列出所有區域變數，可以使用 local_variables 來執行。
5.3 設定
config.web_console.allowed_ips: 授權的 IPv4 或 IPv6 地址和網路清單 (預設值:127.0.0.1/8, ::1)。config.web_console.whiny_requests: 當阻止主控台呈現時，記錄訊息 (預設值:true)。
由於 web-console 在伺服器上遠端評估純 Ruby 程式碼，因此請勿嘗試在生產環境中使用它。
6 除錯記憶體洩漏
Ruby 應用程式 (無論是否在 Rails 上) 都可能洩漏記憶體，無論是在 Ruby 程式碼中還是在 C 程式碼層級。
在本節中，您將學習如何使用 Valgrind 等工具來尋找並修復此類洩漏。
6.1 Valgrind
Valgrind 是一個用於檢測基於 C 的記憶體洩漏和競爭條件的應用程式。
Valgrind 提供多種工具，可以自動檢測許多記憶體管理和執行緒錯誤，並詳細分析您的程式。例如，如果直譯器中的 C 擴充功能呼叫了 malloc() 但沒有正確呼叫 free()，則該記憶體在應用程式終止之前將無法使用。
有關如何安裝 Valgrind 並與 Ruby 搭配使用的更多資訊，請參考 Evan Weaver 的 Valgrind and Ruby。
6.2 尋找記憶體洩漏
Derailed 有一篇關於偵測和修復記憶體洩漏的優秀文章，您可以在此處閱讀。
7 除錯外掛程式
有一些 Rails 外掛程式可以幫助您尋找錯誤並除錯您的應用程式。以下是一些用於除錯的實用外掛程式列表：
- Query Trace 將查詢來源追蹤添加到您的日誌中。
- Exception Notifier 提供一個郵件程式物件和一組預設範本，用於在 Rails 應用程式中發生錯誤時發送電子郵件通知。
- Better Errors 用一個包含更多上下文資訊的新頁面替換標準的 Rails 錯誤頁面，例如原始碼和變數檢視。
- RailsPanel 適用於 Rails 開發的 Chrome 擴充功能，它將結束您對 development.log 的追蹤。在瀏覽器的「開發人員工具」面板中，獲取有關 Rails 應用程式請求的所有資訊。提供對資料庫/渲染/總時間、參數列表、渲染視圖等的深入了解。
- Pry 一個 IRB 的替代品和執行時開發人員控制台。