Redis08_SpringBoot与Redis整合

心已赠人 2022-12-02 15:21 139阅读 0赞

**Redis08\_SpringBoot与Redis整合**

--------------------

**RedisAutoConfiguration 源码分析：**

/** * @ConditionalOnMissingBean(name = "redisTemplate") * 这个注解表示如果name为“redisTemplate”的bean已存在，则该注解修饰的代码块不执行。 * 所以我们可以自定义一个RedisTemplate来替换该默认配置 * * 两个泛型都是Object类型，所以我们使用需要强制转换：<String, Object> **/
    	@Bean
    	@ConditionalOnMissingBean(name = "redisTemplate")	
    	public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
    			throws UnknownHostException { 
    		RedisTemplate<Object, Object> template = new RedisTemplate<>();
    		template.setConnectionFactory(redisConnectionFactory);
    		return template;
    	}
    
    	/** * 因为 String 类型是Redis最常使用的类型，所以单独提出来了一个 StringRedisTemplate bean * **/
    	@Bean
    	@ConditionalOnMissingBean
    	public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory)
    			throws UnknownHostException { 
    		StringRedisTemplate template = new StringRedisTemplate();
    		template.setConnectionFactory(redisConnectionFactory);
    		return template;
    	}

**依赖：**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.3.3.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.blu</groupId>
    	<artifactId>springboot-redis-01</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>springboot-redis-01</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-data-redis</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-configuration-processor</artifactId>
    			<optional>true</optional>
    		</dependency>
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    			<optional>true</optional>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    			<exclusions>
    				<exclusion>
    					<groupId>org.junit.vintage</groupId>
    					<artifactId>junit-vintage-engine</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>
    	</dependencies>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

**配置：**

spring.redis.host=127.0.0.1
    spring.redis.port=6379

测试：

@SpringBootTest
    class SpringbootRedis01ApplicationTests { 
    	
    	@Autowired
    	private RedisTemplate<Object, Object> redisTemplate;
    
    	@Test
    	void contextLoads() { 
    		RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
    		connection.flushDb();
    		redisTemplate.opsForValue().set("name", "BLU");
    		Object object = redisTemplate.opsForValue().get("name");
    		System.out.println(object.toString());
    		redisTemplate.opsForList().leftPush("mylist", "a");
    		redisTemplate.opsForList().leftPush("mylist", "b");
    		List<Object> list = redisTemplate.opsForList().range("mylist", 0, -1);
    		for(Object o : list) { 
    			System.out.println(o);
    		}
    				
    	}
    
    }

BLU
    b
    a

**实体类（需要序列化）：**

@Component
    @AllArgsConstructor
    @NoArgsConstructor
    @Data
    public class User implements Serializable{ 
    	private String name;
    	private int age;
    }

@Autowired
    private RedisTemplate<Object, Object> redisTemplate;
    
    @Test
    public void test() throws JsonProcessingException { 
    	RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
    	connection.flushDb();
    	User user = new User("BLU",3);
    	redisTemplate.opsForValue().set("user",user);
    	System.out.println(redisTemplate.opsForValue().get("user"));	
    
    }

User(name=BLU, age=3)

**问题：**  
![在这里插入图片描述][20200831225156847.png_pic_left]  
**解决（自定义一个 RedisTemplate）：**

@Configuration
    public class RedisConfig { 
    	
    	/** * 自定义一个RedisTemplate */
    
    	@Bean
    	public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
    			throws UnknownHostException { 
    		RedisTemplate<String, Object> template = new RedisTemplate<String,Object>();
    		template.setConnectionFactory(redisConnectionFactory);
    		
    		Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
    		ObjectMapper om = new ObjectMapper();
    		om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
    		om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
    		jackson2JsonRedisSerializer.setObjectMapper(om);
    		
    		StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
    		
    		template.setKeySerializer(stringRedisSerializer);
    		template.setHashKeySerializer(stringRedisSerializer);
    		template.setValueSerializer(jackson2JsonRedisSerializer);
    		template.setHashValueSerializer(jackson2JsonRedisSerializer);
    		template.afterPropertiesSet();
    		
    		return template;
    	}
    }

@Autowired
    private RedisTemplate<String, Object> redisTemplate;
    
    @Test
    public void test() throws JsonProcessingException { 
    	RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
    	connection.flushDb();
    	User user = new User("BLU",3);
    	redisTemplate.opsForValue().set("user",user);
    	System.out.println(redisTemplate.opsForValue().get("user"));	
    
    }

![在这里插入图片描述][20200831225816286.png_pic_left]

--------------------

**RedisUtils工具类：**

package com.blu.utils;
    
    import java.util.List;
    import java.util.Map;
    import java.util.Set;
    import java.util.concurrent.TimeUnit;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    import org.springframework.util.CollectionUtils;
    
    @Component
    public final class RedisUtils { 
     
     
        @Autowired
     
        private RedisTemplate<String, Object> redisTemplate;
     
        // =============================common============================
     
        /** * 26 * 指定缓存失效时间 * 27 * * @param key 键 * 28 * @param time 时间(秒) * 29 * @return 30 */
     
        public boolean expire(String key, long time) { 
     
            try { 
     
                if (time > 0) { 
     
                    redisTemplate.expire(key, time, TimeUnit.SECONDS);
     
                }
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 44 * 根据key 获取过期时间 * 45 * * @param key 键 不能为null * 46 * @return 时间(秒) 返回0代表为永久有效 * 47 */
     
        public long getExpire(String key) { 
     
            return redisTemplate.getExpire(key, TimeUnit.SECONDS);
     
        }
     
        /** * 53 * 判断key是否存在 * 54 * * @param key 键 * 55 * @return true 存在 false不存在 * 56 */
     
        public boolean hasKey(String key) { 
     
            try { 
     
                return redisTemplate.hasKey(key);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 67 * 删除缓存 * 68 * * @param key 可以传一个值 或多个 * 69 */
     
        @SuppressWarnings("unchecked")
     
        public void del(String... key) { 
     
            if (key != null && key.length > 0) { 
     
                if (key.length == 1) { 
     
                    redisTemplate.delete(key[0]);
     
                } else { 
     
                    redisTemplate.delete(CollectionUtils.arrayToList(key));
     
                }
     
            }
     
        }
     
        // ============================String=============================
     
        /** * 83 * 普通缓存获取 * 84 * * @param key 键 * 85 * @return 值 * 86 */
     
        public Object get(String key) { 
     
            return key == null ? null : redisTemplate.opsForValue().get(key);
     
        }
     
        /** * 92 * 普通缓存放入 * 93 * * @param key 键 * 94 * @param value 值 * 95 * @return true成功 false失败 * 96 */
     
        public boolean set(String key, Object value) { 
     
            try { 
     
                redisTemplate.opsForValue().set(key, value);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 109 * 普通缓存放入并设置时间 * 110 * * @param key 键 * 111 * @param value 值 * 112 * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期 * 113 * @return true成功 false 失败 * 114 */
     
        public boolean set(String key, Object value, long time) { 
     
            try { 
     
                if (time > 0) { 
     
                    redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
     
                } else { 
     
                    set(key, value);
     
                }
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 130 * 递增 * 131 * * @param key 键 * 132 * @param delta 要增加几(大于0) * 133 * @return 134 */
     
        public long incr(String key, long delta) { 
     
            if (delta < 0) { 
     
                throw new RuntimeException("递增因子必须大于0");
     
            }
     
            return redisTemplate.opsForValue().increment(key, delta);
     
        }
     
        /** * 143 * 递减 * 144 * * @param key 键 * 145 * @param delta 要减少几(小于0) * 146 * @return 147 */
     
        public long decr(String key, long delta) { 
     
            if (delta < 0) { 
     
                throw new RuntimeException("递减因子必须大于0");
     
            }
     
            return redisTemplate.opsForValue().increment(key, -delta);
     
        }
     
        // ================================Map=================================
     
        /** * 157 * HashGet * 158 * * @param key 键 不能为null * 159 * @param item 项 不能为null * 160 * @return 值 * 161 */
     
        public Object hget(String key, String item) { 
     
            return redisTemplate.opsForHash().get(key, item);
     
        }
     
        /** * 167 * 获取hashKey对应的所有键值 * 168 * * @param key 键 * 169 * @return 对应的多个键值 * 170 */
     
        public Map<Object, Object> hmget(String key) { 
     
            return redisTemplate.opsForHash().entries(key);
     
        }
     
        /** * 176 * HashSet * 177 * * @param key 键 * 178 * @param map 对应多个键值 * 179 * @return true 成功 false 失败 * 180 */
     
        public boolean hmset(String key, Map<String, Object> map) { 
     
            try { 
     
                redisTemplate.opsForHash().putAll(key, map);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 192 * HashSet 并设置时间 * 193 * * @param key 键 * 194 * @param map 对应多个键值 * 195 * @param time 时间(秒) * 196 * @return true成功 false失败 * 197 */
     
        public boolean hmset(String key, Map<String, Object> map, long time) { 
     
            try { 
     
                redisTemplate.opsForHash().putAll(key, map);
     
                if (time > 0) { 
     
                    expire(key, time);
     
                }
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 212 * 向一张hash表中放入数据,如果不存在将创建 * 213 * * @param key 键 * 214 * @param item 项 * 215 * @param value 值 * 216 * @return true 成功 false失败 * 217 */
     
        public boolean hset(String key, String item, Object value) { 
     
            try { 
     
                redisTemplate.opsForHash().put(key, item, value);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 229 * 向一张hash表中放入数据,如果不存在将创建 * 230 * * @param key 键 * 231 * @param item 项 * 232 * @param value 值 * 233 * @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间 * 234 * @return true 成功 false失败 * 235 */
     
        public boolean hset(String key, String item, Object value, long time) { 
     
            try { 
     
                redisTemplate.opsForHash().put(key, item, value);
     
                if (time > 0) { 
     
                    expire(key, time);
     
                }
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 250 * 删除hash表中的值 * 251 * * @param key 键 不能为null * 252 * @param item 项 可以使多个 不能为null * 253 */
     
        public void hdel(String key, Object... item) { 
     
            redisTemplate.opsForHash().delete(key, item);
     
        }
     
        /** * 259 * 判断hash表中是否有该项的值 * 260 * * @param key 键 不能为null * 261 * @param item 项 不能为null * 262 * @return true 存在 false不存在 * 263 */
     
        public boolean hHasKey(String key, String item) { 
     
            return redisTemplate.opsForHash().hasKey(key, item);
     
        }
     
        /** * 269 * hash递增 如果不存在,就会创建一个 并把新增后的值返回 * 270 * * @param key 键 * 271 * @param item 项 * 272 * @param by 要增加几(大于0) * 273 * @return 274 */
     
        public double hincr(String key, String item, double by) { 
     
            return redisTemplate.opsForHash().increment(key, item, by);
     
        }
     
        /** * 280 * hash递减 * 281 * * @param key 键 * 282 * @param item 项 * 283 * @param by 要减少记(小于0) * 284 * @return 285 */
     
        public double hdecr(String key, String item, double by) { 
     
            return redisTemplate.opsForHash().increment(key, item, -by);
     
        }
     
        // ============================set=============================
     
        /** * 292 * 根据key获取Set中的所有值 * 293 * * @param key 键 * 294 * @return 295 */
     
        public Set<Object> sGet(String key) { 
     
            try { 
     
                return redisTemplate.opsForSet().members(key);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return null;
     
            }
     
        }
     
        /** * 306 * 根据value从一个set中查询,是否存在 * 307 * * @param key 键 * 308 * @param value 值 * 309 * @return true 存在 false不存在 * 310 */
     
        public boolean sHasKey(String key, Object value) { 
     
            try { 
     
                return redisTemplate.opsForSet().isMember(key, value);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 321 * 将数据放入set缓存 * 322 * * @param key 键 * 323 * @param values 值 可以是多个 * 324 * @return 成功个数 * 325 */
     
        public long sSet(String key, Object... values) { 
     
            try { 
     
                return redisTemplate.opsForSet().add(key, values);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
     
        /** * 336 * 将set数据放入缓存 * 337 * * @param key 键 * 338 * @param time 时间(秒) * 339 * @param values 值 可以是多个 * 340 * @return 成功个数 * 341 */
     
        public long sSetAndTime(String key, long time, Object... values) { 
     
            try { 
     
                Long count = redisTemplate.opsForSet().add(key, values);
     
                if (time > 0)
     
                    expire(key, time);
     
                return count;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
     
        /** * 355 * 获取set缓存的长度 * 356 * * @param key 键 * 357 * @return 358 */
     
        public long sGetSetSize(String key) { 
     
            try { 
     
                return redisTemplate.opsForSet().size(key);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
     
        /** * 369 * 移除值为value的 * 370 * * @param key 键 * 371 * @param values 值 可以是多个 * 372 * @return 移除的个数 * 373 */
     
        public long setRemove(String key, Object... values) { 
     
            try { 
     
                Long count = redisTemplate.opsForSet().remove(key, values);
     
                return count;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
     
        // ===============================list=================================
     
        /** * 386 * 获取list缓存的内容 * 387 * * @param key 键 * 388 * @param start 开始 * 389 * @param end 结束 0 到 -1代表所有值 * 390 * @return 391 */
     
        public List<Object> lGet(String key, long start, long end) { 
     
            try { 
     
                return redisTemplate.opsForList().range(key, start, end);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return null;
     
            }
     
        }
     
        /** * 402 * 获取list缓存的长度 * 403 * * @param key 键 * 404 * @return 405 */
     
        public long lGetListSize(String key) { 
     
            try { 
     
                return redisTemplate.opsForList().size(key);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
     
        /** * 416 * 通过索引 获取list中的值 * 417 * * @param key 键 * 418 * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推 * 419 * @return 420 */
     
        public Object lGetIndex(String key, long index) { 
     
            try { 
     
                return redisTemplate.opsForList().index(key, index);
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return null;
     
            }
     
        }
     
        /** * 431 * 将list放入缓存 * 432 * * @param key 键 * 433 * @param value 值 * 434 * @param time 时间(秒) * 435 * @return 436 */
     
        public boolean lSet(String key, Object value) { 
     
            try { 
     
                redisTemplate.opsForList().rightPush(key, value);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 将list放入缓存 * * @param key 键 * @param value 值 * @param time 时间(秒) * @return */
     
        public boolean lSet(String key, Object value, long time) { 
     
            try { 
     
                redisTemplate.opsForList().rightPush(key, value);
     
                if (time > 0)
     
                    expire(key, time);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 467 * 将list放入缓存 * 468 * * @param key 键 * 469 * @param value 值 * 470 * @param time 时间(秒) * 471 * @return 472 */
     
        public boolean lSet(String key, List<Object> value) { 
     
            try { 
     
                redisTemplate.opsForList().rightPushAll(key, value);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 484 * 将list放入缓存 * 485 * <p> * 486 * * @param key 键 * 487 * @param value 值 * 488 * @param time 时间(秒) * 489 * @return 490 */
     
        public boolean lSet(String key, List<Object> value, long time) { 
     
            try { 
     
                redisTemplate.opsForList().rightPushAll(key, value);
     
                if (time > 0)
     
                    expire(key, time);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 504 * 根据索引修改list中的某条数据 * 505 * * @param key 键 * 506 * @param index 索引 * 507 * @param value 值 * 508 * @return 509 */
     
        public boolean lUpdateIndex(String key, long index, Object value) { 
     
            try { 
     
                redisTemplate.opsForList().set(key, index, value);
     
                return true;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return false;
     
            }
     
        }
     
        /** * 521 * 移除N个值为value * 522 * * @param key 键 * 523 * @param count 移除多少个 * 524 * @param value 值 * 525 * @return 移除的个数 * 526 */
     
        public long lRemove(String key, long count, Object value) { 
     
            try { 
     
                Long remove = redisTemplate.opsForList().remove(key, count, value);
     
                return remove;
     
            } catch (Exception e) { 
     
                e.printStackTrace();
     
                return 0;
     
            }
     
        }
    }

**测试使用工具类：**

@Autowired
    private RedisUtils redisUtils;
    
    @Test
    void test() { 
    	redisUtils.set("name", "BLU");
    	System.out.println(redisUtils.get("name"));
    }

BLU

[20200831225156847.png_pic_left]: /images/20221123/89d3480f901d458487e0123e94012106.png
[20200831225816286.png_pic_left]: /images/20221123/f0a34eadac1b4211bdd9f48d6fcdf423.png