cn.fscode.commons.redis.utils

类 RedisUtils.SetOps

java.lang.Object

cn.fscode.commons.redis.utils.RedisUtils.SetOps

封闭类:

RedisUtils

public static class RedisUtils.SetOps
extends Object

set相关操作 提示: set中的元素，不可以重复。 提示: set是无序的。 提示: redis中String的数据结构可参考resources/data-structure/Set(集合)的数据结构(示例一).png redis中String的数据结构可参考resources/data-structure/Set(集合)的数据结构(示例二).png

作者:

shenguangyang

构造器概要

构造器

构造器和说明
SetOps()

方法概要

限定符和类型	方法和说明
static long	sAdd(String key, Object... items) 向(key对应的)set中添加items 注: 若key不存在，则会自动创建。
static Set<Object>	sDifference(String key, Collection<String> otherKeys) 获取 (key对应的)Set 减去 (otherKeys对应的)Sets 的差集 注: 如果被减数key不存在， 那么结果为空的集合(，而不是null) 注: 如果被减数key存在，但减数key不存在， 那么结果即为(被减数key对应的)Set 提示: 当有多个减数时， 被减数先减去哪一个减数，后减去哪一个减数，是无所谓的，是不影响最终结果的。
static Set<Object>	sDifference(String key, String otherKey) 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集 注: 如果被减数key不存在， 那么结果为空的集合(，而不是null) 注: 如果被减数key存在，但减数key不存在， 那么结果即为(被减数key对应的)Set
static long	sDifferenceAndStore(String key, Collection<String> otherKeys, String storeKey) 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。
static long	sDifferenceAndStore(String key, String otherKey, String storeKey) 获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。
static Set<Object>	sDistinctRandomMembers(String key, long count) 从key对应的set中随机获取count个项 注: 若count >= set的size, 那么返回的即为这个key对应的set。
static Set<Object>	sIntersect(String key, Collection<String> otherKeys) 获取多个(key对应的)Set的交集 注: 若不存在任何交集，那么返回空的集合(, 而不是null) 注: 若>=1个key不存在，那么返回空的集合(, 而不是null)
static Set<Object>	sIntersect(String key, String otherKey) 获取两个(key对应的)Set的交集 注: 若不存在任何交集，那么返回空的集合(, 而不是null) 注: 若其中一个key不存在(或两个key都不存在)，那么返回空的集合(, 而不是null)
static long	sIntersectAndStore(String key, Collection<String> otherKeys, String storeKey) 获取多个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。
static long	sIntersectAndStore(String key, String otherKey, String storeKey) 获取两个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。
static boolean	sIsMember(String key, Object item) 判断(key对应的)set中是否含有item 注: 若key不存在，则返回false。
static Set<Object>	sMembers(String key) 获取key对应的set 注: 若key不存在, 则返回的是空的set(, 而不是null)
static boolean	sMove(String sourceKey, String item, String destinationKey) 将(sourceKey对应的)sourceSet中的元素item, 移动到(destinationKey对应的)destinationSet中 注: 当sourceKey不存在时， 返回false 注: 当item不存在时， 返回false 注: 若destinationKey不存在， 那么在移动时会自动创建 注: 若已经将(sourceKey对应的)set中的项move出去完了，那么对应的sourceKey会被删除。
static Object	sPop(String key) 从(key对应的)set中随机移出一个item, 并返回这个item 注: 因为set是无序的，所以移出的这个item,是随机的; 并且，哪怕 是数据一样的set,多次测试移出操作,移除的元素也是随机的。
static Object	sRandomMember(String key) 从key对应的set中随机获取一项
static List<Object>	sRandomMembers(String key, long count) 从key对应的set中获取count次随机项(, set中的同一个项可能被多次获取) 注: count可大于set的size。
static long	sRemove(String key, Object... items) 从(key对应的)set中删除items 注: 若key不存在, 则返回0。
static org.springframework.data.redis.core.Cursor<Object>	sScan(String key, org.springframework.data.redis.core.ScanOptions options) 根据options匹配到(key对应的)set中的对应的item, 并返回对应的item集 注: ScanOptions实例的创建方式举例: 1、ScanOptions.NONE 2、ScanOptions.scanOptions().match("n??
static long	sSize(String key) 获取(key对应的)set中的元素个数 注: 若key不存在，则返回0
static Set<Object>	sUnion(String key, Collection<String> otherKeys) 获取两个(key对应的)Set的并集 注: 并集中的元素也是唯一的，这是Set保证的。
static Set<Object>	sUnion(String key, String otherKey) 获取两个(key对应的)Set的并集 注: 并集中的元素也是唯一的，这是Set保证的。
static long	sUnionAndStore(String key, Collection<String> otherKeys, String storeKey) 获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。
static long	sUnionAndStore(String key, String otherKey, String storeKey) 获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SetOps

public SetOps()

方法详细资料

sAdd

public static long sAdd(String key,
                        Object... items)

向(key对应的)set中添加items 注: 若key不存在，则会自动创建。 注: set中的元素会去重。

参数:

key - 定位set的key

items - 要向(key对应的)set中添加的items

返回:

此次添加操作,添加到set中的元素的个数

sRemove

public static long sRemove(String key,
                           Object... items)

从(key对应的)set中删除items 注: 若key不存在, 则返回0。 注: 若已经将(key对应的)set中的项删除完了，那么对应的key也会被删除。

参数:

key - 定位set的key

items - 要移除的items

返回:

实际删除了的个数

sPop

public static Object sPop(String key)

从(key对应的)set中随机移出一个item, 并返回这个item 注: 因为set是无序的，所以移出的这个item,是随机的; 并且，哪怕 是数据一样的set,多次测试移出操作,移除的元素也是随机的。 注: 若已经将(key对应的)set中的项pop完了，那么对应的key会被删除。

参数:

key - 定位set的key

返回:

移出的项

sMove

public static boolean sMove(String sourceKey,
                            String item,
                            String destinationKey)

将(sourceKey对应的)sourceSet中的元素item, 移动到(destinationKey对应的)destinationSet中 注: 当sourceKey不存在时， 返回false 注: 当item不存在时， 返回false 注: 若destinationKey不存在， 那么在移动时会自动创建 注: 若已经将(sourceKey对应的)set中的项move出去完了，那么对应的sourceKey会被删除。

参数:

sourceKey - 定位sourceSet的key

item - 要移动的项目

destinationKey - 定位destinationSet的key

返回:

移动成功与否

sSize

public static long sSize(String key)

获取(key对应的)set中的元素个数 注: 若key不存在，则返回0

参数:

key - 定位set的key

返回:

(key对应的)set中的元素个数

sIsMember

public static boolean sIsMember(String key,
                                Object item)

判断(key对应的)set中是否含有item 注: 若key不存在，则返回false。

参数:

key - 定位set的key

item - 被查找的项

返回:

(key对应的)set中是否含有item

sIntersect

public static Set<Object> sIntersect(String key,
                                     String otherKey)

获取两个(key对应的)Set的交集 注: 若不存在任何交集，那么返回空的集合(, 而不是null) 注: 若其中一个key不存在(或两个key都不存在)，那么返回空的集合(, 而不是null)

参数:

key - 定位其中一个set的键

otherKey - 定位其中另一个set的键

返回:

item交集

sIntersect

public static Set<Object> sIntersect(String key,
                                     Collection<String> otherKeys)

获取多个(key对应的)Set的交集 注: 若不存在任何交集，那么返回空的集合(, 而不是null) 注: 若>=1个key不存在，那么返回空的集合(, 而不是null)

参数:

key - 定位其中一个set的键

otherKeys - 定位其它set的键集

返回:

item交集

sIntersectAndStore

public static long sIntersectAndStore(String key,
                                      String otherKey,
                                      String storeKey)

获取两个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。 case1: 交集不为空, storeKey不存在， 则 会创建对应的storeKey，并将交集添加到(storeKey对应的)set中 case2: 交集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将交集添加到(storeKey对应的)set中 case3: 交集为空, 则不进行下面的操作, 直接返回0 注: 求交集的部分，详见sIntersect(String, String)

参数:

key - 定位其中一个set的键

otherKey - 定位其中另一个set的键

storeKey - 定位(要把交集添加到哪个)set的key

返回:

add到(storeKey对应的)Set后, 该set对应的size

sIntersectAndStore

public static long sIntersectAndStore(String key,
                                      Collection<String> otherKeys,
                                      String storeKey)

获取多个(key对应的)Set的交集, 并将结果add到storeKey对应的Set中。 case1: 交集不为空, storeKey不存在， 则 会创建对应的storeKey，并将交集添加到(storeKey对应的)set中 case2: 交集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将交集添加到(storeKey对应的)set中 case3: 交集为空, 则不进行下面的操作, 直接返回0 注: 求交集的部分，详见sIntersect(String, Collection)

sUnion

public static Set<Object> sUnion(String key,
                                 String otherKey)

获取两个(key对应的)Set的并集 注: 并集中的元素也是唯一的，这是Set保证的。

参数:

key - 定位其中一个set的键

otherKey - 定位其中另一个set的键

返回:

item并集

sUnion

public static Set<Object> sUnion(String key,
                                 Collection<String> otherKeys)

获取两个(key对应的)Set的并集 注: 并集中的元素也是唯一的，这是Set保证的。

参数:

key - 定位其中一个set的键

otherKeys - 定位其它set的键集

返回:

item并集

sUnionAndStore

public static long sUnionAndStore(String key,
                                  String otherKey,
                                  String storeKey)

获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。 case1: 并集不为空, storeKey不存在， 则 会创建对应的storeKey，并将并集添加到(storeKey对应的)set中 case2: 并集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将并集添加到(storeKey对应的)set中 case3: 并集为空, 则不进行下面的操作, 直接返回0 注: 求并集的部分，详见sUnion(String, String)

参数:

key - 定位其中一个set的键

otherKey - 定位其中另一个set的键

storeKey - 定位(要把并集添加到哪个)set的key

返回:

add到(storeKey对应的)Set后, 该set对应的size

sUnionAndStore

public static long sUnionAndStore(String key,
                                  Collection<String> otherKeys,
                                  String storeKey)

获取两个(key对应的)Set的并集, 并将结果add到storeKey对应的Set中。 case1: 并集不为空, storeKey不存在， 则 会创建对应的storeKey，并将并集添加到(storeKey对应的)set中 case2: 并集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将并集添加到(storeKey对应的)set中 case3: 并集为空, 则不进行下面的操作, 直接返回0 注: 求并集的部分，详见sUnion(String, Collection)

参数:

key - 定位其中一个set的键

otherKeys - 定位其它set的键集

storeKey - 定位(要把并集添加到哪个)set的key

返回:

add到(storeKey对应的)Set后, 该set对应的size

sDifference

public static Set<Object> sDifference(String key,
                                      String otherKey)

获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集 注: 如果被减数key不存在， 那么结果为空的集合(，而不是null) 注: 如果被减数key存在，但减数key不存在， 那么结果即为(被减数key对应的)Set

参数:

key - 定位"被减数set"的键

otherKey - 定位"减数set"的键

返回:

item差集

sDifference

public static Set<Object> sDifference(String key,
                                      Collection<String> otherKeys)

获取 (key对应的)Set 减去 (otherKeys对应的)Sets 的差集 注: 如果被减数key不存在， 那么结果为空的集合(，而不是null) 注: 如果被减数key存在，但减数key不存在， 那么结果即为(被减数key对应的)Set 提示: 当有多个减数时， 被减数先减去哪一个减数，后减去哪一个减数，是无所谓的，是不影响最终结果的。

参数:

key - 定位"被减数set"的键

otherKeys - 定位"减数集sets"的键集

返回:

item差集

sDifferenceAndStore

public static long sDifferenceAndStore(String key,
                                       String otherKey,
                                       String storeKey)

获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。 case1: 差集不为空, storeKey不存在， 则 会创建对应的storeKey，并将差集添加到(storeKey对应的)set中 case2: 差集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将差集添加到(storeKey对应的)set中 case3: 差集为空, 则不进行下面的操作, 直接返回0 注: 求并集的部分，详见sDifference(String, String)

参数:

key - 定位"被减数set"的键

otherKey - 定位"减数set"的键

storeKey - 定位(要把差集添加到哪个)set的key

返回:

add到(storeKey对应的)Set后, 该set对应的size

sDifferenceAndStore

public static long sDifferenceAndStore(String key,
                                       Collection<String> otherKeys,
                                       String storeKey)

获取 (key对应的)Set 减去 (otherKey对应的)Set 的差集, 并将结果add到storeKey对应的Set中。 case1: 差集不为空, storeKey不存在， 则 会创建对应的storeKey，并将差集添加到(storeKey对应的)set中 case2: 差集不为空, storeKey已存在， 则 会清除原(storeKey对应的)set中所有的项，然后将差集添加到(storeKey对应的)set中 case3: 差集为空, 则不进行下面的操作, 直接返回0 注: 求并集的部分，详见sDifference(String, String)

参数:

key - 定位"被减数set"的键

otherKeys - 定位"减数集sets"的键集

storeKey - 定位(要把差集添加到哪个)set的key

返回:

add到(storeKey对应的)Set后, 该set对应的size

sMembers

public static Set<Object> sMembers(String key)

获取key对应的set 注: 若key不存在, 则返回的是空的set(, 而不是null)

参数:

key - 定位set的key

返回:

(key对应的)set

sRandomMember

public static Object sRandomMember(String key)

从key对应的set中随机获取一项

参数:

key - 定位set的key

返回:

随机获取到的项

sRandomMembers

public static List<Object> sRandomMembers(String key,
                                          long count)

从key对应的set中获取count次随机项(, set中的同一个项可能被多次获取) 注: count可大于set的size。 注: 取出来的结果里可能存在相同的值。

参数:

key - 定位set的key

count - 要取多少项

返回:

随机获取到的项集

sDistinctRandomMembers

public static Set<Object> sDistinctRandomMembers(String key,
                                                 long count)

从key对应的set中随机获取count个项 注: 若count >= set的size, 那么返回的即为这个key对应的set。 注: 取出来的结果里没有重复的项。

参数:

key - 定位set的key

count - 要取多少项

返回:

随机获取到的项集

sScan

public static org.springframework.data.redis.core.Cursor<Object> sScan(String key,
                                                                       org.springframework.data.redis.core.ScanOptions options)

根据options匹配到(key对应的)set中的对应的item, 并返回对应的item集 注: ScanOptions实例的创建方式举例: 1、ScanOptions.NONE 2、ScanOptions.scanOptions().match("n??e").build()

参数:

key - 定位set的key

options - 匹配set中的item的条件 注: ScanOptions.NONE表示全部匹配。 注: ScanOptions.scanOptions().match(pattern).build()表示按照pattern匹配, 其中pattern中可以使用通配符 * ? 等, * 表示>=0个字符 ？ 表示有且只有一个字符 此处的匹配规则与RedisUtils.KeyOps.keys(String)处的一样。

返回:

匹配到的(key对应的)set中的项