Ohm 项目技术文档

1. 安装指南

1.1 安装 Redis

首先，确保你已经安装了 Redis。在大多数平台上，安装 Redis 非常简单，只需下载源码并运行 make，然后将 redis-server 二进制文件放入你的 PATH 中。

1.2 安装 Ohm

如果你还没有安装 Ohm，可以通过以下命令进行安装：

$ [sudo] gem install ohm

或者，你可以从 GitHub 上获取代码：

$ git clone https://github.com/soveran/ohm.git

2. 项目的使用说明

2.1 连接到 Redis 数据库

Ohm 使用一个轻量级的 Redis 客户端 Redic 来连接 Redis 数据库。你可以通过 Ohm.redis= 方法设置连接，URL 格式为 redis://:<passwd>@<host>:<port>/<db>。例如：

require "ohm"

Ohm.redis = Redic.new("redis://127.0.0.1:6379")

Ohm.redis.call "SET", "Foo", "Bar"

Ohm.redis.call "GET", "Foo"
# => "Bar"

默认情况下，Ohm 会连接到 redis://127.0.0.1:6379。

2.2 创建和使用模型

Ohm 的核心功能是将对象映射到 Redis 数据库中。以下是一个简单的模型示例：

class Event < Ohm::Model
  attribute :name
  reference :venue, :Venue
  set :participants, :Person
  counter :votes

  index :name
end

class Venue < Ohm::Model
  attribute :name
  collection :events, :Event
end

class Person < Ohm::Model
  attribute :name
end

你可以通过以下方式与模型进行交互：

event = Event.create :name => "Ohm Worldwide Conference 2031"
event.id
# => 1

# 查找事件
event == Event[1]
# => true

# 更新事件
event.update :name => "Ohm Worldwide Conference 2032"
# => #<Event:0x007fb4c35e2458 @attributes={:name=>"Ohm Worldwide Conference"}, @_memo={}, @id="1">

# 查找不存在的对象
Event[2]
# => nil

# 查找所有事件
Event.all.to_a
# => [<Event:1 name='Ohm Worldwide Conference 2032'>]

3. 项目API使用文档

3.1 属性类型

Ohm 提供了以下几种属性类型：

• Ohm::Model.attribute：用于存储字符串类型的值。
• Ohm::Model.set：用于存储无序集合，适合快速查找成员。
• Ohm::Model.list：用于存储有序列表，适合队列和保持元素顺序。
• Ohm::Model.counter：用于存储计数器，支持原子操作。
• Ohm::Model.reference：用于引用另一个模型。
• Ohm::Model.collection：用于查找所有引用当前模型的对象。

3.2 跟踪键

你可以指示 Ohm 跟踪任意键，并将其与对象的生命周期绑定。例如：

class Log < Ohm::Model
  track :text
  
  def append(msg)
    redis.call("APPEND", key[:text], msg)
  end
  
  def tail(n = 100)
    redis.call("GETRANGE", key[:text], -(n), -1)
  end
end

3.3 持久化策略

attribute 类型的属性只有在调用 save 方法后才会持久化。list、set 和 counter 类型的属性操作会立即执行。

4. 项目安装方式

4.1 通过 RubyGems 安装

最简单的安装方式是通过 RubyGems：

$ [sudo] gem install ohm

4.2 从 GitHub 安装

你也可以从 GitHub 上克隆项目并手动安装：

$ git clone https://github.com/soveran/ohm.git
$ cd ohm
$ gem build ohm.gemspec
$ [sudo] gem install ohm-<version>.gem

通过以上步骤，你就可以成功安装并使用 Ohm 项目了。