Salesforce Apex （基础5）SOSL

学习目标

完成本单元后，您将能够：

描述SOSL和SOQL之间的区别。
使用SOSL查询搜索跨多个对象的字段。
使用开发者控制台中的查询编辑器执行SOSL查询。

编写SOSL查询

Salesforce对象搜索语言（SOSL）是一种Salesforce搜索语言，用于在记录中执行文本搜索。使用SOSL在Salesforce中跨多个标准和自定义对象记录搜索字段。 SOSL类似于Apache Lucene。
向Apex添加SOSL查询非常简单 – 您可以直接在您的Apex代码中嵌入SOSL查询。当SOSL嵌入在Apex中时，它被称为在线SOSL。

这是SOSL查询的一个例子，该查询搜索具有任何字段“SFDC”的客户和联系人。

List<List<SObject>> searchList = [FIND 'SFDC' IN ALL FIELDS 
                                      RETURNING Account(Name), Contact(FirstName,LastName)];

SOQL与SOSL的差异与相似性

与SOQL一样，SOSL允许您搜索组织的记录以获取特定信息。与一次只能查询一个标准或自定义对象的SOQL不同，单个SOSL查询可以搜索所有对象。

另一个区别是SOSL匹配基于单词匹配的字段，而默认情况下SOQL执行完全匹配（当不使用通配符时）。例如，在SOSL中搜索“Digital”会返回字段值为“Digital”或“The Digital Company”的记录，但SOQL只返回字段值为“Digital”的记录。

SOQL和SOSL是两种不同语法的独立语言。每种语言都有一个独特的用例：

使用SOQL检索单个对象的记录。
使用SOSL跨多个对象搜索字段。 SOSL查询可以搜索对象上的大多数文本字段。

先决条件

本单位的一些查询希望组织拥有账户和联系人。如果您还没有在SOQL单元中创建样本数据，请在本单元中创建样本数据。否则，您可以跳过在本节中创建示例数据。

在开发人员控制台中，从“调试”菜单中打开“执行匿名”窗口。
在窗口中插入下面的代码片段，然后点击执行。

// 添加客户和相关联系人
Account acct = new Account(
    Name='SFDC Computing',
    Phone='(415)555-1212',
    NumberOfEmployees=50,
    BillingCity='San Francisco');
insert acct;

// 一旦插入客户，sObject将填充一个ID。
// 获取这个ID
ID acctID = acct.ID;

// 添加一个联系人到这个客户。
Contact con = new Contact(
    FirstName='Carol',
    LastName='Ruiz',
    Phone='(415)555-1212',
    Department='Wingo',
    AccountId=acctID);
insert con;

// 添加没有联系人的客户
Account acct2 = new Account(
    Name='The SFDC Query Man',
    Phone='(310)555-1213',
    NumberOfEmployees=50,
    BillingCity='Los Angeles',
    Description='Expert in wing technologies.');
insert acct2;

使用查询编辑器

开发者控制台提供查询编辑器控制台，使您可以运行SOSL查询和查看结果。查询编辑器提供了一种快速检查数据库的方法。在将它们添加到您的Apex代码之前，测试您的SOSL查询是一个好方法。当您使用查询编辑器时，您只需提供没有围绕它的Apex代码的SOSL语句。

让我们尝试运行以下SOSL示例：

在开发者控制台中，点击 Query Editor 标签。
将以下内容复制并粘贴到查询编辑器下的第一个框中，然后单击 Execute.

FIND {Wingo} IN ALL FIELDS RETURNING Account(Name), Contact(FirstName,LastName,Department)

注意

查询编辑器和API中的搜索查询必须用大括号（{Wingo}）括起来。相反，在Apex中，搜索查询包含在单引号（’Wingo’）内。

基本的SOSL语法

SOSL允许您指定以下搜索条件：

文本表达（单个单词或短语）来搜索
要搜索的字段的范围
要检索的对象和字段的列表
在源对象中选择行的条件

这是一个基本的SOSL查询语法：

FIND 'SearchQuery' [IN SearchGroup] [RETURNING ObjectsAndFields]

ALL FIELDS
NAME FIELDS
EMAIL FIELDS
PHONE FIELDS
SIDEBAR FIELDS

ObjectsAndFields是可选的。它是在搜索结果中返回的信息 – 一个或多个sObjects的列表，并且在每个sObject中，包含一个或多个字段的列表，并带有可筛选的值。如果未指定，则搜索结果包含找到的所有对象的ID。

单词和短语

SearchQuery包含两种类型的文本：

Single Word— 单个单词，如test或hello。 SearchQuery中的单词由空格，标点符号和从字母到数字的变化（反之亦然）分隔。单词总是不区分大小写的。
Phrase— 由双引号包围的单词和空格的集合，如“约翰史密斯”。多个单词可以与逻辑和分组操作符组合在一起，形成一个更复杂的查询。

搜索示例

要了解SOSL搜索的工作原理，让我们使用不同的搜索字符串来查看输出是基于我们的样本数据。此表列出了各种示例搜索字符串和SOSL搜索结果。

在所有领域搜索：	搜索说明	匹配的记录和字段
查询	此搜索将返回其所有字段都包含文本的所有记录：The和Query。搜索字词中的单词顺序无关紧要。	客户：SFDC查询人（名称字段匹配）
Wingo OR Man	该搜索使用OR逻辑运算符。它返回包含Wingo单词的字段的记录或包含SFDC单词的字段的记录。	联系人：Carol Ruiz，部门：’Wingo’ 客户：SFDC查询人（名称字段匹配）
1212	此搜索将返回其所有字段包含1212字的记录。以-1212结尾的电话字段被匹配，因为1212被短划线分隔时被认为是单词。客户：SFDC查询人，电话：’（415）555-1212′	联系人：Carol Ruiz，电话：’（415）555-1212′
wing*	这是一个通配符搜索。此搜索将返回具有以wing开头的字段值的所有记录。	账号：SFDC查询员，描述： ‘Expert in wing technologies.’

SOSL Apex示例

此示例显示如何在Apex中运行SOSL查询。这个SOSL查询通过使用OR逻辑运算符来组合两个搜索项 – 它在任何字段中搜索Wingo或SFDC。此示例返回所有示例客户，因为它们每个都有一个包含其中一个单词的字段。 SOSL搜索结果以列表形式返回。每个列表包含返回记录的数组。在这种情况下，列表有两个元素。在索引0处，列表包含客户数组。在索引1处，列表包含联系人数组。

在开发者控制台的“执行匿名”窗口中执行此代码段。接下来，检查调试日志以验证是否返回所有记录。

List<List<sObject>> searchList = [FIND 'Wingo OR SFDC' IN ALL FIELDS 
                   RETURNING Account(Name),Contact(FirstName,LastName,Department)];
Account[] searchAccounts = (Account[])searchList[0];
Contact[] searchContacts = (Contact[])searchList[1];

System.debug('Found the following accounts.');
for (Account a : searchAccounts) {
    System.debug(a.Name);
}

System.debug('Found the following contacts.');
for (Contact c : searchContacts) {
    System.debug(c.LastName + ', ' + c.FirstName);
}

告诉我更多…

您可以筛选，重新排序和限制SOSL查询的返回结果。因为SOSL查询可以返回多个sObjects，所以这些过滤器应用在RETURNING子句中的每个sObject中。

您可以通过在对象的WHERE子句中添加条件来过滤SOSL结果。例如，这只会导致其行业服装被退回的客户：退货客户（名称，行业）行业=’服装’）

同样，通过为一个对象添加ORDER BY来支持一个sObject的排序结果。例如，这会导致返回的客户按名称字段排序：RETURNING客户（名称，行业ORDER BY名称）。

返回记录的数量可以限制为记录的一个子集。此示例将返回的客户限制为10个：RETURNING Account（Name，Industry LIMIT 10）