Redis.md

Redis

Redis组件提供了redis客户端的功能.支持连接池，支持数据的自动序列化，支持故障自动转移，除Do方法以外如果key未明确指定过期时间，则默认过期时间为1天。

1. cluster,数据在多个server间按一致性hash分布。
2. masterSlave,写命令使用master，读命令在有slave的情况下，选用slave机器。

配置文件

    # 组件ID，默认为"redis"
    redis:
    # 组件类名称
    class: "@pgo/Client/Redis/Client"
    # KEY前缀，默认"pgo_"
     prefix: "pgo_"
    # 连接密码，默认为空
     password: ""
    # 使用DB的序号，默认为0
     db: 0
    # 每个地址最大空闲连接数，默认为10
     maxIdleConn: 10
    # 连接空闲时间(在这个时间内再次进行操作不需要进行探活)，默认1分钟
     maxIdleTime: "60s"
    # 网络超时(连接、读写等)，默认1秒
     netTimeout: "1s"
    # 服务器探活间隔(自动剔除和添加server)，默认关闭
     probInterval: "0s"
    # 模式,是cluster还是masterSlave,默认cluster 可选值：cluster/masterSlave
     mod:cluster
    # 服务器地址，如果server有权重，请自行按比例添加,如果是master 最好配置在第一个
    servers:
        - "127.0.0.1:6379"
        - "127.0.0.1:6380"

功能列表

redis.Get(key)                 // 获取key的值
redis.MGet(keys)               // 并行获取多个key的值
redis.Set(key, val)            // 设置key的值
redis.MSet(items)              // 并行设置多个key的值
redis.Add(key, val)            // 添加key的值(key存在时添加失败)
redis.MAdd(items)              // 并行添加多个key的值
redis.Del(key)                 // 删除key的值
redis.MDel(keys)               // 并行删除多个key的值
redis.Exists(key)              // 判断key是否存在
redis.Incr(key1, delta)        // 累加key的值
redis.Do(key1, delta)          // 可以使用更多的读写命令

// TODO 其它非cache功能

使用示例

// curl -v http://127.0.0.1:8000/redis/set
func (r *RedisController) ActionSet() {
    // 获取redis的上下文适配对象
    redis := r.GetObject(Redis.AdapterClass).(*Redis.Adapter)

    // 设置用户输入值
    key := r.GetContext().ValidateParam("key", "test_key1").Do()
    val := r.GetContext().ValidateParam("val", "test_val1").Do()
    ok := redis.Set(key, val)
    fmt.Println("redis set test_key1=test_val1:", ok)

    // 设置自定义过期时间
    ok = redis.Set("test_key2", 100, 2*time.Minute)
    fmt.Println("redis set test_key2=100:", ok)

    // 设置map值，会自动进行json序列化
    data := pgo.Map{"f1": 100, "f2": true, "f3": "hello"}
    ok = redis.Set("test_key3", data)
    fmt.Println("redis set test_key3=<map>:", ok)

    // 并行设置多个key
    items := pgo.Map{
        "test_key4": []int{1, 2, 3, 4},
        "test_key5": "test_val5",
        "test_key6": pgo.Map{"f61": 11, "f62": "hello"},
    }
    ok = redis.MSet(items)
    fmt.Println("redis mset test_key[4-6]:", ok)
}

// curl -v http://127.0.0.1:8000/redis/get
func (r *RedisController) ActionGet() {
    // 获取redis的上下文适配对象
    redis := r.GetObject(Redis.AdapterClass).(*Redis.Adapter)

    // 获取string
    if val := redis.Get("test_key1"); val != nil {
        fmt.Println("value of test_key1:", val.String())
    }

    // 获取int
    if val := redis.Get("test_key2"); val != nil {
        fmt.Println("value of test_key2:", val.Int())
    }

    // 获取序列化的数据
    if val := redis.Get("test_key3"); val != nil {
        var data pgo.Map
        val.Decode(&data)
        fmt.Println("value of test_key3:", data)
    }

    // 获取多个key
    if res := redis.MGet([]string{"test_key4", "test_key5", "test_key6"}); res != nil {
        for key, val := range res {
            fmt.Printf("value of %s: %v\n", key, val.String())
        }
    }
}