SpringBoot整合Redis—使用RedisRepositories詳解

2022-03-15 13:01:01

SpringBoot整合Redis

1.新增redis依賴

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-pool2</artifactId>
</dependency>

2.在application.properties中新增redis設定資訊

spring.redis.host=127.0.0.1
# Redis伺服器連線埠
spring.redis.port=6379
# Redis伺服器連線密碼（預設為空）
spring.redis.password=
# 連線池最大連線數（使用負值表示沒有限制）
spring.redis.lettuce.pool.max-active=8
# 連線池最大阻塞等待時間（使用負值表示沒有限制）
spring.redis.lettuce.pool.max-wait=-1
# 連線池中的最大空閒連線
spring.redis.lettuce.pool.max-idle=8
# 連線池中的最小空閒連線
spring.redis.lettuce.pool.min-idle=0
# 連線超時時間（毫秒）
spring.redis.timeout=30000

3.SpringBoot啟動類中新增註解設定

@EnableCaching
@EnableRedisRepositories
//註解開啟使用RedisRepositories
//CRUD操作將會操作redis中的資料
@SpringBootApplication
public class RedisApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(RedisApplication.class, args);
    } 
}

4.建立實體類Entity

@Data
@RedisHash("user")
//RedisHash非常重要
//user表示在redis中新建user集合
//之後所有的UserEntity的儲存操作全部會儲存在user這個集合中
//儲存時Key的格式為——user：id
public class UserEntity{
    @Id
    private Long id; 
    private String name; 
    private Integer age; 
    private Date createTime = new Date();
}

5.建立Dao層——資料操作層

@Repository
public interface UserDao extends CrudRepository<UserEntity,Long> {
}

6.建立Service層——服務層

@Service
public class UserService {
 
    @Autowired
    private UserDao userDao;
 
//因為使用了RedisRepositories，所以簡單的crud將不用使用RedisTemplate
//    @Autowired
//    private RedisTemplate redisTemplate; 
 
    /**
     * 按user:id的方式存入redis
     * @param user
     */
    public void save(UserEntity user){
        //redisTemplate.opsForValue().set(new Random().nextDouble() + "",user); 
        userDao.save(user); 
    }
 
    /**
     * 根據key從redis中查詢對應value
     * @param id
     * @return
     */
    public UserEntity findOne(Long id){ 
        //UserEntity user = (UserEntity) redisTemplate.opsForValue().get(key); 
        UserEntity user = userDao.findById(id).get(); 
        return user;
    }
}

7.建立Controller層——控制層

@RestController
@RequestMapping("user")
public class UserController {
 
    @Autowired
    private UserService userService;
 
    /**
     * 儲存到redis中
     * @return
     */
    @GetMapping("save")
    public String save(){
 
        UserEntity user = new UserEntity(); 
        user.setName(String.valueOf(new Random().nextInt(100000))); 
        user.setAge(new Random().nextInt(100000)); 
        userService.save(user); 
        System.out.println(user.toString()); 
        return "success";
    }
 
    /**
     * 根據key從redis中查詢value
     * @param id
     * @return
     */
    @GetMapping("find/{id}")
    public String find(@PathVariable Long id){
       UserEntity user = userService.findOne(id);
 
        System.out.println(user);
        return "success";
    }
}

8.redis設定類

@Configuration
public class RedisConfig {
 
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        template.setConnectionFactory(factory);
        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();
        // key採用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // hash的key也採用String的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value序列化方式採用jackson
        template.setValueSerializer(jackson2JsonRedisSerializer);
        // hash的value序列化方式採用jackson
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }
}

Redis中的結構為

redis封裝工具類

@Component
public class RedisUtils {
 
	@Autowired
	private RedisTemplate<String, Object> redisTemplate;
 
	// =============================common============================
 
	/**
	 * 指定快取失效時間
	 *
	 * @param key  鍵
	 * @param time 時間(秒)
	 * @return
	 */
	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;
		}
	}
 
	/**
	 * 根據key 獲取過期時間
	 *
	 * @param key 鍵 不能為null
	 * @return 時間(秒) 返回0代表為永久有效
	 */
	public long getExpire(String key) {
		return redisTemplate.getExpire(key, TimeUnit.SECONDS);
	}
 
	/**
	 * 判斷key是否存在
	 *
	 * @param key 鍵
	 * @return true 存在 false不存在
	 */
	public boolean hasKey(String key) {
		try {
			return redisTemplate.hasKey(key);
		} catch (Exception e) {
			e.printStackTrace();
			return false;
		}
	}
 
	/**
	 * 刪除快取
	 *
	 * @param key 可以傳一個值 或多個
	 */
	@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=============================
 
	/**
	 * 普通快取獲取
	 *
	 * @param key 鍵
	 * @return 值
	 */
	public  Object get(String key) {
		return key == null ? null : redisTemplate.opsForValue().get(key);
	}
 
	/**
	 * 普通快取放入
	 *
	 * @param key   鍵
	 * @param value 值
	 * @return true成功 false失敗
	 */
	public boolean set(String key, Object value) {
		try {
			redisTemplate.opsForValue().set(key, value);
			return true;
		} catch (Exception e) {
			e.printStackTrace();
			return false;
		}
	}
 
	/**
	 * 普通快取放入並設定時間
	 *
	 * @param key   鍵
	 * @param value 值
	 * @param time  時間(秒) time要大於0 如果time小於等於0 將設定無限期
	 * @return true成功 false 失敗
	 */
	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;
		}
	}
 
	/**
	 * 遞增
	 *
	 * @param key   鍵
	 * @param delta 要增加幾(大於0)
	 * @return
	 */
	public long incr(String key, long delta) {
		if (delta < 0) {
			throw new RuntimeException("遞增因子必須大於0");
		}
		return redisTemplate.opsForValue().increment(key, delta);
	}
 
	/**
	 * 遞減
	 *
	 * @param key   鍵
	 * @param delta 要減少幾(小於0)
	 * @return
	 */
	public long decr(String key, long delta) {
		if (delta < 0) {
			throw new RuntimeException("遞減因子必須大於0");
		}
		return redisTemplate.opsForValue().increment(key, -delta);
	}
	// ================================Map=================================
 
	/**
	 * HashGet
	 *
	 * @param key  鍵 不能為null
	 * @param item 項 不能為null
	 * @return 值
	 */
	public Object hget(String key, String item) {
		return redisTemplate.opsForHash().get(key, item);
	}
 
	/**
	 * 獲取hashKey對應的所有鍵值
	 *
	 * @param key 鍵
	 * @return 對應的多個鍵值
	 */
	public Map<Object, Object> hmget(String key) {
		return redisTemplate.opsForHash().entries(key);
	}
 
	/**
	 * HashSet
	 *
	 * @param key 鍵
	 * @param map 對應多個鍵值
	 * @return true 成功 false 失敗
	 */
	public boolean hmset(String key, Map<String, Object> map) {
		try {
			redisTemplate.opsForHash().putAll(key, map);
			return true;
		} catch (Exception e) {
			e.printStackTrace();
			return false;
		}
	}
 
	/**
	 * HashSet 並設定時間
	 *
	 * @param key  鍵
	 * @param map  對應多個鍵值
	 * @param time 時間(秒)
	 * @return true成功 false失敗
	 */
	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;
		}
	}
 
	/**
	 * 向一張hash表中放入資料,如果不存在將建立
	 *
	 * @param key   鍵
	 * @param item  項
	 * @param value 值
	 * @return true 成功 false失敗
	 */
	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;
		}
	}
 
	/**
	 * 向一張hash表中放入資料,如果不存在將建立
	 *
	 * @param key   鍵
	 * @param item  項
	 * @param value 值
	 * @param time  時間(秒) 注意:如果已存在的hash表有時間,這裡將會替換原有的時間
	 * @return true 成功 false失敗
	 */
	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;
		}
	}
 
	/**
	 * 刪除hash表中的值
	 *
	 * @param key  鍵 不能為null
	 * @param item 項 可以使多個 不能為null
	 */
	public void hdel(String key, Object... item) {
		redisTemplate.opsForHash().delete(key, item);
	}
 
	/**
	 * 判斷hash表中是否有該項的值
	 *
	 * @param key  鍵 不能為null
	 * @param item 項 不能為null
	 * @return true 存在 false不存在
	 */
	public boolean hHasKey(String key, String item) {
		return redisTemplate.opsForHash().hasKey(key, item);
	}
 
	/**
	 * hash遞增 如果不存在,就會建立一個 並把新增後的值返回
	 *
	 * @param key  鍵
	 * @param item 項
	 * @param by   要增加幾(大於0)
	 * @return
	 */
	public double hincr(String key, String item, double by) {
		return redisTemplate.opsForHash().increment(key, item, by);
	}
 
	/**
	 * hash遞減
	 *
	 * @param key  鍵
	 * @param item 項
	 * @param by   要減少記(小於0)
	 * @return
	 */
	public double hdecr(String key, String item, double by) {
		return redisTemplate.opsForHash().increment(key, item, -by);
	}
	// ============================set=============================
 
	/**
	 * 根據key獲取Set中的所有值
	 *
	 * @param key 鍵
	 * @return
	 */
	public Set<Object> sGet(String key) {
		try {
			return redisTemplate.opsForSet().members(key);
		} catch (Exception e) {
			e.printStackTrace();
			return null;
		}
	}
 
	/**
	 * 根據value從一個set中查詢,是否存在
	 *
	 * @param key   鍵
	 * @param value 值
	 * @return true 存在 false不存在
	 */
	public boolean sHasKey(String key, Object value) {
		try {
			return redisTemplate.opsForSet().isMember(key, value);
		} catch (Exception e) {
			e.printStackTrace();
			return false;
		}
	}
 
	/**
	 * 將資料放入set快取
	 *
	 * @param key    鍵
	 * @param values 值 可以是多個
	 * @return 成功個數
	 */
	public long sSet(String key, Object... values) {
		try {
			return redisTemplate.opsForSet().add(key, values);
		} catch (Exception e) {
			e.printStackTrace();
			return 0;
		}
	}
 
	/**
	 * 將set資料放入快取
	 *
	 * @param key    鍵
	 * @param time   時間(秒)
	 * @param values 值 可以是多個
	 * @return 成功個數
	 */
	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;
		}
	}
 
	/**
	 * 獲取set快取的長度
	 *
	 * @param key 鍵
	 * @return
	 */
	public long sGetSetSize(String key) {
		try {
			return redisTemplate.opsForSet().size(key);
		} catch (Exception e) {
			e.printStackTrace();
			return 0;
		}
	}
 
	/**
	 * 移除值為value的
	 *
	 * @param key    鍵
	 * @param values 值 可以是多個
	 * @return 移除的個數
	 */
	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=================================
 
	/**
	 * 獲取list快取的內容
	 *
	 * @param key   鍵
	 * @param start 開始
	 * @param end   結束 0 到 -1代表所有值
	 * @return
	 */
	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;
		}
	}
 
	/**
	 * 獲取list快取的長度
	 *
	 * @param key 鍵
	 * @return
	 */
	public long lGetListSize(String key) {
		try {
			return redisTemplate.opsForList().size(key);
		} catch (Exception e) {
			e.printStackTrace();
			return 0;
		}
	}
 
	/**
	 * 通過索引 獲取list中的值
	 *
	 * @param key   鍵
	 * @param index 索引 index>=0時， 0 表頭，1 第二個元素，依次類推；index<0時，-1，表尾，-2倒數第二個元素，依次類推
	 * @return
	 */
	public Object lGetIndex(String key, long index) {
		try {
			return redisTemplate.opsForList().index(key, index);
		} catch (Exception e) {
			e.printStackTrace();
			return null;
		}
	}
 
	/**
	 * 將list放入快取
	 *
	 * @param key   鍵
	 * @param value 值
	 * @return
	 */
	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;
		}
	}
 
	/**
	 * 將list放入快取
	 *
	 * @param key   鍵
	 * @param value 值
	 * @return
	 */
	public boolean lSet(String key, List<Object> value) {
		try {
			redisTemplate.opsForList().rightPushAll(key, value);
			return true;
		} catch (Exception e) {
			e.printStackTrace();
			return false;
		}
	}
 
	/**
	 * 將list放入快取
	 *
	 * @param key   鍵
	 * @param value 值
	 * @param time  時間(秒)
	 * @return
	 */
	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;
		}
	}
 
	/**
	 * 根據索引修改list中的某條資料
	 *
	 * @param key   鍵
	 * @param index 索引
	 * @param value 值
	 * @return
	 */
	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;
		}
	}
 
	/**
	 * 移除N個值為value
	 *
	 * @param key   鍵
	 * @param count 移除多少個
	 * @param value 值
	 * @return 移除的個數
	 */
	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;
		}
	}
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。