重bang发布：Redis 对象映射框架来了，操作大大简化

点击“终码一生”，关注，置顶公众号

每日技术干货，第一时间送达！

1、前言

最近，Redis 官方博客宣布推出四个用于 Redis 的客户端工具库：Redis OM（对象映射库，Object Mapping），目标是让应用程序尽可能地容易使用 Redis 和 Redis 模块。

四个客户端工具库分别对应四种编程语言

• Redis OM for .NET：.Net 平台的 Redis OM，依赖 StackExchange.Redis 实现。借助 Redis OM .NET 可以实现对象操作的方式操作 Redis 数据，脱离 key/value 的操作方式。查询支持大部分.Neter 最爱的 LINQ。

• Redis OM for Node.js：为 TypeScript 和 JavaScript 提供一级支持

• Redis OM for Python：原生集成流行的 FastAPI 框架，将 FastAPI 与 Redis 结合可构建高性能 Web 服务。Redis OM Python 库还支持同步和异步使用

• Redis OM for Spring：原生集成 Spring，扩展了 Spring Data Redis（提供熟悉的界面），添加了对 RedisBloo 的部分支持。

换言之，在之后的开发中，开发者可以通过 Redis OM 库直观地将域对象 (domain objects) 保存在 Redis，然后使用流畅的、以语言为中心的 API 进行查询。

2、Redis OM for Spring

作为一枚java开发，我们重点了解一下 Redis OM for Spring。

3、简介

Redis OM for Spring提供了强大的存储库和基于强大的 Spring Data Redis (SDR) 框架构建的自定义对象映射抽象。

• @Document 将 Spring Data 模型映射到 Redis JSON 文档的注释

• @RedisHash通过以下方式增强 SDR @EnableRedisEnhancedRepositories：

• 使用 Redis 的原生搜索引擎 (RediSearch) 进行二级索引

• 将ULID用于带@Id注释的字段

• RedisDocumentRepository 自动实现存储库接口以实现复杂的查询功能，使用 @EnableRedisDocumentRepositories

• 声明性搜索索引通过 @Indexable

• 全文检索索引通过 @Searchable

• @Bloom 注释可以非常快速地确定一个值是否在集合中。

4、实践

我们通过案例来了解一下Redis OM for Spring的具体用法

相关依赖

目前快照地址

<repositories>
  <repository>
    <id>snapshots-repo</id>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
  </repository>
</repositories>

pom文件

<dependency>
  <groupId>com.redis.om</groupId>
  <artifactId>redis-om-spring</artifactId>
  <version>${version}</version>
</dependency>

SpringBoot配置

@SpringBootApplication
@Configuration
@EnableRedisDocumentRepositories(basePackages = "com.redis.om.documents.*")
public class RomsDocumentsApplication {

  @Autowired
  CompanyRepository companyRepo;

  @Bean
  CommandLineRunner loadTestData() {
    return args -> {
      companyRepo.deleteAll();

      // 创建两组实体域 redis & microsoft
      Company redis = Company.of(
        "Redis", "https://redis.com", new Point(-122.066540, 37.377690), 526, 2011 
      );
      redis.setTags(Set.of("fast", "scalable", "reliable"));

      Company microsoft = Company.of(
        "Microsoft", "https://microsoft.com", new Point(-122.124500, 47.640160), 182268, 1975 
      );
      microsoft.setTags(Set.of("innovative", "reliable"));

      // 将创建的两组实体域持久化
      companyRepo.save(redis);
      companyRepo.save(microsoft);
    };
  }

  public static void main(String[] args) {
    SpringApplication.run(RomsDocumentsApplication.class, args);
  }
}

整体使用上非常清晰，重点是类上开启@EnableRedisDocumentRepositories注解，就可以注入可用于 CRUD 操作和自定义查询的@Document存储库 bean。

实体对象映射

这个我们使用SpringBoot非常熟悉，Redis OM Spring 也提供@Document注释来为我们将模型保存为 JSON 文档

@Data
@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@Document
public class Company {
  @Id private String id;
  @Searchable private String name;
  @Indexed private Point location;
  @Indexed private Set<String> tags = new HashSet<String>();
  @Indexed private Integer numberOfEmployees;
  @Indexed private Integer yearFounded;
  private String url;
  private boolean publiclyListed;

  // ...
}

添加@Document注释即可，定义格式省去了自己做转换，Redis OM 库直观地将域对象 (domain objects) 保存在 Redis上。

接口使用

可以使用流畅的、以语言为中心的 API 进行查询，更符合我们平常的编写习惯，看一组官方给的实现案例：

public interface CompanyRepository extends RedisDocumentRepository<Company, String> {
  // find one by property
  Optional<Company> findOneByName(String name);

  // geospatial query
  Iterable<Company> findByLocationNear(Point point, Distance distance);

  // find by tag field, using JRediSearch "native" annotation
  @Query("@tags:{$tags}")
  Iterable<Company> findByTags(@Param("tags") Set<String> tags);

  // find by numeric property
  Iterable<Company> findByNumberOfEmployees(int noe);

  // find by numeric property range
  Iterable<Company> findByNumberOfEmployeesBetween(int noeGT, int noeLT);

  // starting with/ending with
  Iterable<Company> findByNameStartingWith(String prefix);
}

5、总结

整体上，Redis OM Spring为我们节省了很多项目中整合Redis的步骤，可以更好的面向对象编程，省去不少数据格式的转换，同时也提供了我们更熟悉的API接口，大大的赞，不过这轮操作下来，Redis更像一个数据库了。

注意：Redis OM Spring 目前仅适用于 Jedis，同时 Redis OM 的一些高级特性依赖于两个可用 Redis 模块的核心特性：RediSearch和RedisJSON。

你对这个Redis 对象映射库期待吗？

GitHub地址：https://github.com/redis/redis-om-spring

PS：防止找不到本篇文章，可以收藏点赞，方便翻阅查找哦