RedisHelper.StringOps (commons-springboot 1.0.0 API)

java.lang.Object
- top.isopen.commons.springboot.helper.RedisHelper.StringOps

封闭类:

RedisHelper
```
public static class RedisHelper.StringOps
extends Object
```
string 相关操作

从以下版本开始:

2020/3/7 16:54:25

作者:

JustryDeng

构造器概要

构造器
构造器和说明

StringOps()

构造器
构造器和说明
`StringOps()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`append(String key, String value)` 追加值到末尾注: 当 redis 中原本不存在 key 时，那么（从效果上来看）此方法就等价于 `this#set(String, String)`
`static String`	`get(String key)` 根据 key，获取到对应的 value 值
`static String`	`getAndSet(String key, String newValue)` 给指定 key 设置新的 value，并返回旧的 value 注: 若 redis 中不存在 key，那么此操作仍然可以成功，不过返回的旧值是 null
`static boolean`	`getBit(String key, long offset)` 获取（key对应的）value 在二进制下，offset 位置的 bit 值。
`static String`	`getRange(String key, long start, long end)` 对（key 对应的）value 进行截取, 截取范围为 [start, end] 注：若 [start, end] 的范围不在 value 的范围中，那么返回的是空字符串 "" 注：若 value 只有一部分在 [start, end] 的范围中，那么返回的是 value 对应部分的内容（即：不足的地方，并不会以空来填充）
`static long`	`incrBy(String key, long increment)` 增/减整数注：负数则为减。
`static double`	`incrByFloat(String key, double increment)` 增/减浮点数注：慎用浮点数，会有精度问题。
`static List<String>`	`multiGet(Collection<String> keys)` 批量获取 value 值注：若 redis 中，对应的 key 不存在，那么该 key 对应的返回的 value 值为 null
`static void`	`multiSet(Map<String,String> maps)` 批量设置 key-value 注：若存在相同的 key, 则原来的 key-value会被丢弃。
`static boolean`	`multiSetIfAbsent(Map<String,String> maps)` 当 redis 中，不存在任何一个 keys 时，才批量设置 key-value，并返回成功/失败。
`static void`	`set(String key, String value)` 设置 key-value 注：若已存在相同的 key, 那么原来的 key-value 会被丢弃。
`static boolean`	`setBit(String key, long offset, boolean value)` 处理 redis 中 key 对应的 value 值, 将第 offset 位的值, 设置为 1 或 0。
`static void`	`setEx(String key, String value, long timeToLive, TimeUnit unit)` 设置 key-value 注：若已存在相同的 key，那么原来的 key-value 会被丢弃注：原子操作
`static boolean`	`setIfAbsent(String key, String value)` 若不存在 key 时，向 redis 中添加 key-value, 返回成功/失败。
`static boolean`	`setIfAbsent(String key, String value, long timeToLive, TimeUnit unit)` 若不存在 key 时, 向 redis 中添加一个（具有超时时长的）key-value, 返回成功/失败。
`static void`	`setRange(String key, String replaceValue, long offset)` 从（redis 中 key 对应的）value 的 offset 位置起（包含该位置），用 replaceValue 替换对应长度的值。
`static long`	`size(String key)` 获取到 key 对应的 value 的长度。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - StringOps
```
public StringOps()
```
- 方法详细资料
  - set
```
public static void set(String key,
                       String value)
```
    设置 key-value
    注：若已存在相同的 key, 那么原来的 key-value 会被丢弃。
    
    参数:
    
    key - key
    
    value - key 对应的 value
    
    从以下版本开始:
    
    2020/3/8 15:40:59
  - setBit
```
public static boolean setBit(String key,
                             long offset,
                             boolean value)
```
    处理 redis 中 key 对应的 value 值, 将第 offset 位的值, 设置为 1 或 0。
    说明：在 redis 中，存储的字符串都是以二级制的进行存在的；如存储的 key-value 里，值为 abc，实际上，在 redis 里面存储的是 011000010110001001100011，前 8 位对应 a，中间 8 位对应 b，后面 8 位对应 c。示例：这里如果 setBit(key, 6, true) 的话，就是将索引位置 6 的那个数，设置值为 1，值就变成了 011000110110001001100011 追注：offset 即 index，从 0 开始。
    注：参数 value 为 true，则设置为 1；参数 value 为 false，则设置为 0。
    注：若 redis 中不存在对应的 key，那么会自动创建新的。注：offset 可以超过 value 在二进制下的索引长度。
    
    参数:
    
    key - 定位 value 的 key
    
    offset - 要改变的 bit 的索引
    
    value - 改为 1 或 0，true - 改为 1，false - 改为 0
    
    返回:
    
    set 是否成功
    
    从以下版本开始:
    
    2020/3/8 16:30:37
  - setEx
```
public static void setEx(String key,
                         String value,
                         long timeToLive,
                         TimeUnit unit)
```
    设置 key-value
    注：若已存在相同的 key，那么原来的 key-value 会被丢弃
    注：原子操作
    
    参数:
    
    key - key
    
    value - key 对应的 value
    
    timeToLive - 过时时长
    
    unit - timeToLive 的单位
    
    从以下版本开始:
    
    2020/3/8 15:40:59
  - setIfAbsent
```
public static boolean setIfAbsent(String key,
                                  String value)
```
    若不存在 key 时，向 redis 中添加 key-value, 返回成功/失败。若存在，则不作任何操作，返回 false。
    
    参数:
    
    key - key
    
    value - key 对应的 value
    
    返回:
    
    set 是否成功
    
    从以下版本开始:
    
    2020/3/8 16:51:36
  - setIfAbsent
```
public static boolean setIfAbsent(String key,
                                  String value,
                                  long timeToLive,
                                  TimeUnit unit)
```
    若不存在 key 时, 向 redis 中添加一个（具有超时时长的）key-value, 返回成功/失败。若存在，则不作任何操作，返回 false。
    
    参数:
    
    key - key
    
    value - key 对应的 value
    
    timeToLive - 超时时长
    
    unit - timeToLive 的单位
    
    返回:
    
    set 是否成功
    
    从以下版本开始:
    
    2020/3/8 16:51:36
  - setRange
```
public static void setRange(String key,
                            String replaceValue,
                            long offset)
```
    从（redis 中 key 对应的）value 的 offset 位置起（包含该位置），用 replaceValue 替换对应长度的值。
    举例说明： 1. 假设 redis 中存在 key-value("ds", "0123456789"); 调用 setRange("ds", "abcdefghijk", 3)后，redis 中该 value 值就变为了 [012abcdefghijk]
    2. 假设 redis 中存在 key-value("jd", "0123456789"); 调用 setRange("jd", "xyz", 3)后，redis 中该 value 值就变为了 [012xyz6789]
    3. 假设 redis 中存在 key-value("ey", "0123456789"); 调用 setRange("ey", "qwer", 15)后，redis 中该 value 值就变为了 [0123456789 qwer] 注：case3 比较特殊，offset 超过了原 value 的长度了。中间就会有一些空格来填充，但是如果在程序中直接输出的话，中间那部分空格可能会出现乱码。
    
    参数:
    
    key - 定位 key-value 的 key
    
    replaceValue - 要替换的值
    
    offset - 起始位置
    
    从以下版本开始:
    
    2020/3/8 17:04:31
  - size
```
public static long size(String key)
```
    获取到 key 对应的 value 的长度。
    注：长度等于 String.length()。注：若 redis 中不存在对应的 key-value，则返回值为 0.
    
    参数:
    
    key - 定位 value 的 key
    
    返回:
    
    value 的长度
    
    从以下版本开始:
    
    2020/3/8 17:14:30
  - multiSet
```
public static void multiSet(Map<String,String> maps)
```
    批量设置 key-value
    注：若存在相同的 key, 则原来的 key-value会被丢弃。
    
    参数:
    
    maps - key-value 集
    
    从以下版本开始:
    
    2020/3/8 17:21:19
  - multiSetIfAbsent
```
public static boolean multiSetIfAbsent(Map<String,String> maps)
```
    当 redis 中，不存在任何一个 keys 时，才批量设置 key-value，并返回成功/失败。否者，不进行任何操作，并返回 false。
    即：假设调用此方法时传入的参数 map 是这样的：{k1=v1, k2=v2, k3=v3} 那么 redis 中，k1、k2、k3 都不存在时，才会批量设置 key-value；否则不会设置任何 key-value。
    注：若存在相同的 key，则原来的 key-value 会被丢弃。
    
    参数:
    
    maps - key-value 集
    
    返回:
    
    操作是否成功
    
    从以下版本开始:
    
    2020/3/8 17:21:19
  - incrBy
```
public static long incrBy(String key,
                          long increment)
```
    增/减整数
    注：负数则为减。
    注：若 key 对应的 value 值不支持增/减操作（即：value不是数字），那么会抛出 org.springframework.data.redis.RedisSystemException
    
    参数:
    
    key - 用于定位 value 的 key
    
    increment - 增加多少
    
    返回:
    
    增加后的总值。
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - key 对应的 value 值不支持增/减操作时
    
    从以下版本开始:
    
    2020/3/8 17:45:51
  - incrByFloat
```
public static double incrByFloat(String key,
                                 double increment)
```
    增/减浮点数
    注：慎用浮点数，会有精度问题。
    如: 先 RedisHelper.StringOps.set("ds", "123"); 然后再 RedisUtil.StringOps.incrByFloat("ds", 100.6); 就会看到精度问题。
    注：负数则为减。
    注：若 key 对应的 value 值不支持增/减操作（即：value不是数字），那么会抛出 org.springframework.data.redis.RedisSystemException
    
    参数:
    
    key - 用于定位value的key
    
    increment - 增加多少
    
    返回:
    
    增加后的总值。
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - key对应的value值不支持增/减操作时
    
    从以下版本开始:
    
    2020/3/8 17:45:51
  - append
```
public static int append(String key,
                         String value)
```
    追加值到末尾
    注: 当 redis 中原本不存在 key 时，那么（从效果上来看）此方法就等价于 this#set(String, String)
    
    参数:
    
    key - 定位 value 的 key
    
    value - 要追加的 value 值
    
    返回:
    
    追加后，整个 value 的长度
    
    从以下版本开始:
    
    2020/3/8 17:59:21
  - get
```
public static String get(String key)
```
    根据 key，获取到对应的 value 值
    
    参数:
    
    key - key-value 对应的 key
    
    返回:
    
    该 key 对应的值。注: 若 key 不存在，则返回 null。
    
    从以下版本开始:
    
    2020/3/8 16:27:41
  - getRange
```
public static String getRange(String key,
                              long start,
                              long end)
```
    对（key 对应的）value 进行截取, 截取范围为 [start, end]
    注：若 [start, end] 的范围不在 value 的范围中，那么返回的是空字符串 ""
    注：若 value 只有一部分在 [start, end] 的范围中，那么返回的是 value 对应部分的内容（即：不足的地方，并不会以空来填充）
    
    参数:
    
    key - 定位 value 的 key
    
    start - 起始位置（从0开始）
    
    end - 结尾位置（从0开始）
    
    返回:
    
    截取后的字符串
    
    从以下版本开始:
    
    2020/3/8 18:08:45
  - getAndSet
```
public static String getAndSet(String key,
                               String newValue)
```
    给指定 key 设置新的 value，并返回旧的 value
    注: 若 redis 中不存在 key，那么此操作仍然可以成功，不过返回的旧值是 null
    
    参数:
    
    key - 定位 value 的 key
    
    newValue - 要为该 key 设置的新的 value 值
    
    返回:
    
    旧的 value 值
    
    从以下版本开始:
    
    2020/3/8 18:14:24
  - getBit
```
public static boolean getBit(String key,
                             long offset)
```
    获取（key对应的）value 在二进制下，offset 位置的 bit 值。
    注：当 offset 的值在（二进制下的 value 的）索引范围外时，返回的也是 false。
    示例： RedisHelper.StringOps.set("akey", "a"); 字符串 a，转换为二进制为 01100001 那么 getBit("akey", 6) 获取到的结果为 false。
    
    参数:
    
    key - 定位 value 的 key
    
    offset - 定位 bit 的索引
    
    返回:
    
    offset 位置对应的 bit 的值（true - 1, false - 0）
    
    从以下版本开始:
    
    2020/3/8 18:21:10
  - multiGet
```
public static List<String> multiGet(Collection<String> keys)
```
    批量获取 value 值
    注：若 redis 中，对应的 key 不存在，那么该 key 对应的返回的 value 值为 null
    
    参数:
    
    keys - key 集
    
    返回:
    
    value 值集合
    
    从以下版本开始:
    
    2020/3/8 18:26:33

类 RedisHelper.StringOps

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

StringOps

方法详细资料

set

setBit

setEx

setIfAbsent

setIfAbsent

setRange

size

multiSet

multiSetIfAbsent

incrBy

incrByFloat

append

get

getRange

getAndSet

getBit

multiGet