前言
项目地址：
- gitee (mybatisPlus-redis分支)
本文意在记录基于springboot的小型项目骨架搭建，便于后续学习使用。
本文项目环境参考：
- jdk 1.8
- springboot 2.7.6
- mysql 8.2.0
- redis 7.0.12
- knife4j (swagger) 4.3.0
搭建步骤
一、引入 maven 依赖
<?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>
<groupId>com.liboshuai</groupId>
<artifactId>springboot-example</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-example</name>
<description>springboot-example</description>
<profiles>
<!--dev-->
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<profilesActive>dev</profilesActive>
</properties>
</profile>
<!--uat-->
<profile>
<id>uat</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<properties>
<profilesActive>uat</profilesActive>
</properties>
</profile>
<!--prod-->
<profile>
<id>uat</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<properties>
<profilesActive>prod</profilesActive>
</properties>
</profile>
</profiles>
<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<!--spring boot版本-->
<spring-boot.version>2.7.6</spring-boot.version>
<!--Mysql数据库-->
<mysql-connector-j.version>8.0.33</mysql-connector-j.version>
<druid.version>1.2.20</druid.version>
<mybatis-plus.version>3.5.4</mybatis-plus.version>
<!--工具-->
<lombok.version>1.18.30</lombok.version>
<knife4j.version>4.3.0</knife4j.version>
<!--maven-compiler-plugin-->
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
</properties>
<dependencies>
<!---################## Spring boot 相关##################-->
<!--spring boot web依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--spring boot test依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!---################## Mysql 相关##################-->
<!--mysql驱动-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>${mysql-connector-j.version}</version>
</dependency>
<!--druid连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>${druid.version}</version>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!---################## Redis 相关##################-->
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- lettuce pool -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<!---################## 工具类 相关##################-->
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<!--knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<finalName>${project.artifactId}-${project.version}</finalName>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>application-${profilesActive}.properties</include>
<include>application.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${spring-boot.version}</version>
<configuration>
<mainClass>com.liboshuai.springbootexample.SpringbootExampleApplication</mainClass>
<layout>ZIP</layout>
</configuration>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- 指定jdk版本，和指定编码 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin.version}</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
二、新增appliation.properties等配置文件
application.properties:
#################### 系统配置 ######################
# 应用服务 WEB 访问端口
server.port=8080
# 环境变量参数
spring.profiles.active=@profilesActive@
#################### Mybatis-Plus 配置 ######################
mybatis-plus.mapper-locations=classpath:/mapper/*Mapper.xml
mybatis-plus.type-aliases-package=com.liboshuai.springbootexample.entity
#################### Druid连接池的配置信息 ####################
# 初始化时建立物理连接的个数
spring.datasource.druid.initial-size=5
# 最小连接池数量
spring.datasource.druid.min-idle=5
# 最大连接池数量
spring.datasource.druid.maxActive=20
# 获取连接时最大等待时间，单位毫秒
spring.datasource.druid.maxWait=60000
# 有两个含义：1)Destroy线程会检测连接的间隔时间 2)testWhileIdle的时间间隔
spring.datasource.druid.timeBetweenEvictionRunsMillis=60000
# 连接在池中最小生存的时间，单位是毫秒
spring.datasource.druid.minEvictableIdleTimeMillis=300000
# 用来检测连接是否有效的sql，要求是一个查询语句
spring.datasource.druid.validationQuery=SELECT 1
# 建议配置为true，不影响性能，并且保证安全性
spring.datasource.druid.testWhileIdle=true
# 申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能
spring.datasource.druid.testOnBorrow=false
# 归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能
spring.datasource.druid.testOnReturn=false
# 是否缓存preparedStatement，也就是PSCache
spring.datasource.druid.poolPreparedStatements=true
# 每个连接上PSCache的大小
spring.datasource.druid.maxPoolPreparedStatementPerConnectionSize=20
########################## Druid的监控统计功能配置 ##########################
# 启用slf4j日志记录
spring.datasource.druid.filter.slf4j.enabled=true
# 启用wall防火墙拦截器
spring.datasource.druid.filter.wall.enabled=true
# 启用Druid的StatFilter
spring.datasource.druid.filter.stat.enabled=true
# 合并SQL功能，记录慢查询
spring.datasource.druid.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
# 开启Druid的Web监控统计
spring.datasource.druid.web-stat-filter.enabled=true
# 拦截路径
spring.datasource.druid.web-stat-filter.url-pattern=/*
# 配置监控页面不统计的文件类型
spring.datasource.druid.web-stat-filter.exclusions=*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*
# 开启Druid的监控页面
spring.datasource.druid.stat-view-servlet.enabled=true
# Druid监控页面的访问URL
spring.datasource.druid.stat-view-servlet.url-pattern=/druid/*
# IP白名单，未配置或为空则允许所有访问
# spring.datasource.druid.stat-view-servlet.allow=127.0.0.1,192.168.46.120
# IP黑名单，存在同时，deny优先于allow
# spring.datasource.druid.stat-view-servlet.deny=192.168.46.121
# 是否能够重置数据，禁用HTML页面上的“Reset All”功能
spring.datasource.druid.stat-view-servlet.reset-enable=false
# 登录监控页面的用户名
spring.datasource.druid.stat-view-servlet.login-username=admin
# 登录监控页面的密码
spring.datasource.druid.stat-view-servlet.login-password=123456
####################### Swagger 配置 ####################
# SpringDoc OpenAPI 配置
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.tags-sorter=alpha
springdoc.swagger-ui.operations-sorter=alpha
springdoc.api-docs.path=/v3/api-docs
# 分组配置
springdoc.group-configs[0].group=default
springdoc.group-configs[0].paths-to-match[0]=/**
springdoc.group-configs[0].packages-to-scan=com.liboshuai.springbootexample
# Knife4j 增强配置
knife4j.enable=true
knife4j.setting.language=zh_cn
####################### Jackson 配置 ####################
# 日期格式化
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 设置时区
spring.jackson.time-zone=GMT+8
# 设置空如何序列化
spring.jackson.default-property-inclusion=non_null
# 格式化输出
spring.jackson.serialization.indent_output=true
# 忽略无法转换的对象
spring.jackson.serialization.fail_on_empty_beans=false
# 允许对象忽略json中不存在的属性
spring.jackson.deserialization.fail_on_unknown_properties=false
# 允许出现特殊字符和转义符
spring.jackson.parser.allow_unquoted_control_chars=true
# 允许出现单引号
spring.jackson.parser.allow_single_quotes=true
application-dev.properties:
#################### Mysql配置 ####################
# 使用Druid数据库连接池
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# MySQL JDBC驱动类
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 数据库用户名
spring.datasource.username=root
# 数据库密码
spring.datasource.password=Rongshu@2024
# JDBC连接URL，包括数据库服务器地址、端口、数据库名以及额外的连接参数
spring.datasource.url=jdbc:mysql://a.sanhans.icu:18306/spring_boot_example?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true
####################### Redis配置 ####################
# Redis数据库索引（默认为0）
spring.redis.database=0
# Redis服务器地址
spring.redis.host=a.sanhans.icu
# Redis服务器连接端口
spring.redis.port=18381
# Redis服务器连接密码（默认为空）
spring.redis.password=admin123456
# Redis服务器连接超时时间（毫秒）
spring.redis.timeout=5000
# 连接池中的最小空闲连接
spring.redis.lettuce.pool.min-idle=0
# 连接池中的最大空闲连接
spring.redis.lettuce.pool.max-idle=8
# 连接池的最大数据库连接数
spring.redis.lettuce.pool.max-active=8
#连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.lettuce.pool.max-wait=-1
其他环境的配置文件省略......
三、resources目录下新增logback-spring.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 日志存放路径 -->
<property name="log.path" value="/opt/projects/springboot-example/logs"/>
<!-- 日志输出格式 -->
<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>
<!-- 控制台输出 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
</appender>
<!-- 系统日志输出 -->
<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}/info.log</file>
<!-- 循环政策：基于时间创建日志文件 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志文件名格式 -->
<fileNamePattern>${log.path}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 日志最大的历史 60天 -->
<maxHistory>60</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 过滤的级别 -->
<level>INFO</level>
<!-- 匹配时的操作：接收（记录） -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配时的操作：拒绝（不记录） -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}/error.log</file>
<!-- 循环政策：基于时间创建日志文件 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志文件名格式 -->
<fileNamePattern>${log.path}/error.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 日志最大的历史 60天 -->
<maxHistory>60</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 过滤的级别 -->
<level>ERROR</level>
<!-- 匹配时的操作：接收（记录） -->
<onMatch>ACCEPT</onMatch>
<!-- 不匹配时的操作：拒绝（不记录） -->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 系统模块日志级别控制 -->
<logger name="com.liboshuai.springbootexample" level="info"/>
<!-- Spring日志级别控制 -->
<logger name="org.springframework" level="warn"/>
<root level="info">
<appender-ref ref="console"/>
</root>
<!--系统操作日志-->
<root level="info">
<appender-ref ref="file_info"/>
<appender-ref ref="file_error"/>
</root>
</configuration>
四、新增Springboot主启动类SpringbootExampleApplicaiton
@SpringBootApplication
public class SpringbootExampleApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootExampleApplication.class, args);
}
}
五、新增配置类``RedisConfig`
@Configuration
public class RedisConfig {
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> template = new RedisTemplate<>();
template.setConnectionFactory(factory);
Jackson2JsonRedisSerializer<Object> jsonRedisSerializer = getJsonRedisSerializer();
StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
// key采用String的序列化方式
template.setKeySerializer(stringRedisSerializer);
// hash的key也采用String的序列化方式
template.setHashKeySerializer(stringRedisSerializer);
// value序列化方式采用jackson
template.setValueSerializer(jsonRedisSerializer);
// hash的value序列化方式采用jackson
template.setHashValueSerializer(jsonRedisSerializer);
// 支持事物
//template.setEnableTransactionSupport(true);
template.afterPropertiesSet();
return template;
}
/**
* 设置jackson的序列化方式
*/
private Jackson2JsonRedisSerializer<Object> getJsonRedisSerializer() {
Jackson2JsonRedisSerializer<Object> redisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
redisSerializer.setObjectMapper(om);
return redisSerializer;
}
}
六、新增工具类RedisUtil
@Component
public class RedisUtil {
private final RedisTemplate<String, Object> redisTemplate;
public RedisUtil(RedisTemplate<String, Object> redisTemplate) {
this.redisTemplate = redisTemplate;
}
// -------------------key 相关操作---------------------
/**
* 删除 key
*
* @param key 要删除的 键
*/
public void delete(String key) {
redisTemplate.delete(key);
}
/**
* 批量删除 key
*
* @param keys 要删除的 键 的集合
*/
public void delete(Collection<String> keys) {
redisTemplate.delete(keys);
}
/**
* 是否存在 key
*
* @param key 判断该 键 是否存在
* @return 存在返回 true, 不存在返回 false
*/
public Boolean hasKey(String key) {
return redisTemplate.hasKey(key);
}
/**
* 设置过期时间
*
* @param key 要设置的 键
* @param timeout 过期时间
* @param unit 时间单位
* @return 设置成功返回 true, 设置失败返回 false
*/
public Boolean expire(String key, long timeout, TimeUnit unit) {
return redisTemplate.expire(key, timeout, unit);
}
/**
* 设置在什么时间过期
*
* @param key 要设置的 键
* @param date 过期时间
* @return 设置成功返回 true, 设置失败返回 false
*/
public Boolean expireAt(String key, Date date) {
return redisTemplate.expireAt(key, date);
}
/**
* 查找匹配的 key
*
* @param pattern 匹配字符串
* @return 满足匹配条件的 键 的 Set 集合
*/
public Set<String> keys(String pattern) {
return redisTemplate.keys(pattern);
}
/**
* 将当前数据库的 key 移动到给定的数据库 db 当中
*
* @param key 要移动的 键
* @param dbIndex 要移动到的 db 的序号, 从 0 开始
* @return 移动成功返回 true, 移动失败返回 false
*/
public Boolean move(String key, int dbIndex) {
return redisTemplate.move(key, dbIndex);
}
/**
* 移除 key 的过期时间，key 将持久保持
*
* @param key 要移除过期时间的 键
* @return 移除成功返回 true, 并且该 key 将持久存在, 移除失败返回 false
*/
public Boolean persist(String key) {
return redisTemplate.persist(key);
}
/**
* 返回 key 的剩余的过期时间
*
* @param key 要查询剩余过期时间的 键
* @param unit 时间的单位
* @return 剩余的过期时间
*/
public Long getExpire(String key, TimeUnit unit) {
return redisTemplate.getExpire(key, unit);
}
/**
* 返回 key 的剩余的过期时间, 默认时间单位: 秒
*
* @param key 要查询剩余过期时间的 键
* @return 剩余的过期时间, 单位: 秒
*/
public Long getExpire(String key) {
return redisTemplate.getExpire(key);
}
/**
* 从当前数据库中随机返回一个 key
*
* @return 随机获取的 键 的名称
*/
public String randomKey() {
return redisTemplate.randomKey();
}
/**
* 修改 key 的名称
*
* @param oldKey 修改前的 键 的名称
* @param newKey 修改后的 键 的名称
*/
public void rename(String oldKey, String newKey) {
redisTemplate.rename(oldKey, newKey);
}
/**
* 仅当 newkey 不存在时，将 oldKey 改名为 newkey
*
* @param oldKey 修改前的 键 的名称
* @param newKey 修改后的 键 的名称
* @return 修改成功返回 true, 修改失败返回 false
*/
public Boolean renameIfAbsent(String oldKey, String newKey) {
return redisTemplate.renameIfAbsent(oldKey, newKey);
}
/**
* 返回 key 所储存的值的类型
*
* @param key 要查询类型的 键
* @return key 的数据类型
*/
public DataType type(String key) {
return redisTemplate.type(key);
}
// -------------------string 相关操作---------------------
/**
* 设置指定 key 的值
*
* @param key 要设置的 键
* @param value 要设置的 值
*/
public void set(String key, Object value) {
redisTemplate.opsForValue().set(key, value);
}
/**
* 获取指定 key 的值
*
* @param key 键 的名称
* @return 键 对应的 值
*/
public Object get(String key) {
return redisTemplate.opsForValue().get(key);
}
/**
* 返回 key 的 字符串值 中指定位置的 子字符串
*
* @param key 要获取值的 键
* @param start 开始位置, 最小值: 0
* @param end 结束位置, 最大值: 字符串 - 1, 若为 -1 则是获取整个字符串值
* @return 指定 键 的 字符串值 的 子字符串
*/
public String getRange(String key, long start, long end) {
return redisTemplate.opsForValue().get(key, start, end);
}
/**
* 将给定 key 的值设为 value ，并返回 key 的旧值( old value )
*
* @param key 要设置值的 键
* @param value 新值
* @return 旧值
*/
public Object getAndSet(String key, Object value) {
return redisTemplate.opsForValue().getAndSet(key, value);
}
/**
* 对 key 所储存的字符串值，获取指定偏移量上的位( bit )
*
* @param key 键
* @param offset 偏移量
* @return 指定偏移量上的 位( 0 / 1)
*/
public Boolean getBit(String key, long offset) {
return redisTemplate.opsForValue().getBit(key, offset);
}
/**
* 批量获取 key 的 值
*
* @param keys 要获取值的 键 的集合
* @return key对应的值的集合
*/
public List<Object> multiGet(Collection<String> keys) {
return redisTemplate.opsForValue().multiGet(keys);
}
/**
* 设置ASCII码, 字符串'a'的ASCII码是97, 转为二进制是'01100001', 此方法是将二进制第 offset 位值变为 value
*
* @param key 要设置的 键
* @param offset 偏移多少位
* @param value 值, true 为 1, false 为 0
* @return 设置成功返回 true, 设置失败返回 false
*/
public Boolean setBit(String key, long offset, boolean value) {
return redisTemplate.opsForValue().setBit(key, offset, value);
}
/**
* 将值 value 关联到 key ，并将 key 的过期时间设为 timeout
*
* @param key 键
* @param value 值
* @param timeout 过期时间
* @param unit 时间单位, 天: TimeUnit.DAYS 小时: TimeUnit.HOURS 分钟: TimeUnit.MINUTES
* 秒: TimeUnit.SECONDS 毫秒: TimeUnit.MILLISECONDS
*/
public void setEx(String key, Object value, long timeout, TimeUnit unit) {
redisTemplate.opsForValue().set(key, value, timeout, unit);
}
/**
* 只有在 key 不存在时设置 key 的值
*
* @param key 键
* @param value 值
* @return 之前已经存在返回 false, 不存在返回 true
*/
public Boolean setIfAbsent(String key, Object value) {
return redisTemplate.opsForValue().setIfAbsent(key, value);
}
/**
* 用 value 参数覆写给定 key 所储存的字符串值，从偏移量 offset 开始
*
* @param key 键
* @param value 值
* @param offset 从指定位置开始覆写
*/
public void setRange(String key, Object value, long offset) {
redisTemplate.opsForValue().set(key, value, offset);
}
/**
* 获取字符串的长度
*
* @param key 键
* @return 该 key 对应的 值的长度
*/
public Long size(String key) {
return redisTemplate.opsForValue().size(key);
}
/**
* 批量添加 key-value
*
* @param maps key-value 的 map 集合
*/
public void multiSet(Map<String, Object> maps) {
redisTemplate.opsForValue().multiSet(maps);
}
/**
* 同时设置一个或多个 key-value 对，当且仅当所有给定 key 都不存在才会设置成功
*
* @param maps key-value 集合
* @return 之前已经存在返回 false, 不存在返回 true
*/
public Boolean multiSetIfAbsent(Map<String, Object> maps) {
return redisTemplate.opsForValue().multiSetIfAbsent(maps);
}
/**
* 增加(自增长), 负数则为自减
*
* @param key 键
* @param increment 自增量
* @return 增加后的值
*/
public Long incrBy(String key, long increment) {
return redisTemplate.opsForValue().increment(key, increment);
}
/**
* 自增长, 增长量为浮点数
*
* @param key 键
* @param increment 自增量
* @return 增加后的值
*/
public Double incrByFloat(String key, double increment) {
return redisTemplate.opsForValue().increment(key, increment);
}
/**
* 将 value 追加到指定 key 的值的末尾
*
* @param key 键
* @param value 要追加的值
* @return 追加值后新值的长度
*/
public Integer append(String key, String value) {
return redisTemplate.opsForValue().append(key, value);
}
// -------------------hash 相关操作-------------------------
/**
* 获取存储在哈希表中指定字段的值
*
* @param key 键
* @param field 字段名( 即 map 中的 key )
* @return 值
*/
public Object hGet(String key, String field) {
return redisTemplate.opsForHash().get(key, field);
}
/**
* 获取给定 哈希表 中的所有键值对
*
* @param key 哈希表
* @return 所有的 键值对
*/
public Map<Object, Object> hGetAll(String key) {
return redisTemplate.opsForHash().entries(key);
}
/**
* 获取指定 哈希表 中所有给定字段的值
*
* @param key 哈希表
* @param fields 要获取值的字段集合
* @return 哈希表中所有给定字段的值
*/
public List<Object> hMultiGet(String key, Collection<Object> fields) {
return redisTemplate.opsForHash().multiGet(key, fields);
}
/**
* 向指定 哈希表 中存储一个 键值对
*
* @param key 哈希表
* @param hashKey 字段名
* @param value 值
*/
public void hPut(String key, String hashKey, Object value) {
redisTemplate.opsForHash().put(key, hashKey, value);
}
/**
* 向指定 哈希表 中存储多个 键值对
*
* @param key 哈希表
* @param maps 键值对集合
*/
public void hPutAll(String key, Map<String, Object> maps) {
redisTemplate.opsForHash().putAll(key, maps);
}
/**
* 仅当 hashKey 不存在时才设置
*
* @param key 哈希表
* @param hashKey 字段名
* @param value 值
* @return 设置成功返回 true, 设置失败返回 false
*/
public Boolean hPutIfAbsent(String key, String hashKey, Object value) {
return redisTemplate.opsForHash().putIfAbsent(key, hashKey, value);
}
/**
* 删除哈希表中一个或多个字段
*
* @param key 哈希表
* @param fields 要删除的字段集合
* @return 删除成功的数目
*/
public Long hDelete(String key, Object... fields) {
return redisTemplate.opsForHash().delete(key, fields);
}
/**
* 查看哈希表中指定的字段是否存在
*
* @param key 要查看的哈希表
* @param field 字段名
* @return 存在返回 true, 不存在返回 false
*/
public boolean hExists(String key, String field) {
return redisTemplate.opsForHash().hasKey(key, field);
}
/**
* 为哈希表 key 中的指定字段的整数值加上增量 increment
*
* @param key 指定的哈希表
* @param field 字段名
* @param increment 增加的量
* @return 增加后的值
*/
public Long hIncrBy(String key, Object field, long increment) {
return redisTemplate.opsForHash().increment(key, field, increment);
}
/**
* 为哈希表 key 中的指定字段的整数值加上增量 increment( 浮点型 )
*
* @param key 指定的哈希表
* @param field 字段名
* @param delta 增加的量( 浮点型 )
* @return 增加后的值
*/
public Double hIncrByFloat(String key, Object field, double delta) {
return redisTemplate.opsForHash().increment(key, field, delta);
}
/**
* 获取所有哈希表中的字段
*
* @param key 哈希表
* @return 所有的 字段
*/
public Set<Object> hKeys(String key) {
return redisTemplate.opsForHash().keys(key);
}
/**
* 获取哈希表中字段的数量
*
* @param key 哈希表
* @return 哈希表所有字段的数量
*/
public Long hSize(String key) {
return redisTemplate.opsForHash().size(key);
}
/**
* 获取哈希表中所有值
*
* @param key 哈希表
* @return 哈希表中所有的值
*/
public List<Object> hValues(String key) {
return redisTemplate.opsForHash().values(key);
}
/**
* 迭代哈希表中的键值对
*
* @param key 哈希表
* @param options 迭代的限制条件, 为 ScanOptions.NONE 则无限制
* @return 下一个键值对元组的游标
*/
public Cursor<Entry<Object, Object>> hScan(String key, ScanOptions options) {
return redisTemplate.opsForHash().scan(key, options);
}
// ------------------------list 相关操作----------------------------
/**
* 通过索引获取列表中的元素
*
* @param key 元素所在的列表
* @param index 下标, 从 0 开始
* @return 列表中指定下标的值
*/
public Object lIndex(String key, long index) {
return redisTemplate.opsForList().index(key, index);
}
/**
* 获取列表指定范围内的元素
*
* @param key 元素所在列表
* @param start 开始位置, 0 是开始位置
* @param end 结束位置, -1 返回所有
* @return 指定索引范围内的元素
*/
public List<Object> lRange(String key, long start, long end) {
return redisTemplate.opsForList().range(key, start, end);
}
/**
* 存储在 list 头部( 左边 )
*
* @param key 列表
* @param value 存储的值
* @return 列表长度
*/
public Long lLeftPush(String key, Object value) {
return redisTemplate.opsForList().leftPush(key, value);
}
/**
* 将多个值存入列表中
*
* @param key 列表
* @param value 值, 可以输入多个
* @return 列表长度
*/
public Long lLeftPushAll(String key, Object... value) {
return redisTemplate.opsForList().leftPushAll(key, value);
}
/**
* 将多个值存入列表中
*
* @param key 列表
* @param value 值的集合
* @return 列表长度
*/
public Long lLeftPushAll(String key, Collection<Object> value) {
return redisTemplate.opsForList().leftPushAll(key, value);
}
/**
* 当 list 存在的时候才加入
*
* @param key 列表
* @param value 值
* @return 列表长度
*/
public Long lLeftPushIfPresent(String key, Object value) {
return redisTemplate.opsForList().leftPushIfPresent(key, value);
}
/**
* 如果 pivot 存在,在 pivot 前面添加
*
* @param key 列表
* @param pivot 基准值
* @param value 要添加的值
* @return 列表长度
*/
public Long lLeftPush(String key, Object pivot, Object value) {
return redisTemplate.opsForList().leftPush(key, pivot, value);
}
/**
* 存储在 list 尾部( 右边 )
*
* @param key 列表
* @param value 值
* @return 列表长度
*/
public Long lRightPush(String key, Object value) {
return redisTemplate.opsForList().rightPush(key, value);
}
/**
* 将多个值存入列表中
*
* @param key 列表
* @param value 值, 可以输入多个
* @return 列表长度
*/
public Long lRightPushAll(String key, Object... value) {
return redisTemplate.opsForList().rightPushAll(key, value);
}
/**
* 将多个值存入列表中
*
* @param key 列表
* @param value 值的集合
* @return 列表长度
*/
public Long lRightPushAll(String key, Collection<Object> value) {
return redisTemplate.opsForList().rightPushAll(key, value);
}
/**
* 为已存在的列表添加值
*
* @param key 存在的列表
* @param value 值
* @return 列表长度
*/
public Long lRightPushIfPresent(String key, Object value) {
return redisTemplate.opsForList().rightPushIfPresent(key, value);
}
/**
* 在 pivot 元素的右边添加值
*
* @param key 列表
* @param pivot 基准值
* @param value 要添加的值
* @return 列表长度
*/
public Long lRightPush(String key, Object pivot, Object value) {
return redisTemplate.opsForList().rightPush(key, pivot, value);
}
/**
* 通过索引设置列表元素的值
*
* @param key 列表
* @param index 位置
* @param value 值
*/
public void lSet(String key, long index, Object value) {
redisTemplate.opsForList().set(key, index, value);
}
/**
* 移出并获取列表的第一个元素
*
* @param key 列表
* @return 删除的元素
*/
public Object lLeftPop(String key) {
return redisTemplate.opsForList().leftPop(key);
}
/**
* 移出并获取列表的第一个元素, 如果列表没有元素会阻塞列表直到等待超时或发现可弹出元素为止
*
* @param key 列表
* @param timeout 等待时间
* @param unit 时间单位
* @return 删除的元素
*/
public Object lBLeftPop(String key, long timeout, TimeUnit unit) {
return redisTemplate.opsForList().leftPop(key, timeout, unit);
}
/**
* 移除并获取列表最后一个元素
*
* @param key 列表
* @return 删除的元素
*/
public Object lRightPop(String key) {
return redisTemplate.opsForList().rightPop(key);
}
/**
* 移出并获取列表的最后一个元素, 如果列表没有元素会阻塞列表直到等待超时或发现可弹出元素为止
*
* @param key 列表
* @param timeout 等待时间
* @param unit 时间单位
* @return 删除的元素
*/
public Object lBRightPop(String key, long timeout, TimeUnit unit) {
return redisTemplate.opsForList().rightPop(key, timeout, unit);
}
/**
* 移除列表的最后一个元素，并将该元素添加到另一个列表并返回
*
* @param sourceKey 要移除元素的列表
* @param destinationKey 要添加元素的列表
* @return 移动的元素
*/
public Object lRightPopAndLeftPush(String sourceKey, String destinationKey) {
return redisTemplate.opsForList().rightPopAndLeftPush(sourceKey, destinationKey);
}
/**
* 从列表中弹出一个值，将弹出的元素插入到另外一个列表中并返回它; 如果列表没有元素会阻塞列表直到等待超时或发现可弹出元素为止
*
* @param sourceKey 要移除元素的列表
* @param destinationKey 要添加元素的列表
* @param timeout 等待时间
* @param unit 时间单位
* @return 移动的元素
*/
public Object lBRightPopAndLeftPush(String sourceKey, String destinationKey, long timeout, TimeUnit unit) {
return redisTemplate.opsForList().rightPopAndLeftPush(sourceKey, destinationKey, timeout, unit);
}
/**
* 删除集合中值等于 value 的元素
*
* @param key 列表
* @param index index = 0, 删除所有值等于value的元素;
* index > 0, 从头部开始删除第一个值等于 value 的元素;
* index < 0, 从尾部开始删除第一个值等于 value 的元素;
* @param value 值
* @return 列表长度
*/
public Long lRemove(String key, long index, Object value) {
return redisTemplate.opsForList().remove(key, index, value);
}
/**
* 裁剪 list
*
* @param key 列表
* @param start 起始位置
* @param end 结束位置
* @see <a href="https://redis.io/commands/ltrim">Redis Documentation: LTRIM</a>
*/
public void lTrim(String key, long start, long end) {
redisTemplate.opsForList().trim(key, start, end);
}
/**
* 获取列表长度
*
* @param key 列表
* @return 列表长度
*/
public Long lLen(String key) {
return redisTemplate.opsForList().size(key);
}
// --------------------set 相关操作--------------------------
/**
* set 添加元素
*
* @param key 集合
* @param values 值, 可以同时添加多个
* @return 集合长度
*/
public Long sAdd(String key, Object... values) {
return redisTemplate.opsForSet().add(key, values);
}
/**
* set 移除元素
*
* @param key 集合
* @param values 要移除的元素, 可以同时移除多个
* @return 集合长度
*/
public Long sRemove(String key, Object... values) {
return redisTemplate.opsForSet().remove(key, values);
}
/**
* 移除并返回集合的一个随机元素
*
* @param key 集合
* @return 集合中随机一个元素
*/
public Object sPop(String key) {
return redisTemplate.opsForSet().pop(key);
}
/**
* 将元素 value 从一个集合移到另一个集合
*
* @param key 被移除的集合
* @param value 要移除的元素
* @param destKey 移动到的目标集合
* @return 移动成功返回 true, 移动失败返回 false
*/
public Boolean sMove(String key, Object value, String destKey) {
return redisTemplate.opsForSet().move(key, value, destKey);
}
/**
* 获取集合的大小
*
* @param key 集合
* @return 集合长度
*/
public Long sSize(String key) {
return redisTemplate.opsForSet().size(key);
}
/**
* 判断集合是否包含 value
*
* @param key 集合
* @param value 元素
* @return 包含返回 true, 不包含返回 false
*/
public Boolean sIsMember(String key, Object value) {
return redisTemplate.opsForSet().isMember(key, value);
}
/**
* 获取两个集合的交集
*
* @param key 集合1
* @param otherKey 集合2
* @return 两个集合的交集
*/
public Set<Object> sIntersect(String key, String otherKey) {
return redisTemplate.opsForSet().intersect(key, otherKey);
}
/**
* 获取 key 集合与多个集合的交集
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @return 多个集合的交集
*/
public Set<Object> sIntersect(String key, Collection<String> otherKeys) {
return redisTemplate.opsForSet().intersect(key, otherKeys);
}
/**
* key 集合与 otherKey 集合的交集存储到 destKey 集合中
*
* @param key 集合1
* @param otherKey 集合2
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sIntersectAndStore(String key, String otherKey, String destKey) {
return redisTemplate.opsForSet().intersectAndStore(key, otherKey,
destKey);
}
/**
* key 集合与多个集合的交集存储到 destKey 集合中
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sIntersectAndStore(String key, Collection<String> otherKeys, String destKey) {
return redisTemplate.opsForSet().intersectAndStore(key, otherKeys,
destKey);
}
/**
* 获取两个集合的并集
*
* @param key 集合1
* @param otherKeys 集合2
* @return 两个集合的并集
*/
public Set<Object> sUnion(String key, String otherKeys) {
return redisTemplate.opsForSet().union(key, otherKeys);
}
/**
* 获取 key 集合与多个集合的并集
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @return 多个集合的并集
*/
public Set<Object> sUnion(String key, Collection<String> otherKeys) {
return redisTemplate.opsForSet().union(key, otherKeys);
}
/**
* key 集合与 otherKey 集合的并集存储到 destKey 中
*
* @param key 集合1
* @param otherKey 集合2
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sUnionAndStore(String key, String otherKey, String destKey) {
return redisTemplate.opsForSet().unionAndStore(key, otherKey, destKey);
}
/**
* key 集合与多个集合的并集存储到 destKey 中
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sUnionAndStore(String key, Collection<String> otherKeys, String destKey) {
return redisTemplate.opsForSet().unionAndStore(key, otherKeys, destKey);
}
/**
* 获取两个集合的差集
*
* @param key 集合1
* @param otherKey 集合2
* @return 集合1 - 集合2 的差集
*/
public Set<Object> sDifference(String key, String otherKey) {
return redisTemplate.opsForSet().difference(key, otherKey);
}
/**
* 获取 key 集合与多个集合的差集
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @return 集合1 - 集合2 - 集合3 - ... 集合n 的差集
*/
public Set<Object> sDifference(String key, Collection<String> otherKeys) {
return redisTemplate.opsForSet().difference(key, otherKeys);
}
/**
* key 集合与 otherKey 集合的差集存储到 destKey 中
*
* @param key 集合1
* @param otherKey 集合2
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sDifference(String key, String otherKey, String destKey) {
return redisTemplate.opsForSet().differenceAndStore(key, otherKey,
destKey);
}
/**
* key 集合与多个集合的差集存储到 destKey 中
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long sDifference(String key, Collection<String> otherKeys, String destKey) {
return redisTemplate.opsForSet().differenceAndStore(key, otherKeys,
destKey);
}
/**
* 获取集合所有元素
*
* @param key 集合
* @return 集合中所有元素
*/
public Set<Object> setMembers(String key) {
return redisTemplate.opsForSet().members(key);
}
/**
* 随机获取集合中的一个元素
*
* @param key 集合
* @return 集合中随机一个元素
*/
public Object sRandomMember(String key) {
return redisTemplate.opsForSet().randomMember(key);
}
/**
* 随机获取集合中 count 个元素
*
* @param key 集合
* @param count 要获取的元素个数
* @return count 个随机元素组成的集合
*/
public List<Object> sRandomMembers(String key, long count) {
return redisTemplate.opsForSet().randomMembers(key, count);
}
/**
* 随机获取集合中 count 个元素并且去除重复的
*
* @param key 集合
* @param count 要获取的元素个数
* @return count 个随机元素组成的集合, 并且不包含重复元素
*/
public Set<Object> sDistinctRandomMembers(String key, long count) {
return redisTemplate.opsForSet().distinctRandomMembers(key, count);
}
/**
* 迭代集合中的元素
*
* @param key 集合
* @param options 迭代的限制条件, 为 ScanOptions.NONE 则无限制
* @return 下一个元素的游标
*/
public Cursor<Object> sScan(String key, ScanOptions options) {
return redisTemplate.opsForSet().scan(key, options);
}
// ------------------zSet 相关操作--------------------------------
/**
* 添加元素, 有序集合是按照元素的 score 值由小到大排列
*
* @param key 有序集合
* @param value 元素
* @param score 分数
* @return 添加成功返回 true, 添加失败返回 false
*/
public Boolean zAdd(String key, Object value, double score) {
return redisTemplate.opsForZSet().add(key, value, score);
}
/**
* 添加多个元素到有序集合中
*
* @param key 有序集合
* @param values 多个元素值
* @return 有序集合长度
*/
public Long zAdd(String key, Set<TypedTuple<Object>> values) {
return redisTemplate.opsForZSet().add(key, values);
}
/**
* 移除有序集合中的值
*
* @param key 有序集合
* @param values 要移除的值, 可以同时移除多个
* @return 有序集合长度
*/
public Long zRemove(String key, Object... values) {
return redisTemplate.opsForZSet().remove(key, values);
}
/**
* 增加元素的 score 值，并返回增加后的值
*
* @param key 有序集合
* @param value 要增加的元素
* @param delta 增加的分数是多少
* @return 增加后的分数
*/
public Double zIncrementScore(String key, Object value, double delta) {
return redisTemplate.opsForZSet().incrementScore(key, value, delta);
}
/**
* 返回元素在集合的排名,有序集合是按照元素的 score 值由小到大排列
*
* @param key 有序集合
* @param value 值
* @return 排名, 从小到大顺序, 0 表示第一位
*/
public Long zRank(String key, Object value) {
return redisTemplate.opsForZSet().rank(key, value);
}
/**
* 返回元素在集合的排名,按元素的 score 值由大到小排列
*
* @param key 有序集合
* @param value 值
* @return 排名, 从大到小顺序
*/
public Long zReverseRank(String key, Object value) {
return redisTemplate.opsForZSet().reverseRank(key, value);
}
/**
* 获取集合的元素, 从小到大排序
*
* @param key 有序集合
* @param start 开始位置
* @param end 结束位置, -1 表示从开始位置开始后面的所有元素
* @return 指定区间的值的集合
*/
public Set<Object> zRange(String key, long start, long end) {
return redisTemplate.opsForZSet().range(key, start, end);
}
/**
* 获取集合元素, 并且把 score 值也获取
*
* @param key 有序集合
* @param start 开始位置
* @param end 结束位置, -1 表示从开始位置开始后面的所有元素
* @return 指定区间的元素及分数的元组的集合
*/
public Set<TypedTuple<Object>> zRangeWithScores(String key, long start, long end) {
return redisTemplate.opsForZSet().rangeWithScores(key, start, end);
}
/**
* 根据 score 值查询集合元素
*
* @param key 有序集合
* @param min 最小值
* @param max 最大值
* @return 分数 在最小值与最大值之间的元素集合
*/
public Set<Object> zRangeByScore(String key, double min, double max) {
return redisTemplate.opsForZSet().rangeByScore(key, min, max);
}
/**
* 根据 score 值查询集合元素及其分数, 并按分数从小到大排序
*
* @param key 有序集合
* @param min 最小值
* @param max 最大值
* @return 分数 在最小值与最大值之间的元素与分数的元组的集合
*/
public Set<TypedTuple<Object>> zRangeByScoreWithScores(String key, double min, double max) {
return redisTemplate.opsForZSet().rangeByScoreWithScores(key, min, max);
}
/**
* 根据 score 值查询集合元素及其分数, 从小到大排序, 只获取 start 到 end 位置之间的结果
*
* @param key 有序集合
* @param min 最低分数
* @param max 最高分数
* @param start 开始位置
* @param end 结束位置
* @return 分数在 min 与 max 之间, 位置在 start 与 end 之间的元素与分数的元组的集合
*/
public Set<TypedTuple<Object>> zRangeByScoreWithScores(String key, double min, double max, long start, long end) {
return redisTemplate.opsForZSet().rangeByScoreWithScores(key, min, max, start, end);
}
/**
* 获取集合的元素, 从大到小排序
*
* @param key 有序集合
* @param start 开始位置
* @param end 结束位置
* @return 按照 分数 倒序的元素集合
*/
public Set<Object> zReverseRange(String key, long start, long end) {
return redisTemplate.opsForZSet().reverseRange(key, start, end);
}
/**
* 获取集合的元素, 从大到小排序, 并返回 score 值
*
* @param key 有序集合
* @param start 开始位置
* @param end 结束位置
* @return 指定区间的元素及其分数的元组的集合
*/
public Set<TypedTuple<Object>> zReverseRangeWithScores(String key, long start, long end) {
return redisTemplate.opsForZSet().reverseRangeWithScores(key, start, end);
}
/**
* 根据 score 值查询集合元素, 从大到小排序
*
* @param key 有序集合
* @param min 分数最小值
* @param max 分数最大值
* @return 分数在 min 与 max 之间的元素的集合, 按分数倒序
*/
public Set<Object> zReverseRangeByScore(String key, double min, double max) {
return redisTemplate.opsForZSet().reverseRangeByScore(key, min, max);
}
/**
* 根据 score 值查询集合元素, 从大到小排序
*
* @param key 有序集合
* @param min 分数最小值
* @param max 分数最大值
* @return 分数在 min 与 max 之间的元素与分数的元组的集合, 按分数倒序
*/
public Set<TypedTuple<Object>> zReverseRangeByScoreWithScores(String key, double min, double max) {
return redisTemplate.opsForZSet().reverseRangeByScoreWithScores(key, min, max);
}
/**
* 根据 score 值查询集合元素及其分数, 从小到大排序, 只获取 start 到 end 位置之间的结果, 按分数从小到大排序
*
* @param key 有序集合
* @param min 分数最小值
* @param max 分数最大值
* @param start 开始位置
* @param end 结束位置
* @return 分数在 min 与 max 之间, 位置在 start 与 end 之间的元素与分数的元组的集合, 按分数倒序
*/
public Set<Object> zReverseRangeByScore(String key, double min, double max, long start, long end) {
return redisTemplate.opsForZSet().reverseRangeByScore(key, min, max, start, end);
}
/**
* 根据 score 值获取集合元素数量
*
* @param key 有序集合
* @param min 分数最小值
* @param max 分数最大值
* @return 分数在最小值与最大值之间的元素数量
*/
public Long zCount(String key, double min, double max) {
return redisTemplate.opsForZSet().count(key, min, max);
}
/**
* 获取集合大小( 底层实现还是 zcard )
*
* @param key 有序集合
* @return 集合中的元素数量
*/
public Long zSize(String key) {
return redisTemplate.opsForZSet().size(key);
}
/**
* 获取集合大小
*
* @param key 有序集合
* @return 集合中的元素数量
*/
public Long zZCard(String key) {
return redisTemplate.opsForZSet().zCard(key);
}
/**
* 获取集合中 value 元素的 score 值
*
* @param key 有序集合
* @param value 元素值
* @return 该元素值的分数
*/
public Double zScore(String key, Object value) {
return redisTemplate.opsForZSet().score(key, value);
}
/**
* 移除指定索引位置的成员
*
* @param key 有序集合
* @param start 开始位置
* @param end 结束位置
* @return 移除的元素个数
*/
public Long zRemoveRange(String key, long start, long end) {
return redisTemplate.opsForZSet().removeRange(key, start, end);
}
/**
* 根据指定的 score 值的范围来移除成员
*
* @param key 有序集合
* @param min 分数最小值
* @param max 分数最大值
* @return 移除的元素个数
*/
public Long zRemoveRangeByScore(String key, double min, double max) {
return redisTemplate.opsForZSet().removeRangeByScore(key, min, max);
}
/**
* 获取 key 和 otherKey 的并集并存储在 destKey 中
*
* @param key 集合1
* @param otherKey 集合2
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long zUnionAndStore(String key, String otherKey, String destKey) {
return redisTemplate.opsForZSet().unionAndStore(key, otherKey, destKey);
}
/**
* 获取 key 和 otherKeys 的并集并存储在 destKey 中
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long zUnionAndStore(String key, Collection<String> otherKeys, String destKey) {
return redisTemplate.opsForZSet().unionAndStore(key, otherKeys, destKey);
}
/**
* 获取 key 和 otherKey 的交集并存储在 destKey 中
*
* @param key 集合1
* @param otherKey 集合2
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long zIntersectAndStore(String key, String otherKey, String destKey) {
return redisTemplate.opsForZSet().intersectAndStore(key, otherKey, destKey);
}
/**
* 获取 key 和 otherKeys 的交集并存储在 destKey 中
*
* @param key 集合1
* @param otherKeys 其余多个集合
* @param destKey 用于保存结果的集合
* @return 新集合的长度
*/
public Long zIntersectAndStore(String key, Collection<String> otherKeys, String destKey) {
return redisTemplate.opsForZSet().intersectAndStore(key, otherKeys, destKey);
}
/**
* 迭代有序集合
*
* @param key 有序集合
* @param options 迭代限制条件, 为 ScanOptions.NONE 则无限制
* @return 下一个元素及分数元组的游标
*/
public Cursor<TypedTuple<Object>> zScan(String key, ScanOptions options) {
return redisTemplate.opsForZSet().scan(key, options);
}
}
七、新增JsonUtil工具类
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.List;
/**
* @Author liboshuai
* @Date 2023/12/18 18:03
*/
@Slf4j
public class JsonUtil {
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
private static final ObjectMapper OBJECT_MAPPER_SNAKE_CASE = new ObjectMapper();
// 日期格式化
private static final String STANDARD_FORMAT = "yyyy-MM-dd HH:mm:ss";
static {
//对象的所有字段全部列入
OBJECT_MAPPER.setSerializationInclusion(JsonInclude.Include.ALWAYS);
//取消默认转换timestamps形式
OBJECT_MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//忽略空Bean转json的错误
OBJECT_MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
//所有的日期格式都统一为以下的样式，即yyyy-MM-dd HH:mm:ss
OBJECT_MAPPER.setDateFormat(new SimpleDateFormat(STANDARD_FORMAT));
//忽略 在json字符串中存在，但是在java对象中不存在对应属性的情况。防止错误
OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
}
static {
//对象的所有字段全部列入
OBJECT_MAPPER_SNAKE_CASE.setSerializationInclusion(JsonInclude.Include.ALWAYS);
//取消默认转换timestamps形式
OBJECT_MAPPER_SNAKE_CASE.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//忽略空Bean转json的错误
OBJECT_MAPPER_SNAKE_CASE.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
//所有的日期格式都统一为以下的样式，即yyyy-MM-dd HH:mm:ss
OBJECT_MAPPER_SNAKE_CASE.setDateFormat(new SimpleDateFormat(STANDARD_FORMAT));
//忽略 在json字符串中存在，但是在java对象中不存在对应属性的情况。防止错误
OBJECT_MAPPER_SNAKE_CASE.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//转换为下划线
OBJECT_MAPPER_SNAKE_CASE.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
}
private JsonUtil() {
}
/**
* 对象转Json格式字符串
*
* @param obj 对象
* @return Json格式字符串
*/
public static <T> String obj2String(T obj) {
if (obj == null) {
return null;
}
try {
return obj instanceof String ? (String) obj : OBJECT_MAPPER.writeValueAsString(obj);
} catch (JsonProcessingException e) {
log.warn("Parse Object to String error : {}", e.getMessage());
return null;
}
}
/**
* 对象转file
* @param fileName
* @param obj
*/
public static void obj2File(String fileName,Object obj){
if (obj == null){
return;
}
try {
OBJECT_MAPPER.writeValue(new File(fileName),obj);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 对象转Json格式字符串; 属性名从驼峰改为下划线形式
*
* @param obj 对象
* @return Json格式字符串
*/
public static <T> String obj2StringFieldSnakeCase(T obj) {
if (obj == null) {
return null;
}
try {
ObjectMapper objectMapper = OBJECT_MAPPER_SNAKE_CASE;
return obj instanceof String ? (String) obj : objectMapper.writeValueAsString(obj);
} catch (JsonProcessingException e) {
log.warn("Parse Object to String error : {}", e.getMessage());
return null;
}
}
/**
* 字符串转换为自定义对象； 属性名从下划线形式改为驼峰
*
* @param str 要转换的字符串
* @param clazz 自定义对象的class对象
* @return 自定义对象
*/
public static <T> T string2ObjFieldLowerCamelCase(String str, Class<T> clazz) {
if (StringUtils.isEmpty(str) || clazz == null) {
return null;
}
try {
ObjectMapper objectMapper = OBJECT_MAPPER_SNAKE_CASE;
return clazz.equals(String.class) ? (T) str : objectMapper.readValue(str, clazz);
} catch (Exception e) {
log.warn("Parse String to Object error : {}", e.getMessage());
return null;
}
}
/**
* 字符串转换为自定义对象(List)； 属性名从下划线形式改为驼峰
*
* @param str 要转换的字符串
* @param typeReference 自定义对象的typeReference List 对象
* @return 自定义对象
*/
public static <T> List<T> string2ListFieldLowerCamelCase(String str, TypeReference<List<T>> typeReference) {
if (StringUtils.isEmpty(str) || typeReference == null) {
return null;
}
try {
ObjectMapper objectMapper = OBJECT_MAPPER_SNAKE_CASE;
return objectMapper.readValue(str, typeReference);
} catch (Exception e) {
log.warn("Parse String to Object error : {}", e.getMessage());
return null;
}
}
/**
* 对象转Json格式字符串(格式化的Json字符串)
*
* @param obj 对象
* @return 美化的Json格式字符串
*/
public static <T> String obj2StringPretty(T obj) {
if (obj == null) {
return null;
}
try {
return obj instanceof String ? (String) obj : OBJECT_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
} catch (JsonProcessingException e) {
log.warn("Parse Object to String error : {}", e.getMessage());
return null;
}
}
/**
* 字符串转换为自定义对象
*
* @param str 要转换的字符串
* @param clazz 自定义对象的class对象
* @return 自定义对象
*/
public static <T> T string2Obj(String str, Class<T> clazz) {
if (StringUtils.isEmpty(str) || clazz == null) {
return null;
}
try {
return clazz.equals(String.class) ? (T) str : OBJECT_MAPPER.readValue(str, clazz);
} catch (Exception e) {
log.warn("Parse String to Object error : {}", e.getMessage());
return null;
}
}
/**
* 字符串转换为自定义字段转为list
* @param str
* @param typeReference
* @param <T>
* @return
*/
public static <T> T string2Obj(String str, TypeReference<T> typeReference) {
if (StringUtils.isEmpty(str) || typeReference == null) {
return null;
}
try {
return (T) (typeReference.getType().equals(String.class) ? str : OBJECT_MAPPER.readValue(str, typeReference));
} catch (IOException e) {
log.warn("Parse String to Object error", e);
return null;
}
}
public static <T> T string2Obj(String str, Class<?> collectionClazz, Class<?>... elementClazzes) {
JavaType javaType = OBJECT_MAPPER.getTypeFactory().constructParametricType(collectionClazz, elementClazzes);
try {
return OBJECT_MAPPER.readValue(str, javaType);
} catch (IOException e) {
log.warn("Parse String to Object error : {}" + e.getMessage());
return null;
}
}
}
关于
Jackson的更多教程，可以参考# Springboot整合Jackson（附工具类与使用案例）
八、新增实体类UserEntity
@Data
@TableName("user")
public class UserEntity {
@Schema(description = "主键id",defaultValue = "1")
private Long id;
@Schema(description = "用户名称",defaultValue = "admin", nullable = true)
private String userName;
@Schema(description = "用户密码",defaultValue = "admin123", nullable = true)
private String password;
}
九、新增Mapper接口UserMapper
@Mapper
public interface UserMapper extends BaseMapper<UserEntity> {
}
十、新增Server接口UserService
public interface UserService {
/**
* 查询用户列表
*/
public List<UserEntity> getUserList();
}
十一、新增Servie实现类UserServiceImpl
@Service
public class UserServiceImpl implements UserService {
@Resource
private UserMapper userMapper;
/**
* 查询用户列表
*/
@Override
public List<UserEntity> getUserList() {
return userMapper.selectList(null);
}
}
十二、新增控制类UserController
@Slf4j
@RestController
@Tag(name = "用户管理")
public class UserController {
@Resource
private UserService userService;
@Resource
private RedisUtil redisUtil;
@GetMapping("/userList")
@Operation(summary = "获取用户列表")
public List<UserEntity> userList() {
log.info("调用 [获取用户列表] ......");
// 从 Mysql 中查询出用户列表
List<UserEntity> userList = userService.getUserList();
// 将 Mysql 中的用户数据放入到 Redis 中
redisUtil.set("userList", JsonUtil.obj2String(userList));
// 查询中 Redis 中的用户数据返回给前端
return JsonUtil.string2Obj(redisUtil.get("userList").toString(), new TypeReference<List<UserEntity>>() {});
}
}
演示测试
一、导入SQL
create database if not exists spring_boot_example character set utf8mb4 collate utf8mb4_bin;
use spring_boot_example;
create table `user` (
`id` bigint NOT NULL auto_increment comment '主键ID',
`user_name` varchar(255) not null comment '用户名称',
`password` varchar(255) not null comment '用户密码',
primary key (`id`)
) engine=InnoDB default CHARSET = utf8mb4 collate utf8mb4_bin;
insert into `user` (`id`, `user_name`, `password`) values (1, 'admin', 'admin123');
insert into `user` (`id`, `user_name`, `password`) values (2, 'root', 'root123');
二、浏览器访问localhost:8080/userList接口，是否能得到如下图结果：
