SETBIT

设置或清除存储在 key 中的字符串值在 offset 位置的位。

该位是设置还是清除取决于 value，value 可以是 0 或 1。

当 key 不存在时，会创建一个新的字符串值。字符串会被扩展以确保它能容纳 offset 处的位。offset 参数必须大于或等于 0，且小于 2^32（这将位图限制在 512MB）。当 key 中的字符串扩展时，新增的位会被设置为 0。

警告：当设置最后一个可能的位（offset 等于 2^32 -1）并且存储在 key 中的字符串值尚未包含字符串值或包含较小的字符串值时，Valkey 需要分配所有中间内存，这可能会阻塞服务器一段时间。在 2010 年的 MacBook Pro 上，设置位号 2^32 -1（分配 512MB）大约需要 300 毫秒，设置位号 2^30 -1（分配 128MB）大约需要 80 毫秒，设置位号 2^28 -1（分配 32MB）大约需要 30 毫秒，设置位号 2^26 -1（分配 8MB）大约需要 8 毫秒。请注意，一旦完成首次分配，后续对同一 key 调用 SETBIT 将不再有分配开销。

示例

127.0.0.1:6379> SETBIT mykey 7 1
(integer) 0
127.0.0.1:6379> SETBIT mykey 7 0
(integer) 1
127.0.0.1:6379> GET mykey
"\x00"

模式：访问整个位图

有些情况下，您需要一次性设置单个位图的所有位，例如在将其初始化为默认非零值时。可以通过多次调用 SETBIT 命令来完成此操作，每个需要设置的位调用一次。然而，作为一项优化，您可以使用单个 SET 命令来设置整个位图。

位图不是一个实际的数据类型，而是在字符串类型上定义的一组面向位的操作（更多信息请参阅数据类型介绍页面中的位图部分）。这意味着位图可以与字符串命令一起使用，最重要的是与 SET 和 GET 一起使用。

由于 Valkey 的字符串是二进制安全的，因此位图可以简单地编码为字节流。字符串的第一个字节对应位图的偏移量 0..7，第二个字节对应 8..15 范围，依此类推。

例如，设置一些位后，获取位图的字符串值将如下所示

> SETBIT bitmapsarestrings 2 1
> SETBIT bitmapsarestrings 3 1
> SETBIT bitmapsarestrings 5 1
> SETBIT bitmapsarestrings 10 1
> SETBIT bitmapsarestrings 11 1
> SETBIT bitmapsarestrings 14 1
> GET bitmapsarestrings
"42"

通过获取位图的字符串表示形式，客户端可以使用其原生编程语言中的原生位操作来提取位值，从而解析响应的字节。同样地，也可以通过在客户端执行位到字节的编码，并使用生成的字符串调用 SET 来设置整个位图。

模式：设置多个位

SETBIT 擅长设置单个位，当需要设置多个位时可以多次调用。为了优化此操作，您可以用对可变参数 BITFIELD 命令的单次调用以及使用类型为 u1 的字段来替换多次 SETBIT 调用。

例如，上面的示例可以替换为

> BITFIELD bitsinabitmap SET u1 2 1 SET u1 3 1 SET u1 5 1 SET u1 10 1 SET u1 11 1 SET u1 14 1

高级模式：访问位图范围

也可以使用 GETRANGE 和 SETRANGE 字符串命令来高效地访问位图中的位偏移范围。下面是一个 Valkey 惯用 Lua 脚本的示例实现，可以通过 EVAL 命令运行

--[[
Sets a bitmap range

Bitmaps are stored as Strings in Valkey. A range spans one or more bytes,
so we can call `SETRANGE` when entire bytes need to be set instead of flipping
individual bits. Also, to avoid multiple internal memory allocations in
Valkey, we traverse in reverse.
Expected input:
  KEYS[1] - bitfield key
  ARGV[1] - start offset (0-based, inclusive)
  ARGV[2] - end offset (same, should be bigger than start, no error checking)
  ARGV[3] - value (should be 0 or 1, no error checking)
]]--

-- A helper function to stringify a binary string to semi-binary format
local function tobits(str)
  local r = ''
  for i = 1, string.len(str) do
    local c = string.byte(str, i)
    local b = ' '
    for j = 0, 7 do
      b = tostring(bit.band(c, 1)) .. b
      c = bit.rshift(c, 1)
    end
    r = r .. b
  end
  return r
end

-- Main
local k = KEYS[1]
local s, e, v = tonumber(ARGV[1]), tonumber(ARGV[2]), tonumber(ARGV[3])

-- First treat the dangling bits in the last byte
local ms, me = s % 8, (e + 1) % 8
if me > 0 then
  local t = math.max(e - me + 1, s)
  for i = e, t, -1 do
    server.call('SETBIT', k, i, v)
  end
  e = t
end

-- Then the danglings in the first byte
if ms > 0 then
  local t = math.min(s - ms + 7, e)
  for i = s, t, 1 do
    server.call('SETBIT', k, i, v)
  end
  s = t + 1
end

-- Set a range accordingly, if at all
local rs, re = s / 8, (e + 1) / 8
local rl = re - rs
if rl > 0 then
  local b = '\255'
  if 0 == v then
    b = '\0'
  end
  server.call('SETRANGE', k, rs, string.rep(b, rl))
end

注意：从位图中获取位偏移范围的实现留给读者作为练习。

RESP2/RESP3 回复

整数回复：存储在 offset 处的原始位值。