Salesforce 的数据模型是基于 sObject 的。在 Apex 中,所有的标准对象、自定义对象都是继承自 sObject 的。
关于在 Apex 中得到 sObject 的信息,我们要基于两点来使用:
- 系统类 Schema 中定义了 DescribeSObjectResult 类来保存一个 sObject 的信息,也提供了若干方法来得到 sObject 的信息
- 每个 sObject 对象都是一个类,其中有固定的静态变量和方法来得到 sObject 自身的信息
详细的方法可以查阅官方文档。
基本用例
下面用一些基本的例子来说明在 Apex 中得到 sObject 信息的方法和语法。
得到当前 sObject 的类型
使用 getSObjectType() 方法可以得到当前 sObject 变量的类型。与此类似,使用 “XXX.sObjectType” 的语法可以得到名为 “XXX” 的 sObject 的类型。
// 定义一个 sObject 变量,在此以 Account 为例
sObject obj = new Account();
// 得到当前的 sObject 的类型
Schema.sObjectType objType = obj.getSObjectType();
// 确认其类型是否是 Account
System.assertEquals(objType, Account.sObjectType);
同样的语法可以用在 sObject 列表变量中。
// 定义一个 sObject 列表变量,在此以 Account 为例
List<sObject> objList = new List<Account>();
// 得到当前的 sObject 列表的类型
Schema.sObjectType objListType = objList.getSObjectType();
// 确认其类型是否是 Account
System.assertEquals(objListType, Account.sObjectType);
使用 describeSObjects() 函数可以得到多个 sObject 类型的信息。
// 定义字符串列表,其中包含若干 sObject 的 API 名称
List<String> objTypeList = new List<String>{'Account', 'ExampleCustomObj__c'};
// 得到 Account 和 ExampleCustomObj__c 的信息
Schema.DescribeSobjectResult[] results = Schema.describeSObjects(objTypeList);
得到当前 sObject 类型的描述
使用 getDescribe() 方法可以得到当前 sObject 的类型详细信息。与此类似,使用 “Schema.sObjectType.XXX” 可以得到名为 “XXX” 的 sObject 的类型详细信息。
// 得到 Account 类型的描述信息
Schema.DescribeSObjectResult dsr = Account.sObjectType.getDescribe();
// 确认其信息是 Account 类型的信息
System.assertEquals(dsr, Schema.sObjectType.Account);
得到字段的信息
Schema 类中定义了 Schema.DescribeFieldResult 类,可以用来存储字段的信息。得到字段信息的方法与上述示例类似。
// 得到 Account 类型的 Name 字段的信息
Schema.DescribeFieldResult dfr = Schema.sObjectType.Account.fields.Name;
// 得到字段的信息
Schema.SObjectField fieldInfo = dfr.getSObjectField();
// 确认字段的类型
System.assertEquals(fieldInfo, Account.Name);
// 得到字段的描述信息
dfr = dfr.getSObjectField().getDescribe();
// 得到关于 Account 类型所有字段的信息,保存到一个 Map 变量中
Map<String, Schema.SObjectField> fieldMap = Schema.SObjectType.Account.fields.getMap();
关于权限
由于用户不一定对 sObject 对象或字段有权限,所以上述代码在不同环境下执行会有不同的结果。
在普通的 Apex 类中执行的时候,用户的权限没有影响。
在匿名代码段中执行的时候,用户的权限会影响到返回的结果。只有用户有权限的类型或字段信息才会返回。