使用 Offline Application Block 进行开发

Microsoft Corporation

内容：第 3 章详细说明了构建和使用该应用程序块的过程。本章还提供了快速入门，以帮助您了解实现自己的脱机解决方案所需的步骤。

本页内容

	安装 Offline Application Block
	Offline Application Block 快速入门
	使用 Offline Application Block
	开发自己的提供程序
	小结
	更多信息

现在您已经了解了 Offline Application Block 的设计，接下来就可以使用该应用程序块开发解决方案了。要开发使用 Offline Application Block 的应用程序，您需要：

本章为您说明了如何使用 Offline Application Block 以及与该应用程序块随附的不同子系统相关联的提供程序，来开发解决方案。本章还讨论了设计注意事项以及如何开发自己的提供程序。本章使用连接检测提供程序（由该应用程序块提供）作为参考示例。

安装 Offline Application Block

在安装 Offline Application Block 之前，查看软件要求和该应用程序块构建的文件夹结构非常重要。

软件要求

要使用 Offline Application Block，您必须确保系统符合下列最低软件要求：

此外，您可能需要安装 Microsoft Internet 信息服务 (IIS)，这取决于应用程序的目的，或是您是否打算安装 InsuranceClaimsService Web 服务，以便在同一计算机上运行 InsuranceClaimsQuickStart\InsuranceClaimsClient。

该应用程序块具有用于“队列存储”的内置提供程序。这些提供程序使用：

除其他提供程序之外，该应用程序块还具有用于缓存的内置提供程序。

注 有关相应队列和缓存提供程序的配置详细信息，请参阅本章结尾的“设置桌面引擎和 MSMQ”部分。

构建 Offline Application Block

您必须先构建解决方案，然后添加对几个程序集的引用，之后才能使用 Offline Application Block。

构建 Offline Application Block

要在应用程序中使用 Offline Application Block，您需要添加一个对 Common、Offline Providers 和 Offline 程序集的引用。如果您使用的是 Visual C#，请将 using 指令添加到要访问块代码的文件中。如果您使用的是 Visual Basic .NET，请将 Imports 指令添加到您要在其中访问块代码的文件中。例如，如果您使用 Visual C# 编写一个新的服务代理，请将以下 using 指令添加到要访问块代码的文件中：

...
using Microsoft.ApplicationBlocks.SmartClient.Offline;
...
  

在 Visual Basic 中使用的相应 Imports 指令是：

...
Imports Microsoft.ApplicationBlocks.SmartClient.Offline
...
  

Offline Application Block 文件夹结构

当您安装 Offline Application Block 时，安装程序包将创建以下文件夹结构：

<Install Location>
+---Offline
    +---Caching
    :   +---src
    :       +---cs
    :           +---Cache
    :           :   +---DataProtectionImplementations
    :           :   +---ExpirationsImplementations
    :           :   +---ScavengingImplementations
    :           :   +---StorageImplementations
    :           +---MemoryMappedFile
    +---Common
    :   +---src
    :       +---cs
    :           +---Common
    :           :   +---Crypto
    :           :   :   +---doc
    :           :   +---doc
    :           +---Version
    +---DAAB
    :   +---src
    :       +---cs
    :           +---Microsoft.ApplicationBlocks.Data
    +---Database
    :   +---Cache
    :   +---Queue
    +---Docs
    +---EMAB
    :   +---src
    :       +---cs
    :           +---Microsoft.ApplicationBlocks.ExceptionManagement
    :           +---Microsoft.ApplicationBlocks.ExceptionManagement.Interfaces
    +---QuickStarts
    :   +---src
    :   :   +---cs
    :   :   :   +---ConnectionManagementQuickStart
    :   :   :   +---DownloadQuickStart
    :   :   :   +---InsuranceClaimsQuickStart
    :   :   :   :   +---Database
    :   :   :   :   +---InsuranceClaimsClient
    :   :   :   :   +---InsuranceClaimsService
    :   :   :   +---UploadQuickStart
    :   :   +---vb
    :   :       +---ConnectionManagementQuickStart
    :   :       +---DownloadQuickStart
    :   :       +---InsuranceClaimsQuickStart
    :   :       :   +---Database
    :   :       :   +---InsuranceClaimsClient
    :   :       :   +---InsuranceClaimsService
    :   :       +---UploadQuickStart
    :   +---Utility
    :       +---ValidationKeyGeneration
    +---src
        +---cs
            +---Offline
            :   +---Builders
            :   +---ConnectionManagement
            :   +---DataLoadingManagement
            :   +---Executor
            :   +---QueueManagement
            :   +---ReferenceDataManagement
            :   +---ServiceAgentManagement
            +---Offline Providers
            :   +---CacheStorageProviders
            :   +---ConnectionDetectionStrategies
            :   +---QueueStorageProviders
            +---Versioning

每个快速入门解决方案都构建在各自的子文件夹中。表 3.1 说明了在安装 Offline Application Block 时安装程序包所创建的文件夹。

表 3.1：Offline Application Block 安装程序包创建的文件夹

返回页首

Offline Application Block 快速入门

要将脱机功能添加到应用程序中，请先查看该应用程序块随附的四个快速入门：

您可以使用这些快速入门来更好地理解 Offline Application Block、开发新的提供程序或修改现有的提供程序。例如，您可能要为连接检测功能开发几个提供程序，但在配置文件中只启用所需的提供程序。

要点 这些快速入门旨在帮助您理解该应用程序块；它们不是现成的产品代码示例。

下面的段落将在开发人员要在应用程序中执行的任务的上下文中讨论每个快速入门。

管理应用程序的连接状态

“连接管理快速入门”说明如何使用该应用程序块的“连接状态管理”子系统组件，来检测应用程序是处于联机状态还是脱机状态，以及强制改变应用程序的状态。

该快速入门的单屏幕中包含两个按钮 — Go Offline 和 Go Online，可让用户将应用程序的状态更改为联机或脱机。该屏幕还有一个标签，用来显示应用程序的连接状态。

当该快速入门运行时，应用程序块开始在后台轮询连接，以自动检测连接状态更改。如果连接状态随后被强制为脱机，则轮询会立即停止。该快速入门注册了 ConnectionManager 类的 ConnectionStateChangedEvent。注册该事件可让快速入门对连接状态的更改做出反应。当连接状态更改时，会引发该事件，并且屏幕上的连接状态标签会发生更改，以反映应用程序的连接状态。

构建连接管理快速入门

要启动该快速入门，请双击 ConnectionManagerQuickStart.exe。

“连接管理快速入门”文件

这些快速入门文件位于 <installation location>\Offline\QuickStarts\src\<language>\ConnectionManagementQuickStart\ 文件夹中。表 3.2 说明了与该“连接管理快速入门”讨论相关的文件。

表 3.2：“连接管理快速入门”文件

详细信息

该快速入门使用了该应用程序块随附的默认连接检测提供程序（策略）。该默认连接检测提供程序使用 WinInet 动态链接库 (DLL) 的 InternetGetConnectedState 方法来检测连接状态更改。例如，如果在运行该示例时，将网络电缆从连接到网络的计算机中拔出，则连接状态将显示更改为脱机模式。

检测连接的提供程序是在应用程序配置文件中指定的。有关在配置文件中指定提供程序的详细信息，请参阅第 4 章“Offline Application Block 配置和安全注意事项”。

传输中的数据：下载

“下载快速入门”说明如何下载参考数据，以便应用程序的用户即使在应用程序脱机时也可以继续使用该应用程序。

该快速入门的单屏幕中包含一个 Download 按钮和一个用来显示结果的网格。当用户单击 Download 按钮时，数据开始下载（从本地的 XML 文件读取）并显示在网络中。

构建下载快速入门

要启动该快速入门，请双击 DownloadQuickStart.exe。

“下载快速入门”文件

这些快速入门文件位于 <installation location>\Offline\QuickStarts\src\<language>\DownloadQuickStart\ 文件夹中。表 3.3 说明了与该“下载快速入门”讨论相关的文件。

表 3.3：“下载快速入门”文件

详细信息

该快速入门使用服务代理（DownloadDataServiceAgent）来启动下载。DownloadDataServiceAgent 负责使用必要的上下文信息创建正确的 ReferenceDataDefinition，例如使用 OnlineProxyContext 创建 OnlineProxy 类以便从虚拟服务（为进行说明而使用的一个本地方法调用）中检索数据，以及使用 ServiceAgentContext 将结果返回到控制器。该服务代理调用 DataLoaderManager 来启动下载具有正确 ReferenceDataDefinition 值的参考数据。

OnlineProxy 负责检索数据，然后使用“参考数据管理”子系统将该数据存储在“参考数据缓存”中。

默认情况下，该快速入门使用 InMemoryQueueStorageProvider 来缓存数据。用于缓存的提供程序是在应用程序的配置文件中指定的。有关如何在配置文件中指定提供程序的详细信息，请参阅第 4 章“Offline Application Block 配置和安全注意事项”。

传输中的数据：上载

“上载快速入门”说明如何将应用程序用户修改后的数据上载到服务器。该快速入门说明了如何使用该应用程序块的“消息数据管理”子系统。

该快速入门的基本窗体包含几个字段、一个 Save 按钮和一个 Cancel 按钮。当该快速入门启动时，它会读取包含数据的本地 XML 文件，并在窗体中显示数据。当用户修改数据并单击 Save 按钮后，该数据会保存到本地 XML 文件中。这模拟了使用与远程服务进行通信时所必需的所有组件。

构建上载快速入门

要启动该快速入门，请双击 UploadQuickStart.exe。

“上载快速入门”文件

该快速入门文件位于 <installation location>\Offline\QuickStarts\src\<language>\UploadQuickStart\ 文件夹中。表 3.4 说明了与该“上载快速入门”讨论相关的文件。

表 3.4：“上载快速入门”文件

详细信息

该快速入门说明了“消息数据管理”子系统是如何工作的。当该快速入门启动时，它从本地 XML 文件中读取数据，并将数据显示在窗体中。在用户修改数据后单击 Save 按钮时，控制器将调用 UploadDataServiceAgent 对象的 UpdateWorkItem 方法。

UploadDataServiceAgent 对象可创建处理请求和提供必要上下文信息（例如 OnlineProxyContext 和 ServiceAgentContext 对象）所需的 Payload 对象。

创建 payload 后，UploadDataServiceAgent 对象会将它存储在队列中。Executor 对象从队列中提取 payload，然后调用 OnlineProxy 对象来处理请求。

OnlineProxy 对象将更新本地 XML 文件中的数据。它还可以将该信息传达到某个服务。它使用 ServiceAgentContext 对象将结果返回到控制器。

默认情况下，该快速入门使用 InMemoryQueueStorageProvider 来排队消息。用于排队的提供程序是在应用程序的配置文件中指定的。有关如何在配置文件中指定提供程序的详细信息，请参阅第 4 章“Offline Application Block 配置和安全注意事项”。

综合的端到端解决方案

“保险理赔快速入门”将本章前面部分和第 2 章中讨论的所有概念结合在一起。该快速入门说明了一个使用 Web 服务运行在服务器（也可以是本地计算机）上并提供业务功能的端到端应用程序。

注 默认情况下，在安装该快速入门解决方案时，创建虚拟目录的 Web 服务对象和脚本都会包含在其中。该脚本将在同一台计算机上创建 Web 服务。作为一种备选方法，为了模拟更加真实的情形，您可以在其他计算机上创建 Web 服务。为此，您必须对解决方案文件进行适当的更改，同时也要更改 Web 参考。

该快速入门包括两个部分：保险理赔客户端（智能客户端应用程序）和保险理赔服务（Web 服务）。

该客户端为智能客户端应用程序，它能够在脱机模式下工作。Web 服务能够将业务功能作为 Web 方法公开。

该用户界面是单个屏幕，它结合了前面的快速入门中说明的所有用户界面。屏幕上包含多个按钮，可用于强制应用程序联机或脱机，下载工作项目，以及保存在应用程序联机时要上载的工作项目。该快速入门使用了 Offline Application Block 的所有子系统。

您必须先创建 Web 服务和该 Web 服务所使用的数据库，然后才能构建该快速入门。

创建保险理赔 Web 服务及其使用的数据库

请注意，您必须在安装有 Web 服务的计算机上执行前面的步骤。

要点 默认情况下，MSDE 使用 Windows 身份验证作为其登录模式。Web 服务运行在名为 ASPNET 的默认用户下，您必须先授予该用户权限并对其进行配置，然后才能有效地使用 MSDE。有关如何授予权限和配置帐户的说明，请参阅 .NET Framework SDK QuickStart Configuration Details 文档。默认情况下，该文档位于：<运行 Visual Studio .NET 的计算机的 drive:\>Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\Samples\Setup\html\ConfigDetails.htm。

但是，如果要将身份验证从 Windows 模式更改为混合模式，您必须将以下注册表项中的 LoginMode 十六进制值从 1 更改为 2： My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\VSDOTNET\MSSQLServer。

在创建 Web 服务和数据库后，请使用下列步骤来构建快速入门。

构建“保险理赔快速入门”

要启动该快速入门，请双击 InsuranceClaimsQuickStart.exe。

“保险理赔快速入门”文件

该快速入门的解决方案位于 <installationlocation>\Offline\QuickStarts\src\<language>\ InsuranceClaimsQuickStart\InsuranceClaimsClient\ 文件夹中。表 3.4 和 3.5 说明了与该“保险理赔快速入门”讨论相关的文件。

表 3.4：“保险理赔快速入门”文件

表 3.5：保险理赔服务的 Web 服务文件

详细信息

有关如何执行特定操作的信息，请参阅前面快速入门的详细信息。例如，前面快速入门中的详细信息说明了下载或上载工作项目所涉及的组件。

前面的快速入门和此快速入门的唯一不同之处在于 OnlineProxy 类的行为。要使这些快速入门保持在一个基本水平，前面快速入门中的 OnlineProxy 类要在本地检索或更新数据。在这种情况下，该快速入门将与 Web 服务进行交互，并演示了一个使用 Offline Application Block 的应用程序的端到端方案。

返回页首

使用 Offline Application Block

在使用 Offline Application Block 之前，您应评估现有的提供程序，并确定是否要使用它们或创建新的提供程序。

根据应用程序的要求评估提供程序

当您要将脱机功能添加到应用程序时，必须根据下列提供程序来确定应用程序的要求：

加密提供程序– Common Block 提供了 Data Protection API 作为其加密提供程序。您应根据组织的安全性要求来评估该提供程序是否适合您的应用程序体系结构。如果不适合，您需要创建一个自定义提供程序。

有关在应用程序中使用提供程序或开发自己的自定义提供程序的信息，请参阅本章后面的“开发自己的提供程序”。

使用 Offline Block 的任务

在设计阶段，您的组织会决定 Offline Application Block 要满足的业务要求。某些要求会涉及到用户界面 (UI) 和用户界面控制器 (UIC)。这些用户界面依赖于您组织所提出的业务要求，并决定联机/脱机操作与用户之间的交互。有关 UIC 和用户界面处理 (UIP) 的讨论超出了本指南的范围。

下表向您展示了在构建具有脱机功能的应用程序时，可能要执行的常见任务。

开始

开始访问脱机功能

...
private OfflineBlockBuilder offlineBlockBuilderInstance;
    offlineBlockBuilderInstance = OfflineBlockBuilder.Instance;
...
  

...
Private OfflineBlockBuilder offlineBlockBuilderInstance
    offlineBlockBuilderInstance = OfflineBlockBuilder.Instance
...
  

...
offlineBlockBuilderInstance.ConnectionManager.ConnectionState ChangedEvent += new ConnectionStateChangedEventHandler(ConnectionManager
        ConnectionStateChangedEvent);
...
  

...
    offlineBlockBuilderInstance AddHandler offlineBlockBuilderInstance.ConnectionManager.ConnectionStateChangedEvent, AddressOf ConnectionManagerConnectionStateChangedEvent
...
  

...
FailsafeServiceAgent refFailSafeServiceAgent = offlineBlockBuilderInstance.FailsafeServiceAgent;
refFailSafeServiceAgent.ErrorEvent += new MethodExecutionFailureReportEventHandler(
FailSafeServiceAgentErrorEvent);
...
  

...
Dim refFailSafeServiceAgent As FailsafeServiceAgent = offlineBlockBuilderInstance.FailsafeServiceAgent
            AddHandler refFailSafeServiceAgent.ErrorEvent, AddressOf FailSafeServiceAgentErrorEvent
...
  

...
offlineBlockBuilderInstance.Start() ;
...
  

...
offlineBlockBuilderInstance = OfflineBlockBuilder.Start
...
  

...
offlineBlockBuilderInstance.ConnectionManager.GoOffline() ;
...
  

...
offlineBlockBuilderInstance.ConnectionManager.GoOffline()
...
  

...
offlineBlockBuilderInstance.ConnectionManager.GoOnline() ;
...
  

...
offlineBlockBuilderInstance.ConnectionManager.GoOnline()
...
  

使用“应用程序服务代理”中的 DataLoaderManager 将数据加载到客户端数据存储区中

以下代码阐释了前面的步骤：

[C#]

...
string onlineProxyAssemblyName = "InsuranceClaimsClient";
string onlineProxyClassName = "Microsoft.ApplicationBlocks.SmartClient.Offline.QuickStarts.OnlineProxy";
string onlineProxyMethodName ="GetWorkItems";
string specificServiceAgentMethodTobeInvoked = "DataAvailableCallBack";
const int absoluteExpirationTime = 600;
string cacheKey = "SmartClient";
OnlineProxyContext onlineProxyMethodContext = 
    new OnlineProxyContext(onlineProxyAssemblyName, 
    onlineProxyClassName, onlineProxyMethodName);
ServiceAgentContext specificServiceAgentContext = new 
    ServiceAgentContext(specificServiceAgentMethodTobeInvoked);
ReferenceDataDefinition refDataDefination = new 
    ReferenceDataDefinition(cacheKey, absoluteExpirationTime, 
    onlineProxyMethodContext);
offlineBlockBuilderInstance.DataLoaderManager.LoadData(this.Guid, 
    specificServiceAgentContext, refDataDefination);
...
  

[Visual Basic]

...
Dim onlineProxyAssemblyName As String = "InsuranceClaimsClient"
Dim onlineProxyClassName As String = 
"Microsoft.ApplicationBlocks.SmartClient.Offline.QuickStarts.OnlineProxy"
Dim onlineProxyMethodName As String = "GetWorkItems"
Dim specificServiceAgentMethodTobeInvoked As String = 
    "DataAvailableCallBack"
Const absoluteExpirationTime As Integer = 600
Dim cacheKey As String = "SmartClient"
Dim onlineProxyMethodContext As New 
    OnlineProxyContext(onlineProxyAssemblyName, onlineProxyClassName, 
    onlineProxyMethodName)
Dim specificServiceAgentContext As New 
    ServiceAgentContext(specificServiceAgentMethodTobeInvoked)
Dim refDataDefination As New ReferenceDataDefinition(cacheKey, 
    absoluteExpirationTime, onlineProxyMethodContext)
offlineBlockBuilderInstance.DataLoaderManager.LoadData(Me.Guid, 
    specificServiceAgentContext, refDataDefination)
...
  

使用“应用程序服务代理”中的 QueueManager 将数据排入队列

以下代码阐释了前面的步骤：

[C#]

...
string onlineProxyAssemblyName = "InsuranceClaimsClient";
string onlineProxyClassName = "Microsoft.ApplicationBlocks.SmartClient.Offline.QuickStarts.OnlineProxy";
string onlineProxyMethodName ="UpdateWorkItem";
string specificServiceAgentMethodTobeInvoked = "DataUpdatedCallBack";
OnlineProxyContext onlineProxyMethodContext = new 
    OnlineProxyContext(onlineProxyAssemblyName, onlineProxyClassName, 
    onlineProxyMethodName);
ServiceAgentContext specificServiceAgentContext = new 
    ServiceAgentContext(specificServiceAgentMethodTobeInvoked);
Payload messageToEnqueue = new 
    Payload(onlineProxyMethodContext,this.Guid,
    specificServiceAgentContext, changedAppData);
offlineBlockBuilderInstance.PayloadConsumer.Enqueue(messageToEnqueue);
...
  

[Visual Basic]

...
Dim onlineProxyAssemblyName As String = "InsuranceClaimsClient"
Dim onlineProxyClassName As String = "Microsoft.ApplicationBlocks.SmartClient.Offline.QuickStarts.OnlineProxy"
Dim onlineProxyMethodName As String = "UpdateWorkItem"
Dim specificServiceAgentMethodToInvoke As String = "DataUpdatedCallBack"
Dim onlineProxyMethodContext As New OnlineProxyContext(onlineProxyAssemblyName, onlineProxyClassName, onlineProxyMethodName)
Dim specificServiceAgentContext As New ServiceAgentContext(specificServiceAgentMethodToInvoke)
Dim messageToEnqueue As New Payload(onlineProxyMethodContext, _
    Me.Guid, specificServiceAgentContext, _
    changedAppData)
offlineBlockBuilderInstance.PayloadConsumer.Enqueue(messageToEnqueue)

返回页首

开发自己的提供程序

至此，本章的重点一直是如何在不加修改的情况下将 Offline Application Block 用于您的应用程序。设计的关键方面在于，您可以利用自己的提供程序来扩展应用程序块。这些注意事项适用于您创建的任何提供程序。

开发自己的提供程序

WinInetDetectionStrategy 提供程序说明了以前的设计注意事项如何表示“连接管理”子系统用于连接检测的连接检测提供程序。

WinInetDetectionStrategy 提供程序实现 IConnectionDetectionStrategy 和 IProvider 接口。这些提供程序的配置设置在 ConnectionManagerProviders 区段中被定义为 provider 元素，其 name 特性设置为 winINetDetectionStrategy。通用属性被指定为特性，而自定义属性 pollingInterval 被指定为 provider 元素的子元素。ConnectionManagerConfigurator 类可读取配置信息，并创建该提供程序的一个实例。

设置 MSDE 和 MSMQ

在通过这些快速入门或任何自定义应用程序使用 MSDE 和 MSMQ 提供程序之前，您需要相应地设置 MSDE 和 MSMQ。

MSDE 设置

在将 MSDE 提供程序用于缓存或队列之前，您必须配置 MSDE，以使其在客户端计算机上正常工作。有关详细信息，请参阅 <drive:\ >Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\Samples\Setup\html\ConfigDetails.htm。

要配置 MSDE 提供程序以用于缓存，您必须创建该缓存块所使用的必要表格和存储过程。

创建表格和过程

在将 MSDE 提供程序用于队列时，您必须创建“消息数据管理”子系统所使用的必要数据库。

创建数据库

消息队列

在将 MSMQ 提供程序用于队列之前，您必须在本地计算机上配置“消息队列”。有关详细信息，请参阅 Microsoft Message Queuing (MSMQ) Center (http://www.Microsoft.com/windows2000/technologies/communications/msmq/default.asp)

如果不存在队列，Offline Application Block 将创建一个。建议您在使用消息队列提供程序之前，手动创建一个队列。这可让您根据组织的安全要求来灵活地配置“消息队列”。以下步骤说明如何手动创建队列。

手动创建专用队列

有关部署要求和注意事项的详细信息，请参阅第 4 章。

返回页首

小结

Offline Application Block 为您提供了可用于将脱机功能添加到应用程序的灵活设计和基础结构。在许多情况下，您可以将随附的提供程序用于子系统。在某些情况下，您需要自定义这些提供程序或创建自己的提供程序。Offline Application Block 提供的这些快速入门为您提供了理解如何使用该应用程序块的有用起点。

返回页首

更多信息

有关 MSDE 的详细信息，请参阅“Distributing the SQL Server Desktop Engine”。

有关 SQL Server 的详细信息，请参阅 SQL Server。

有关消息队列的详细信息，请参阅“Message Queuing (MSMQ) ”？

有关 DPAPI 的详细信息，请参阅 Windows Data Protection。

转到原英文页面