• 下载 TK.SPTools.CAMLBuilder.Expressions.zip - 5.08 KB

• 下载 TK.SPTools.CAMLBuilder.Expressions_-_Source.zip - 11 KB

使用 CAMLBuilder.Expressions 构建 CAML 查询

本文介绍了一种解决方案，可用于以非常简单的方式以编程方式构造复杂的 Sharepoint CAML 查询。

解决方案的类图

背景

如果您曾经处理过 Sharepoint 并不得不使用 CAML 查询，您可能会发现有时组合查询是多么痛苦，尤其是在代码中。

参数化固定查询

如果您不想最后连接多个字符串片段，您可以使用流行的工具U2U Caml Query Builder（http://www.u2u.net）首先设计您的查询，然后对其进行参数化，这样您就可以轻松地将其与任何参数集一起使用。

任意查询

然而，前面的方法不幸地仅适用于固定查询。
如果查询是动态构建的，这意味着构建查询所需的条件集只能在运行时确定，您就无法拥有固定的参数化查询，因为在这种情况下查询本身会发生变化。您仍然可以根据任何条件在运行时连接查询片段（条件），但这正是我们想要避免的。

此外，CAML 语言本身使得构建查询更加困难，因为例如，一个运算符只能有两个操作数，因此您需要根据您拥有的条件数量以不同的方式构建查询。

想象一个场景，您想显示一个已过滤的 Sharepoint 列表，其中过滤条件由用户定义。有时您可能只需要一个过滤器，有时需要多个，或者根本不需要过滤器。
- 如果您有一个过滤器，您不需要 <And> 运算符，只需在查询中有一个条件即可。
- 如果您有两个过滤器，您需要 <And> 运算符并在其下放置两个条件。
- 如果您有多个过滤器，您需要 <And> 运算符并在其下放置条件，但由于运算符只能接受两个操作数，您不能只将所有必需的条件放在 <And> 下，而是需要添加一个内部 <And>，这会引导您构建一个递归。

请参阅以下示例。

介绍 CAMLBuilder 表达式

CAML Builder Expressions 为上述问题提供了一个简单的解决方案。您可以使用 Expressions API 构建任意表达式树，然后简单地获取生成的 CAML 查询结果。

有两种表达式：（请参阅：类图）

- 条件
- 运算符

标准
Criteria 定义了字段上的简单条件。它可以是 Simple Criteria 或 Condition Criteria。
Simple 只获取 FieldName，而 Condition 获取 FieldName、FieldType 和 Value 以将字段值与进行比较。

支持的条件类型

简单

• IsNull
• IsNotNull

条件

• Eq (等于)
• Neq (不等于)
• Gt (大于)
• Geq (大于等于)
• Lt (小于)
• Leq (小于等于)
• BeginsWith
• Contains
• DateRangesOverlap

运算符
Operator 定义了一个由多个 Criterias 或 Operators 组成的复杂表达式。由于 Operator 也可以包含多个 Criteria 和 Operator，因此可以通过这种方式构建复杂的表达式树。

有两种运算符

• 并且
• 或者

构建表达式示例

  构建条件

  1. 简单条件

Criteria exp1 = Criteria.IsNull("Status"); 
Criteria exp2 = Criteria.IsNotNull("Status");

  注意：唯一 SimpleCriteria 是 IsNull 和 IsNotNull。其余都是 ConditionCriteria。

  2. 条件

Criteria exp1 = Criteria.Eq("Status", "Choice", "Completed"); 
Criteria exp2 = Criteria.Neq("Status", "Choice", "Completed");
Criteria exp3 = Criteria.Geq("Price", "Number", "3");

exp1 将生成：        

<Eq>          
    <FieldRef Name='Status' />          
    <Value Type='Choice'>Completed</Value>        
</Eq>

exp2 将生成：       

  <Neq>          
    <FieldRef Name='Status' />          
    <Value Type='Choice'>Completed</Value>        
</Neq>

而 exp3 将生成： 
       
 <Geq>          
     <FieldRef Name='Price' />          
     <Value Type='Number'>3</Value>        
 </Geq>

构建复杂表达式示例

1. 在运算符下添加条件。

Operator exp = Operator.And(
                    Criteria.Eq("Status", "Choice", "Completed"),
                    Criteria.Eq("Priority", "Choice", "High"),
                    Criteria.Neq("ContactName", "Text", "John")
                 );

这将构建一个表达式，用于检索所有 Status 是 Completed 且 Priority 是 High，但 ContactName 不是 John 的行。

如您所见，您可以在一个运算符下传递两个以上的条件。Expression 引擎将负责生成正确的 CAML（嵌套运算符）。

注意：运算符必须至少有两个操作数；否则，在生成过程中会抛出异常。

2. 嵌套运算符

 您还可以将运算符添加到运算符下以构建复杂的表达式树。

 	Operator exp =  Operator.And(
                          Criteria.Eq("Status", "Choice", "Completed"),
                          Operator.Or(
                            Criteria.Eq("Priority", "Choice", "High"),
                            Criteria.Neq("ContactName", "Text", "John")
                          )
                        );

3. 一次添加子表达式

您也可以使用如下构造：

	
 Expression exp = ..
 IEnumerable expressions = ...

 And and = new And();
 and.Add(exp);       //add one expression
 and.AddRange(expressions);  //add multiple expressions at a time

Criteria exp1 = Criteria.Eq("Status", "Choice", "Completed");
Criteria exp2 = Criteria.Eq("Priority", "Choice", "High");
Criteria exp3 = Criteria.Neq("ContactName", "Text", "John");


Expression exp =  Operator.And(
                     exp1,
                     Operator.Or(
                          exp2,
                          exp3
                     )
                 );


//can be rewritten as:
Expression exp = exp1 * (exp2 + exp3);


//or using negate on Eq
Criteria exp4 = Criteria.Eq("ContactName", "Text", "John");
   
Expression exp = exp1 * (exp2 + !exp4);

• ‘*’ 代表 AND
• ‘+’ 代表 OR
• ‘!’ 代表 Negate

exp1 = Criteria.Eq("Status", "Number", "2").AddFieldRefAttribute("Explicit", "True");

exp2 = Criteria.Eq("Contact", "Lookup", "2").AddFieldRefAttribute("LookupId", "True");

exp3 = Criteria.Eq("Date", "DateTime", "zz").AddValueAttribute("IncludeTimeValue", "False");

Expression exp = .... //exp can either be Criteria or Operator 

exp.OrderBy("Status", true);

exp = exp.OrderBy("Status", true).OrderBy("Title", false);

Expression exp = .... //exp can either be Criteria or Operator

exp.GroupBy("Status");

exp = exp.GroupBy("Status", true).GroupBy("Title", false);

            
            Expression exp = ....

            exp.GetCAML();
            exp.GetCAMLQuery();

//generates compile time error
Criteria c = new ConditionCriteria("Status", "Choice", "Completed", CriteriaType.Eq); 

//correct
Criteria c = Criteria.Eq("Status", "Chocie", "Completed");