EM-Synchrony 技术文档

1. 安装指南

1.1 安装 Ruby

首先，确保你已经安装了 Ruby 环境。你可以通过以下命令检查 Ruby 是否已安装：

ruby -v

如果没有安装，请根据你的操作系统选择合适的安装方式。例如，在 Ubuntu 上可以使用以下命令安装：

sudo apt-get install ruby-full

1.2 安装 EM-Synchrony

使用 RubyGems 安装 EM-Synchrony：

gem install em-synchrony

2. 项目的使用说明

EM-Synchrony 是一个用于简化事件驱动代码的 Ruby 库，特别适用于 EventMachine 和 Fiber 的结合使用。它提供了多种 Fiber 感知的工具和类，帮助开发者更轻松地处理异步代码。

2.1 主要功能

• Fiber 感知的 ConnectionPool：支持同步和异步查询。
• Fiber 感知的 Iterator：允许控制并发并混合同步/异步代码。
• Fiber 感知的异步内联支持：将任何异步函数转换为同步。
• Fiber 感知的 Multi-request 接口：支持任何回调启用的客户端。
• Fiber 感知的 TCPSocket：由 EventMachine 驱动。
• Fiber 感知的 Thread、Mutex、ConditionVariable 类。
• Fiber 感知的 sleep、defer、system 方法。

2.2 支持的客户端

• mysql2：.query 是同步的，.aquery 是异步的。
• activerecord：需要 synchrony/activerecord，设置 AR 适配器为 em_mysql2。
• em-http-request：.get 等是同步的，.aget 等是异步的。
• em-memcached 和 remcached：.get 等和 .multi_* 方法是同步的。
• em-mongo：.find、.first 是同步的。
• mongoid：所有函数都是同步的，且兼容 Rails。
• AMQP：大部分函数是同步的。

3. 项目API使用文档

3.1 Fiber-aware Iterator

允许对任何异步任务的集合执行 each、map、inject 等操作。通过调用 iter.next 或 iter.return(result) 来推进迭代器。

require "em-synchrony"
require "em-synchrony/em-http"

EM.synchrony do
    concurrency = 2
    urls = ['http://url.1.com', 'http://url2.com']

    results = EM::Synchrony::Iterator.new(urls, concurrency).map do |url, iter|
        http = EventMachine::HttpRequest.new(url).aget
        http.callback { iter.return(http) }
        http.errback { iter.return(http) }
    end

    p results
    EventMachine.stop
end

3.2 Fiber-aware ConnectionPool

允许创建一个资源池，由一个或多个 Fiber 共享。

require "em-synchrony"
require "em-synchrony/mysql2"

EventMachine.synchrony do
    db = EventMachine::Synchrony::ConnectionPool.new(size: 2) do
        Mysql2::EM::Client.new
    end

    multi = EventMachine::Synchrony::Multi.new
    multi.add :a, db.aquery("select sleep(1)")
    multi.add :b, db.aquery("select sleep(1)")
    res = multi.perform

    p "Look ma, no callbacks, and parallel MySQL requests!"
    p res

    EventMachine.stop
end

3.3 Fiber-aware Multi interface

允许同时发起多个请求，并在所有请求完成后继续执行。

require "em-synchrony"
require "em-synchrony/em-http"
EventMachine.synchrony do
    multi = EventMachine::Synchrony::Multi.new
    multi.add :a, EventMachine::HttpRequest.new("http://www.postrank.com").aget
    multi.add :b, EventMachine::HttpRequest.new("http://www.postrank.com").apost
    res = multi.perform

    p "Look ma, no callbacks, and parallel HTTP requests!"
    p res

    EventMachine.stop
end

4. 项目安装方式

4.1 使用 RubyGems 安装

gem install em-synchrony

4.2 在项目中使用

在 Ruby 项目中，可以通过以下方式引入 EM-Synchrony：

require 'em-synchrony'

4.3 示例代码

以下是一个简单的示例，展示了如何使用 EM-Synchrony 进行并行 HTTP 请求：

require "em-synchrony"
require "em-synchrony/em-http"
EventMachine.synchrony do
    multi = EventMachine::Synchrony::Multi.new
    multi.add :a, EventMachine::HttpRequest.new("http://www.postrank.com").aget
    multi.add :b, EventMachine::HttpRequest.new("http://www.postrank.com").apost
    res = multi.perform

    p "Look ma, no callbacks, and parallel HTTP requests!"
    p res

    EventMachine.stop
end

通过以上文档，你应该能够顺利安装和使用 EM-Synchrony 项目。如果有任何问题，请参考项目的 GitHub Wiki 或联系项目维护者。