golang实现Redis客户端操作的高效插件库godis的使用

godis简介

godis是一个用Golang实现的Redis客户端库，参考了Jedis的设计。这个库实现了大多数Redis命令，包括普通Redis命令、集群命令、哨兵命令、管道命令和事务命令。

如果你曾经使用过Jedis，那么你可以轻松使用godis，因为godis的方法几乎与Jedis相同。特别值得一提的是，godis实现了单机模式和集群模式下的分布式锁，性能比Redisson更好。

特性

• 集群支持
• 管道操作
• 事务支持
• 分布式锁
• 其他功能正在开发中

安装

使用go get安装：

go get -u github.com/piaohao/godis

或者使用go.mod：

require github.com/piaohao/godis latest

快速开始

1. 基础示例

package main

import (
    "github.com/piaohao/godis"
)

func main() {
    // 创建Redis客户端连接
    redis := godis.NewRedis(&godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    })
    defer redis.Close()
    
    // 设置键值
    redis.Set("godis", "1")
    
    // 获取键值
    arr, _ := redis.Get("godis")
    println(arr)
}

2. 使用连接池

package main

import (
    "github.com/piaohao/godis"
)

func main() {
    option := &godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    }
    
    // 创建连接池
    pool := godis.NewPool(&godis.PoolConfig{}, option)
    
    // 从连接池获取连接
    redis, _ := pool.GetResource()
    defer redis.Close()
    
    redis.Set("godis", "1")
    arr, _ := redis.Get("godis")
    println(arr)
}

3. 发布订阅

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    option := &godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    }
    
    pool := godis.NewPool(&godis.PoolConfig{}, option)
    
    // 启动订阅协程
    go func() {
        redis, _ := pool.GetResource()
        defer redis.Close()
        
        pubsub := &godis.RedisPubSub{
            OnMessage: func(channel, message string) {
                println(channel, message)
            },
            OnSubscribe: func(channel string, subscribedChannels int) {
                println(channel, subscribedChannels)
            },
            OnPong: func(channel string) {
                println("recieve pong")
            },
        }
        redis.Subscribe(pubsub, "godis")
    }()
    
    time.Sleep(1 * time.Second)
    
    {
        // 发布消息
        redis, _ := pool.GetResource()
        defer redis.Close()
        redis.Publish("godis", "godis pubsub")
        redis.Close()
    }
    
    time.Sleep(1 * time.Second)
}

4. 集群操作

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    // 创建Redis集群客户端
    cluster := godis.NewRedisCluster(&godis.ClusterOption{
        Nodes:             []string{"localhost:7000", "localhost:7001", "localhost:7002", "localhost:7003", "localhost:7004", "localhost:7005"},
        ConnectionTimeout: 0,
        SoTimeout:         0,
        MaxAttempts:       0,
        Password:          "",
        PoolConfig:        &godis.PoolConfig{},
    })
    
    cluster.Set("cluster", "godis cluster")
    reply, _ := cluster.Get("cluster")
    println(reply)
}

5. 管道操作

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    option := &godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    }
    
    pool := godis.NewPool(&godis.PoolConfig{}, option)
    redis, _ := pool.GetResource()
    defer redis.Close()
    
    // 创建管道
    p := redis.Pipelined()
    
    // 添加命令到管道
    infoResp, _ := p.Info()
    timeResp, _ := p.Time()
    
    // 执行管道中的所有命令
    p.Sync()
    
    // 获取结果
    timeList, _ := timeResp.Get()
    println(timeList)
    
    info, _ := infoResp.Get()
    println(info)
}

6. 事务操作

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    option := &godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    }
    
    pool := godis.NewPool(nil, option)
    redis, _ := pool.GetResource()
    defer redis.Close()
    
    // 开启事务
    p, _ := redis.Multi()
    
    // 添加命令到事务
    infoResp, _ := p.Info()
    timeResp, _ := p.Time()
    
    // 执行事务
    p.Exec()
    
    // 获取结果
    timeList, _ := timeResp.Get()
    println(timeList)
    
    info, _ := infoResp.Get()
    println(info)
}

7. 分布式锁

单机Redis锁

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    // 创建锁管理器
    locker := godis.NewLocker(&godis.Option{
        Host: "localhost",
        Port: 6379,
        Db:   0,
    }, &godis.LockOption{
        Timeout: 5*time.Second,
    })
    
    // 尝试获取锁
    lock, err := locker.TryLock("lock")
    if err == nil && lock!=nil {
        // 执行业务代码
        // ...
        
        // 释放锁
        locker.UnLock(lock)
    }
}

Redis集群锁

package main

import (
    "github.com/piaohao/godis"
    "time"
)

func main() {
    // 创建集群锁管理器
    locker := godis.NewClusterLocker(&godis.ClusterOption{
        Nodes:             []string{"localhost:7000", "localhost:7001", "localhost:7002", "localhost:7003", "localhost:7004", "localhost:7005"},
        ConnectionTimeout: 0,
        SoTimeout:        0,
        MaxAttempts:      0,
        Password:         "",
        PoolConfig:       &godis.PoolConfig{},
    }, &godis.LockOption{
        Timeout: 5*time.Second,
    })
    
    // 尝试获取锁
    lock, err := locker.TryLock("lock")
    if err == nil && lock!=nil {
        // 执行业务代码
        // ...
        
        // 释放锁
        locker.UnLock(lock)
    }
}

许可证

godis采用MIT许可证，100%免费且开源。

感谢

• [jedis] - Java实现的流行Redis客户端
• [gf] - Golang实现的优秀Web框架
• [go-commons-pool] - 参考了Apache Common Pool

联系方式

piao.hao@qq.com