在 SharePoint 中使用具有外部数据的客户端对象模型入门

了解如何使用 SharePoint 客户端对象模型来处理 SharePoint 中的 Business Connectivity Services (BCS)。

什么是 SharePoint 客户端对象模型？

SharePoint 客户端对象模型是表示服务器对象模型的一套基于客户端的库。 它们打包在三个不同的 DLL 中，可以适应不同的开发类型。 客户端对象模型包括服务器 API 的大部分主要函数。 这允许从浏览器脚本, .NET Web 应用程序和 Silverlight 应用程序访问相同类型的功能。
为了改进和扩展处理外部数据的功能，Business Connectivity Services (BCS) 扩展了客户端对象模型，使其包括其他功能。

了解

开始结合使用 SharePoint 客户端对象模型和外部数据

若要使用 SharePoint 客户端对象模型 (CSOM) 开发解决方案，您将需要以下内容：

• SharePoint

• Visual Studio 2012

• Visual Studio 2012 Office 开发人员工具

有关如何设置开发环境的信息，请参阅 在 SharePoint 中为 BCS 设置开发环境。

若要访问客户端对象模型提供的功能，您仅需要添加对其项目中的 Microsoft.SharePoint.Client.Runtime.dll 和 Microsoft.SharePoint.Client.dll 文件的引用。 您也可以通过引用全局程序集缓存中的以下 DLL 来使用客户端对象模型：

• \\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.Runtime.dll

• \\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.dll

SharePoint 客户端对象模型要素

以下文章将帮助您更好地了解 SharePoint 中的客户端对象模型。

表 1. 了解客户端对象模型的核心概念

您可以使用客户端对象模型进行哪些操作？

您可以使用 SharePoint 客户端对象模型检索、更新和管理包含在 SharePoint 中的数据。 SharePoint 以不同的格式提供客户端库以适应大部分开发人员。 对于使用脚本语言的 Web 开发人员，在 JavaScript 中提供客户端库。 对于 .NET 开发人员，客户端库作为 .NET 客户端托管 DLL 提供。 对于 Silverlight 应用程序开发人员，由 Silverlight DLL 提供客户端库。

有关您可以使用 SharePoint 中的客户端对象模型执行的操作，请参阅表 2 中的文章。

表 2. 使用具有外部数据的客户端对象模型的基本任务

以下是您可以使用 CSOM 完成的基本任务示例。

获取特定实体

该例展示如何从 SharePoint 获取上下文，然后检索指定的数据源实体。

ClientContext ctx = new ClientContext("http://sharepointservername"); 
Web web = ctx.Web; 
ctx.Load(web); 
Entity entity = ctx.Web.GetEntity("http://sharepointservername", "EntityName"); 
ctx.Load(entity); 
ctx.ExecuteQuery(); 

创建通用调用程序

该例展示如何编写通用调用程序，使您可以创建在您的代码中使用的实体对象。

LobSystem lobSystem = entity.GetLobSystem();
ctx.Load(lobSystem);

LobSystemInstanceCollection lobInstances = lobSystem.GetLobSystemInstances();
ctx.Load(lobInstances);
ctx.ExecuteQuery();

LobSystemInstance lsi;
foreach(LobSystemInstance lobInstance in lobInstances)
{
  if (lobInstance.Name.CompareTo("MyLOBSystemInstance") == 0)
  {
    lsi = lobInstance;
  }
}

if (null != lsi)
{
  entity.Execute("MethodInstanceName", lsi, Array.Empty<object>()); 
  ctx.Load(myObj); 
  ctx.ExecuteQuery();
}

检索分页结果集

下面的示例展示如何检索经过筛选的分页数据集。 在该情况下，页面值是 50。

// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")
// Assuming that the "RowLimit" filter has the Limit filter type
fCollection.SetFilterValue("RowLimit", 0, 50)

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery(); 

查询已筛选的信息

下面的示例展示如何返回已筛选的结果集。 在该情况下，已筛选的数据列是 X.Y.Z.Country 域。 代码查询任何含有"印度"值的内容，然后将结果放入集中。

// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery(); 

基本知识之外的内容：了解关于客户端对象模型的详细信息

有关使用 SharePoint 中的客户端对象模型的详细信息，请参阅表 3 中的信息。

表 3. 客户端对象模型高级概念

另请参阅

• SharePoint 中的 Business Connectivity Services

• SharePoint 外接程序

• 如何：使用客户端代码库访问 SharePoint 中的外部数据

• 使用 SharePoint 客户端库代码完成基本操作

• SharePoint：使用 CSOM 访问复杂外部内容类型