共计 10745 个字符，预计需要花费 27 分钟才能阅读完成。
自动写代码机器人，免费开通
这篇文章将为大家详细讲解有关 redis 有哪些 api，丸趣 TV 小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。
一、Redis Client 介绍
1.1、简介
Jedis Client 是 Redis 官网推荐的一个面向 java 客户端，库文件实现了对各类 API 进行封装调用。
Jedis 源码工程地址：https://github.com/xetorthio/jedis
1.2、使用
Redis Client 最好选用与服务端对应的版本，本例中使用 Redis 2.8.19 客户端使用 jedis -2.6.3，Maven 工程添加如下引用即可。
dependency
groupId redis.clients /groupId
artifactId jedis /artifactId
version 2.6.3 /version
type jar /type
scope compile /scope
/dependency1.3、注意事项
Redis Client 拥有众多对接版本，本项目目前使用 Jedis 为官方推荐 Java 对接客户端，是基于其对 Redis 良好的版本支持和 API 对接，另外编码中尽量避免使用废弃接口。
Redis 目前正在新版过渡期，3.0 版本暂未稳定，但是由于 3.0 版本提供了最新的集群功能，可能在日后稳定版发布以后升级到 3.0，目前使用的 Jedis 支持 3.0 的目前版本 API。
二、Redis Client 常用 API
2.1、环境要求
语言：Java
JDK：1.7
Redis : 2.8.19（稳定版）
2.2、系统使用
2.2.1、建立连接
普通连接
Jedis jedis = new Jedis( localhost
jedis.set( foo , bar
String value = jedis.get( foo
System.out.println(value);设置连接池配置
该方法用于得到 redis 连接池连接使用的连接池配置，该连接池配置也可以通过 spring 注入的方式来进行相对应的配置，连接池采用的是平时比较常用的 org.apache.commons.pool2.impl.GenericObjectPoolConfig 来进行的连接池管理
配置文件如下
#redis 服务器 ip #
redis.ip=172.30.5.117
#redis 服务器端口号#
redis.port=6379
###jedis##pool##config###
#jedis 的最大分配对象#
jedis.pool.maxActive=1024
#jedis 最大保存 idel 状态对象数 #
jedis.pool.maxIdle=200
#jedis 池没有对象返回时，最大等待时间 #
jedis.pool.maxWait=1000
#jedis 调用 borrowObject 方法时，是否进行有效检查#
jedis.pool.testOnBorrow=true
#jedis 调用 returnObject 方法时，是否进行有效检查 #
jedis.pool.testOnReturn=true连接池配置实例化代码（也可通过 spring 注入进行配置）：
/**
* 获取化连接池配置
* @return JedisPoolConfig
* */
private JedisPoolConfig getPoolConfig(){if(config == null){config = new JedisPoolConfig();
// 最大连接数
config.setMaxTotal(Integer.valueOf(getResourceBundle().getString(redis.pool.maxTotal)));
// 最大空闲连接数
config.setMaxIdle(Integer.valueOf(getResourceBundle().getString(redis.pool.maxIdle)));
// 获取连接时的最大等待毫秒数 (如果设置为阻塞时 BlockWhenExhausted), 如果超时就抛异常, 小于零: 阻塞不确定的时间, 默认 -1
config.setMaxWaitMillis(Long.valueOf(getResourceBundle().getString(redis.pool.maxWaitMillis)));
// 在获取连接的时候检查有效性, 默认 false
config.setTestOnBorrow(Boolean.valueOf(getResourceBundle().getString(redis.pool.testOnBorrow)));
// 在获取返回结果的时候检查有效性, 默认 false
config.setTestOnReturn(Boolean.valueOf(getResourceBundle().getString(redis.pool.testOnReturn)));
return config;
}普通连接池连接
这里展示的是普通的连接池方式链接 redis 的方案，跟普通的数据库连接池的操作方式类似；* 初始化 JedisPool
* */
private void initJedisPool(){if(pool == null){
// 获取服务器 IP 地址
String ipStr = getResourceBundle().getString( redis.ip
// 获取服务器端口
int portStr = Integer.valueOf(getResourceBundle()
.getString(redis.port));
// 初始化连接池
pool = new JedisPool(getPoolConfig(), ipStr,portStr);
}Sentinel 连接池连接
该连接池用于应对 Redis 的 Sentinel 的主从切换机制，能够正确在服务器宕机导致服务器切换时得到正确的服务器连接，当服务器采用该部署策略的时候推荐使用该连接池进行操作；
private void initJedisSentinelPool(){if(sentinelpool == null){
// 监听器列表
Set String sentinels = new HashSet String
// 监听器 1
sentinels.add(new HostAndPort( 192.168.50.236 ,
26379).toString());
// 监听器 2
sentinels.add(new HostAndPort( 192.168.50.237 ,
26379).toString());
// 实际使用的时候在 properties 里配置即可：redis.sentinel.hostandports
=192.168.50.236:26379,192.168.50.237:26379
getResourceBundle().getString( redis.sentinel.hostandports)
//mastername 是服务器上的 master 的名字，在 master 服务器的 sentinel.conf 中配置:
//[sentinel monitor server-1M 192.168.50.236 6379 2]
// 中间的 server-1M 即为这里的 masterName
String masterName = getResourceBundle()
.getString( redis.sentinel.masterName
// 初始化连接池
sentinelpool = new JedisSentinelPool(masterName,
sentinels, getPoolConfig());
}ShardedJedisPool 连接池分片连接
/**
* 初始化 ShardedJedisPool
* Redis 在容灾处理方面可以通过服务器端配置 Master-Slave 模式来实现。* 而在分布式集群方面目前只能通过客户端工具来实现一致性哈希分布存储，即 key 分片存储。* Redis 可能会在 3.0 版本支持服务器端的分布存储
* */
private void initShardedJedisPool() {if (shardPool == null) {
// 创建多个 redis 共享服务
String redis1Ip = getResourceBundle().getString( redis1.ip
int redis1Port = Integer.valueOf(bundle.getString( redis.port));
JedisShardInfo jedisShardInfo1 = new JedisShardInfo(redis1Ip, redis1Port);
String redis2Ip = getResourceBundle().getString( redis2.ip
int redis2Port = Integer.valueOf(bundle.getString( redis.port));
JedisShardInfo jedisShardInfo2 = new JedisShardInfo(redis2Ip, redis2Port);
List JedisShardInfo serverlist = new LinkedList JedisShardInfo
serverlist.add(jedisShardInfo1);
serverlist.add(jedisShardInfo2);
// 初始化连接池
shardPool = new ShardedJedisPool(getPoolConfig(),serverlist);
}读写删除操作
// 从池中获取一个 Jedis 对象
Jedis jedis = sentinelpool.getSentinelpoolResource();
String keys = name
// 删除 key-value 对象，如果 key 不存在则忽略此操作
jedis.del(keys);
// 存数据
jedis.set(keys, snowolf
// 判断 key 是否存在，不存在返回 false 存在返回 true
jedis.exists(keys);
// 取数据
String value = jedis.get(keys);
// 释放对象池（3.0 将抛弃该方法）sentinelpool.returnSentinelpoolResource(jedis);三、示例代码
1. String 的简单追加
// 从池中获取一个 Jedis 对象
JedisUtil.getInstance().STRINGS.append(key, value);2. 价格时间排序（前提是已经存储了价格，时间的 SortSet）
// 执行 2 级排序操作（）
String stPriceSet =“stPriceSet”;//stPriceSet 价格的 sortset 列表名
String stTimeSet =“stTimeSet”; // stTimeSet 时间的 sortset 列表名
Set Tuple sumSet = JedisUtilEx.getInstance()
.getSortSetByPirceUpAndTimeDown(stPriceSet, stTimeSet);
// 排序以后可以重复获取上次排序结果 (缓存时间 10 分钟)
Set Tuple sumSet = JedisUtilEx.getInstance()
getLastPirceUpAndTimeDownSet();3. 价格时间排序（前提是已经存储了价格，时间的 SortSet）
// 执行 2 级排序操作
String stPriceSet =“stPriceSet”;//stPriceSet 价格的 sortset 列表名
String stTimeSet =“stTimeSet”; // stTimeSet 时间的 sortset 列表名
Set Tuple sumSet = JedisUtilEx.getInstance()
. getSortSetByPirceDownAndTimeDown (stPriceSet, stTimeSet);
// 排序以后可以重复获取上次排序结果 (缓存时间 10 分钟)
Set Tuple sumSet = JedisUtilEx.getInstance()
getLastPirceDownAndTimeDownSet ();4. 保存 JavaBean 到 hash 表中
// bean 继承至 RedisBean
JedisUtilEx.getInstance().setBeanToHash(bean);5. 从 hash 表中读取 JavaBean
//uuid 为业务制定的唯一标识符规则（相当于主键）String uuid =“1”; // 该 ID 是我们提前就知道的
// T 继承至 RedisBean;
JedisUtilEx.getInstance().getBeanFromHash (uuid,Class T cls);6. 将 JavaBean 列表装入 hash 中
//list 中的 bean 继承至 RedisBean
List T beanList = …;
JedisUtilEx.getInstance().setBeanListToHash(beanList);
// 异步版本的存储列表到 hash
JedisUtilEx.getInstance().setBeanListToHashSyn(beanList);7. 普通的操作流程示例
// 获取 jedis 引用
Jedis jedis = JedisUtil.getInstance().getJedis();
// 执行业务以及调用 jedis 提供的接口功能
jedis.hset(…);
// 执行完成以后务必释放资源
JedisUtil.getInstance().returnJedis(jedis);
// 若以后不会使用 JEDIS，需要关闭所有链接池
RedisConnetcion.destroyAllPools();8. 事务执行流程
// 获取连接资源
Jedis jd = JedisUtil.getInstance().getJedis();
// 开启事务
Transaction ts = jd.multi();
// 执行业务以及调用 jedis 提供的接口功能
jedis.hset(…);
// 执行事务
List Object list = ts.exec();
// 释放资源
JedisUtil.getInstance().returnJedis(jd);9. 异步执行
// 获取连接资源
Jedis jedis = JedisUtil.getInstance().getJedis();
// 获取管道
Pipeline pipeline = jedis.pipelined();
// 执行业务以及调用 jedis 提供的接口功能
jedis.hset(…);
// 提交并释放管道
pipeline.syncAndReturnAll();
// 释放资源
JedisUtil.getInstance().returnJedis(jedis);10. 如何获取 Jedis 命名规则的合成 KEY
// 获取类的唯一键值 key, 例如：User:1(User 为 class,1 为 uuid) 其中 user 继承于 Reidsbean
JedisUtilEx.getInstance().getBeanKey(user);
// 另一种获取类的唯一键值 key 的方法
JedisUtilEx.getInstance().getBeanKey(String uuid,Class T cls);
// 获取 bean 对应的 KEY(对应列的唯一键值 key)
JedisUtilEx.getInstance().getBeanKey(String uuid,Class T cls,String... fileds);
// 获取 bean 对应的 KEY(集群 key)
JedisUtilEx.getInstance().getBeanKey(Class T cls,String... fileds);四、jedis 操作命令：
1. 对 value 操作的命令
exists(key)：确认一个 key 是否存在
del(key)：删除一个 key
type(key)：返回值的类型
keys(pattern)：返回满足给定 pattern 的所有 key
randomkey：随机返回 key 空间的一个 key
rename(oldname, newname)：将 key 由 oldname 重命名为 newname，若 newname 存在则删除 newname 表示的 key
dbsize：返回当前数据库中 key 的数目
expire：设定一个 key 的活动时间（s）ttl：获得一个 key 的活动时间
select(index)：按索引查询
move(key, dbindex)：将当前数据库中的 key 转移到有 dbindex 索引的数据库
flushdb：删除当前选择数据库中的所有 key
flushall：删除所有数据库中的所有 key2. 对 String 操作的命令
set(key, value)：给数据库中名称为 key 的 string 赋予值 value
get(key)：返回数据库中名称为 key 的 string 的 value
getset(key, value)：给名称为 key 的 string 赋予上一次的 value
mget(key1, key2,…, key N)：返回库中多个 string（它们的名称为 key1，key2…）的 value
setnx(key, value)：如果不存在名称为 key 的 string，则向库中添加 string，名称为 key，值为 value
setex(key, time, value)：向库中添加 string（名称为 key，值为 value）同时，设定过期时间 time
mset(key1, value1, key2, value2,…key N, value N)：同时给多个 string 赋值，名称为 key i 的 string 赋值 value i
msetnx(key1, value1, key2, value2,…key N, value N)：如果所有名称为 key i 的 string 都不存在，则向库中添加 string，名称 key i 赋值为 value i
incr(key)：名称为 key 的 string 增 1 操作
incrby(key, integer)：名称为 key 的 string 增加 integer
decr(key)：名称为 key 的 string 减 1 操作
decrby(key, integer)：名称为 key 的 string 减少 integer
append(key, value)：名称为 key 的 string 的值附加 value
substr(key, start, end)：返回名称为 key 的 string 的 value 的子串 3. 对 List 操作的命令
rpush(key, value)：在名称为 key 的 list 尾添加一个值为 value 的元素
lpush(key, value)：在名称为 key 的 list 头添加一个值为 value 的 元素
llen(key)：返回名称为 key 的 list 的长度
lrange(key, start, end)：返回名称为 key 的 list 中 start 至 end 之间的元素（下标从 0 开始，下同）ltrim(key, start, end)：截取名称为 key 的 list，保留 start 至 end 之间的元素
lindex(key, index)：返回名称为 key 的 list 中 index 位置的元素
lset(key, index, value)：给名称为 key 的 list 中 index 位置的元素赋值为 value
lrem(key, count, value)：删除 count 个名称为 key 的 list 中值为 value 的元素。count 为 0，删除所有值为 value 的元素，count 0 从头至尾删除 count 个值为 value 的元素，count 0 从尾到头删除 |count| 个值为 value 的元素。lpop(key)：返回并删除名称为 key 的 list 中的首元素
rpop(key)：返回并删除名称为 key 的 list 中的尾元素
blpop(key1, key2,… key N, timeout)：lpop 命令的 block 版本。即当 timeout 为 0 时，若遇到名称为 key i 的 list 不存在或该 list 为空，则命令结束。如果 timeout 0，则遇到上述情况时，等待 timeout 秒，如果问题没有解决，则对 key i+ 1 开始的 list 执行 pop 操作。brpop(key1, key2,… key N, timeout)：rpop 的 block 版本。参考上一命令。rpoplpush(srckey, dstkey)：返回并删除名称为 srckey 的 list 的尾元素，并将该元素添加到名称为 dstkey 的 list 的头部 4. 对 Set 操作的命令
sadd(key, member)：向名称为 key 的 set 中添加元素 member
srem(key, member)：删除名称为 key 的 set 中的元素 member
spop(key)：随机返回并删除名称为 key 的 set 中一个元素
smove(srckey, dstkey, member)：将 member 元素从名称为 srckey 的集合移到名称为 dstkey 的集合
scard(key)：返回名称为 key 的 set 的基数
sismember(key, member)：测试 member 是否是名称为 key 的 set 的元素
sinter(key1, key2,…key N)：求交集
sinterstore(dstkey, key1, key2,…key N)：求交集并将交集保存到 dstkey 的集合
sunion(key1, key2,…key N)：求并集
sunionstore(dstkey, key1, key2,…key N)：求并集并将并集保存到 dstkey 的集合
sdiff(key1, key2,…key N)：求差集
sdiffstore(dstkey, key1, key2,…key N)：求差集并将差集保存到 dstkey 的集合
smembers(key)：返回名称为 key 的 set 的所有元素
srandmember(key)：随机返回名称为 key 的 set 的一个元素 5. 对 zset（sorted set）操作的命令
zadd(key, score, member)：向名称为 key 的 zset 中添加元素 member，score 用于排序。如果该元素已经存在，则根据 score 更新该元素的顺序。zrem(key, member)：删除名称为 key 的 zset 中的元素 member
zincrby(key, increment, member)：如果在名称为 key 的 zset 中已经存在元素 member，则该元素的 score 增加 increment；否则向集合中添加该元素，其 score 的值为 increment
zrank(key, member)：返回名称为 key 的 zset（元素已按 score 从小到大排序）中 member 元素的 rank（即 index，从 0 开始），若没有 member 元素，返回“nil”zrevrank(key, member)：返回名称为 key 的 zset（元素已按 score 从大到小排序）中 member 元素的 rank（即 index，从 0 开始），若没有 member 元素，返回“nil”zrange(key, start, end)：返回名称为 key 的 zset（元素已按 score 从小到大排序）中的 index 从 start 到 end 的所有元素
zrevrange(key, start, end)：返回名称为 key 的 zset（元素已按 score 从大到小排序）中的 index 从 start 到 end 的所有元素
zrangebyscore(key, min, max)：返回名称为 key 的 zset 中 score = min 且 score = max 的所有元素
zcard(key)：返回名称为 key 的 zset 的基数
zscore(key, element)：返回名称为 key 的 zset 中元素 element 的 score
zremrangebyrank(key, min, max)：删除名称为 key 的 zset 中 rank = min 且 rank = max 的所有元素
zremrangebyscore(key, min, max)：删除名称为 key 的 zset 中 score = min 且 score = max 的所有元素
zunionstore / zinterstore(dstkeyN, key1,…,keyN, WEIGHTS w1,…wN, AGGREGATE SUM|MIN|MAX)：对 N 个 zset 求并集和交集，并将最后的集合保存在 dstkeyN 中。对于集合中每一个元素的 score，在进行 AGGREGATE 运算前，都要乘以对于的 WEIGHT 参数。如果没有提供 WEIGHT，默认为 1。默认的 AGGREGATE 是 SUM，即结果集合中元素的 score 是所有集合对应元素进行 SUM 运算的值，而 MIN 和 MAX 是指，结果集合中元素的 score 是所有集合对应元素中最小值和最大值。6. 对 Hash 操作的命令
hset(key, field, value)：向名称为 key 的 hash 中添加元素 field — value
hget(key, field)：返回名称为 key 的 hash 中 field 对应的 value
hmget(key, field1, …,field N)：返回名称为 key 的 hash 中 field i 对应的 value
hmset(key, field1, value1,…,field N, value N)：向名称为 key 的 hash 中添加元素 field i — value i
hincrby(key, field, integer)：将名称为 key 的 hash 中 field 的 value 增加 integer
hexists(key, field)：名称为 key 的 hash 中是否存在键为 field 的域
hdel(key, field)：删除名称为 key 的 hash 中键为 field 的域
hlen(key)：返回名称为 key 的 hash 中元素个数
hkeys(key)：返回名称为 key 的 hash 中所有键
hvals(key)：返回名称为 key 的 hash 中所有键对应的 value
hgetall(key)：返回名称为 key 的 hash 中所有的键（field）及其对应的 value五、Redis 命名规则
由于 Redis 所有数据为键值对，即所有数据均只能通过键值（Key）来进行管理，故需
要规范命名规则，jedis 客户端包装了有专门的命名规则生产函数，调用即可！
关于 redis 有哪些 api 就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。
向 AI 问一下细节
丸趣 TV 网 – 提供最优质的资源集合！
正文完
![Frank#smith[Kfyzeiuqujbpygze,2,5]](https://cravatar.cn/avatar/ebd2642d86a4b40100d29dc76ec89b0d?s=96&d=monsterid&r=r)
