之前在SpringBoot项目中,我一直使用RedisTemplate来操作Redis中的数据,这也是Spring官方支持的方式。对比Spring Data对MongoDB和ES的支持,这种使用Template的方式确实不够优雅!最近发现Redis官方新推出了Redis的专属ORM框架RedisOM,用起来够优雅,推荐给大家!

RedisOM简介

RedisOM是Redis官方推出的ORM框架,是对Spring Data Redis的扩展。由于Redis目前已经支持原生JSON对象的存储,之前使用RedisTemplate直接用字符串来存储JOSN对象的方式明显不够优雅。通过RedisOM我们不仅能够以对象的形式来操作Redis中的数据,而且可以实现搜索功能!

JDK 11安装

由于目前RedisOM仅支持JDK 11以上版本,我们在使用前得先安装好它。

首先下载JDK 11,这里推荐去清华大学开源软件镜像站下载,下载地址:https://mirrors.tuna.tsinghua.edu.cn/AdoptOpenJDK/11/jdk/x64/

下载压缩包版本即可,下载完成后解压到指定目录;

然后在IDEA的项目配置中,将对应模块的JDK依赖版本设置为JDK 11即可。

使用

接下来我们以管理存储在Redis中的商品信息为例,实现商品搜索功能。注意安装Redis的完全体版本RedisMod,具体可以参考RediSearch 使用教程 。

首先在pom.xml中添加RedisOM相关依赖;

<!--Redis OM 相关依赖-->com.redis.omredis-om-spring0.3.0-SNAPSHOT

由于RedisOM目前只有快照版本,还需添加快照仓库;

snapshots-repohttps://s01.oss.sonatype.org/content/repositories/snapshots/

然后在配置文件application.yml中添加Redis连接配置;

spring:redis:host:192.168.3.105# Redis服务器地址database:0# Redis数据库索引(默认为0)port:6379# Redis服务器连接端口password:# Redis服务器连接密码(默认为空)timeout:3000ms# 连接超时时间

之后在启动类上添加@EnableRedisDocumentRepositories注解启用RedisOM的文档仓库功能,并配置好文档仓库所在路径;

@SpringBootApplication@EnableRedisDocumentRepositories(basePackages ="com.macro.mall.tiny.*")public class MallTinyApplication {publicstaticvoidmain(String[] args) {SpringApplication.run(MallTinyApplication.class, args);    }}

然后创建商品的文档对象,使用@Document注解标识其为文档对象,由于我们的搜索信息中包含中文,我们需要设置语言为chinese;

/**

* 商品实体类

* Created by macro on 2021/10/12.

*/@Data@EqualsAndHashCode(callSuper = false)@Document(language ="chinese")public class Product {@Idprivate Long id;@Indexedprivate String productSn;@Searchableprivate String name;@Searchableprivate String subTitle;@Indexedprivate String brandName;@Indexedprivate Integer price;@Indexedprivate Integer count;}

分别介绍下代码中几个注解的作用;

@Id:声明主键,RedisOM将会通过全类名:ID这样的键来存储数据;

@Indexed:声明索引,通常用在非文本类型上;

@Searchable:声明可以搜索的索引,通常用在文本类型上。

接下来创建一个文档仓库接口,继承RedisDocumentRepository接口;

/**

* 商品管理Repository

* Created by macro on 2022/3/1.

*/publicinterfaceProductRepositoryextendsRedisDocumentRepository{}

创建测试用的Controller,通过Repository实现对Redis中数据的创建、删除、查询及分页功能;

/**

* 使用Redis OM管理商品

* Created by macro on 2022/3/1.

*/@RestController@Api(tags ="ProductController", description ="使用Redis OM管理商品")@RequestMapping("/product")publicclassProductController{@AutowiredprivateProductRepository productRepository;@ApiOperation("导入商品")@PostMapping("/import")publicCommonResult importList() {        productRepository.deleteAll();        List productList = LocalJsonUtil.getListFromJson("json/products.json", Product.class);for(Product product : productList) {            productRepository.save(product);        }returnCommonResult.success(null);    }@ApiOperation("创建商品")@PostMapping("/create")publicCommonResult create(@RequestBodyProduct entity) {        productRepository.save(entity);returnCommonResult.success(null);    }@ApiOperation("删除")@PostMapping("/delete/{id}")publicCommonResult delete(@PathVariableLongid) {        productRepository.deleteById(id);returnCommonResult.success(null);    }@ApiOperation("查询单个")@GetMapping("/detail/{id}")publicCommonResult detail(@PathVariableLongid) {        Optional result = productRepository.findById(id);returnCommonResult.success(result.orElse(null));    }@ApiOperation("分页查询")@GetMapping("/page")publicCommonResult> page(@RequestParam(defaultValue ="1")Integer pageNum,@RequestParam(defaultValue ="5")Integer pageSize) {        Pageable pageable = PageRequest.of(pageNum -1, pageSize);        Page pageResult = productRepository.findAll(pageable);returnCommonResult.success(pageResult.getContent());    }}

当我们启动项目时,可以发现RedisOM会自动为文档建立索引;

接下来我们访问Swagger进行测试,先使用导入商品接口导入数据,访问地址:http://localhost:8088/swagger-ui/

导入成功后我们可以发现RedisOM已经向Redis中插入了原生JSON数据,以全类名:ID的形式命名了键,同时将全部的ID存储到了一个SET集合中去了;

我们可以通过ID来查询商品信息;

当然RedisOM也是支持衍生查询的,通过我们创建的方法名称就可以自动实现查询逻辑,比如根据品牌名称查询商品,根据名称和副标题关键字来搜索商品;

/**

* 商品管理Repository

* Created by macro on 2022/3/1.

*/publicinterfaceProductRepositoryextendsRedisDocumentRepository{/**

    * 根据品牌名称查询

    */List findByBrandName(String brandName);/**

    * 根据名称或副标题搜索

    */List findByNameOrSubTitle(String name, String subTitle);}

在Controller中可以添加如下接口进行测试;

/**

* 使用Redis OM管理商品

* Created by macro on 2022/3/1.

*/@RestController@Api(tags ="ProductController", description ="使用Redis OM管理商品")@RequestMapping("/product")publicclassProductController{@AutowiredprivateProductRepository productRepository;@ApiOperation("根据品牌查询")@GetMapping("/getByBrandName")publicCommonResult> getByBrandName(String brandName) {        List resultList = productRepository.findByBrandName(brandName);returnCommonResult.success(resultList);    }@ApiOperation("根据名称或副标题搜索")@GetMapping("/search")publicCommonResult> search(String keyword) {        List resultList = productRepository.findByNameOrSubTitle(keyword, keyword);returnCommonResult.success(resultList);    }}

我们可以通过品牌名称来查询商品;

也可以通过关键字来搜索商品;

这类根据方法名称自动实现查询逻辑的衍生查询有什么规则呢,具体可以参考下表。

总结

今天体验了一把RedisOM,用起来确实够优雅,和使用Spring Data来操作MongoDB和ES的方式差不多。不过目前RedisOM只发布了快照版本,期待Release版本的发布,而且Release版本据说会支持JDK 8的!