©
本文檔使用 php中文網手册 發布
BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]
自3.2.0起可用。
时间复杂度: O(1)用于指定的每个子命令
该命令将 Redis 字符串视为一个位数组,并且能够处理具有不同位宽和任意非(必要)对齐偏移量的特定整数字段。实际上,使用此命令可以将位偏移量为1234的带符号5位整数设置为特定值,从偏移量4567中检索31位无符号整数。类似地,该命令处理指定整数的递增和递减,提供保证和良好指定的溢出和下溢行为,用户可以配置。
BITFIELD 能够在同一个命令调用中使用多位字段。它需要执行一系列操作,并返回一个响应数组,其中每个数组都与参数列表中的相应操作相匹配。
例如,以下命令将位偏移量为100的8位有符号整数加1,并在位偏移量0处获取4位无符号整数的值:
> BITFIELD mykey INCRBY i5 100 1 GET u4 01) (integer) 12) (integer) 0
注意:
使用当前字符串长度以外的 GET 位(包括密钥根本不存在的情况)进行寻址,结果执行的操作与缺失部分一样都是由设置为0的位组成。
2. 根据需要的最小长度,根据所触及的最远位,使用当前字符串长度之外的 SET 或 INCRBY 位进行寻址将放大字符串,根据需要对其进行填零。
以下是支持的命令列表。
GET <type>
<offset>
- 返回指定的位域。
SET <type>
<offset>
<value>
- 设置指定的位域并返回其旧值。
INCRBY <type>
<offset>
<increment>
- 递增或递减(如果给定负递增)指定的位域并返回新值。
还有一个子命令通过设置溢出行为来改变连续的 INCRBY子 命令调用的行为:
OVERFLOW [WRAP|SAT|FAIL]
在期望整数类型的情况下,可以通过i
为有符号整数和u
无符号整数加上整数类型的位数来构成它。例如u8
,一个8位的无符号整数,i16
是一个16位的有符号整数。支持的类型对于有符号整数最多为64位,对于无符号整数最多为63位。使用无符号整数的限制是由于当前Redis协议无法将64位无符号整数作为答复返回。位和位置偏移有两种方式可以指定位域命令中的偏移量。如果指定了一个没有任何前缀的数字,它将被用作字符串内的基于零的位偏移量。但是如果偏移量前缀为a#
字符,指定的偏移量乘以整数类型的宽度,例如:BITFIELD mystring SET i8#0 100 i8#1 200将设置第一个i8整数在偏移量0和第二个偏移量为8.这种方式你没有如果你想要的是一个给定大小的整数数组,你可以在你的客户端内部进行数学运算。溢出控制使用该OVERFLOW
命令,用户可以通过指定一个来微调增量的行为或减少溢出(或下溢)以下行为:
WRAP:环绕,包含有符号和无符号整数。在无符号整数的情况下,包装类似于以整数可以包含的最大值(C标准行为)来执行操作。使用带符号整数,而不是包装意味着溢出重新开始朝向最负值,并且溢出朝向最正值,例如,如果i8
整数设置为127,则将其递增1 -128
。
SAT:使用饱和算术,即在下溢时将该值设置为最小整数值,并在溢出时将其设置为最大整数值。例如,i8
从数值120开始递增一个以10 为增量的整数将导致数值127,并且进一步增量将始终使数值保持在127.在下溢时发生同样的情况,但是朝向该数值被阻塞在最大负值。
FAIL:在这种模式下,没有检测到溢出或下溢操作。相应的返回值设置为 NULL,以向调用者发送信号。
请注意,每条OVERFLOW
语句只影响子命令列表中后面的 INCRBY命令,直到下一条OVERFLOW
语句为止。
默认情况下,如果未另外指定,则使用 WRAP。
> BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 11) (integer) 12) (integer) 1> BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 11) (integer) 22) (integer) 2> BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 11) (integer) 32) (integer) 3> BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 11) (integer) 02) (integer) 3
该命令返回一个数组,其中每个条目都是在相同位置给出的子命令的相应结果。OVERFLOW
子命令不会计为生成回复。
以下是OVERFLOW FAIL
返回 NULL 的示例。
> BITFIELD mykey OVERFLOW FAIL incrby u2 102 11) (nil)
这个命令的动机是,将许多小整数存储为单个大位图(或通过几个键分段以避免拥有大量密钥)的能力具有极高的内存效率,并为要应用的Redis打开新的使用案例,尤其是实时分析领域。这种用例受控于以受控方式指定溢出的能力。
有趣的事实:Reddit的2017年4月愚人节项目r / place是使用Redis BITFIELD命令构建的,以便获取内存中的协作画布表示。
通常 BITFIELD 是一个快速命令,但是请注意,处理当前短字符串的远位会触发一个分配,这比在已存在的位上执行该命令可能更昂贵。
BITFIELD 使用的表示认为位图的位号为0是第一个字节的最高有效位,依此类推,因此例如在偏移7处将5位无符号整数设置为值23,并将其设置为先前设置为全零,将产生以下表示:
+--------+--------+|00000001|01110000|+--------+--------+
当偏移和整数大小与字节边界对齐时,这与大端相同,但是当这种对齐不存在时,重要的是也要理解字节中的位是如何排序的。