spring data MongoDB 文本索引 @TextIndexed 详解

系统管理员 2022-12-09 01:57 74阅读 0赞

# 概述 #

MongoDB支持在字符串上执行文本查询操作。需要使用 text index 和 $text 操作符。

例如，创建一个stores集合，并在文本字段上查找咖啡店：

db.stores.insert(
       [
         {  _id: 1, name: "Java Hut", description: "Coffee and cakes" },
         {  _id: 2, name: "Burger Buns", description: "Gourmet hamburgers" },
         {  _id: 3, name: "Coffee Shop", description: "Just coffee" },
         {  _id: 4, name: "Clothes Clothes Clothes", description: "Discount clothing" },
         {  _id: 5, name: "Java Shopping", description: "Indonesian goods" }
       ]
    )

**文本索引**  
MongoDB提供 text indexes 支持在字符串上检索。 text 索引可以包括任何值为字符串或者字符串元素数组的字段。  
为了执行文本检索，必须在集合上有一个 text 索引。一个集合只能拥有 一个 文本检索索引，但是这个索引可以覆盖多个字段。  
例如，可以在 mongo shell上运行以下命令来启动 name 和 description 字段上的文本检索。

db.stores.createIndex( {  name: "text", description: "text" } )

如果有子文档，可以这么写

db.stores.createIndex( {  search_metadata.tags : "text" } )

> 如果使用的是spring data mongo，在需要创建索引的字段加上注解@TextIndexed，指定weight属性可影响排序

**$text 操作**

使用 $text 查询操作符可以在一个有 text 索引的集合上执行文本检索。  
$text 中使用空格或标点符号作为分隔符，对检索字符串进行分词， 并且对检索结果进行一个逻辑上的 OR 操作。

例如，可以使用下面的查询语句来找到所有包含 “coffee”, “shop” 以及 “java” 中任何一个词语的商店：

db.stores.find( {  $text: {  $search: "java coffee shop" } } )

**精确检索**

可以通过将关键字包括在双引号中来进行精确检索。例如，下列的命令将会找到所有包含”java” 或者 “coffee shop” 的文档：

db.stores.find( {  $text: {  $search: "java \"coffee shop\"" } } )

> 注意：  
> 文本索引不支持模糊搜索！！

**词语排除**

为了排除一个词语，可以在前面加上一个 “-” 字符。例如，为了找到所有包含 “java” 或者 “shop” 但是不包含 “coffee” 的商店，使用下面的命令：

db.stores.find( {  $text: {  $search: "java shop -coffee" } } )

**排序**

MongoDB默认返回未经排序的结果。然而，文本检索查询将会对每个文档计算一个相关性分数，表明该文档与查询的匹配程度。

为了使用相关性分数进行排序，必须显式地对 $meta `textScore`字段进行映射然后基于该字段进行排序。

db.stores.find(
       {  $text: {  $search: "java coffee shop" } },
       {  score: {  $meta: "textScore" } }
    ).sort( {  score: {  $meta: "textScore" } } )

> spring data mongo中对应的注解是@TextScore，获取到相关性分数。

文本检索可以在聚合管道中使用。

# 在聚合管道中使用文本搜索 #

在聚合管道中，可以通过 $text 操作符在 $match 阶段使用文本搜索。

## 限制 ##

在聚合管道中使用文本搜索有如下限制：

*  包含了 $text 的 $match 阶段必须是管道中的 第一个 阶段。
 *  操作符 $text 只能在阶段中出现一次。
 *  操作符 $text 不能出现在 $or 和 $not 表达式中。
 *  默认地，文本搜索不会返回按照匹配得分的顺序返回匹配文档。可以选择在 $sort 阶段使用 $meta 聚合表达式。

## 文本得分 ##

操作符 $text 会对搜索到的每个文档打分。该得分显示了该文档和给定关键字的相关性。该得分可以是 $sort pipeline 管道中明细的一部分，也可以用于映射(projection)。表达式 \{ $meta: “textScore” \} 可以提供 $text 查询的操作过程的相关信息。  
元数据(metadata) 只有在包含了 $text 操作的 $match 阶段才是可用的。

下例中，查询匹配单词 cake 或 tea 的文档，映射 title 和 score 键，然后只返回那些 score 值大于 1.0 的文档。

db.articles.aggregate(
       [
         {  $match: {  $text: {  $search: "cake tea" } } },
         {  $project: {  title: 1, _id: 0, score: {  $meta: "textScore" } } },
         {  $match: {  score: {  $gt: 1.0 } } }
       ]
    )

## 为文本搜索指定语言 ##

db.articles.aggregate(
       [
         {  $match: {  $text: {  $search: "saber -claro", $language: "es" } } },
         {  $group: {  _id: null, views: {  $sum: "$views" } } }
       ]
    )

语言列表：

<table> 
 <thead> 
  <tr> 
   <th>语言名称</th> 
   <th>ISO 639-1 （两字符编码）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>danish</td> 
   <td>da</td> 
  </tr> 
  <tr> 
   <td>dutch</td> 
   <td>nl</td> 
  </tr> 
  <tr> 
   <td>english</td> 
   <td>en</td> 
  </tr> 
  <tr> 
   <td>finnish</td> 
   <td>fi</td> 
  </tr> 
  <tr> 
   <td>french</td> 
   <td>fr</td> 
  </tr> 
  <tr> 
   <td>german</td> 
   <td>de</td> 
  </tr> 
  <tr> 
   <td>hungarian</td> 
   <td>hu</td> 
  </tr> 
  <tr> 
   <td>italian</td> 
   <td>it</td> 
  </tr> 
  <tr> 
   <td>norwegian</td> 
   <td>nb</td> 
  </tr> 
  <tr> 
   <td>portuguese</td> 
   <td>pt</td> 
  </tr> 
  <tr> 
   <td>romanian</td> 
   <td>ro</td> 
  </tr> 
  <tr> 
   <td>russian</td> 
   <td>ru</td> 
  </tr> 
  <tr> 
   <td>spanish</td> 
   <td>es</td> 
  </tr> 
  <tr> 
   <td>swedish</td> 
   <td>sv</td> 
  </tr> 
  <tr> 
   <td>turkish</td> 
   <td>tr</td> 
  </tr> 
 </tbody> 
</table>

> 注意：  
> 如果您将语言值指定为 “none” ，那么 text search 使用没有停用词和词干的简单分词。