Computer >> Hướng Dẫn Máy Tính >  >> Lập Trình >> Ruby

Các kịch bản một lần hiệu quả trong Rails: Hướng dẫn các tác vụ ad-hoc

Bạn có bao giờ muốn nhập một loạt dữ liệu vào ứng dụng từ file CSV? Hoặc bạn cần sửa các ký tự bị mã hóa sai trong một số đánh giá của khách hàng. Hoặc bạn thay đổi ý định về cách lưu trữ dữ liệu trong Redis, và phải di chuyển mọi thứ từ định dạng cũ sang định dạng mới.

Tại Avvo, chúng tôi gọi đây là "tác vụ ad-hoc". Nghĩa là, bạn có thể chỉ cần chạy chúng một lần. Vậy cách tốt nhất để xử lý tác vụ ad-hoc trong Rails là gì?

Viết một migration cơ sở dữ liệu

Migration hoạt động tốt nếu bạn cần thay đổi cấu trúc dữ liệu trong cơ sở dữ liệu. Nó theo dõi xem tác vụ đã chạy chưa, nó mang thay đổi sang các môi trường khác – đó là thứ migration được xây dựng cho. Đó cũng là thứ bạn có thể đã dùng chúng cho.

Nếu bạn thay đổi dữ liệu cùng lúc, migration có thể hoạt động tốt. Nhưng có một số điều cần chú ý.

Gọi thứ như Permissions.create(...) trong migration có thể gây rắc rối. Nếu model đã thay đổi, migration của bạn có thể bị hỏng, vì model của bạn có thể không khả dụng khi migration chạy. Hoặc model của bạn có thể đã thay đổi giữa lúc bạn viết migration và khi nó chạy. Có cách để khắc phục, nhưng chúng dễ gây lỗi và có thể thất bại theo cách kỳ lạ.

Migration cũng kém hữu ích hơn nếu tác vụ của bạn không liên quan đến ActiveRecord.

Những điều này không phải là rào cản tuyệt đối. Nhưng tôi có xu hướng không nhập hoặc thay đổi nhiều dữ liệu trong migration. Có các lựa chọn tốt hơn.

Viết một rake task

Bạn có một tác vụ. Bạn có thể chỉ muốn chạy nó một lần. Và bạn muốn có thể kiểm thử nó trên máy của mình và chạy nó trong production.

Rake task hoạt động rất tốt cho việc này. Rails thậm chí có thể tạo rake task cho bạn:

$ be rails g task locations import create lib/tasks/locations.rake

Điều này tạo một file để bạn nhét mã của mình vào:

lib/tasks/locations.rake
namespace :locations do desc "TODO" task import: :environment do end end

Bên trong khối task đó, bạn có thể sử dụng tất cả model và phần còn lại của mã trong ứng dụng Rails của bạn. Việc nhập và thay đổi dữ liệu dễ dàng, vì bạn có thể viết mã giống như đang ngồi tại console Rails.

Khi bạn đã viết xong task, bạn có thể chạy nó với rake locations:import. Nếu bạn dùng Heroku, bạn có thể chạy với heroku run rake locations:import. Nếu bạn dùng Capistrano, bạn có thể dùng gem capistrano-rake để chạy task. Bạn có thể có một lựa chọn thậm chí tốt hơn.

Viết một công việc theo lịch, sử dụng sidekiq-scheduler

Nếu ứng dụng của bạn đủ lớn, bạn có thể đã dùng Sidekiq, Resque, hoặc thứ gì đó tương tự.

Hầu hết các bộ xử lý công việc nền này có thể lên lịch chạy công việc sau. Trong Sidekiq, ví dụ, có gem sidekiq-scheduler. Và với sidekiq-scheduler, có một thủ thuật bạn có thể làm.

Điều gì xảy ra nếu bạn có một công việc không bao giờ tự động lên lịch cho mình, nhưng cho phép bạn thủ công lên lịch nó bất cứ khi nào bạn muốn? Điều đó sẽ hoạt động tốt cho các công việc "một lần" mà bạn có thể muốn chạy lại sau, hoặc mà bạn thích chạy qua giao diện người dùng.

Trong sidekiq-scheduler, bạn có thể lên lịch công việc rất xa trong tương lai, và đặt công việc ở trạng thái disabled:

sidekiq.yml
:schedule: location_importer: class: LocationImporterWorker at: '3001/01/01' enabled: false

Sau đó, khi bạn truy cập sidekiq-web, bạn sẽ thấy một nút để thủ công đưa công việc vào hàng đợi:

Các kịch bản một lần hiệu quả trong Rails: Hướng dẫn các tác vụ ad-hoc

Với điều này, bạn có thể chạy công việc của mình bất cứ khi nào bạn sẵn sàng, cả trong development và production. Và nếu bạn bao giờ cần chạy nó lại, nó ngay đó trong UI.

Đây không phải lựa chọn tốt nhất nếu công việc của bạn nguy hiểm. Quá dễ dàng để nhấn nhầm nút đó. Và nó cũng không tuyệt vời nếu công việc mất một thời gian để hoàn thành, vì Sidekiq hoạt động tốt nhất nếu công việc kết thúc nhanh. Công việc của bạn sẽ chiếm một worker, và bạn sẽ không thể khởi động lại Sidekiq an toàn cho đến khi công việc của bạn kết thúc. Nhưng nếu công việc của bạn nhanh, và có thể chạy an toàn nhiều hơn một lần, điều này hoạt động tốt. Nếu đó là loại tác vụ dọn dẹp, bạn có thể quyết định bạn muốn chạy nó định kỳ.

Nếu bạn chỉ muốn tập trung vào lên lịch và kích hoạt, hoặc cần sự linh hoạt hơn để đặt tham số trong các kịch bản một lần, một độc giả tên Dmitry đã chỉ cho tôi sidekiq-enqueuer. Với sidekiq-enqueuer, bạn có thể lên lịch công việc và đặt tham số, tất cả qua giao diện web Sidekiq.

SSH vào production và dán code vào Rails console

Chỉ đùa thôi.

Bạn nên chọn cái nào?

Tôi đã dùng tất cả các cách này để chạy tác vụ một lần. Nhưng tôi thường sẽ chọn rake task trước. Nó hoạt động, khó chạy nhầm, và dễ dàng loại bỏ khi bạn xong. Tôi không chọn rake task mọi lúc.

Tôi có thể chọn migration nếu:

  • Công việc sửa dữ liệu bằng SQL như một phần của thay đổi schema cơ sở dữ liệu.
  • Công việc là công việc dữ liệu rất đơn giản, như thay đổi dữ liệu trong một cột hoặc thêm vài bản ghi.
  • Tôi muốn dễ dàng theo dõi xem công việc đã chạy chưa, và không chạy lại.

Tôi có thể chọn Sidekiq job nếu:

  • Tôi nghĩ tôi có thể muốn chạy công việc lại sau.
  • Ai đó không phải tôi phải chạy nó. Tất cả những gì họ phải làm là nhấn một nút.
  • Đó là công việc nhập hoặc dọn dẹp dữ liệu ngắn. Tôi có thể phải chạy những cái đó định kỳ, ngay cả khi tôi không mong đợi lúc đầu.

Còn bạn? Bạn có bất kỳ lựa chọn nào khác, hoặc làm các lựa chọn khác nhau? Hãy để lại bình luận và cho tôi biết!