SpringBoot第41讲：SpringBoot集成Redis - 基于RedisTemplate+Jedis的数据操作

SpringBoot第41讲：SpringBoot集成Redis - 基于RedisTemplate+Jedis的数据操作

Redis是最常用的KV数据库，Spring 通过模板方式（RedisTemplate）提供了对Redis的数据查询和操作功能。本文是SpringBoot第41讲，主要介绍基于RedisTemplate + Jedis方式对Redis进行查询和操作的案例。

1、知识准备

需要对Redis的基础和基础数据类型有理解，且需要对Spring中对数据库操作常见的模板方式的封装了解，并了解RedisTemplate。

1.1、Redis基础和5种基础数据类型

Redis 相关的知识体系，请参考 Redis知识体系详解+原理+应用+面试

首先对Redis来说，所有的key（键）都是字符串。我们在谈基础数据结构时，讨论的是存储值的数据类型，主要包括常见的5种数据类型，分别是：String、List、Set、Zset、Hash。

结构类型	结构存储的值	结构的读写能力
String字符串	可以是字符串、整数或浮点数	对整个字符串或字符串的一部分进行操作；对整数或浮点数进行自增或自减操作；
List列表	一个链表，链表上的每个节点都包含一个字符串	对链表的两端进行push和pop操作，读取单个或多个元素；根据值查找或删除元素；
Set集合	包含字符串的无序集合	字符串的集合，包含基础的方法：是否存在添加、获取、删除；还包含计算交集、并集、差集等
Hash散列	包含键值对的无序散列表	包含方法有添加、获取、删除单个元素
Zset有序集合	和散列一样，用于存储键值对	字符串成员与浮点数分数之间的有序映射；元素的排列顺序由分数的大小决定；包含方法有添加、获取、删除单个元素 以及根据分值范围或成员来获取元素

1.2、什么是 Jedis (SpringBoot 1.x)

Jedis是Redis的Java客户端，在 SpringBoot 1.x 版本中也是默认的客户端。在 SpringBoot 2.x 版本中默认客户端是Luttuce。

1.3、Spring中的 Template 和 RedisTemplate

Spring 通过模板方式（RedisTemplate）提供了对Redis的数据查询和操作功能。

什么是模板模式？

模板方法模式(Template pattern): 在一个方法中定义一个算法的骨架, 而将一些步骤延迟到子类中. 模板方法使得子类可以在不改变算法结构的情况下, 重新定义算法中的某些步骤。

Spring中有哪些模板模式的设计？

比如：jdbcTemplate, mongodbTemplate, elasticsearchTemplate…等等

对五种基础数据类型和三种特殊数据类型的操作？可以参考这篇文章 Redis入门 - 数据类型：5种基础数据类型和3种特殊类型详解

RedisTemplate对于Redis5种基础类型的操作？

redisTemplate.opsForValue(); // 操作字符串
redisTemplate.opsForHash(); // 操作hash
redisTemplate.opsForList(); // 操作list
redisTemplate.opsForSet(); // 操作set
redisTemplate.opsForZSet(); // 操作zset

对HyperLogLogs（基数统计）类型的操作?

redisTemplate.opsForHyperLogLog();

对geospatial (地理位置)类型的操作?

redisTemplate.opsForGeo();

对于BitMap的操作？也是在opsForValue()方法返回类型ValueOperations中

Boolean setBit(K key, long offset, boolean value);
Boolean getBit(K key, long offset);

对于Stream的操作？

相关内容请 参考: Redis Stream 详解

redisTemplate.opsForStream();

2、实现案例

本例子主要基于SpringBoot2+ 使用Jedis客户端，通过RedisTemplate模板方式访问Redis数据。

2.1、包依赖

引入spring-boot-starter-data-redis包，SpringBoot2中默认的客户端是Lettuce, 所以需要exclude掉lettuce-core包，并引入jedis的包。

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
    <exclusions>
        <exclusion>
            <artifactId>lettuce-coreartifactId>
            <groupId>io.lettucegroupId>
        exclusion>
    exclusions>
dependency>
<dependency>
    <groupId>redis.clientsgroupId>
    <artifactId>jedisartifactId>
dependency>
<dependency>
    <groupId>org.apache.commonsgroupId>
    <artifactId>commons-pool2artifactId>
    <version>2.9.0version>
dependency>

2.2、yml配置

如下是常用的Jedis的使用配置

spring:
  redis:
    database: 0
    host: 127.0.0.1
    port: 6379
#    password: test
    Auth: 123456
    jedis:
      pool:
        min-idle: 0
        max-active: 8
        max-idle: 8
        max-wait: -1ms
    connect-timeout: 30000ms

使用 Auth: 123456 是为了解决这个问题

• 【redis】ERR AUTH ＜password＞ called without any password configured for the default user

2.3、RedisConfig配置

通过@Bean的方式配置RedisTemplate，主要是设置RedisConnectionFactory以及各种类型数据的Serializer。

package springboot.redis.jedis.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

/**
 * Redis configuration.
 *
 * @author qiwenjie
 */
@Configuration
public class RedisConfig {

    /**
     * redis template.
     *
     * @param factory factory
     * @return RedisTemplate
     */
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.afterPropertiesSet();
        return template;
    }
}

2.4、RedisTemplate的使用

我们以整个系列文章一致的UserController简单示例下

package springboot.redis.jedis.controller;

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.*;
import springboot.redis.jedis.entity.User;
import springboot.redis.jedis.entity.response.ResponseResult;
import javax.annotation.Resource;

/**
 * @author qiwenjie
 */
@RestController
@RequestMapping("/user")
public class UserController {

    // 注意：这里@Autowired是报错的，因为@Autowired按照类名注入的
    @Resource
    private RedisTemplate<String, User> redisTemplate;

    /**
     * @param user user param
     * @return user
     */
    @ApiOperation("Add")
    @PostMapping("add")
    public ResponseResult<User> add(User user) {
        redisTemplate.opsForValue().set(String.valueOf(user.getId()), user);
        return ResponseResult.success(redisTemplate.opsForValue().get(String.valueOf(user.getId())));
    }

    /**
     * @return user list
     */
    @ApiOperation("Find")
    @GetMapping("find/{userId}")
    public ResponseResult<User> edit(@PathVariable("userId") String userId) {
        return ResponseResult.success(redisTemplate.opsForValue().get(userId));
    }
}

2.5、简单测试

插入数据：redisTemplate.opsForValue().set();

获取数据：redisTemplate.opsForValue().get();

3、spring-boot-starter-redis详解

3.1、背景

为啥要自定义starter，增强代码复用性

3.2、怎么实现的？

白龙马自行实现了redis的starter，添加了redis多数据源功能

使用了Spring拦截器，选择具体的redis管理器实例，然后执行具体方法

package com.huxun.springboot.autoconfig.redis;

import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;

/**
 * @Description: 用于管理多个Redis客户端实例的管理器。
 */
public class MultiRedisClientManager extends RedisClientManager implements MethodInterceptor {

    /**
     * redis选择器。
     */
    private RedisSelector redisSelector;

    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        // 选择具体的redis管理器实例
        RedisClientManager clientManager = redisSelector.select();
        // 执行具体方法
        return method.invoke(clientManager, objects);
    }

    public void setRedisSelector(RedisSelector redisSelector) {
        this.redisSelector = redisSelector;
    }
}

3.3、怎么使用？

在防重提交拦截器中的使用

引入依赖

<dependency>
      <groupId>com.huxungroupId>
      <artifactId>spring-boot-starter-redisartifactId>
      <version>1.0.1version>
dependency>

java代码

@Component
@Slf4j
public class ResubmitCheckInterceptor implements HandlerInterceptor {
   	@Autowired
    private RedisClientManager redisClientManager;
  
   	boolean lockResult = redisClientManager.setnx(key, HxTrace.getTraceId(), reCheck.expireTime(), reCheck.timeUnit());
    if (!lockResult) {
      throw new FinanceException(ServiceResponseCode.DATA_IS_NULL.getCode(), reCheck.info());
    }
    try {
      	redisClientManager.delIfValue(lockKey, HxTrace.getTraceId());
    } catch (Exception e) {
      log.warn("redis删除key失败，param:{}, cause:{}", lockKey, e);
    }
}

4、示例源码

todo