技术文档：girl_friday 异步任务处理库

本文档旨在帮助用户安装、使用和理解 girl_friday 项目，这是一个用于执行 Ruby 应用程序中异步任务的库。

1. 安装指南

推荐使用 JRuby 1.6+ 或 Rubinius 2.0+ 来运行 girl_friday。这些是当前执行 Ruby 代码的优秀选择。

使用以下命令安装 girl_friday：

gem install girl_friday

girl_friday 不支持 Ruby 1.8 (MRI)，因为它没有原生线程支持。Ruby 1.9.3 可以在配合释放 GIL 的网络 I/O 插件（如 mysql2）时工作得很好，但不要使用原始的 mysql 插件。

2. 项目使用说明

在 Gemfile 中添加 girl_friday：

gem 'girl_friday'

在 Rails 应用的 config/initializers/girl_friday.rb 文件中定义你的队列：

EMAIL_QUEUE = GirlFriday::WorkQueue.new(:user_email, :size => 3) do |msg|
  UserMailer.registration_email(msg).deliver
end

IMAGE_QUEUE = GirlFriday::WorkQueue.new(:image_crawler, :size => 7) do |msg|
  ImageCrawler.process(msg)
end

:sizesize是要启动的工作线程数，默认为 5。如果工作线程访问数据库，请确保在config/database.yml` 中设置足够的连接池大小。

要使用 Redis 后端，需要使用 connection_pool 插件来共享 Redis 连接：

require 'connection_pool'

redis_pool = ConnectionPool.new(:size => 5, :timeout => 5) { Redis.new }

CLEAN_FILTER_QUEUE = GirlFriday::WorkQueue.new(:clean_filter, :store => GirlFriday::Store::Redis, :store_config => { :pool => redis_pool }) do |msg|
  Filter.clean(msg)
end

在控制器动作或模型中，可以调用 #push(msg) 方法：

EMAIL_QUEUE.push(:email => @user.email, :name => @user.name)

传递给 push 方法的消息参数是一个哈希，其内容完全由用户定义。

消息处理块不应访问任何实例数据或块外部的变量。这是共享的可变状态，操作起来非常危险。强烈建议队列处理块非常简短，最好是仅包含一到两个方法调用。这样可以轻松地对这些方法进行单元测试，而不是处理块本身。

可以调用 GirlFriday::WorkQueue.immediate! 来立即处理任务，这在测试时非常有用。GirlFriday::WorkQueue.queue! 会恢复默认行为，任务将由演员处理。

即使没有对队列的引用，队列也不会被垃圾收集，直到它们被关闭。如果您动态创建队列，请确保调用 WorkQueue#shutdown 以避免内存泄漏。GirlFriday.shutdown! 将关闭进程中的所有运行队列。

3. 项目 API 使用文档

请参考 girl_friday 的 wiki 获取更多详细信息、高级选项和调整内容。您将找到关于使用 Redis 进行队列持久化、实现干净关闭、查询运行时度量的详细信息，以及更多内容。

4. 项目安装方式

如上所述，使用以下命令安装 girl_friday：

gem install girl_friday

请确保选择合适的 Ruby 环境（JRuby 或 Rubinius），并根据需要调整数据库连接池配置。

本文档由 CSDN 公司开发的 InsCode AI 大模型撰写，旨在为 girl_friday 用户提供了全面的安装和使用指南。