Linq To Salesforce

September 23rd, 2012

锤子与钉子

手中有锤子，眼前的一切就都变成钉子了…

手上有 LINQ，就想把一切都转换成 LINQ。Salesforce API 也不例外。

Salesforce 的 API 调用方法还算简单，可以自动生成实体，但是有如下缺点：

查询语句还是原始的 SOQL ，类似于 SQL
每次查询最多 200 个对象，如果超过了，还需要用 QueryMore 方法继续查询

总之，我想把 Salesforce API 查询语句转换为 LINQ 的查询形式，是否可行？

调研

如果网上有好的框架可以用，那何必自己写呢？

但是可能使用 Salesforce 的很少，利用 .net 调用 Salesforce 的就更少了。

但是还是找到了几个框架：

http://salesforce-entity-framework.smartcode.com/

http://www.devart.com/dotconnect/salesforce/

http://www.rssbus.com/ado/salesforce/features.aspx

其中，devart.com 的那个我试用了一下，非常庞大！还会出现各种错误，因为它不仅仅是 Linq To Salesforce，它其实是 Linq To Entity Framework，所以还包括了实体设计等功能，而 Linq To Salesforce 仅仅是把 Linq 查询转换成 SOQL 罢了。

所以还是放弃了。

而且这些框架都是收费的，都太重量级了，所以还是自己写一个吧。

自己实现 Linq To Salesforce

自己实现 Linq To Salesforce 最关键的就是把表达式树转换成SOQL：

var result = Query<Contract>()
                .Where(c => c.CreatedDate > DateTime.Now.AddMonths(-1))
                .ToList();
// SELECT Id FROM Contract WHERE CreatedDate > 20120801T00:00:00.000Z

所以，关键点就是解析表达式树了，你可以自己用自己的逻辑实现解析表达式树，但是更推荐用微软的 IQueryable、IQueryProvider 和 ExpressionVisitor 来实现标准的表达式树解析。

http://msdn.microsoft.com/zh-cn/library/bb546158.aspx

还有第一篇文章中的一个示例项目：

http://iqtoolkit.codeplex.com/

我的 Linq To Salesforce

我的项目已经发布到了 Github 上了：https://github.com/dozer47528/LinqToSalesforce

框架内容简介：

SalesforceQuery：职责是保存 IQueryProvider 和 Expression 的引用，并调用 IQueryProvider 得到最终结果；

SalesforceProviderBase： IQueryProvider 的具体实现，抽象类，需要自己继承后实现关键算法，职责是调用 ExpressionVisitor 把表达式树解析成 SOQL 语句；

SalesforceVisitor：ExpressionVisitor 的具体实现，职责就是把表达式树解析成 SOQL 语句。

备注：SalesforceProviderBase 为什么是抽象类，还需要手动实现关键算法？因为 Salesforce 的 API 是利用强类型 WSDL 生成的，它们也不是统一的，每个组织都有自己的 WSDL 文件，所以如果没有统一的查询方法和对象，我无法在框架中实现它。但是，我的 Test 项目中给出了一个实现示例，非常简单的示例。

使用步骤1：

继承 SalesforceProviderBase<T> ，实现自己的 SalesforceProvider<T> ，这里需要重写 2 个方法：

protected abstract int GetCount(string cmd);
protected abstract IEnumerable<T> GetEnumerable(string cmd);

传入的参数都是已经解析好的 SOQL 语句，第一个方法是用来返回总数的，第二个方法是用来返回 IEnumerable 的。

项目中的 LinqToSalesforce.Test/SalesforceQuery/SalesforceProviderSample.cs 是一段实例代码。

使用步骤2：

创建 IQueryable 对象：

protected SalesforceQuery<T> Query<T>(SelectTypeEnum selectType = SelectTypeEnum.SelectIdAndUseAttachModel) where T : sObject
{
      return new SalesforceQuery<T>(new SalesforceProviderSample<T> { SelectType = selectType });
}

接下来直接对这个对象调用 LINQ 方法即可：

var result = Query<Contract>()
    .Where(c => c.CreatedDate > DateTime.Now.AddMonths(-1))
    .ToList();

注意事项：

实现 SalesforceProviderBase<T> 中的 GetEnumerable 方法的时候请注意利用迭代器模式取回所有数据，因为 Salesforce 默认只会返回 200 条数据。
SOQL 没有 join 查询，如果要查询关联对象的话，SOQL 是这样实现的：[SELECT Accoint.Name From Contract]，而在 Linq To Salesforce 中，这种查询可能会有点麻烦，具体的可以参考测试项目中的 SelectRelatedTest 测试。
创建查询对象的时候，SelectTypeEnum 是什么？因为 Salesforce 的特殊性（没有Select *，没有 join），我默认提供了四种查询查询模式：默认查询Id字段后面再调用 Select 方法的时候使用 Select 中的类容；默认查询Id字段后面再调用 Select 方法的时候附加上 Select 中的类容（默认）；默认查询所有字段后面再调用 Select 方法的时候使用 Select 中的类容；默认查询所有字段后面再调用 Select 方法的时候附加上 Select 中的类容。
别用 DateTime 类型和 Salesforce 中的日期类型做比较，因为在 .net 中没有日期类型，所以它们都被转换成了 DateTime。但在 SOQL 中，他们的格式是不一样的。所以如果要用日期类型作为筛选条件，那么请使用 SalesforceDate 这个对象。

功能列表：

支持 Select 关联对象
支持 First, FirstOrDefault, Single, SingleOrDefault 方法
支持 Count 方法

最后，如果有任何问题，大家可以在我的博客留言，也可以在 Github 上和我交流。

本作品由 Dozer 创作，采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可。

编程技术 (86)