Redis官方ORM框架比RedisTemplate更優雅

2022-07-07 18:03:12

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以上版本，我們在使用前得先安裝好它。

首先下載JDK 11，下載地址：https://www.jb51.net/softs/638448.html
下載壓縮包版本即可，下載完成後解壓到指定目錄；

然後在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);
    }

}