# spring-boot-starter-fast-redis

**Repository Path**: opsfast/spring-boot-starter-fast-redis

## Basic Information

- **Project Name**: spring-boot-starter-fast-redis
- **Description**: 整合RedisTemplate与StringRedisTemplate，提供更友好更完善的API，更方便的调用，支持Jedis、Lettuce、Redisson等主流客户端，并且在非集群模式下支持分片操作
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 83
- **Created**: 2019-06-13
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# spring-boot-starter-fast-redis

<p align="center">
    <img src="https://img.shields.io/badge/JDK-1.8+-green.svg" />
    <img src="https://img.shields.io/maven-central/v/wiki.xsx/spring-boot-starter-fast-redis.svg?label=Maven%20Central" />
    <img src="https://img.shields.io/:license-apache-blue.svg" />
    <a href='https://gitee.com/xsxgit/spring-boot-starter-fast-redis/stargazers'>
        <img src='https://gitee.com/xsxgit/spring-boot-starter-fast-redis/badge/star.svg?theme=dark' alt='star' />
    </a>
</p>

#### 介绍
整合RedisTemplate与StringRedisTemplate，开箱即用，提供更友好更完善的API，更方便的调用，支持Jedis、Lettuce、Redisson等主流客户端，并且在非集群模式下支持分片操作

#### 软件架构
依赖spring-boot-starter-data-redis

#### 安装教程

```
<dependency>
    <groupId>wiki.xsx</groupId>
    <artifactId>spring-boot-starter-fast-redis</artifactId>
    <version>1.5.1</version>
</dependency>
```

#### 文档地址
https://apidoc.gitee.com/xsxgit/spring-boot-starter-fast-redis

#### 使用说明
调用 wiki.xsx.core.util.RedisUtil.getXXXHandler 方法获取对应类型实例

0.  getNumberHandler：获取数字实例(Number)
1.  getStringHandler：获取字符串实例(String)
2.  getHashHandler： 获取哈希实例(Hash)
3.  getListHandler： 获取列表实例(List)
4.  getSetHandler：获取无序集合实例(Set)
5.  getZsetHandler：获取有序集合实例(Zset)
6.  getHyperLogLogHandler：获取基数实例(HyperLogLog)
7.  getBitmapHandler：获取位图实例(Bitmap)
8.  getGeoHandler： 获取地理位置实例(Geo)
9.  getDBHandler： 获取数据库实例(DB)
10. getKeyHandler： 获取键实例(Key)
11. getScriptHandler: 获取脚本实例(Lua Script)
12. getPubSubHandler: 获取发布订阅实例(Pubsub)
13. getRedisLockHandler: 获取分布式锁实例(Lock)
14. getSentinelHandler: 获取哨兵实例(Sentinel)
15. getClusterHandler: 获取集群实例(Cluster)
15. getCustomCommandHandler: 获取自定义命令实例(CustomCommand)

**特别说明： @since 为redis版本所支持的方法，例如@since redis 1.0.0表示1.0.0的redis版本即可使用该方法**

**XXXAsObj为对象类型序列化相关方法，XXX为字符串类型序列化相关方法，分布式锁需依赖redisson**

#### 分布式锁的使用

##### 不使用redisson客户端
```
添加依赖：
<dependency>
     <groupId>org.redisson</groupId>
     <artifactId>redisson-spring-data-21</artifactId>
     <version>3.11.0</version>
</dependency>

直接调用API:
wiki.xsx.core.handler.RedisLockHandler handler = wiki.xsx.core.util.RedisUtil.getRedisLockHandler();
handler.getLock(String name);
...
```

##### 使用redisson客户端：
```
添加依赖：
<dependency>
     <groupId>org.redisson</groupId>
     <artifactId>redisson-spring-data-21</artifactId>
     <version>3.10.7</version>
</dependency>

redisson配置：
#yaml方式:
spring: 
    redis: 
        redisson: 
            config: classpath:redisson.yaml
            
#properties方式:
spring.redis.redisson.config=classpath:redisson.yaml
**更多配置可参考https://github.com/redisson/redisson/wiki/2.-%E9%85%8D%E7%BD%AE%E6%96%B9%E6%B3%95#23-%E5%B8%B8%E7%94%A8%E8%AE%BE%E7%BD%AE**

调用API:
wiki.xsx.core.handler.RedisLockHandler handler = wiki.xsx.core.util.RedisUtil.getRedisLockHandler();
handler.getLock(String name);
...
```