# SETBIT

设置或清除存储在key处的字符串值中偏移量处的位

语法

SETBIT key offset value

可用版本：

2.2.0
时间复杂度：

O(1)
ACL 类别：

@write, @bitmap, @slow

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

该位根据value设置或清除， value可以是 0 或 1。

当key不存在时，创建一个新的字符串值。字符串被增长以确保它可以在offset保持一点。偏移量参数必须大于或等于 0，并且小于 2^32（这将位图限制为 512MB）。当key处的字符串增长时，添加的位设置为 0。

警告：当设置最后一个可能的位（偏移量等于 2^32 -1）并且存储在key的字符串值还没有保存字符串值，或者保存一个小字符串值时，Redis 需要分配所有可以阻塞的中间内存服务器一段时间。在 2010 款 MacBook Pro 上，设置位数 2^32 -1（512MB 分配）大约需要 300 毫秒，设置位数 2^30 -1（128MB 分配）大约需要 80 毫秒，设置位数 2^28 -1（32MB 分配）需要约 30 毫秒，设置位号 2^26 -1（8MB 分配）需要约 8 毫秒。请注意，一旦完成第一次分配，SETBIT对同一键的后续调用将不会产生分配开销。

# 返回

整数：存储在偏移处的原始位值。

# 例子

redis> SETBIT mykey 7 1
(integer) 0
redis> SETBIT mykey 7 0
(integer) 1
redis> GET mykey
""
redis>

# 模式：访问整个位图

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

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

因为 Redis 的字符串是二进制安全的，所以位图被简单地编码为字节流。字符串的第一个字节对应于位图的偏移量 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擅长设置单个位，需要设置多个位时可以多次调用。要优化此操作，您可以用SETBIT对 variadic 命令的单个调用 BITFIELD 和使用 type 的字段来替换多个调用u1。

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

> 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 字符串命令来有效地访问位图中的位偏移范围。以下是可以使用 EVAL 命令运行的惯用 Redis Lua 脚本中的示例实现：

--[[
Sets a bitmap range

Bitmaps are stored as Strings in Redis. 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
Redis, 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
    redis.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
    redis.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
  redis.call('SETRANGE', k, rs, string.rep(b, rl))
end

**注意：**从位图中获取一系列位偏移的实现留给读者作为练习。

# 反馈

如果您在此页面上发现问题，或有改进建议，请提交请求以合并或打开存储库中的问题。

← SET Setex →