Golang使用lua脚本实现redis原子操作

目录

• [redis 调用lua脚本](#redis 调用lua脚本)
• [redis+lua 实现评分排行榜实时更新](#redis+lua 实现评分排行榜实时更新)
  

[lua 脚本](#lua 脚本)
golang调用redis+lua示例
byte切片与string的转换优化

redis 调用lua脚本

eval命令

redis调用lua脚本需要使用eval命令。

redis eval命令格式：

redis 127.0.0.1:6379> eval script numkeys key [key ...] arg [arg ...]

最简单的例子：

127.0.0.1:6379> eval "return {'hello, grassinwind!'}" 0
1) "hello, grassinwind!"
127.0.0.1:6379> eval "return redis.call('set',keys[1],'bar')" 1 foo
ok

使用redis-cli调用lua脚本示例(若在windows系统下，则需要在git bash中执行，在powershell中无法读取value)：

***@laptop-v7v47h0l mingw64 /d/study/code/lua
$ redis-cli.exe -a 123 --eval test.lua testkey , hello
hello

test.lua如下(redis log打印在server的日志中)：

local key,value = keys[1],argv[1]
redis.log(redis.log_notice, "key=", key, "value=", value)
redis.call('set', key, value)
local a = redis.call('get', key)
return a

script命令

redis提供了以下几个script命令，用于对于脚本子系统进行控制：

script flush：清除所有的脚本缓存

script load：将脚本装入脚本缓存，不立即运行并返回其校验和

script exists：根据指定脚本校验和，检查脚本是否存在于缓存

script kill：杀死当前正在运行的脚本（防止脚本运行缓存，占用内存）

主要优势： 减少网络开销：多个请求通过脚本一次发送，减少网络延迟

原子操作：将脚本作为一个整体执行，中间不会插入其他命令，无需使用事务

复用：客户端发送的脚本永久存在redis中，其他客户端可以复用脚本

可嵌入性：可嵌入java，c#等多种编程语言，支持不同操作系统跨平台交互

通过script命令加载及执行lua脚本示例：

127.0.0.1:6379> script load "return 'hello grassinwind'"
"c66be1d9b54b3182f8d8e12f8b01a4e5c7c4af5b"
127.0.0.1:6379> script exists "c66be1d9b54b3182f8d8e12f8b01a4e5c7c4af5b"
1) (integer) 1
127.0.0.1:6379> evalsha "c66be1d9b54b3182f8d8e12f8b01a4e5c7c4af5b" 0
"hello grassinwind"
127.0.0.1:6379> script flush
ok
127.0.0.1:6379> script exists "c66be1d9b54b3182f8d8e12f8b01a4e5c7c4af5b"
1) (integer) 0

#redis+lua 实现评分排行榜实时更新

使用redis的zset保存排行数据，使用lua脚本实现评分排行更新的原子操作。

lua 脚本

相关redis命令： zcard key 获取有序集合的成员数

zrangebyscore key min max [withscores] [limit] 通过分数返回有序集合指定区间内的成员(从小到大的顺序)

zremrangebyrank key start stop 移除有序集合中给定的排名区间的所有成员

zadd key score1 member1 [score2 member2] 向有序集合添加一个或多个成员，或者更新已存在成员的分数

主要思路是维护一个zset，将评分前n位保存到redis中，当成员的评分发生变化时，动态更新zset的成员信息。

lua脚本如下，其中 keys[1]表示zset的key， argv[1]表示期望的zset最大存储成员数量， argv[2]表示评分上限，默认评分下限是0， argv[3]表示待添加的评分， argv[4]表示待添加的成员名称。

-- redis zset operations
-- argv[capacity maxscore newmemberscore member]
-- 执行示例 redis-cli.exe --eval zsetop.lua mtest , 3 5 5 test1
-- 获取键和参数
local key,cap,maxsetscore,newmemberscore,member = keys[1],argv[1],argv[2],argv[3],argv[4]
redis.log(redis.log_notice, "key=", key,",cap=", cap,",maxsetscore=", maxsetscore,",newmemberscore=", newmemberscore,",member=", member)
local len = redis.call('zcard', key);
-- len need not nil, otherwise will occur "attempt to compare nil with number"
if len then
 if tonumber(len) >= tonumber(cap)
 then
  local num = tonumber(len)-tonumber(cap)+1
  local list = redis.call('zrangebyscore',key,0,maxsetscore,'limit',0,num)
  redis.log(redis.log_notice,"key=",key,"maxsetscore=",maxsetscore, "num=",num)
  for k,lowestscoremember in pairs(list) do
   local lowestscore = redis.call('zscore', key,lowestscoremember)
   redis.log(redis.log_notice, "list: ", lowestscore, lowestscoremember)
   if tonumber(newmemberscore) > tonumber(lowestscore)
   then
    local rank = redis.call('zrevrank',key,member)
    -- rank is nil indicate new member is not exist in set, need remove the lowest score member
    if not rank then
     local index = tonumber(len) - tonumber(cap);
     redis.call('zremrangebyrank',key, 0, index)
    end
    redis.call('zadd', key, newmemberscore, member);
    break
   end
  end
 else
  redis.call('zadd', key, newmemberscore, member);
 end
end

golang调用redis+lua示例

init函数中读取lua脚本并通过redisgo包的newscript函数加载这个脚本，在使用时通过返回的指针调用lua.do()即可。

func init() {
 ...
 file, err := os.open(zsetopfilename)
 if err != nil {
 panic("open"+zsetopfilename+" "+err.error())
 }
 bytes,err := ioutil.readall(file)
 if err != nil {
 panic(err.error())
 }
 zsetopscript = utils.unsafebytestostring(bytes)
 logs.debug(zsetopscript)
 lua =redis.newscript(1,zsetopscript)
}
func zaddwithcap(key,member string, score float32, maxscore, cap int) (reply interface{}, err error) {
 c := pool.get()
 //do optimistically evaluates the script using the evalsha command. if script not exist, will use eval command.
 reply, err= lua.do(c,key,cap,maxscore,score,member)
 return
}

redisgo包对do方法做了优化，会检查这个脚本的sha是否存在，若不存在，会通过eval命令执行即会加载脚本，下次执行就可以通过

evalsha来执行了。

func (s *script) do(c conn, keysandargs ...interface{}) (interface{}, error) {
 v, err := c.do("evalsha", s.args(s.hash, keysandargs)...)
 if e, ok := err.(error); ok && strings.hasprefix(string(e), "noscript ") {
 v, err = c.do("eval", s.args(s.src, keysandargs)...)
 }
 return v, err
}

byte切片与string的转换优化

在go读取了脚本内容存在byte切片中，需要转化为string来调用redis.newscript来创建对象。

通过unsafe包转化可以避免内存拷贝从而提高效率。

unsafe 包提供了 2 点重要的能力： 任何类型的指针和 unsafe.pointer 可以相互转换。 uintptr 类型和 unsafe.pointer 可以相互转换。

通过unsafe包将byte切片转换为string示例：

func unsafebytestostring(bytes []byte) string {
 hdr := &reflect.stringheader{
 data: uintptr(unsafe.pointer(&bytes[0])),
 len: len(bytes),
 }
 return *(*string)(unsafe.pointer(hdr))
}

string与slice底层结构如下：

type sliceheader struct {
 data uintptr
 len int
 cap int
 } 
type stringheader struct {
 data uintptr
 len int
 }

github链接

详见https://github.com/grassinwind2019/bookms

总结

到此这篇关于golang使用lua脚本实现redis原子操作的文章就介绍到这了,更多相关golang lua脚本实现redis原子操作内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！