RedisUtils.StringOps (commons-redis-spring-boot-starter 1.0.0 API)

java.lang.Object
- cn.fscode.commons.redis.utils.RedisUtils.StringOps

封闭类:

RedisUtils
```
public static class RedisUtils.StringOps
extends Object
```
string相关操作提示: redis中String的数据结构可参考resources/data-structure/String(字符串)的数据结构(示例一).png redis中String的数据结构可参考resources/data-structure/String(字符串)的数据结构(示例二).png

作者:

shenguangyang

构造器概要

构造器
构造器和说明

StringOps()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`append(String key, String value)` 追加值到末尾注: 当redis中原本不存在key时,那么（从效果上来看）此方法就等价于`set(String, Object)`
`static Object`	`get(ICacheKey cacheKey)`
`static Object`	`get(String key)` 根据key，获取到对应的value值
`static Object`	`getAndSet(String key, Object 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<Object>`	`multiGet(Collection<String> keys)` 批量获取value值注: 若redis中，对应的key不存在，那么该key对应的返回的value值为null
`static void`	`multiSet(Map<String,Object> maps)` 批量设置 key-value 注: 若存在相同的key, 则原来的key-value会被丢弃。
`static boolean`	`multiSetIfAbsent(Map<String,Object> maps)` 当redis中,不存在任何一个keys时, 才批量设置 key-value, 并返回成功/失败.
`static void`	`set(String key, Object 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, Object value, long timeout)`
`static void`	`setEx(String key, Object value, long timeout, 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 timeout, 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,
                       Object value)
```
    设置key-value 注: 若已存在相同的key, 那么原来的key-value会被丢弃。
    
    参数:
    
    key - key
    
    value - key对应的value
  - 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是否成功
  - setEx
```
public static void setEx(String key,
                         Object value,
                         long timeout,
                         TimeUnit unit)
```
    设置key-value 注: 若已存在相同的key, 那么原来的key-value会被丢弃
    
    参数:
    
    key - key
    
    value - key对应的value
    
    timeout - 过时时长
    
    unit - timeout的单位
  - setEx
```
public static void setEx(String key,
                         Object value,
                         long timeout)
```
  - setIfAbsent
```
public static boolean setIfAbsent(String key,
                                  String value)
```
    若不存在key时, 向redis中添加key-value, 返回成功/失败。若存在，则不作任何操作, 返回false。
    
    参数:
    
    key - key
    
    value - key对应的value
    
    返回:
    
    set是否成功
  - setIfAbsent
```
public static boolean setIfAbsent(String key,
                                  String value,
                                  long timeout,
                                  TimeUnit unit)
```
    若不存在key时, 向redis中添加一个(具有超时时长的)key-value, 返回成功/失败。若存在，则不作任何操作, 返回false。
    
    参数:
    
    key - key
    
    value - key对应的value
    
    timeout - 超时时长
    
    unit - timeout的单位
    
    返回:
    
    set是否成功
  - 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 - 起始位置
  - size
```
public static long size(String key)
```
    获取到key对应的value的长度。注: 长度等于String.length()。注: 若redis中不存在对应的key-value, 则返回值为0.
    
    参数:
    
    key - 定位value的key
    
    返回:
    
    value的长度
  - multiSet
```
public static void multiSet(Map<String,Object> maps)
```
    批量设置 key-value 注: 若存在相同的key, 则原来的key-value会被丢弃。
    
    参数:
    
    maps - key-value 集
  - multiSetIfAbsent
```
public static boolean multiSetIfAbsent(Map<String,Object> 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 集
    
    返回:
    
    操作是否成功
  - 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值不支持增/减操作时
  - incrByFloat
```
public static double incrByFloat(String key,
                                 double increment)
```
    增/减浮点数注: 慎用浮点数，会有精度问题。如: 先 RedisUtil.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值不支持增/减操作时
  - append
```
public static int append(String key,
                         String value)
```
    追加值到末尾注: 当redis中原本不存在key时,那么（从效果上来看）此方法就等价于set(String, Object)
    
    参数:
    
    key - 定位value的key
    
    value - 要追加的value值
    
    返回:
    
    追加后，整个value的长度
  - get
```
public static Object get(String key)
```
    根据key，获取到对应的value值
    
    参数:
    
    key - key-value对应的key
    
    返回:
    
    该key对应的值。注: 若key不存在，则返回null。
  - get
```
public static Object get(ICacheKey cacheKey)
```
  - 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开始)
    
    返回:
    
    截取后的字符串
  - getAndSet
```
public static Object getAndSet(String key,
                               Object newValue)
```
    给指定key设置新的value, 并返回旧的value 注: 若redis中不存在key, 那么此操作仍然可以成功，不过返回的旧值是null
    
    参数:
    
    key - 定位value的key
    
    newValue - 要为该key设置的新的value值
    
    返回:
    
    旧的value值
  - getBit
```
public static boolean getBit(String key,
                             long offset)
```
    获取(key对应的)value在二进制下，offset位置的bit值。注: 当offset的值在(二进制下的value的)索引范围外时, 返回的也是false。示例: RedisUtil.StringOps.set("akey", "a"); 字符串a, 转换为二进制为01100001 那么getBit("akey", 6)获取到的结果为false。
    
    参数:
    
    key - 定位value的key
    
    offset - 定位bit的索引
    
    返回:
    
    offset位置对应的bit的值(true - 1, false - 0)
  - multiGet
```
public static List<Object> multiGet(Collection<String> keys)
```
    批量获取value值注: 若redis中，对应的key不存在，那么该key对应的返回的value值为null
    
    参数:
    
    keys - key集
    
    返回:
    
    value值集合

类 RedisUtils.StringOps

构造器概要

方法概要

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

构造器详细资料

StringOps

方法详细资料

set

setBit

setEx

setEx

setIfAbsent

setIfAbsent

setRange

size

multiSet

multiSetIfAbsent

incrBy

incrByFloat

append

get

get

getRange

getAndSet

getBit

multiGet