Bài viết gốc Rails Design Patterns: Presenter & Service Objects
Tại sao chúng ta cần sử dụng design patterns?
Vấn đề đó là cấu trúc của Rails, Model-View-Controller cho thấy kết cấu cơ bản để biết vị trí viết code.
Nhưng vẫn chưa đủ, View sẽ trở nên lớn và đầy logic khi mục đích chung chỉ biểu diễn thông tin.
Trong controller chứa chi tiết ngoài những gì cần làm trong controller theo nhiệm vụ cơ bản của nó.
Giải pháp là gì?
Trong bài viết này có 2 giải pháp cho vấn đề trên dưới dạng design patterns.
- Sử dụng presenter pattern
- Sử dụng service object pattern
Không phải ai cũng đồng ý làm sao để thực thi nó nhưng trong bài viết sẽ có bản để có thể hoạt động được. Hãy cùng tìm hiểu các patterns đó.
Sử dụng Presenter trong Rails
các Views để biểu diễn thông tin có nghĩa là các tệp HTML, CSS và ERB(Embedded Ruby).
Chú ý rằng không nên có bất kỳ câu truy vấn ActiveRecord trong các views.
Tất cả logic phải loại bỏ từ views nếu muốn nó sạch sẽ và dễ làm việc. (Logic ở đây có nghĩa là các câu lệch if và toán tử ?:
Bây giờ cách giải quyết xử lý logic trong views đó là sử dụng helpers.
Helpers là hữu ích khi chúng ta có một phương định dạng thức toàn cục có thể sử dụng trong một số các views.
Vd: Biểu diễn định dạng markdown, hiển thị ngày tháng với một định dạng nhất định, xóa một số từ cụ thể từ văn bản, vv…
Cách dùng
Chúng ta có thể để code trong thư mục app/helpers và trong tệp date_helper.rb.
1 2 3 4 5 6 | <span class="token keyword">module</span> <span class="token constant">DateHelper</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">display_date_only_month_year</span></span> date date<span class="token punctuation">.</span>strftime <span class="token string">"%B %Y"</span> <span class="token keyword">end</span> <span class="token keyword">end</span> |
Lời khuyên
Hãy luôn đưa đầu vào cho phương thức helpers qua đối số thay vì dựa vào các biến tức thời. Vì cách này sẽ giúp tránh được nhiều rắc rối
Phương thức Helpers có giới hạn đặc biệt nếu dùng nó cho tất cả định trong các views. Vì helpers có xu hướng xây dựng và thiếu tính tổ chức.
Thay thế các điều kiện và phương thức định dạng phức tạp
Hãy tưởng tự dạng bạn có một đoạn view như sau
1 2 3 4 5 | <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>p</span><span class="token punctuation">></span></span> Post title: <span class="token erb language-erb"><span class="token delimiter punctuation"><%=</span> post<span class="token punctuation">.</span>title<span class="token punctuation">.</span>gsub <span class="token string">"forbidden word"</span><span class="token punctuation">,</span> <span class="token string">""</span> <span class="token delimiter punctuation">%></span></span> <span class="token erb language-erb"><span class="token delimiter punctuation"><%=</span> link_to <span class="token string">"Read post"</span><span class="token punctuation">,</span> post<span class="token punctuation">,</span> <span class="token keyword">class</span><span class="token punctuation">:</span> <span class="token string">"w-75 p-3 text-<span class="token interpolation"><span class="token comment">#{post.draft? ? "orange" : "green"}</span></span> border-<span class="token interpolation"><span class="token comment">#{post.draft? ? "orange" : "green"}</span></span>"</span> <span class="token delimiter punctuation">%></span></span> <span class="token tag"><span class="token tag"><span class="token punctuation"></</span>p</span><span class="token punctuation">></span></span> |
Đoạn code trên ngắn phải không? nhưng khi đọc code thấy phức tạp với các toán tử và lặp lại code. Bad practice
Hãy tạo một presenter class để giải quyết như sau
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | <span class="token keyword">class</span> <span class="token class-name">PostPresenter</span> attr_reader <span class="token symbol">:post</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">initialize</span></span> post <span class="token variable">@post</span> <span class="token operator">=</span> post <span class="token keyword">end</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">title_without_forbidden_words</span></span> post<span class="token punctuation">.</span>title<span class="token punctuation">.</span>gsub <span class="token string">"forbidden word"</span><span class="token punctuation">,</span> <span class="token string">""</span> <span class="token keyword">end</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">css_color</span></span> post<span class="token punctuation">.</span>draft<span class="token operator">?</span> <span class="token operator">?</span> <span class="token string">"orange"</span> <span class="token punctuation">:</span> <span class="token string">"green"</span> <span class="token keyword">end</span> <span class="token keyword">end</span> |
Lưu đoạn code trên trong thư mục app/presenters/post_presenter.rb, tạo thư mục presenters nếu chưa có nhé.
1 2 3 4 5 6 | <span class="token erb language-erb"><span class="token delimiter punctuation"><%</span> presenter <span class="token operator">=</span> <span class="token constant">PostPresenter</span><span class="token punctuation">.</span><span class="token keyword">new</span> post <span class="token delimiter punctuation">%></span></span> <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>p</span><span class="token punctuation">></span></span> Post title: <span class="token erb language-erb"><span class="token delimiter punctuation"><%=</span> presenter<span class="token punctuation">.</span>title_without_forbidden_words <span class="token delimiter punctuation">%></span></span> <span class="token erb language-erb"><span class="token delimiter punctuation"><%=</span> link_to <span class="token string">"Read post"</span><span class="token punctuation">,</span> post<span class="token punctuation">,</span> <span class="token keyword">class</span><span class="token punctuation">:</span> <span class="token string">"w-75 p-3 text-<span class="token interpolation"><span class="token comment">#{presenter.css_color}</span></span> border-<span class="token interpolation"><span class="token comment">#{presenter.css_color}</span></span>"</span> <span class="token delimiter punctuation">%></span></span> <span class="token tag"><span class="token tag"><span class="token punctuation"></</span>p</span><span class="token punctuation">></span></span> |
ưu điểm ở đây là:
- Xóa tất cả logic từ view
- Đặt tên có nghĩa cho định dạng và các toán tử quyết định.
- Tái sử dụng class này trong các views khác mà không lặp lại code
Đây là cách mà dùng presenter trong Rails
Cách sử dụng các Service Subjects
Trong controller nên chỉ chứa những phần cần làm, chúng không nên chứa về cách làm sao để gửi một Tweet, tính phí khách hàng hoặc tạo tệp PDF.
Các xử lý này nên ủy quyền cho một service object.
Một service object là một Ruby module mà đóng gói logic để hoàn thành một hành vi.
Vd:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <span class="token keyword">module</span> <span class="token constant">TwitterSerivce</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token keyword">self</span><span class="token punctuation">.</span><span class="token function">send_welcome_message</span></span> twitter_handle client<span class="token punctuation">.</span>update <span class="token string">"@{twiter_handle} welcome to 'Dev studio', we hope you enjoy our music!"</span> <span class="token keyword">end</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token keyword">self</span><span class="token punctuation">.</span><span class="token function">client</span></span> <span class="token variable">@client</span> <span class="token operator">||</span><span class="token operator">=</span> <span class="token constant">Twitter</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">REST</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Client</span><span class="token punctuation">.</span><span class="token keyword">new</span> <span class="token keyword">do</span> <span class="token operator">|</span>config<span class="token operator">|</span> config<span class="token punctuation">.</span>consumer_key <span class="token operator">=</span> <span class="token string">"..."</span> config<span class="token punctuation">.</span>consumer_secret <span class="token operator">=</span> <span class="token string">"..."</span> config<span class="token punctuation">.</span>access_token <span class="token operator">=</span> <span class="token string">"..."</span> config<span class="token punctuation">.</span>access_token_secret <span class="token operator">=</span> <span class="token string">"..."</span> <span class="token keyword">end</span> <span class="token keyword">end</span> <span class="token keyword">end</span> |
Để tiện hãy lưu code dưới thư mục app/services và tên tệp twitter_service.rb.
Tại sao phải dùng cách trên? vì Rails autoloads tất cả từ thư mục app/, code trên sẽ sẵn có trong các controllers.
Trong controller chúng ta có thể sử dụng như sau
1 2 3 4 5 6 | <span class="token keyword">class</span> <span class="token class-name">UsersController</span> <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">create</span></span> <span class="token constant">TwitterService</span><span class="token punctuation">.</span>send_welcome_message user<span class="token punctuation">.</span>twitter_handle <span class="token keyword">end</span> <span class="token keyword">end</span> |
Đây là hành vi của service object.
Kết luận
Trong bài viết đã đưa hai pattern Rails giúp chúng ta cải tiến chất lượng code trong dự án. Hãy áp dụng nó bây giờ.
Cảm ơn các bạn đã đọc