演练:创建 N 层数据应用程序

适用于:yesnoVisual Studio Visual Studio for Mac noVisual Studio Code

“N 层”数据应用程序是指用于访问数据且分为多个逻辑层(或“多层”)的应用程序。 通过将应用程序组件分离到相对独立的层中,可以提高应用程序的可维护性和可伸缩性。 该结构之所以具有这种优点,是因为它有利于采用可应用于单个层而无需重新设计整个解决方案的新技术。 N 层体系结构包括一个表示层、一个中间层和一个数据层。 中间层通常包括数据访问层、业务逻辑层和共享组件(例如身份验证和验证)。 数据层则包括关系数据库。 N 层应用程序通常将敏感信息存储在中间层的数据访问层中,目的是将它们与访问表示层的最终用户隔离。 请参阅 N 层数据应用程序概述,了解更多相关信息。

在 N 层应用程序中,分离各层的一种方法是为要包括在应用程序中的每一层创建相互独立的项目。 类型化数据集包含一个 DataSet Project 属性,该属性决定了生成的数据集和 TableAdapter 代码应归属到哪些项目中。

本演练演示如何使用“数据集设计器”将数据集和 TableAdapter 代码分离到相互独立的类库项目中。 分离数据集和 TableAdapter 代码后,将创建 Visual Studio 中的 Windows Communication Foundation 服务和 WCF 数据服务服务,以调用数据访问层。 最后,将创建一个 Windows 窗体应用程序并将其用作表示层。 该层将访问数据服务中的数据。

在本演练期间,你将要执行以下步骤:

  • 新建将包含多个项目的 N 层解决方案。

  • 将两个类库项目添加到 N 层解决方案中。

  • 使用“数据源配置”向导创建类型化数据集

  • 将生成的 TableAdapters 和数据集代码分离到相互独立的项目中。

  • 创建 Windows Communication Foundation (WCF) 服务以调入数据访问层。

  • 在服务中创建函数以从数据访问层检索数据。

  • 创建 Windows 窗体应用程序来充当表示层。

  • 创建绑定到数据源的 Windows 窗体控件。

  • 编写代码以填充数据表。

先决条件

本演练使用 SQL Server Express LocalDB 和 Northwind 示例数据库。

  1. 如果尚未安装 SQL Server Express LocalDB,可以从 SQL Server Express 下载页或通过 Visual Studio 安装程序安装。 在 Visual Studio 安装程序中,可以将 SQL Server Express LocalDB 作为 .NET 桌面开发工作负载的一部分或作为单个组件进行安装 。

  2. 按照以下步骤安装 Northwind 示例数据库:

    1. 在 Visual Studio 中,打开“SQL Server 对象资源管理器”窗口。 (在 Visual Studio 安装程序中 SQL Server 对象资源管理器作为数据存储和处理工作负载的一部分安装。)展开 SQL Server 节点 。 右键单击 LocalDB 实例并选择“新建查询”。

      此时将打开查询编辑器窗口。

    2. Northwind Transact-SQL 脚本复制到剪贴板。 此 T-SQL 脚本从头开始创建 Northwind 数据库并用数据填充它。

    3. 将 T-SQL 脚本粘贴到查询编辑器中,然后选择“执行”按钮。

      不久后,查询完成运行并且 Northwind 数据库创建完成。

    1. 在 Visual Studio 中,打开“SQL Server 对象资源管理器”窗口。 (在 Visual Studio 安装程序中 SQL Server 对象资源管理器作为数据存储和处理工作负载的一部分安装。)展开 SQL Server 节点 。 右键单击 LocalDB 实例并选择“新建查询”。

      如果未看到LocalDB实例,请使用工具栏按钮添加SQL Server。 此时,将显示“导入” 对话框。 在对话框中,展开 “本地 ”并选择 “MSSQLLocalDB”。 输入适当的凭据。 可以保留数据库的默认选项。

      Screenshot of Connect to SQL Database dialog

    2. 选择“连接”。 为SQL Server 对象资源管理器中的LocalDB添加节点。

    3. 右键单击 LocalDB 实例并选择“新建查询”。

      此时将打开查询编辑器窗口。

    4. Northwind Transact-SQL 脚本复制到剪贴板。 此 T-SQL 脚本从头开始创建 Northwind 数据库并用数据填充它。

    5. 将 T-SQL 脚本粘贴到查询编辑器中,然后选择“执行”按钮。

      不久后,查询完成运行并且 Northwind 数据库创建完成。

创建 N 层解决方案和用于保存数据集的类库 (DataEntityTier)

本演练的第一步是创建一个解决方案和两个类库项目。 第一个类库将保存数据集(生成的类型化 DataSet 类以及将保存应用程序数据的数据表)。 此项目将用作应用程序的数据实体层,它通常位于中间层内。 数据集创建初始数据集,并自动将代码分离到两个类库中。

注意

请确保已正确命名项目和解决方案,然后再单击“确定”。 这样做可使你更轻松地完成本演练。

创建 N 层解决方案和 DataEntityTier 类库

  1. 在Visual Studio中,使用 C# 或 Visual Basic 的 Windows 窗体 (.NET Framework) 项目模板创建项目。 不支持 .NET Core、.NET 5 及更高版本。

  2. 将项目命名为“DataEntityTier”

  3. 将解决方案命名为“NTierWalkthrough”,然后选择“确定” 。

    创建包含 DataEntityTier 项目的 NTierWalkthrough 解决方案并将其添加到“解决方案资源管理器”中

创建用于保存 TableAdapter 的类库 (DataAccessTier)

创建 DataEntityTier 项目后,下一步是创建另一个类库项目。 此项目将保存生成的 TableAdapter,它称为应用程序的“数据访问层”。 数据访问层包含连接到数据库所需的信息,通常位于中间层内。

创建用于 TableAdapter 的单独类库

  1. 右键单击“解决方案资源管理器”中的解决方案,然后选择“添加”>“新建项目”

  2. 选择类库 (.NET Framework) 项目模板。

  3. 将项目命名为“DataAccessTier”,然后选择“确定” 。

    DataAccessTier 项目即被创建并添加到 NTierWalkthrough 解决方案中。

创建数据集

下一步是创建类型化数据集。 通过单个项目中的数据集类(包括 DataTables 类)和 TableAdapter 类创建类型化数据集。 (所有类都将生成到单个文件中。)在将数据集和 TableAdapter 分离到不同的项目中时,移到另一个项目中的是数据集类,TableAdapter 类则留在原始项目中。 因此,应在最终包含 TableAdapter 的项目(DataAccessTier 项目)中创建数据集。 使用“数据源配置向导”来创建数据集。

注意

你必须具有对 Northwind 示例数据库的访问权限,才能创建连接。 有关如何设置 Northwind 示例数据库的信息,请参阅如何:安装示例数据库

创建数据集

  1. 在“解决方案资源管理器”中选择“DataAccessTier” 。

  2. 在“数据”菜单上,选择“显示数据源” 。

    “数据源”窗口随即打开

  3. 在“数据源”窗口,选择“添加新数据源”以启动“数据源配置”向导

  4. 在“选择数据源类型”页上,选择“数据库”,然后选择“下一步” 。

  5. 在“选择数据连接”页面上,执行以下操作之一

    如果下拉列表中包含到 Northwind 示例数据库的数据连接,请选择该连接。

    -或-

    选择“新建连接”以打开“添加连接”对话框 。

  6. 如果数据库需要密码,请选择该选项以包括敏感数据,然后选择“下一步”。

    注意

    如果选择了本地数据库文件(而不是连接至 SQL Server),系统可能会询问你是否将该文件添加到项目中。 选择“是”将该数据库文件添加到项目中。

  7. 在“将连接字符串保存到应用程序配置文件中”页上,选择“下一步” 。

  8. “选择数据库对象” 页面上展开 “表” 节点。

  9. 选择“Customers”和“Orders”表的复选框,然后选择“完成” 。

    将 NorthwindDataSet 添加到 DataAccessTier 项目后即会显示在“数据源”窗口内

将 TableAdapter 与数据集分离

创建数据集后,接着是要将生成的数据集类与 TableAdapter 分离。 通过将“数据集项目”属性设置为要用于存储分离出的数据集类的项目的名称,可以达到此目的

将 TableAdapter 与数据集分离

  1. 在“解决方案资源管理器”中双击“NorthwindDataSet.xsd”,以在“数据集设计器”中打开该数据集

  2. 选择设计器上的空白区域。

  3. 在“属性”窗口中查找“数据集项目”节点

  4. 在“数据集项目”列表中,选择“DataEntityTier” 。

  5. 在“生成”菜单上,选择“生成解决方案” 。

    将数据集和 TableAdapter 分离到两个类库项目中。 最初包含整个数据集的项目 (DataAccessTier) 现在只包含 TableAdapter。 “DataSet Project”属性中指定的项目 (DataEntityTier) 则包含类型化数据集:NorthwindDataSet.Dataset.Designer.vb(或 NorthwindDataSet.Dataset.Designer.cs) 。

注意

分离数据集与 TableAdapter(通过设置“数据集项目”属性)时,将不会自动移动项目中现有的数据集分部类。 你必须手动将它们移到数据集项目中。

创建新的服务应用程序

本演练演示如何使用 WCF 服务访问数据访问层,因此让我们创建一个新的 WCF 服务应用程序。

创建新的 WCF 服务应用程序

  1. 右键单击“解决方案资源管理器”中的解决方案,然后选择“添加”>“新建项目”

  2. 在“新建项目”对话框的左侧窗格中,选择“WCF” 。 在中间窗格中,选择“WCF 服务库”。

  3. 将该项目命名为“DataService”,然后选择“确定” 。

    DataService 项目即被创建并添加到 NTierWalkthrough 解决方案中。

在数据访问层中创建用于返回客户和订单数据的方法

数据服务需要调用数据访问层中的两个方法:GetCustomersGetOrders。 这些方法返回 Northwind CustomersOrders 表。 在 DataAccessTier 项目中创建 GetCustomersGetOrders 方法。

在数据访问层中创建返回 Customers 表的方法

  1. 在“解决方案资源管理器”中,双击“NorthwindDataset.xsd”以打开数据集 。

  2. 右键单击“CustomersTableAdapter”,然后单击“添加查询” 。

  3. 在“选择命令类型”页面上,保留“使用 SQL 语句”的默认值,然后单击“下一步”

  4. 在“选择查询类型”页面上,保留“选择返回行”的默认值,然后单击“下一步”

  5. 在“指定 SQL SELECT 语句”页面上,保留默认查询,然后单击“下一步”

  6. 在“选择要生成的方法”页面上,为“返回 DataTable”部分的“方法名称”键入“GetCustomers”

  7. 单击“完成” 。

在数据访问层中创建返回 Orders 表的方法

  1. 右键单击“OrdersTableAdapter”,然后单击“添加查询”

  2. 在“选择命令类型”页面上,保留“使用 SQL 语句”的默认值,然后单击“下一步”

  3. 在“选择查询类型”页面上,保留“选择返回行”的默认值,然后单击“下一步”

  4. 在“指定 SQL SELECT 语句”页面上,保留默认查询,然后单击“下一步”

  5. 在“选择要生成的方法”页面上,为“返回 DataTable”部分的“方法名称”键入“GetOrders”

  6. 单击“完成” 。

  7. 在“生成”菜单中,单击“生成解决方案”。

向数据服务添加对数据实体和数据访问层的引用

由于数据服务需要数据集和 TableAdapter 中的信息,因此需要添加对“DataEntityTier”和“DataAccessTier”项目的引用 。

添加对数据服务的引用

  1. 在“解决方案资源管理器”中右键单击 DataService,然后单击“添加引用”

  2. 在“添加引用”对话框中,单击“项目”选项卡

  3. 选择“DataAccessTier”和“DataEntityTier”项目

  4. 单击 “确定”

向服务中添加函数以调用数据访问层中的 GetCustomers 和 GetOrders 方法

现在数据访问层包含返回数据的方法,接下来要在数据服务中创建调用这些方法的方法。

注意

对于 C# 项目,必须添加对 System.Data.DataSetExtensions 程序集的引用,才能编译下面的代码。

在数据服务中创建 GetCustomers 和 GetOrders 函数

  1. 在“DataService”项目中,双击“IService1.vb”或“IService1.cs”

  2. 在“在此处添加服务操作”注释的下方添加以下代码

    [OperationContract]
    DataEntityTier.NorthwindDataSet.CustomersDataTable GetCustomers();
    
    [OperationContract]
    DataEntityTier.NorthwindDataSet.OrdersDataTable GetOrders();
    

    注意

    本教程的代码在 C# 和 Visual Basic中提供。 若要在此页面上的 C# 和 Visual Basic 之间切换代码语言,请使用右侧页面顶部的代码语言切换器。

  3. 在 DataService 项目中,双击“Service1.vb”(或“Service1.cs”) 。

  4. 将以下代码添加到“Service1”类中:

    public DataEntityTier.NorthwindDataSet.CustomersDataTable GetCustomers()
    {
        DataAccessTier.NorthwindDataSetTableAdapters.CustomersTableAdapter
             CustomersTableAdapter1
            = new DataAccessTier.NorthwindDataSetTableAdapters.CustomersTableAdapter();
        return CustomersTableAdapter1.GetCustomers();
    }
    public DataEntityTier.NorthwindDataSet.OrdersDataTable GetOrders()
    {
        DataAccessTier.NorthwindDataSetTableAdapters.OrdersTableAdapter
             OrdersTableAdapter1
            = new DataAccessTier.NorthwindDataSetTableAdapters.OrdersTableAdapter();
        return OrdersTableAdapter1.GetOrders();
    }
    
  5. 在“生成”菜单中,单击“生成解决方案”。

创建表示层以显示数据服务中的数据

现在,解决方案中的数据服务已具有调入数据访问层的方法,接下来要创建另一个项目,以调入数据服务并将数据显示给用户。 对于本演练,创建一个 Windows 窗体应用程序;它将充当 N 层应用程序的表示层。

创建表示层项目

  1. 右键单击“解决方案资源管理器”中的解决方案,然后选择“添加”>“新建项目”

  2. 在“新建项目”对话框的左侧窗格中,选择“Windows 桌面” 。 在中间窗格,选择“Windows 窗体应用”。

  3. 将该项目命名为“PresentationTier”,然后单击“确定”

    PresentationTier 项目即被创建并添加到 NTierWalkthrough 解决方案中。

将 PresentationTier 项目设置为启动项目

我们将 PresentationTier 项目设置为解决方案的启动项目,因为它是用于显示数据和进行数据交互的实际客户端应用程序。

将新的表示层项目设置为启动项目

  • 在“解决方案资源管理器”中,右键单击“PresentationTier”,然后单击“设为启动项目”

添加对表示层的引用

客户端应用程序 PresentationTier 需要具有对数据服务的服务引用,才能访问服务中的方法。 另外,WCF 服务又需要具有对数据集的引用,才能启用类型共享。 而只有通过数据服务启用类型共享,表示层才能使用添加到数据集分部类中的代码。 由于数据表的行和列更改事件中通常添加有类似于验证代码的代码,因此可能需要从客户端访问此代码。

添加定义表示层的引用

  1. 在“解决方案资源管理器”中,右键单击“PresentationTier”,然后选择“添加引用” 。

  2. 在“添加引用”对话框中,选择“项目”选项卡 。

  3. 选择“DataEntityTier”,然后选择“确定” 。

添加对表示层的服务引用

  1. 在“解决方案资源管理器”中,右键单击“PresentationTier”,然后选择“添加服务引用” 。

  2. 在“添加服务引用”对话框中,选择“发现” 。

  3. 选择“Service1”,然后选择“确定” 。

    注意

    如果当前计算机上存在多项服务,请选择你在本演练的前面部分中创建的服务(即包含 GetCustomersGetOrders 方法的服务)。

将 DataGridView 添加到窗体,以显示数据服务返回的数据

在添加对数据服务的服务引用后,将自动使用该服务返回的数据填充“数据源”窗口

将两个数据绑定 DataGridView 添加到窗体中

  1. 在“解决方案资源管理器”中,选择“PresentationTier”项目

  2. 在“数据源”窗口中,展开“NorthwindDataSet”,然后查找“Customers”节点

  3. 将“Customers”节点拖到 Form1 上

  4. 在“数据源”窗口中,展开“Customers”节点,然后查找相关的“Orders”节点(“Orders”节点嵌套在“Customers”节点中)

  5. 将相关的“Orders”节点拖到 Form1 上

  6. 通过双击窗体的空白区域,创建一个 Form1_Load 事件处理程序。

  7. 将以下代码添加到 Form1_Load 事件处理程序中。

    ServiceReference1.Service1Client DataSvc =
        new ServiceReference1.Service1Client();
    northwindDataSet.Customers.Merge(DataSvc.GetCustomers());
    northwindDataSet.Orders.Merge(DataSvc.GetOrders());
    

增加服务所允许的最大消息大小

maxReceivedMessageSize 的默认值不足以容纳从 CustomersOrders 表中检索到的数据。 在下面的步骤中,会将该值增加到 6553600。 可以更改客户端上的值,这会自动更新服务引用。

注意

较小的默认大小旨在降低遭受拒绝服务 (DoS) 攻击的可能性。 有关详细信息,请参阅 MaxReceivedMessageSize

增加 maxReceivedMessageSize 值

  1. 在“解决方案资源管理器”的“PresentationTier”项目中,双击“app.config”文件

  2. 找到 maxReceivedMessageSize 属性并将值更改为 6553600。 如果未看到该 basicHttpBinding 条目,请添加如下例所示:

    <system.serviceModel>
     <bindings>
         <basicHttpBinding>
             <binding maxBufferSize="6553600" maxReceivedMessageSize="6553600" />
         </basicHttpBinding>
     </bindings>
    </system.serviceModel>
    

测试应用程序

按 F5 运行应用程序。 应用程序会从数据服务中检索 CustomersOrders 表的数据,并将检索到的数据显示在窗体上。

后续步骤

根据应用程序的需求,在基于 Windows 的应用程序中保存相关数据后,可能还要执行一些步骤。 例如,你可以对此应用程序进行以下增强:

  • 将验证添加到数据集。

  • 将其他方法添加到服务,以将数据更新回数据库。

另请参阅