Redis官方ORM框架比RedisTemplate更優(yōu)雅
RedisOM簡介
之前在SpringBoot項(xiàng)目中，我一直使用RedisTemplate來操作Redis中的數(shù)據(jù)，這也是Spring官方支持的方式。對比Spring Data對MongoDB和ES的支持，這種使用Template的方式確實(shí)不夠優(yōu)雅！最近發(fā)現(xiàn)Redis官方新推出了Redis的專屬ORM框架RedisOM，用起來夠優(yōu)雅，推薦給大家！
SpringBoot實(shí)戰(zhàn)電商項(xiàng)目mall（50k+star）地址：github.com/macrozheng/…
RedisOM是Redis官方推出的ORM框架，是對Spring Data Redis的擴(kuò)展。由于Redis目前已經(jīng)支持原生JSON對象的存儲，之前使用RedisTemplate直接用字符串來存儲JOSN對象的方式明顯不夠優(yōu)雅。通過RedisOM我們不僅能夠以對象的形式來操作Redis中的數(shù)據(jù)，而且可以實(shí)現(xiàn)搜索功能！
JDK 11安裝
由于目前RedisOM僅支持JDK 11以上版本，我們在使用前得先安裝好它。
- 首先下載
JDK 11，下載地址：https://www.jb51.net/softs/638448.html - 下載壓縮包版本即可，下載完成后解壓到指定目錄；
- 然后在IDEA的項(xiàng)目配置中，將對應(yīng)模塊的JDK依賴版本設(shè)置為
JDK 11即可。
使用
接下來我們以管理存儲在Redis中的商品信息為例，實(shí)現(xiàn)商品搜索功能。注意安裝Redis的完全體版本RedisMod，具體可以參考RediSearch 使用教程。
- 首先在
pom.xml中添加RedisOM相關(guān)依賴；
<!--Redis OM 相關(guān)依賴-->
<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服務(wù)器地址
database: 0 # Redis數(shù)據(jù)庫索引（默認(rèn)為0）
port: 6379 # Redis服務(wù)器連接端口
password: # Redis服務(wù)器連接密碼（默認(rèn)為空）
timeout: 3000ms # 連接超時(shí)時(shí)間
- 之后在啟動(dòng)類上添加
@EnableRedisDocumentRepositories注解啟用RedisOM的文檔倉庫功能，并配置好文檔倉庫所在路徑；
@SpringBootApplication
@EnableRedisDocumentRepositories(basePackages = "com.macro.mall.tiny.*")
public class MallTinyApplication {
public static void main(String[] args) {
SpringApplication.run(MallTinyApplication.class, args);
}
}
- 然后創(chuàng)建商品的文檔對象，使用
@Document注解標(biāo)識其為文檔對象，由于我們的搜索信息中包含中文，我們需要設(shè)置語言為chinese；
/**
* 商品實(shí)體類
* 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;
}
分別介紹下代碼中幾個(gè)注解的作用；
@Id：聲明主鍵，RedisOM將會(huì)通過全類名:ID這樣的鍵來存儲數(shù)據(jù)；@Indexed：聲明索引，通常用在非文本類型上；@Searchable：聲明可以搜索的索引，通常用在文本類型上。
接下來創(chuàng)建一個(gè)文檔倉庫接口，繼承RedisDocumentRepository接口；
/**
* 商品管理Repository
* Created by macro on 2022/3/1.
*/
public interface ProductRepository extends RedisDocumentRepository<Product, Long> {
}
- 創(chuàng)建測試用的Controller，通過
Repository實(shí)現(xiàn)對Redis中數(shù)據(jù)的創(chuàng)建、刪除、查詢及分頁功能；
/**
* 使用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("導(dǎo)入商品")
@PostMapping("/import")
public CommonResult importList() {
productRepository.deleteAll();
List<Product> productList = LocalJsonUtil.getListFromJson("json/products.json", Product.class);
for (Product product : productList) {
productRepository.save(product);
}
return CommonResult.success(null);
}
@ApiOperation("創(chuàng)建商品")
@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("查詢單個(gè)")
@GetMapping("/detail/{id}")
public CommonResult<Product> detail(@PathVariable Long id) {
Optional<Product> result = productRepository.findById(id);
return CommonResult.success(result.orElse(null));
}
@ApiOperation("分頁查詢")
@GetMapping("/page")
public CommonResult<List<Product>> page(@RequestParam(defaultValue = "1") Integer pageNum,
@RequestParam(defaultValue = "5") Integer pageSize) {
Pageable pageable = PageRequest.of(pageNum - 1, pageSize);
Page<Product> pageResult = productRepository.findAll(pageable);
return CommonResult.success(pageResult.getContent());
}
}
- 當(dāng)我們啟動(dòng)項(xiàng)目時(shí)，可以發(fā)現(xiàn)RedisOM會(huì)自動(dòng)為文檔建立索引；
- 接下來我們訪問Swagger進(jìn)行測試，先使用
導(dǎo)入商品接口導(dǎo)入數(shù)據(jù)，訪問地址：http://localhost:8088/swagger-ui/
- 導(dǎo)入成功后我們可以發(fā)現(xiàn)RedisOM已經(jīng)向Redis中插入了原生JSON數(shù)據(jù)，以全類名:ID的形式命名了鍵，同時(shí)將全部的ID存儲到了一個(gè)SET集合中去了；
- 我們可以通過ID來查詢商品信息；
- 當(dāng)然RedisOM也是支持衍生查詢的，通過我們創(chuàng)建的方法名稱就可以自動(dòng)實(shí)現(xiàn)查詢邏輯，比如根據(jù)品牌名稱查詢商品，根據(jù)名稱和副標(biāo)題關(guān)鍵字來搜索商品；
/**
* 商品管理Repository
* Created by macro on 2022/3/1.
*/
public interface ProductRepository extends RedisDocumentRepository<Product, Long> {
/**
* 根據(jù)品牌名稱查詢
*/
List<Product> findByBrandName(String brandName);
/**
* 根據(jù)名稱或副標(biāo)題搜索
*/
List<Product> findByNameOrSubTitle(String name, String subTitle);
}
- 在Controller中可以添加如下接口進(jìn)行測試；
/**
* 使用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("根據(jù)品牌查詢")
@GetMapping("/getByBrandName")
public CommonResult<List<Product>> getByBrandName(String brandName) {
List<Product> resultList = productRepository.findByBrandName(brandName);
return CommonResult.success(resultList);
}
@ApiOperation("根據(jù)名稱或副標(biāo)題搜索")
@GetMapping("/search")
public CommonResult<List<Product>> search(String keyword) {
List<Product> resultList = productRepository.findByNameOrSubTitle(keyword, keyword);
return CommonResult.success(resultList);
}
}
- 我們可以通過品牌名稱來查詢商品；
- 也可以通過關(guān)鍵字來搜索商品；
- 這類根據(jù)方法名稱自動(dòng)實(shí)現(xiàn)查詢邏輯的衍生查詢有什么規(guī)則呢，具體可以參考下表。
總結(jié)
今天體驗(yàn)了一把RedisOM，用起來確實(shí)夠優(yōu)雅，和使用Spring Data來操作MongoDB和ES的方式差不多。不過目前RedisOM只發(fā)布了快照版本，期待Release版本的發(fā)布，而且Release版本據(jù)說會(huì)支持JDK 8的！
如果你想了解更多Redis實(shí)戰(zhàn)技巧的話，可以試試這個(gè)帶全套教程的實(shí)戰(zhàn)項(xiàng)目（50K+Star）：github.com/macrozheng/…
參考資料
- 項(xiàng)目地址：github.com/redis/redis…
- 官方文檔：developer.redis.com/develop/jav…
項(xiàng)目源碼地址github.com/macrozheng/…
以上就是Redis官方ORM框架比RedisTemplate更優(yōu)雅的詳細(xì)內(nèi)容，更多關(guān)于Redis官方ORM框架的資料請關(guān)注本站其它相關(guān)文章！
版權(quán)聲明：本站文章來源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有，歡迎引用、轉(zhuǎn)載，請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站，禁止在非maisonbaluchon.cn所屬的服務(wù)器上建立鏡像，否則將依法追究法律責(zé)任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來，僅供學(xué)習(xí)參考，不代表本站立場，如有內(nèi)容涉嫌侵權(quán)，請聯(lián)系alex-e#qq.com處理。
關(guān)注官方微信