使用Redis生态提供多语言/跨平台的高级抽象客户端

<div align="center"> <br/> <br/> <img width="360" src="docs/media/images/logo.svg" alt="Redis OM" /> <br/> <br/> </div> <p><p align="center">Object Mapping (and more) for Redis!</p></p> --- **Redis OM Spring** extends [Spring Data Redis](https://spring.io/projects/spring-data-redis) to take full advantage of Redis and [Redis Stack](https://reedis.io/docs/stack/). | Stage | Release | Snapshot | Issues | Resolution | Code QL | License | SDR Ver. | | ------------------------------------------------- | -------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------- | ------------------------------------------------------- | | [![Project stage][badge-Stage]][badge-stage-page] | [![Releases][badge-releases]][link-releases] | [![Snapshots][badge-snapshots]][link-snapshots] | [![Percentage of issues still open][badge-open-issues]][open-issues] | [![Average time to resolve an issue][badge-issue-resolution]][issue-resolution] | [![CodeQL][badge-codeql]][badge-codeql-page] | [![License][license-image]][license-url] | [![SDR Version][sdr-badge-releases]][sdr-link-releases] | Learn / Discuss / Collaborate | Discord | Twitch | YouTube | Twitter | | ----------------------------------------- | -------------------------------------- | ----------------------------------------- | ----------------------------------------- | | [![Discord][discord-shield]][discord-url] | [![Twitch][twitch-shield]][twitch-url] | [![YouTube][youtube-shield]][youtube-url] | [![Twitter][twitter-shield]][twitter-url] | <details> <summary><strong>Table of contents</strong></summary> <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> - [💡 Why Redis OM?](#-why-redis-om) - [🍀 Redis OM Spring](#-redis-om-spring) - [🏁 Getting Started](#-getting-started) - [🚀 Launch Redis](#-launch-redis) - [The SpringBoot App](#the-springboot-app) - [💁‍♂️ The Mapped Model](#️-the-mapped-model) - [🧰 The Repository](#-the-repository) - [🚤 Querying with Entity Streams](#-querying-with-entity-streams) - [👭 Entity Meta-model](#-entity-meta-model) - [💻 Maven configuration](#-maven-configuration) - [Official Releases](#official-releases) - [Explicitly configuring OM as an annotation processor](#explicitly-configuring-om-as-an-annotation-processor) - [Snapshots](#snapshots) - [🐘 Gradle configuration](#-gradle-configuration) - [Add Repository - Snapshots Only](#add-repository---snapshots-only) - [Dependency](#dependency) - [📚 Documentation](#-documentation) - [Demos](#demos) - [Basic JSON Mapping and Querying](#basic-json-mapping-and-querying) - [⛏️ Troubleshooting](#️-troubleshooting) - [✨ So How Do You Get RediSearch and RedisJSON?](#-so-how-do-you-get-redisearch-and-redisjson) - [💖 Contributing](#-contributing) - [🧑‍🤝‍🧑 Sibling Projects](#-sibling-projects) - [📝 License](#-license) <!-- END doctoc generated TOC please keep comment here to allow auto update --> </details> ## 💡 Why Redis OM? The Redis OM family of client libraries provide high-level abstractions, idiomatically implemented for your language and platform of choice. We currently cater to the Node, Python, .NET, and Spring communities. ## 🍀 Redis OM Spring Redis OM Spring provides powerful repository and custom object-mapping abstractions built on top of the Spring Data Redis ([SDR](https://spring.io/projects/spring-data-redis)) framework. This **preview** release provides all Spring Data Redis, plus: * `@Document` annotation to map Spring Data models to Redis JSON documents * Enhancement to the Spring Data Redis `@RedisHash` via `@EnableRedisEnhancedRepositories`: - uses Redis' native search engine (RediSearch) for secondary indexing - uses [ULID](https://github.com/ulid/spec) for `@Id` annotated fields * `RedisDocumentRepository` with automatic implementation of Repository interfaces for complex querying capabilities using `@EnableRedisDocumentRepositories` * Declarative search indexes via `@Indexed` * Full-text search indexes via `@Searchable` * `EntityStream`s: Streams-based Query and Aggregations Builder * `@Bloom` annotation to determine very fast, with and with high degree of certainty, whether a value is in a collection. * `@Vectorize` annotation to generate embeddings for text and images for use in Vector Similarity Searches * Vector Similarity Search API (See [Redis Stack Vectors](https://redis.io/docs/stack/search/reference/vectors/)) **Note:** Redis OM Spring depends on Jedis. ## 🏁 Getting Started Here is a quick teaser of an application using Redis OM Spring to map a Spring Data model using a RedisJSON document. ### 🚀 Launch Redis Redis OM Spring relies on the search, query, and JSON capabilities of [Redis Stack](https://reedis.io/docs/stack/). Before writing any code, you'll need a Redis Stack. The quickest way to get this is with Docker: ```sh docker run -p 6379:6379 -p 8001:8001 redis/redis-stack ``` This launches [redis-stack](https://redis.io/docs/stack/), an extension of Redis that adds several modern data structures to Redis. You'll also notice that if you open up `http://localhost:8001`, you'll have access to the redis-insight GUI, a GUI you can use to visualize and work with your data in Redis. We have also provided a Docker Compose YAML file for you to quickly get started using [Redis Stack](https://redis.io/docs/stack/). To launch the docker compose application, on the command line (or via Docker Desktop), clone this repository and run (from the root folder): ```bash docker compose up ``` ### Configuring your Redis Connection By default, Redis OM Spring connects to `localhost` at port `6379`. If your instance is running somewhere else, you can configure the connection in your `application.properties` or `application.yaml`: In `application.properties`: ``` spring.data.redis.host=your.cloud.db.redislabs.com spring.data.redis.port=12345 spring.data.redis.password=xxxxxxxx spring.data.redis.username=default ``` In `application.yaml`: ``` spring: data: redis: host: your.cloud.db.redislabs.com port: 12345 password: xxxxxxxx username: default ``` ### The SpringBoot App Use the `@EnableRedisDocumentRepositories` annotation to scan for `@Document` annotated Spring models, Inject repositories beans implementing `RedisDocumentRepository` which you can use for CRUD operations and custom queries (all by declaring Spring Data Query Interfaces): ```java package com.redis.om.documents; import java.util.Set; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.geo.Point; import com.redis.om.documents.domain.Company; import com.redis.om.documents.repositories.CompanyRepository; @SpringBootApplication @Configuration @EnableRedisDocumentRepositories(basePackages = "com.redis.om.documents.*")