Redis.go 技术文档

1. 安装指南

安装步骤

要安装 redis.go，只需运行以下命令：

go get github.com/hoisie/redis

此命令将从 GitHub 下载并安装 redis.go 库到您的 Go 工作环境中。

2. 项目的使用说明

概述

redis.go 是一个用于 Redis 键值存储的客户端库。它支持 Redis 2.6.x 版本，并提供了对所有 Redis 数据类型（字符串、列表、集合、有序集合和哈希）的支持。该库设计简单，易于使用，并提供了连接池、并发访问支持等功能。

主要特性

• 支持所有 Redis 数据类型：包括字符串、列表、集合、有序集合和哈希。
• 简单易用：设计简洁，使用方便。
• 连接池：支持连接池，并可配置连接池大小。
• 并发访问：支持并发访问 Redis 服务器。
• 连接管理：自动管理与 Redis 服务器的连接，包括断开和超时的连接。
• 数据序列化：支持将 Go 类型序列化为哈希。

示例代码

Hello World 示例

package main

import "github.com/hoisie/redis"

func main() {
    var client redis.Client
    var key = "hello"
    client.Set(key, []byte("world"))
    val, _ := client.Get("hello")
    println(key, string(val))
}

字符串操作示例

var client redis.Client
client.Set("a", []byte("hello"))
val, _ := client.Get("a")
println(string(val))
client.Del("a")

列表操作示例

var client redis.Client
vals := []string{"a", "b", "c", "d", "e"}
for _, v := range vals {
    client.Rpush("l", []byte(v))
}
dbvals,_ := client.Lrange("l", 0, 4)
for i, v := range dbvals {
    println(i,":",string(v))
}
client.Del("l")

发布/订阅示例

sub := make(chan string, 1)
sub <- "foo"
messages := make(chan Message, 0)
go client.Subscribe(sub, nil, nil, nil, messages)

time.Sleep(10 * 1000 * 1000)
client.Publish("foo", []byte("bar"))

msg := <-messages
println("received from:", msg.Channel, " message:", string(msg.Message))

close(sub)
close(messages)

3. 项目API使用文档

主要API

Set(key string, value []byte)

设置指定键的值。

client.Set("key", []byte("value"))

Get(key string) ([]byte, error)

获取指定键的值。

val, _ := client.Get("key")
println(string(val))

Del(key string)

删除指定键。

client.Del("key")

Rpush(key string, value []byte)

将值推入列表的右侧。

client.Rpush("list", []byte("value"))

Lrange(key string, start, end int) ([][]byte, error)

获取列表中指定范围的值。

vals, _ := client.Lrange("list", 0, 4)
for i, v := range vals {
    println(i, ":", string(v))
}

Publish(channel string, message []byte)

向指定频道发布消息。

client.Publish("channel", []byte("message"))

Subscribe(channels, patterns, messages chan Message)

订阅指定频道并接收消息。

messages := make(chan Message, 0)
go client.Subscribe(channels, nil, nil, nil, messages)

4. 项目安装方式

使用 go get 安装

最简单的安装方式是使用 go get 命令：

go get github.com/hoisie/redis

此命令会自动下载并安装 redis.go 库到您的 Go 工作环境中。

手动安装

如果您希望手动安装，可以按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/hoisie/redis.git
   

2. 进入项目目录：

   cd redis
   

3. 安装依赖并构建项目：

   go install
   

通过以上步骤，您可以手动安装并使用 redis.go 库。