OpenResty shared dict

shared dict 支持数据的存放和读取，还支持原子计数和队列操作，可用于 worker 间的通信。

OpenResty 中常见的几种数据共享的方法

• Nginx 中的变量

  可以在 Nginx C 模块之间共享数据，也可以在 C 模块和 lua-nginx-module 之间共享数据。 性能较差，只能存储字符串，不支持其他 Lua 类型。

  location /foo {
    content_by_lua_block {
        ngx.var.my_var = 123;
    }
  }
  

• ngx.ctx 在同一个请求的不同阶段共享数据

  当请求结束，ngx.ctx 会被销毁

  location /foo {
    rewrite_by_lua_block {
        ngx.ctx.host = ngx.var.host;
    }
    access_by_lua_block {
        ngx.ctx.host = 'test.com';
    }
    content_by_lua_block {
        ngx.say(ngx.ctx.host);
    }
  }
  

• 使用模块级别的变量，可以在 worker 内的所有请求之间共享数据

  --mydata.lua
  local _M = {}
  
  local data = {
    dog = 3,
    cat = 4,
    pig = 5,
  }
  
  function _M.get_age(name)
    return data[name]
  end
  
  return _M
  

  location /foo {
    content_by_lua_block {
        local mydata = require "mydata";
        ngx.say(mydata.get_age("dog"));
    }
  }
  

  一般只存只读数据，涉及到写操作可能会有竞争。

• shared dict，数据可以在多个 worker 之间共享。

  有局限性，必须事先在 Nginx 的配置文件中声明共享内存的大小，并且不能在运行时修改

  lua_shared_dict dogs 10m
  

  只能缓存字符串，不支持复杂的 Lua 数据类型

前三种数据共享的范围都是在请求级别或者单个 worker 级别，只有 shared dict 可以完成 worker 之间的数据共享。

shared dict API

字典读写类

$ resty --shdict='dogs 1m' -e 'local dict = ngx.shared.dogs
                               dict:set("Tom", 56)
                               print(dict:get("Tom"))'

• safe_set

• add

• safe_add

• replace

• get_stable

  value, flags, stale = ngx.shared.DICT:get_stale(key)
  

队列操作

• lpush/rpush 在队列两端增加元素
• lpop/rpop 在队列两端弹出元素
• llen 返回队列的元素数量