Trong Ruby có một class có thể giúp bạn theo dõi một số hoạt động như gọi method, khai báo class, exception,… Và class đó là TracePoint. Nó khá hữu ích khi bạn muốn theo dõi và gọi một hàm cụ thể, bạn có thể xem hàm đó được gọi như thế nào, nó trả về gì.
Tạo một TracePoint
Dưới đây là một ví dụ tạo một TracePoint để theo dõi các lần gọi hàm từ một method:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | <span class="token keyword">class</span> <span class="token class-name">Foo</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">bar</span></span> yaa mod <span class="token keyword">end</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">yaa</span></span> mod <span class="token keyword">end</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">mod</span></span> <span class="token keyword">end</span> <span class="token keyword">end</span> trace <span class="token operator">=</span> <span class="token constant">TracePoint</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token symbol">:call</span><span class="token punctuation">)</span> <span class="token keyword">do</span> <span class="token operator">|</span>tp<span class="token operator">|</span> puts <span class="token string">"<span class="token interpolation"><span class="token delimiter tag">#{</span>tp<span class="token punctuation">.</span>defined_class<span class="token delimiter tag">}</span></span>#<span class="token interpolation"><span class="token delimiter tag">#{</span>tp<span class="token punctuation">.</span>method_id<span class="token delimiter tag">}</span></span>"</span> <span class="token keyword">end</span> trace<span class="token punctuation">.</span>enable <span class="token constant">Foo</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">.</span>bar trace<span class="token punctuation">.</span>disable <span class="token comment"># Foo#bar</span> <span class="token comment"># Foo#yaa</span> <span class="token comment"># Foo#mod</span> <span class="token comment"># Foo#mod</span> |
Với event :call bạn có thể theo dõi được các lần Ruby gọi một method bất kỳ. Vì vậy bạn có thể ở trên ta có trace.enable và trace.disable để đảm bảo trace của chúng ta sẽ không theo chạy tất cả mọi lần mỗi lần có phương thức nào đó gọi, mà chỉ giới hạn trong một phạm vi nhất định.
Các sự kiện có thể theo dõi
Bảng bên dưới liệt kê các sự kiện mà TracePoint hỗ trợ (Ruby 2.5.0):
| Tên sự kiện | Mô tả |
|---|---|
| line | Chạy code trên một dòng mới |
| class | Khi bắt đầu định nghĩa một Class hoặc Module |
| end | Khi kết thúc định nghĩa một Class hoặc Module |
| call | Gọi một hàm trong Ruby |
| return | Trả về từ một hàm trong Ruby |
| c_call | Gọi một hàm được viết bằng C |
| c_return | Trả về từ một hàm được viết bằng C |
| raise | Khi bắn ra một exception |
| b_call | Bắt đầu một block |
| b_return | Kết thúc một block |
| thread_begin | Khi bắt đầu một thread |
| thread_end | Khi kết thúc một thread |
| fiber_switch | khi chuyển đổi ngữ cảnh |
Fiber là một class trong Ruby dùng tạo các đoạn code có thể dừng và tiếp tục.
Các phương thức có sẵn
Bảng bên dưới liệt kê các phương thức mà TracePoint hỗ trợ (Ruby 2.5.0):
| Tên phương thức | Mô tả |
|---|---|
| binding | Trả về đối tượng binding tạo ra kèm sự kiện |
| defined_class | Trả về Class hoặc Module mà phương thức đang được gọi |
| disable | Vô hiệu hoá TracePoint |
| enable | Kích hoạt TracePoint |
| enabled? | Kiểm tra trạng thái hoạt động của TracePoint |
| event | Tên sự kiện đang xảy ra |
| inspect | Trả về một chuỗi chứa trạng thái TracePoint |
| lineno | Số dòng xảy ra sự kiện |
| method_id | Tên phương thức được gọi |
| path | Đường dẫn của file đang chạy |
| raised_exception | Giá trị trả về từ Exception của sự kiện :raise |
| return_value | Trả về giá trị từ các sự kiện :return, :c_return, :b_return |
| self | Trả về đối tượng đã tạo ra sự kiện |
Vẽ luồng gọi hàm với TracePoint
Mình đã viết một gem để mô hình hoá một hàm trong ruby, với ví dụ ở đầu bài ta sẽ có:
Ví dụ về hàm tính số Fibonacci:
Code:
1 2 3 4 5 6 | <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">fibonacci</span></span> n <span class="token keyword">return</span> n <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token number">0.</span><span class="token number">.1</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token keyword">include</span><span class="token operator">?</span> n fibonacci<span class="token punctuation">(</span>n <span class="token operator">-</span> <span class="token number">1</span><span class="token punctuation">)</span> <span class="token operator">+</span> fibonacci<span class="token punctuation">(</span>n <span class="token operator">-</span> <span class="token number">2</span><span class="token punctuation">)</span> <span class="token keyword">end</span> |
Kết luận
Hy vọng bài viết có thể giúp bạn hiểu rõ thêm về TracePoint trong Ruby.
Gem mình đã viết