LINQ to SharePoint是2010版的SharePoint的一个很好的新特性,用于对SharePoint服务器发起查询。不同于经典CAML的查询,它是通过一个强类型的实体模型和LINQ查询语法来查询列表数据。
正如上一篇文章中提到的那样,使用LINQ to SharePoint的第一步就是运行SPMetal工具来为已有的SharePoint站点创建实体模型。此工具位于14\ BIN。这里有一个如何使用它的示例:
SPMetal /web:http://我们的SharePoint站点:端口 /code:SiteEntities.cs
这个命令将在在14\ BIN下创建一个名为 Model.cs 的C#代码文件,其中包含了实体模型。将这个文件添加到我们的项目后,我们就可以使用LINQ to SharePoint来执行查询了。例如,可以使用如下的服务器端代码,输出“Manager”列表中标题长度至少为3个字符长所有列表项:
using (SiteEntitiesDataContext ctx = new SiteEntitiesDataContext("http://moss.contoso.com/sites/Lab01")) { StringBuilder output = new StringBuilder(); foreach (Manager项目 manager in ctx.Manager.Where(x => x.标题.Length >= 3)) { output.AppendLine(manager.名称); } Console.WriteLine(output.ToString()); }
默认情况下,创建者,创建时间,修改者,修改时间这些栏不会被SPMetal自动创建。然而,该框架提供了对LINQ to SharePoint提供程序的扩展能力,可以扩展其中的对象——关系映射系统。换句话说,一旦我们告诉了LINQ to SharePoint如何从内容数据库中检索和更新这些栏,那么以后就可以很容易地使用这些栏了。
下面我们就动手扩展模型的基础实体类(“项目”类),新建一个C#代码文件(这里命名为“ModelExtensions.cs”):
using System; using System.Collections.Generic; using System.Linq; using System.Text; using Microsoft.SharePoint.Linq; using Microsoft.SharePoint; public partial class 项目 : ICustomMapping { [CustomMapping(Columns = new String[] { "Modified", "Created", "Editor", "Author" })] public void MapFrom(object listItem) { SPListItem item = (SPListItem)listItem; this.Modified = (DateTime)item["Modified"]; this.Created = (DateTime)item["Created"]; this.CreatedBy = (string)item["Author"]; this.ModifiedBy = (string)item["Editor"]; } public void MapTo(object listItem) { SPListItem item = (SPListItem)listItem; item["Modified"] = this.Modified; item["Created"] = this.Created; item["Author"] = this.CreatedBy; item["Editor"] = this.ModifiedBy; } public void Resolve(RefreshMode mode, object originalListItem, object databaseObject) { SPListItem originalItem = (SPListItem)originalListItem; SPListItem databaseItem = (SPListItem)databaseObject; DateTime originalModifiedValue = (DateTime)originalItem["Modified"]; DateTime dbModifiedValue = (DateTime)databaseItem["Modified"]; DateTime originalCreatedValue = (DateTime)originalItem["Created"]; DateTime dbCreatedValue = (DateTime)databaseItem["Created"]; string originalCreatedByValue = (string)originalItem["Author"]; string dbCreatedByValue = (string)databaseItem["Author"]; string originalModifiedByValue = (string)originalItem["Editor"]; string dbModifiedByValue = (string)databaseItem["Editor"]; if (mode == RefreshMode.OverwriteCurrentValues) { this.Modified = dbModifiedValue; this.Created = dbCreatedValue; this.CreatedBy = dbCreatedByValue; this.ModifiedBy = dbModifiedByValue; } else if (mode == RefreshMode.KeepCurrentValues) { databaseItem["Modified"] = this.Modified; databaseItem["Created"] = this.Created; databaseItem["Author"] = this.CreatedBy; databaseItem["Editor"] = this.ModifiedBy; } else if (mode == RefreshMode.KeepChanges) { if (this.Modified != originalModifiedValue) { databaseItem["Modified"] = this.Modified; } else if (this.Modified == originalModifiedValue && this.Modified != dbModifiedValue) { this.Modified = dbModifiedValue; } if (this.Created != originalCreatedValue) { databaseItem["Created"] = this.Created; } else if (this.Created == originalCreatedValue && this.Created != dbCreatedValue) { this.Created = dbCreatedValue; } if (this.CreatedBy != originalCreatedByValue) { databaseItem["Author"] = this.CreatedBy; } else if (this.CreatedBy == originalCreatedByValue && this.CreatedBy != dbCreatedByValue) { this.CreatedBy = dbCreatedByValue; } if (this.ModifiedBy != originalModifiedByValue) { databaseItem["Editor"] = this.ModifiedBy; } else if (this.ModifiedBy == originalModifiedByValue && this.ModifiedBy != dbModifiedByValue) { this.ModifiedBy = dbModifiedByValue; } } } public DateTime Modified { get; set; } public DateTime Created { get; set; } public string CreatedBy { get; set; } public string ModifiedBy { get; set; } }
更多关于ICustomMapping接口的介绍,可以查看这些MSDN文章:ICustomMapping成员和RefreshMode枚举。
将这个文件添加到我们的项目后,在我们进行查询时可以使用创建者,创建时间,修改者,修改时间了:
StringBuilder output = new StringBuilder(); using (SiteEntitiesDataContext model = new SiteEntitiesDataContext("http://moss.contoso.com/sites/Lab01")) { string dateStr = ("2012/8/6 16:22").ToString(CultureInfo.InvariantCulture); DateTime convertedDate = DateTime.SpecifyKind(DateTime.Parse(dateStr), DateTimeKind.Utc); foreach (Manager项目 manager in model.Manager.Where(x => x.Created > convertedDate)) { output.AppendLine(manager.标题 + " " + manager.名称); } } Console.WriteLine(output.ToString());
还是用原来的Manager列表,在当前视图中增加显示“创建时间”一栏:
以上的代码查询所有创建时间晚于16:22的列表项。结果如下:
需要注意的是,作者和修改者这两个栏是User类型的。直接输出这些字符串的话可能会含有很多你不需要的信息。解析这钟字符串的一个简单方法是创建一个SPFieldUserValue,用当前的SPWeb和这个字符串作为参数。然后,我们可以从SPFieldUserValue.User中提取出实际需要的SPUser信息。
比如:
using(SPSite site=new SPSite("http://moss.contoso.com/sites/Lab01")) { using (SPWeb web = site.OpenWeb()) { using (SiteEntitiesDataContext ctx = new SiteEntitiesDataContext("http://moss.contoso.com/sites/Lab01")) { var result = ctx.Manager.Where(m => m.国家 == 国家.USA); foreach (Manager项目 manager in result) { SPFieldUserValue t = new SPFieldUserValue(web, manager.CreatedBy); Console.WriteLine(manager.标题 + " " + manager.名称 + " - " + t.User.Name + " - " + manager.Modified.ToShortDateString()); } } } }
输出结果为:
希望此代码对你有帮助,Enjoy SharePoint!
参考资料
LINQ To SharePoint: Working with Created, CreatedBy, Modified and ModifiedBy