salesforce零基础学习(七十五)浅谈SOSL(Salesforce Object Search Language)
在工作中,我们更多操作的是一个表的对象,所以我们对SOQL的使用很多。但是有时候,我们需要对几个表进行查询操作,类似salesforce的全局搜索功能,这时,使用SOQL没法满足功能了,我们就需要使用SOSL.其实不只是多个表检索可以使用SOSL,如果针对某个字段进行高级的检索也可以使用SOSL。
背景:Account表中的Name字段,存储了以下的数据
1.上海电信
2.上海-电信
3.上海(电信)
4.电信-上海
5.电信上海
6.电信(上海)
7.上海xx电信
8.海上信电
9.海信电上。
当用户搜索上海电信时,需要将1,2,3,4,5,6,7检索出来,8,9排除。使用正常的SOQL语句实现起来难度较大,这种情况可以考虑使用SOSL,尽管SOSL不一定将所有的结果返回,但是可以返回大部分情况。
一.SOSL简单介绍
SOSL全称为Salesforce Object Search Language。SOSL查询可以在以下环境使用:
Search()的调用/apex语句/Visualforce的Controller和getter方法里面/Eclipse的Schema Explorer(没有测试成功)
SOSL支持对多个objects同时查询text/email/phone类型字段的数据,SOSL可以查询标准的对象以及自定义的对象。当然SOSL不是所有的对象或者字段都支持搜索,以下情况下是不允许搜索的:
1.sObject不允许搜索:创建sObject或者自带标准sObject,只有允许搜索的sObject才可以使用SOSL,判断一个sObject是否可以搜索,可以使用Schema的DescribeSObjectResult类来判断,如果希望一个自定义对象允许搜索,只需要把allow search勾选即可。
2.Number, date, or checkbox 这几种类型是不支持使用SOSL的,如果需要搜索这几种,需要使用SOQL。
3.Textarea 类型,除非SearchGroup选择的是ALL FIELDS,否则不支持搜索。
4.关联到对象上的Attachment数据不允许搜索。
除了上述的使用限制以外,其实SOSL还有一些其他的限制,比如SOSL语句长度不能超过20000个字符,超过的话会报error。其他的限制详看开发文档。
SOSL在apex中调用时,search query使用的是单引号'',在search调用中使用的是{},下面的demo以及代码均以apex写法为主。
二.SOSL的语法
SOSL的语法如下:
1.FIND:搜索指定的文本,如果searchQuery超过10000,则无结果返回,如果超过4000,所有的逻辑都将移除。SearchQuery除了纯文本以外,还可以使用*或者?的通配符进行匹配,*代表后面的所有位为任意内容,?代表后面的一位为任意内容。
比如FIND 'z*o'会将所有zero,zoo数据查询出来,但是'z?o'会过滤掉zero对应的数据,只会查出zoo对应的数据。
searchQuery也可以使用与或等操作,详情查看SOQL与SOSL开发文档。
2.IN:设置查询组--即查询的类型,SearchGroup包含四种固定的类型:ALL FIELDS/EMAIL FIELDS/NAME FIELDS/PHONE FIELDS。如果想要在Name或者Email/Phone类型中进行搜索,则可以设置指定的类型,否则设置ALL FIELDS,默认查询组为ALL FIELDS。
3.RETURNING:此部分作为搜索返回结果的处理部分,显得尤为重要,RETURNING可以返回一个对象,也可以返回多个对象,多个对象通过逗号分隔;对象中可以返回多个字段,也可以在返回的结果中添加自定义的逻辑。比如我们希望搜索Opportunity和Account的Name中包含zero中的数据,其中,要求Opportunity中的数据按照创建日期正序排列,只查询十条,并且只搜索Name和StageName字段,Account要求Name除了含有zero以外还需要包含zhang,并且最多只查询1条,这种情况下RETURNING就可以发挥神奇的作用了。
eg:FIND 'zero' IN ALL FIELDS RETURNING account(where Name like '%zhang%' limit 1),Opportunity(Name,StageName order by createddate asc limit 10)
备注(如果使用order by,object的field不能为空,如果上述内容修改成以下写法便是错误的)
FIND 'zero' IN ALL FIELDS RETURNING account(where Name like '%zhang%' limit 1),Opportunity(order by createddate asc limit 10)
其他部分自行查看开发文档。
三.SOSL应用
封装了一个SOSL工具类,用户可以根据需要查询的关键字,设置返回的结果的格式来返回需要的数据,如果不设置returning的field的内容,则默认返回所有可以访问的字段,否则返回指定字段:
public with sharing class SOSLController { public class RetrieveWrapper {
//keyword:used to retrieve this
public String retrieveKeyword{get;set;}
//search group: values :(ALL FIELDS/EMAIL FIELDS/NAME FIELDS/PHONE FIELDS/SIDEBAR FIELDS)
public String searchGroup{get;set;}
//obj api name -> field eg: account->[Name,Site]
public Map<String,List<String>> objName2FieldsMap{get;set;}
//obj api name -> condition eg : account -> where name like 'test%' order by name asc limit 10 offset 1
public Map<String,String> objName2QueryConditionMap{get;set;}
} public class SearchResultWrapper {
//sobject api name eg:Account
public String objName{get;set;}
//sObject Field Name => Value
public Map<String,Object> objFieldName2Value{get;set;}
} public static List<SearchResultWrapper> search(RetrieveWrapper wrapper) {
String retrieveSQL = buildRetrieveSQL(wrapper);
List<SearchResultWrapper> searchResultWrappers = new List<SearchResultWrapper>();
if(retrieveSQL == null || (!retrieveSQL.contains('FIND'))) {
return null;
}
System.debug(LoggingLevel.INFO, '*** retrieveSQL: ' + retrieveSQL);
List<List<sObject>> searchResults = search.query(retrieveSQL);
if(searchResults.size() > 0) {
for(List<sObject> objs : searchResults) {
String objName;
if(objs.size() > 0) {
String objId = objs.get(0).Id;
objName = getAPINameByObjId(objId);
}
List<String> retrieveFields;
if(objName != null) { if(wrapper.objName2FieldsMap != null && wrapper.objName2FieldsMap.get(objName) != null) {
retrieveFields = wrapper.objName2FieldsMap.get(objName);
} else {
retrieveFields = getAvailableFields(objName);
}
} for(sObject obj : objs) {
SearchResultWrapper resultWrapper = new SearchResultWrapper();
resultWrapper.objName = objName;
Map<String,Object> fieldValueMap = new Map<String,Object>();
for(String field : retrieveFields){
if(obj.get(field) != null) {
fieldValueMap.put(field, obj.get(field));
}
}
resultWrapper.objFieldName2Value = fieldValueMap;
searchResultWrappers.add(resultWrapper);
}
}
}
return searchResultWrappers;
} private static String buildRetrieveSQL(RetrieveWrapper wrapper) {
String fetchSQL;
if(wrapper.retrieveKeyword != null && wrapper.retrieveKeyword.trim() != '') {
String keyword = '\'' + wrapper.retrieveKeyword + '\'';
fetchSQL = 'FIND ' + keyword; if(wrapper.searchGroup != null) {
fetchSQL += ' IN ' + wrapper.searchGroup;
} else {
fetchSQL += ' IN ALL FIELDS';
} if(wrapper.objName2FieldsMap != null) {
List<String> objToFieldsList = new List<String>();
for(String key : wrapper.objName2FieldsMap.keySet()) {
String objName = key;
String fieldStr;
if(wrapper.objName2FieldsMap != null && wrapper.objName2FieldsMap.get(objName) != null) {
fieldStr = String.join(wrapper.objName2FieldsMap.get(objName),',');
} else {
fieldStr = String.join(getAvailableFields(objName), ',');
}
String filterStr;
if(wrapper.objName2QueryConditionMap != null) {
filterStr = wrapper.objName2QueryConditionMap.get(objName);
} if(String.isNotEmpty(filterStr)){
fieldStr = '(' + fieldStr + ' WHERE ' + filterStr +')';
}
else{
if(fieldStr != null) {
fieldStr = '(' + fieldStr +')';
}
}
if(fieldStr != null) {
objName = key + fieldStr;
} else {
objName = key;
} objToFieldsList.add(objName);
} if(objToFieldsList.size() > 0) {
fetchSQL += ' RETURNING ' + String.join(objToFieldsList, ',');
}
}
}
return fetchSQL;
} private static String getAPINameByObjId(String objId) {
String objPrefix = objId.left(3);
return objId2APIName.get(objPrefix);
} private static Map<String,String> objId2APIName {
get {
if(objId2APIName == null) {
objId2APIName = new Map<String,String>();
Map<String, Schema.SObjectType> gd = Schema.getGlobalDescribe();
for(String objectName : gd.keySet()) {
Schema.SObjectType objectType = gd.get(objectName);
String prefix = objectType.getDescribe().getKeyPrefix();
if(prefix != null) {
objId2APIName.put(prefix, objectName);
}
}
}
return objId2APIName;
}
set;
} private static List<String> getAvailableFields(String objName) {
List<String> availableFields = new List<String>();
List<Schema.DescribeSObjectResult> objDescribes = Schema.describeSObjects(new List<String>{objName});
Schema.DescribeSObjectResult objDescribe;
if(objDescribes != null && objDescribes.size() > 0) {
objDescribe = objDescribes.get(0);
} else {
return null;
}
Map<String,SObjectField> sObjectFieldMaps = objDescribe.fields.getMap();
for(String objField : sObjectFieldMaps.keySet()) {
SObjectField field = sObjectFieldMaps.get(objField);
DescribeFieldResult fieldResult = field.getDescribe();
if(fieldResult.isAccessible()) {
availableFields.add(fieldResult.getName());
}
}
return availableFields;
}
}
调用代码如下:
SOSLController.RetrieveWrapper wrapper = new SOSLController.RetrieveWrapper();
wrapper.retrieveKeyword = '上海电信';
wrapper.objName2FieldsMap = new Map<String,List<String>>();
List<String> userFieldsList = new List<String>();
userFieldsList.add('Name');
wrapper.objName2FieldsMap.put('account',userFieldsList);
//wrapper.objName2FieldsMap.put('account',null);
List<SOSLController.SearchResultWrapper> searchResults = SOSLController.search(wrapper);
System.debug(LoggingLevel.INFO, '*** searchResults: \n' + JSON.serializePretty(searchResults));
结果:
总结:本篇只是描述一下SOSL的基本使用,还有很多细节使用以及限制没有涉及。本篇只起到抛砖引玉效果,如果项目中需要使用SOSL或者想要研究的,最好先自行查看文档。
salesforce零基础学习(七十五)浅谈SOSL(Salesforce Object Search Language)的更多相关文章
- salesforce 零基础学习(十九)Permission sets 讲解及设置
Permission sets以及Profile是常见的设置访问权限的方式. Profile规则为'who see what'.通过Profile可以将一类的用户设置相同的访问权限.对于有着相同Pro ...
- salesforce 零基础学习(十八)WorkFlow介绍及用法
说起workflow大家肯定都不陌生,这里简单介绍一下salesforce中什么情况下使用workflow. 当你分配许多任务,定期发送电子邮件,记录修改时,可以通过自动配置workflow来完成以上 ...
- salesforce 零基础学习(十六)Validation Rules & Date/time
上一篇介绍的内容为Formula,其中的Date/time部分未指出,此篇主要介绍Date/time部分以及Validation rules. 本篇参考PDF: Date/time:https://r ...
- salesforce lightning零基础学习(八) Aura Js 浅谈一: Component篇
我们在开发lightning的时候,常常会在controller.js中写 component.get('v.label'), component.set('v.label','xxValue'); ...
- salesforce零基础学习(九十五)lightning out
随着salesforce对lightning的推进,越来越多的项目基于lightning开发,导致很多小伙伴可能都并不了解classic或者认为不需要用到classic直接就开始了lightning的 ...
- salesforce lightning零基础学习(九) Aura Js 浅谈二: Event篇
上一篇介绍了Aura Framework中 Component类的部分方法,本篇将要介绍Event常用的方法. 1. setParam (String key , Object value):设置事件 ...
- salesforce零基础学习(九十九)Git 在salesforce项目中的应用(vs code篇)
本篇参考: https://code.visualstudio.com/docs/editor/versioncontrol https://git-scm.com/doc https://git-s ...
- salesforce零基础学习(一百一十)list button实现的一些有趣事情
本篇参考: salesforce零基础学习(九十五)lightning out https://developer.salesforce.com/docs/component-library/docu ...
- salesforce 零基础学习(五十二)Trigger使用篇(二)
第十七篇的Trigger用法为通过Handler方式实现Trigger的封装,此种好处是一个Handler对应一个sObject,使本该在Trigger中写的代码分到Handler中,代码更加清晰. ...
- salesforce零基础学习(八十)使用autoComplete 输入内容自动联想结果以及去重实现
项目中,我们有时候会需要实现自动联想功能,比如我们想输入用户或者联系人名称,去联想出系统中有的相关的用户和联系人,当点击以后获取相关的邮箱或者其他信息等等.这种情况下可以使用jquery ui中的au ...
随机推荐
- cpp(第十三章)
1.动态(晚期)联编需要显示定义复制构造函数,赋值运算符,虚构函数. 2.纯虚类不能声明对象. 3.赋值运算符的特征标随类而异. 4.返回类型协变,重新定义继承的方法,应确保与原来的原型完全相同,但如 ...
- 在Visual Studio for Mac中使用fastlane管理iOS的provision
Xamarin开发中,最烦的就是provision的管理了. 全手工的话,要先创建一个key,上传后生成cert文件,再创建provision.如果在手机上调试,还要把手机加到provision中去. ...
- Java 9 揭秘(4. 模块依赖)
文 by / 林本托 Tips 做一个终身学习的人. 在此章节中,主要学习以下内容: 如何声明模块依赖 模块的隐式可读性意味着什么以及如何声明它 限定导出(exports)与非限定导出之间的差异 声明 ...
- ActiveMQ 学习第二弹
经历了昨天的初识 ActiveMQ,正好今天下班有点事耽搁了还没法回家,那就再学习会 ActiveMQ 吧!现在官网的文档没啥好看的了,毕竟是入门学习,太深奥的东西也理解不了.然后看官网上有推荐书籍& ...
- 关于Eclipse+SVN 开发配置
入职快一个月,学的比较慢,但学的东西很多,受益匪浅.有时候真正意义上,感受到:代码使我快乐,我爱编程. 好久没有开笔,不知道说些什么,也不知道应该说什么. 但总觉得有些东西,很想说出来,不用理会他人的 ...
- 使用DBeaver连接hive
介绍 在hive命令行beeline中写一些很长的查询语句不是很方便,查询结果也不是很友好,于是找了一个hive的客户端界面工具DBeaver,它也支持很多符合JDBC连接的数据库,例如MySQL.O ...
- TypeScript技巧集锦(陆续更新)
在C++项目中编译TypeScript(以下简称ts) 编辑ts文件的属性,项类型选择"自定义生产工具". 命令行输入tsc所在位置与编译参数,我的是"C:\Progra ...
- Docker Hub工作流程-Docker for Web Developers(6)
在Github上创建项目仓库 和创建其他Github项目一样,在Github创建一个仓库,然后在仓库里面增加一个dockerfile,然后提交并推送到Github上. 我已经创建的仓库地址:https ...
- Navicat连接报错:cannot load OCI DLL,126
32位系统下报错:cannot load OCI DLL,126 解决方法:navicat 菜单中 -工具->选项->OCI 选择oracle安装目录下bin里面的oci.dll 在win ...
- Myeclipse中隐藏jar包
在package explorer的右上角有一个向下的小三角 点击选择Filter 在打开的对话框中 第一个选框中打上对勾 文字框中填上 *.jar 然后点击OK就行了 多个隐藏内容之间用逗号隔开 如 ...