Redis之使用教程(Java版)java
博客地址 https://blog.piaoruiqing.com/blog/2019/06/11/redis使用进阶git
Jedis
: redis java客户端实现.Lettuce
: redis java客户端实现, 基于netty.spring-data-redis
: Spring针对redis的封装, 配置简单, 提供了与Redis存储交互的抽象封装, 十分优雅, 也极具扩展性. 可集成Jedis、Lettuce等redis客户端. springboot2.0后官方默认集成的客户端从Jedis改成Lettuce.本文将针对使用Java集成Redis进行讲解, Jedis
及Lettuce
的使用仅做简单描述, spring
的redis
集成及使用将做为主要讲解内容.github
引入依赖:spring
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.3</version>
</dependency>
复制代码
Jedis
是对redis命令的封装, 使用上基本与redis-cli
无异, 操做string的使用示例以下:docker
/** jedis pool */
private static final JedisPool POOL = new JedisPool(new JedisPoolConfig(), "test-redis-server", 6379);
// test Binary-safe strings with Jedis
try (Jedis jedis = POOL.getResource()){
{ // SET mykey myvalue
String result = jedis.set("mykey", "myvalue");
LOGGER.info("cmd: SET mykey myvalue, result: {}", result);
}
{ // GET mykey
String result = jedis.get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
{ // KEYS my*
Set<String> keys = jedis.keys("my*");
LOGGER.info("cmd: KEYS my*, result: {}", JsonUtils.writeValueAsString(keys, true));
}
{ // EXISTS mykey
Boolean result = jedis.exists("mykey");
LOGGER.info("cmd: EXISTS mykey, result: {}", result);
}
{ // DEL mykey
Long result = jedis.del("mykey");
LOGGER.info("cmd: DEL mykey, result: {}", result);
}
{ // GET mykey
String result = jedis.get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
}
复制代码
JedisPool
: Jedis并非线程安全的, 因此多线程状况下不该共用Jedis
实例, 但建立大量的Jedis会形成没必要要的开销甚至对性能产生较大影响, 故使用JedisPool
来避免这些问题, 它是一个线程安全的网络链接池. 可使用它可靠地建立多个Jedis实例, 完成后将Jedis实例回收到链接池中.JedisPool.getResource
: 从链接池获取一个Jedis链接, 注意: Jedis
使用完毕后须要调用Jedis.close
方法释放资源.(Jedis
实现了AutoCloseable
, 推荐使用try-with-resource
的写法)lettuce.io/ubuntu
引入依赖:数组
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>5.1.7.RELEASE</version>
</dependency>
复制代码
Lettuce是一个可扩展的Redis客户端,用于构建非阻塞的Reactive应用程序. 它基于Netty框架构建, 性能较高, 且支持不少redis的高级特性. 目前springboot2.0已将Lettuce做为默认redis客户端. 与上一小节对应, 操做string的使用示例以下:缓存
/** redis client */
private static final RedisClient CLIENT = RedisClient.create("redis://@test-redis-server:6379/0");
// test Binary-safe strings with Lettuce
try (StatefulRedisConnection<String, String> connection = CLIENT.connect()) {
RedisCommands<String, String> commands = connection.sync();
{ // SET mykey myvalue
String result = commands.set("mykey", "myvalue");
LOGGER.info("cmd: SET mykey myvalue, result: {}", result);
}
{ // GET mykey
String result = commands.get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
{ // KEYS my*
List<String> keys = commands.keys("my*");
LOGGER.info("cmd: KEYS my*, result: {}", JsonUtils.writeValueAsString(keys, true));
}
{ // EXISTS mykey
Long result = commands.exists("mykey");
LOGGER.info("cmd: EXISTS mykey, result: {}", result);
}
{ // DEL mykey
Long result = commands.del("mykey");
LOGGER.info("cmd: DEL mykey, result: {}", result);
}
{ // GET mykey
String result = commands.get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
}
复制代码
spring-data-redis
是Spring Data
家族的一部分, 提供了简单的配置以轻松访问redis, 针对存储操做提供了低级别和高级别的抽象, 将开发人员从基础实现中解放出来.安全
引入依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<version>2.1.5.RELEASE</version>
</dependency>
复制代码
使用spring-data-redis
开发时, 可能最常使用的就是RedisTemplate
, 因此在开始前咱们先了解下RedisTemplate
:
RedisTemplate
是一个简化了Redis访问的工具类.execute
方法, 支持callback, 它提供的RedisConnection
处理方式不须要关心链接的声明周期(简言之就是不用建立也不用关链接)使用方法很简单, 首先在Configuration
中定义StringRedisTemplate
的Bean:
/** * StringRedisTemplate * @param factory * @return */
@Bean
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
StringRedisTemplate template = new StringRedisTemplate(factory);
StringRedisSerializer serializer = new StringRedisSerializer(); // (一)
template.setKeySerializer(serializer); // (二)
template.setHashKeySerializer(serializer);
template.setValueSerializer(serializer);
template.setHashValueSerializer(serializer);
return template;
}
复制代码
(一): RedisSerializer
: 对象到二进制数组序列化和反序列化接口, 序列化和反序列化key和value, StringRedisSerializer
、GenericJackson2JsonRedisSerializer
都是其实现.
(二): KeySerializer
用来序列化redis key, HashKeySerializer
用来序列化redis hash数据结构的field. 请勿混淆.
固然, 不要忘记了application.yml
中添加redis相关配置:
spring:
redis:
host: test-redis-server
port: 6379
复制代码
准备工做完成了, 如今就来体验一下, 一样地与前文对应, 操做string的使用示例以下: :
@Resource
private StringRedisTemplate stringRedisTemplate;
/** * test Binary-safe strings with RedisTemplate */
@Test
public void testStringRedisTemplateSimple() {
{ // SET mykey myvalue
stringRedisTemplate.opsForValue().set("mykey", "myvalue");
}
{ // GET mykey
String result = stringRedisTemplate.opsForValue().get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
{ // KEYS my*
Set<String> keys = stringRedisTemplate.keys("my*");
LOGGER.info("cmd: KEYS my*, result: {}", JsonUtils.writeValueAsString(keys, true));
}
{ // EXISTS mykey
Boolean result = stringRedisTemplate.hasKey("mykey");
LOGGER.info("cmd: EXISTS mykey, result: {}", result);
}
{ // DEL mykey
Boolean result = stringRedisTemplate.delete("mykey");
LOGGER.info("cmd: DEL mykey, result: {}", result);
}
{ // GET mykey
String result = stringRedisTemplate.opsForValue().get("mykey");
LOGGER.info("cmd: GET mykey, result: {}", result);
}
}
复制代码
opsForValue
: 获取Binary-safe strings
的操做类ValueOperations
( 即spring对redis操做的一个封装类. 一样地, 对hash
、set
等也有其对应的封装HashOperations
、SetOperations
等).不一样应用的缓存能够简单地经过key的前缀来划分
让咱们来思考这样一个问题, 若是咱们想要对不一样应用(服务)的缓存进行划分, 以便于管理和维护, 应该如何实现?
或许增长前缀是一个不错的想法, 但若是每次编码中都须要将前缀prefix
拼接到key中, 一方面增长了工做量, 另外一份面也增长了出错的风险, 若是忘记拼接了怎么办. 对, 也许你也想到了, 前文提到RedisSerializer
是spring-data-redis
对象到二进制数组序列化和反序列化接口, 用来序列化和反序列化key和value, 咱们能够从这里作文章:
public interface RedisSerializer<T> {
/** * Serialize the given object to binary data. * * @param t object to serialize. Can be {@literal null}. * @return the equivalent binary data. Can be {@literal null}. */
@Nullable
byte[] serialize(@Nullable T t) throws SerializationException;
/** * Deserialize an object from the given binary data. * * @param bytes object binary representation. Can be {@literal null}. * @return the equivalent object instance. Can be {@literal null}. */
@Nullable
T deserialize(@Nullable byte[] bytes) throws SerializationException;
}
复制代码
serialize
: 对象 -> byte数组.deserialize
: byte数组 -> 对象.RedisTemplate
对redis的操做和RedisSerializer
都有必然的联系, 那么能够经过实现该接口并指定RedisTemplate
的KeySerializer
来实现增长前缀的功能. 如此一来, 增长前缀的操做就从业务中剥离出来, 对于调用方来讲, 彻底是透明的, 还算优雅, 具体实现以下:
/** * generic redis key serializer * @author piaoruiqing * @date: 2019-06-11 22:37 */
public class GenericRedisKeySerializer implements RedisSerializer<Object> {
private final Charset charset;
private String prefix;
private int index;
public GenericRedisKeySerializer(String prefix) {
this(prefix, StandardCharsets.UTF_8);
}
public GenericRedisKeySerializer(String prefix, Charset charset) {
Assert.notNull(charset);
Assert.notNull(prefix);
this.charset = charset;
this.prefix = prefix + ":";
index = this.prefix.length();
}
@Override
public String deserialize(byte[] bytes) {
if (null == bytes) {
return null;
}
String key = new String(bytes, charset);
if (key.indexOf(prefix) == 0) {
return key.substring(index, key.length());
}
return key;
}
@Override
public byte[] serialize(Object key) {
if (null == key) {
return null;
}
String string = key.toString();
if (!string.startsWith(prefix)) {
string = prefix + string;
}
return string.getBytes(charset);
}
}
复制代码
将前文的StringRedisTemplate
稍做修改:
@Value("${spring.application.name:undefined}")
private String applicationName;
/** * StringRedisTemplate * @param factory * @return */
@Bean
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
StringRedisTemplate template = new StringRedisTemplate(factory);
// StringRedisSerializer serializer = new StringRedisSerializer();
GenericRedisKeySerializer serializer = new GenericRedisKeySerializer(applicationName);
template.setKeySerializer(serializer);
template.setHashKeySerializer(serializer);
template.setValueSerializer(serializer);
template.setHashValueSerializer(serializer);
return template;
}
复制代码
StringRedisSerializer
替换为自定义的GenericRedisKeySerializer
并指定前缀为应用名体验一下:
stringRedisTemplate.opsForValue().set("mykey", "myvalue");
String result = stringRedisTemplate.opsForValue().get("mykey"); // "myvalue"
复制代码
链接到redis查看key, 已经带有前缀了
root@ubuntu:/home/ubuntu# docker exec -it redis redis-cli
127.0.0.1:6379> keys *
1) "redis-simple:mykey"
复制代码
RedisTemplate
默认使用JDK序列化JdkSerializationRedisSerializer
, 咱们能够指定使用其余方式的序列化, 好比JSON、protostuff
前文已经描述了如何自定义key的序列化方式, value的序列化配置与其相同, 都是实现RedisSerializer
并在建立RedisTemplate
时指定, 就不重复贴代码了.
经常使用的序列化方式有几种:
JDK
: 默认, 比较方便, 可序列化全部的类, 但速度慢且占空间较大.JSON
: 性能好, 输出内容比较易读.Protostuff
: 性能很高, 速度快且占用空间较小.本文针对redis讲解了redis java客户端的使用、与spring集成以及进阶使用, 后续将针对Redis的其余使用技巧进行讲解, 敬请关注.