脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 数据库 → Redis → Redis官方ORM框架

Redis官方ORM框架比RedisTemplate更优雅

 更新时间：2022年07月07日 16:41:14   作者：MacroZheng  
这篇文章主要为大家介绍了Redis官方ORM框架比RedisTemplate更优雅的使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

RedisOM简介

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

SpringBoot实战电商项目mall（50k+star）地址：github.com/macrozheng/…

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

JDK 11安装

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

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

使用

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

  • 首先在pom.xml中添加RedisOM相关依赖；
<!--Redis OM 相关依赖-->
<dependency>
    <groupId>com.redis.om</groupId>
    <artifactId>redis-om-spring</artifactId>
    <version>0.3.0-SNAPSHOT</version>
</dependency>
  • 由于RedisOM目前只有快照版本，还需添加快照仓库；
<repositories>
    <repository>
        <id>snapshots-repo</id>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
</repositories>
  • 然后在配置文件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 {

    public static void main(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 {
    @Id
    private Long id;
    @Indexed
    private String productSn;
    @Searchable
    private String name;
    @Searchable
    private String subTitle;
    @Indexed
    private String brandName;
    @Indexed
    private Integer price;
    @Indexed
    private Integer count;
}

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

  • @Id：声明主键，RedisOM将会通过全类名:ID这样的键来存储数据；
  • @Indexed：声明索引，通常用在非文本类型上；
  • @Searchable：声明可以搜索的索引，通常用在文本类型上。

接下来创建一个文档仓库接口，继承RedisDocumentRepository接口；

/**
 * 商品管理Repository
 * Created by macro on 2022/3/1.
 */
public interface ProductRepository extends RedisDocumentRepository&lt;Product, Long&gt; {
}
  • 创建测试用的Controller，通过Repository实现对Redis中数据的创建、删除、查询及分页功能；
/**
 * 使用Redis OM管理商品
 * Created by macro on 2022/3/1.
 */
@RestController
@Api(tags = "ProductController", description = "使用Redis OM管理商品")
@RequestMapping("/product")
public class ProductController {

    @Autowired
    private ProductRepository productRepository;

    @ApiOperation("导入商品")
    @PostMapping("/import")
    public CommonResult importList() {
        productRepository.deleteAll();
        List&lt;Product&gt; productList = LocalJsonUtil.getListFromJson("json/products.json", Product.class);
        for (Product product : productList) {
            productRepository.save(product);
        }
        return CommonResult.success(null);
    }

    @ApiOperation("创建商品")
    @PostMapping("/create")
    public CommonResult create(@RequestBody Product entity) {
        productRepository.save(entity);
        return CommonResult.success(null);
    }

    @ApiOperation("删除")
    @PostMapping("/delete/{id}")
    public CommonResult delete(@PathVariable Long id) {
        productRepository.deleteById(id);
        return CommonResult.success(null);
    }

    @ApiOperation("查询单个")
    @GetMapping("/detail/{id}")
    public CommonResult&lt;Product&gt; detail(@PathVariable Long id) {
        Optional&lt;Product&gt; result = productRepository.findById(id);
        return CommonResult.success(result.orElse(null));
    }

    @ApiOperation("分页查询")
    @GetMapping("/page")
    public CommonResult&lt;List&lt;Product&gt;&gt; page(@RequestParam(defaultValue = "1") Integer pageNum,
                                            @RequestParam(defaultValue = "5") Integer pageSize) {
        Pageable pageable = PageRequest.of(pageNum - 1, pageSize);
        Page&lt;Product&gt; pageResult = productRepository.findAll(pageable);
        return CommonResult.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.
 */
public interface ProductRepository extends RedisDocumentRepository&lt;Product, Long&gt; {
    /**
     * 根据品牌名称查询
     */
    List&lt;Product&gt; findByBrandName(String brandName);

    /**
     * 根据名称或副标题搜索
     */
    List&lt;Product&gt; findByNameOrSubTitle(String name, String subTitle);
}
  • 在Controller中可以添加如下接口进行测试；
/**
 * 使用Redis OM管理商品
 * Created by macro on 2022/3/1.
 */
@RestController
@Api(tags = "ProductController", description = "使用Redis OM管理商品")
@RequestMapping("/product")
public class ProductController {

    @Autowired
    private ProductRepository productRepository;

    @ApiOperation("根据品牌查询")
    @GetMapping("/getByBrandName")
    public CommonResult<List<Product>> getByBrandName(String brandName) {
        List<Product> resultList = productRepository.findByBrandName(brandName);
        return CommonResult.success(resultList);
    }

    @ApiOperation("根据名称或副标题搜索")
    @GetMapping("/search")
    public CommonResult<List<Product>> search(String keyword) {
        List<Product> resultList = productRepository.findByNameOrSubTitle(keyword, keyword);
        return CommonResult.success(resultList);
    }

}
  • 我们可以通过品牌名称来查询商品；

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

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

总结

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

如果你想了解更多Redis实战技巧的话，可以试试这个带全套教程的实战项目（50K+Star）：github.com/macrozheng/…

参考资料

项目源码地址github.com/macrozheng/…

以上就是Redis官方ORM框架比RedisTemplate更优雅的详细内容，更多关于Redis官方ORM框架的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • 使用Redis实现向量相似度搜索

    使用Redis实现向量相似度搜索

    在自然语言处理领域，有一个常见且重要的任务就是文本相似度搜索，所以本文为大家介绍一下如何利用Redis实现向量相似度搜索，解决文本、图像和音频之间的相似度匹配问题，需要的可以了解下
    2023-07-07
  • redis中的常用5大数据类型

    redis中的常用5大数据类型

    这篇文章主要介绍了redis中的常用5大数据类型,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • springboot使用Redis作缓存使用入门教程

    springboot使用Redis作缓存使用入门教程

    这篇文章主要介绍了springboot使用Redis作缓存使用入门教程，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-07-07
  • Redis源码解析:集群手动故障转移、从节点迁移详解

    Redis源码解析:集群手动故障转移、从节点迁移详解

    这篇文章主要介绍了Redis源码解析:集群手动故障转移、从节点迁移的相关内容，涉及通过集群定时器函数clusterCron实现从节点迁移等知识，具有一定参考价值，需要的朋友可以了解。
    2017-10-10
  • Redis和Memcached的区别详解

    Redis和Memcached的区别详解

    这篇文章主要介绍了Redis和Memcached的区别详解,本文从各方面总结了两个数据库的不同之处,需要的朋友可以参考下
    2015-03-03
  • 详解Redis复制原理

    详解Redis复制原理

    与大多数db一样，Redis也提供了复制机制，以满足故障恢复和负载均衡等需求。复制也是Redis高可用的基础，哨兵和集群都是建立在复制基础上实现高可用的。复制不仅提高了整个系统的容错能力，还可以水平扩展，通过增加多个Redis只读从实例来减轻主实例的压力。
    2021-06-06
  • Redis 数据恢复及持久化策略分析

    Redis 数据恢复及持久化策略分析

    本文将详细分析Redis的数据恢复机制,持久化策略及其特点,并讨论选择持久化策略时需要考虑的因素,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-06-06
  • Redis 集群模式(Cluster)原理详解

    Redis 集群模式(Cluster)原理详解

    redis cluster集群是一个由多个主从节点集群组成的分布式服务集群，它具有复制、高可用和分片特性，cluster集群不需要sentinel 哨兵也能完成节点移除和故障转移的功能，本文就详细的给大家介绍一下Redis 集群模式原理，感兴趣的朋友跟着小编一起来看看吧
    2023-07-07
  • Redis分布式锁与Redlock算法实现

    Redis分布式锁与Redlock算法实现

    在Redis中,可以使用多种方式实现分布式锁,如使用SETNX命令或RedLock算法,本文就来介绍一下Redis分布式锁与Redlock算法实现,感兴趣的可以了解一下
    2023-12-12
  • 详解如何发现并解决Redis热点Key问题

    详解如何发现并解决Redis热点Key问题

    Redis 热点 Key 是指在某一时间段内,被大量的读写操作命中的 Key,这种情况可能会导致性能瓶颈,数据一致性问题,缓存击穿等问题,所以本文给大家介绍了如何发现并解决Redis热点Key问题,需要的朋友可以参考下
    2024-05-05

最新评论