演练：使用业务数据在 SharePoint 中创建外部列表

业务数据连接 (BDC) 服务使 SharePoint 能够显示来自后端服务器应用程序、Web 服务和数据库的业务数据。

本演练演示如何为 BDC 服务创建一个模型，以返回有关示例数据库中联系人的信息。 然后，使用此模型在 SharePoint 中创建一个外部列表。

本演练演示以下任务：

• 创建项目。
• 向模型添加实体。
• 添加 Finder 方法。
• 添加特定的 Finder 方法。
• 测试项目。

先决条件

您需要满足以下条件才能完成本演练：

• 支持的 Windows 和 SharePoint 版本。

• 对 AdventureWorks 示例数据库的访问权限。 有关如何安装 AdventureWorks 数据库的详细信息,请参阅 SQL Server 示例数据库。

创建一个包含 BDC 模型的项目

1. 在 Visual Studio 中的菜单栏上，选择“文件”>“新建”>“项目” 。

   “新建项目” 对话框随即打开。

2. 在“Visual C#”或“Visual Basic”下，展开“SharePoint”节点，然后选择“2010”项 。

3. 在“模板”窗格中，选择“SharePoint 2010 项目”，将项目命名为“AdventureWorksTest”，然后选择“确定”按钮 。

   此时将显示“SharePoint 自定义向导”。 在此向导中，可以指定用于调试项目的站点并设置解决方案的信任级别。

4. 选择“部署为场解决方案”选项按钮以设置信任级别。

5. 选择“完成”按钮以接受默认的本地 SharePoint 站点。

6. 在解决方案资源管理器中，选择 SharePoint 项目节点。

7. 在菜单栏上，依次选择“项目”>“添加新项”。

   此时将打开“添加新项”对话框。

8. 在“模板”窗格中，选择“业务数据连接模型(仅场解决方案)”，将项目命名为 AdventureWorksContacts，然后选择“添加”按钮 。

向项目添加数据访问类

1. 在菜单栏上，选择“工具”>“连接到数据库” 。

   随即会打开“添加连接”对话框。

2. 添加到 SQL Server AdventureWorks 示例数据库的连接。

   有关详细信息，请参阅添加/修改连接 (Microsoft SQL Server)。

3. 在 “解决方案资源管理器”中，选择项目节点。

4. 在菜单栏上，依次选择“项目”>“添加新项”。

5. 在“已安装的模板”窗格中，选择“数据”节点 。

6. 在“模板”窗格中，选择“LINQ to SQL 类” 。

7. 在“名称”框中指定 AdventureWorks，然后选择“添加”按钮 。

   .dbml 文件会添加到项目中，对象关系设计器（O/R 设计器）将打开。

8. 在菜单栏上，选择“视图”>“服务器资源管理器” 。

9. 在服务器资源管理器中，展开代表 AdventureWorks 示例数据库的节点，然后展开“Tables”节点 。

10. 将“Contact (Person)”表拖到 O/R 设计器上。

    一个实体类将创建并显示在设计图面上。 该实体类的属性映射到 Contact (Person) 表中的列。

从 BDC 模型中删除默认实体

业务数据连接模型项目将名为 Entity1 的默认实体添加到模型中。 删除此实体。 稍后，你将添加新实体。 从空模型开始可减少完成演练所需的步骤数。

1. 在解决方案资源管理器中，展开“BdcModel1”节点，然后打开 BdcModel1.bdcm 文件 。

2. 业务数据连接模型文件在 BDC 设计器中打开。

3. 在设计器中，打开“Entity1”的快捷菜单，然后选择“删除” 。

4. 在解决方案资源管理器中，打开 Entity1.vb（在 Visual Basic 中）或 Entity1.cs（在 C# 中）的快捷菜单，然后选择“删除” 。

5. 打开 Entity1Service.vb（在 Visual Basic 中）或 Entity1Service.cs（在 C# 中）的快捷菜单，然后选择“删除” 。

向模型添加实体

向模型添加实体。 可以将实体从 Visual Studio 的“工具箱”添加到 BDC 设计器上。

1. 在菜单栏上，依次选择“视图”>“工具箱” 。

2. 在“工具箱”的“BusinessDataConnectivity”选项卡中，将“实体”添加到 BDC 设计器上 。

   新实体将显示在设计器上。 Visual Studio 将名为 EntityService.vb（在 Visual Basic 中）或 EntityService.cs（在 C# 中）的文件添加到项目 。

3. 在菜单栏上，选择“查看”>“属性”>“窗口” 。

4. 在“属性”窗口中，将“Name”属性值设置为“Contact” 。

5. 在设计器中，打开实体的快捷菜单，选择“添加”，然后选择“标识符” 。

   实体上会显示一个新标识符。

6. 在“属性”窗口中，将标识符的名称更改为“ContactID” 。

7. 在“类型名称”列表中，选择“System.Int32” 。

添加特定的 Finder 方法

若要使 BDC 服务能够显示特定联系人，必须添加特定 Finder 方法。 当用户选择列表中的某一项，并选择功能区中的“查看项”按钮时，BDC 服务会调用特定的 Finder 方法。

使用“BDC 方法详细信息”窗口将特定的 Finder 方法添加到 Contact 实体。 若要返回特定实体，请向该方法添加代码。

1. 在 BDC 设计器中，选择“Contact”实体。

2. 在菜单栏上，选择“视图”>“其他窗口”>“BDC 方法详细信息” 。

   “BDC 方法详细信息”窗口将打开。

3. 在“添加方法”列表中，选择“创建特定的 Finder 方法” 。

   Visual Studio 将以下元素添加到模型中。 这些元素显示在“BDC 方法详细信息”窗口中。

   • 名为 ReadItem 的方法。

   • 方法的输入参数。

   • 方法的返回参数。

   • 每个参数的类型描述符。

   • 方法的方法实例。

4. 在“BDC 方法详细信息”窗口中，打开为“Contact”类型描述符显示的列表，然后选择“编辑” 。

   “BDC 资源管理器”将打开，并提供模型的分层视图。

5. 在“属性”窗口中，打开“TypeName”属性旁边的列表，选择“当前项目”选项卡，然后选择“Contact”属性 。

6. 在“BDC 资源管理器”中，打开“Contact”的快捷菜单，然后选择“添加类型描述符” 。

   名为“TypeDescriptor1”的新类型描述符随即显示在“BDC 资源管理器”中 。

7. 在“属性”窗口中，将“Name”属性值设置为“ContactID” 。

8. 打开“TypeName”属性旁边的列表，然后选择“Int32” 。

9. 打开“Identifier”属性旁边的列表，然后选择“ContactID” 。

10. 重复步骤 6，为以下每个字段创建类型描述符。

    名称	类型名称
    FirstName	System.String
    LastName	System.String
    电话	System.String
    EmailAddress	System.String
    EmailPromotion	System.Int32
    NameStyle	System.Boolean
    PasswordHash	System.String
    PasswordSalt	System.String

11. 在 BDC 设计器中，在“Contact”实体上打开“ReadItem”方法 。

    Contact 服务代码文件随即在代码编辑器中打开。

12. 在 ContactService 类中，将 ReadItem 方法替换为以下代码。 此代码执行以下任务：

    • 从 AdventureWorks 数据库的 Contact 表中检索记录。

    • 将 Contact 实体返回给 BDC 服务。

    注意

    将 ServerName 字段的值替换为你的服务器名称。

    C#

    public static Contact ReadItem(int contactID)
    {
        const string ServerName = "MySQLServerName";
        AdventureWorksDataContext dataContext = new AdventureWorksDataContext
              ("Data Source=" + ServerName + ";" +
               "Initial Catalog=AdventureWorks;Integrated Security=True");
    
        Contact Contact =
            (from contacts in dataContext.Contacts.AsEnumerable().Take(20)
             where contacts.ContactID == contactID
             select contacts).Single();
        return Contact;
    }
    

    VB

    Public Shared Function ReadItem(ByVal contactID As Integer) As Contact
        Const ServerName As String = "MySQLServerName"
        Dim dataContext As AdventureWorksDataContext = _
            New AdventureWorksDataContext("Data Source=" & ServerName & _
                ";Initial Catalog=AdventureWorks;Integrated Security=True")
    
        Dim Contact As Contact = _
            (From TempContacts In dataContext.Contacts.AsEnumerable().Take(20) _
            Where TempContacts.ContactID = contactID _
            Select TempContacts).[Single]()
        Return Contact
    End Function
    

添加 Finder 方法

若要使 BDC 服务能够在列表中显示联系人，必须添加 Finder 方法。 使用“BDC 方法详细信息”窗口将 Finder 方法添加到 Contact 实体。 若要将实体集合返回给 BDC 服务，请向该方法添加代码。

1. 在 BDC 设计器中，选择“Contact”实体。

2. 在“BDC 方法详细信息”窗口中，折叠“ReadItem”节点 。

3. 在“添加方法”列表的“ReadList”方法下，选择“创建 Finder 方法” 。

   Visual Studio 添加了一个方法、一个返回参数和一个类型描述符。

4. 在 BDC 设计器中，在“Contact”实体上打开“ReadList”方法 。

   联系人服务代码文件随即在代码编辑器中打开。

5. 在 ContactService 类中，将 ReadList 方法替换为以下代码。 此代码执行以下任务：

   • 从 AdventureWorks 数据库的 Contacts 表中检索数据。

   • 将 Contact 实体列表返回给 BDC 服务。

     注意

     将 ServerName 字段的值替换为你的服务器名称。

     C#

     public static IEnumerable<Contact> ReadList()
     {
         const string ServerName = "MySQLServerName";
         AdventureWorksDataContext dataContext = new AdventureWorksDataContext
               ("Data Source=" + ServerName + ";" +
                "Initial Catalog=AdventureWorks;Integrated Security=True");
     
         IEnumerable<Contact> Contacts =
             from contacts in dataContext.Contacts.Take(20)
             select contacts;
         return Contacts;
     
     }
     

     VB

     Public Shared Function ReadList() As IEnumerable(Of Contact)
         Const ServerName As String = "MySQLServerName"
         Dim dataContext As AdventureWorksDataContext = _
             New AdventureWorksDataContext("Data Source=" & ServerName & _
                 ";Initial Catalog=AdventureWorks;Integrated Security=True")
     
         Dim Contacts As IEnumerable(Of Contact) = _
             From TempContacts In dataContext.Contacts.Take(20) _
                   Select TempContacts
         Return Contacts
     End Function
     

   ---

测试项目

运行项目时，SharePoint 站点将打开，Visual Studio 将模型添加到业务数据连接服务。 在 SharePoint 中创建一个引用 Contact 实体的外部列表。 AdventureWorks 数据库中的联系人数据显示在列表中。

注意

在调试解决方案之前，可能必须在 SharePoint 中修改安全设置。 有关详细信息，请参阅设计业务数据连接模型。

1. 选择 F5。

   SharePoint 网站随即打开。

2. 在“站点操作”菜单中，选择“更多选项”命令 。

3. 在“创建”页中，选择“外部列表”模板，然后选择“创建”按钮 。

4. 将自定义列表命名为“Contacts”。

5. 选择“外部内容类型”字段旁边的浏览按钮。

6. 在“外部内容类型选取器”对话框中，选择“AdventureWorksContacts.BdcModel1.Contact”项，然后选择“创建”按钮 。

   SharePoint 随即创建包含 AdventureWorks 示例数据库中的联系人的外部列表。

7. 若要测试特定的 Finder 方法，请在列表中选择联系人。

8. 在功能区上，选择“项”选项卡，然后选择“查看项”命令 。

   所选联系人的详细信息随即显示在窗体中。

相关内容

• 如何：添加 Creator 方法。
• 如何：添加 Updater 方法。
• 如何：添加 Deleter 方法。
• BDC 模型设计工具概述
• 将业务数据集成到 SharePoint 中