.NET Framework 包含外接程序模型, 开发人员可以使用该模型来创建支持外接程序扩展性的应用程序。 借助此外接程序模型,可以创建与应用程序功能集成并进行扩展的外接程序。 在某些情况下, 应用程序还需要显示外接程序提供的用户界面。本主题演示 WPF 如何补充 .NET Framework 外接程序模型, 以实现这些方案、其背后的体系结构、其优点和其局限性。
系统必备
熟悉 .NET Framework 外接程序模型是必需的。 有关详细信息,请参阅外接程序和扩展性。
外接程序概述
为了需要对应用程序重新编译和重新部署才能引入新功能这一复杂过程,应用程序实现了扩展机制,使开发者(包括第一方和第三方)能够创建与应用程序集成的其他应用程序。 支持此扩展性类型的最常见方式是,使用外接程序(也称为“加载项”和“插件”)。 通过外接程序公开扩展性的实际应用程序示例包括:
-
Internet Explorer 加载项。
-
Windows Media Player 插件。
-
Visual Studio 外接程序。
例如,通过 Windows Media Player 外接程序模型,第三方开发人员可以实现“插件”,从而以各种方式对 Windows Media Player 进行扩展,包括为 Windows Media Player 本身不支持的媒体格式(例如 DVD、MP3)创建解码器和编码器,创建音频效果和外观。 尽管有一些实体和行为是所有外接程序模型共有的,但会生成每个外接程序模型以公开某个应用程序的特有功能。
典型外接程序扩展性解决方案的三大实体是“协定”、“外接程序”和“主机应用程序”。 协定会定义外接程序与主机应用程序之间的两种集成方式:
-
外接程序集成主机应用程序所实现的功能。
-
主机应用程序公开供外接程序集成的功能。
为了使外接程序能发挥作用,主机应用程序需要在运行时找到它们并进行加载。 因此,支持外接程序的应用程序需要承担以下附加的职责:
-
发现:查找符合主机应用程序支持的协定的外接程序。
-
激活:加载、运行和建立与外接程序的通信。
-
隔离:使用应用程序域或进程来建立隔离边界, 以保护应用程序不受加载项的潜在安全性和执行问题的限制。
-
通信:通过调用方法和传递数据, 允许外接程序和宿主应用程序跨隔离边界彼此进行通信。
-
生存期管理:以干净、可预测的方式加载和卸载应用程序域和进程 (请参阅应用程序域)。
-
版本控制:确保在创建新版本的时, 主机应用程序和外接程序仍可进行通信。
总之,开发一个可靠的外接程序模型不是一项简单的任务。 出于此原因, .NET Framework 提供了一个用于生成外接程序模型的基础结构。
Note: 有关外接程序的更多详细信息,请参阅外接程序和扩展性。
.NET Framework 外接程序模型概述
xref:System.AddIn命名空间中的 .NET Framework 外接程序模型包含一组类型, 这些类型旨在简化外接程序扩展性的开发。 .NET Framework 外接程序模型的基本单位为协定, 该协定定义主机应用程序和外接程序之间的通信方式。 会使用特定于主机应用程序的协定视图向主机应用程序公开协定。 同样,向外接程序公开特定于外接程序的协定视图。 使用适配器,主机应用程序和外接程序可以在它们各自的协定视图之间进行通信。 协定、视图和适配器称为管道段,一组相关的管道段组成一条管道。 管道是 .NET Framework 外接程序模型支持发现、激活、安全隔离、执行隔离 (使用应用程序域和进程)、通信、生存期管理和版本控制的基础。
所有这些支持使得开发人员能够生成与主机应用程序的功能相集成的外接程序。 不过, 某些方案需要宿主应用程序显示外接程序提供的用户界面。由于 .NET Framework 中的每个表示技术都有自己的模型来实现用户界面, .NET Framework 外接程序模型不支持任何特定的表示技术。 而 WPF 却扩展了 .NET Framework 外接程序模型, 其中包含外接程序的 UI 支持。
WPF 外接程序
WPF 与 .NET Framework 外接程序模型一起使用, 可以解决需要宿主应用程序从外接程序显示用户界面的各种方案。具体而言, WPF 使用以下两种编程模型解决了这些方案:
-
外接程序返回 UI。 外接程序通过方法调用向宿主应用程序返回一个 UI, 由协定定义。 此方案可用于以下情况:
-
外接程序返回的 UI 的外观依赖于只在运行时存在的数据或条件, 如动态生成的报表。
-
外接程序提供的服务的 UI 不同于可以使用外接程序的宿主应用程序的 UI。
-
外接程序主要为主机应用程序执行服务, 并使用 UI 向主机应用程序报告状态。
-
-
外接程序为 UI。 外接程序是由协定定义的 UI。 此方案可用于以下情况:
-
外接程序提供的服务都需要显示,例如广告。
-
外接程序提供的服务的 UI 对于所有可使用该外接程序的宿主应用程序 (如计算器或颜色选取器) 都是通用的。
-
这些方案要求可以在主机应用程序和外接程序应用程序域之间传递 UI 对象。 由于 .NET Framework 外接程序模型依赖于远程处理来在应用程序域之间进行通信, 因此在它们之间传递的对象必须是可远程处理的。
可远程处理的对象是某个类的实例,并执行以下一个或多个任务:
Note: 有关创建可远程处理 .NET Framework 对象的详细信息, 请参阅使对象可远程处理。
WPF UI 类型不能远程处理。 为了解决此问题, WPF 扩展了 .NET Framework 外接程序模型, 以允许从主机应用程序显示外接程序创建的 WPF UI。 此支持由 WPF 通过两xref:System.AddIn.Contract.INativeHandleContract种类型提供: xref:System.AddIn.Pipeline.FrameworkElementAdapters由类实现的接口和两个静态方法: xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*和xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*。 从较高层面来看,这些类型和方法按以下方式使用:
-
WPF 要求外接程序提供的用户界面是直接或间接从xref:System.Windows.FrameworkElement派生的类, 如形状、控件、用户控件、布局面板和页面。
-
无论协定声明在外接程序和宿主应用程序之间传递 UI, 都必须将其声明为xref:System.AddIn.Contract.INativeHandleContract ( xref:System.Windows.FrameworkElement而非)。xref:System.AddIn.Contract.INativeHandleContract是可跨隔离边界传递的外接程序 UI 的可远程表示形式。
-
在从外接程序的应用程序域中传递xref:System.Windows.FrameworkElement时, xref:System.AddIn.Contract.INativeHandleContract通过调用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*将作为打包成。
-
向宿主应用程序的应用程序域传递后, xref:System.AddIn.Contract.INativeHandleContract必须xref:System.Windows.FrameworkElement通过调用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*将重新打包为。
如何xref:System.AddIn.Contract.INativeHandleContract使用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*、、 xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*和取决于具体的方案。 下面几节介绍每个编程模型的详细信息。
外接程序返回用户界面
若要使外接程序向宿主应用程序返回 UI, 需要满足以下要求:
-
必须创建宿主应用程序、外接程序和管道, 如 .NET Framework外接程序和扩展性文档中所述。
-
协定必须实现xref:System.AddIn.Contract.IContract并返回 UI, 协定必须使用类型xref:System.AddIn.Contract.INativeHandleContract为的返回值声明方法。
-
在外接程序和宿主应用程序之间传递的 UI 必须直接或间接从xref:System.Windows.FrameworkElement派生。
-
必须xref:System.Windows.FrameworkElement xref:System.AddIn.Contract.INativeHandleContract先将外接程序返回的 UI 从转换为, 然后才能跨越隔离边界。
-
在跨越隔离边界之后, 必须将返回的xref:System.AddIn.Contract.INativeHandleContract UI 从转换为。 xref:System.Windows.FrameworkElement
-
宿主应用程序将显示返回xref:System.Windows.FrameworkElement的。
有关演示如何实现返回 UI 的外接程序的示例, 请参阅创建返回 Ui 的外接程序。
外接程序为用户界面
当外接程序为 UI 时, 需要以下各项:
-
必须创建宿主应用程序、外接程序和管道, 如 .NET Framework外接程序和扩展性文档中所述。
-
外接程序的协定接口必须实现xref:System.AddIn.Contract.INativeHandleContract。
-
传递到主机应用程序的外接程序必须直接或间接从xref:System.Windows.FrameworkElement派生。
-
在越过隔离边界xref:System.Windows.FrameworkElement xref:System.AddIn.Contract.INativeHandleContract之前, 外接程序必须从转换为。
-
在越过隔离边界xref:System.AddIn.Contract.INativeHandleContract xref:System.Windows.FrameworkElement后, 外接程序必须从转换为。
-
宿主应用程序将显示返回xref:System.Windows.FrameworkElement的。
有关演示如何实现作为 UI 的外接程序的示例, 请参阅创建作为 ui 的外接程序。
从外接程序返回多个 UI
外接程序通常为宿主应用程序提供多个用户界面以显示。 例如, 请考虑作为 UI 的外接程序, 该外接程序还向宿主应用程序提供状态信息。 此类外接程序可以通过结合使用外接程序返回用户界面和外接程序为用户界面模型中的技术来实现。
外接程序和 XAML 浏览器应用程序
到目前为止,示例中的主机应用程序都安装为独立应用程序。 但是,如果满足以下附加的生成和实现要求,XAML 浏览器应用程序 (XBAP) 也可以承载外接程序:
-
必须对XBAP应用程序清单进行专门配置, 以将管道 (文件夹和程序集) 和外接程序程序集下载到客户端计算机上的 ClickOnce 应用程序缓存中, 这与位于相同的文件夹中。 XBAP
-
用于发现和加载外接程序的XBAP 代码必须使用作为管道和外接程序位置的ClickOnce应用程序缓存。XBAP
-
如果外接程序引用位于源站点的松散文件,则 XBAP 必须将外接程序加载到专门的安全上下文中;在由 XBAP 承载时,外接程序只能引用位于主机应用程序源站点的松散文件。
下面几个小节将详细介绍这些任务。
配置用于 ClickOnce 部署的管道和外接程序
XBAP下载到 ClickOnce 部署缓存中的安全文件夹并从该文件夹运行。 为了使 XBAP 能够承载外接程序,还必须将管道和外接程序程序集下载到该安全文件夹。 为此,需要将应用程序清单配置为包含要下载的管道和外接程序程序集。 这在 Visual Studio 中最容易实现,但为使 Visual Studio 检测到管道程序集,管道和外接程序程序集需要位于宿主 XBAP 项目的根文件夹中。
因此,第一步是通过设置每个管道程序集和外接程序程序集项目的生成输出,向 XBAP 项目的根文件夹生成管道和外接程序程序集。 下表显示管道程序集项目和外接程序程序集项目的生成输出路径,这些路径位于与宿主 XBAP 项目相同的解决方案和根文件夹中。
表 1:XBAP 承载的管道程序集的生成输出路径
| 管道程序集项目 | 生成输出路径 |
|---|---|
| 协定 | ..\HostXBAP\Contracts\ |
| 加载项视图 | ..\HostXBAP\AddInViews\ |
| 加载项方适配器 | ..\HostXBAP\AddInSideAdapters\ |
| 宿主端适配器 | ..\HostXBAP\HostSideAdapters\ |
| 外接程序 | ..\HostXBAP\AddIns\WPFAddIn1 |
下一步是通过在 Visual Studio 中执行以下操作,将管道程序集和外接程序程序集指定为 XBAP 内容文件:
-
通过在“解决方案资源管理器”中右键单击每个管道文件夹,然后选择“包括在项目中”,将管道和外接程序程序集包括在项目中。
-
在“属性”窗口中,将每个管道程序集和外接程序程序集的“生成操作”都设置为“内容”。
最后一步是配置应用程序清单,以包含要下载的管道程序集文件和外接程序程序集文件。 文件应位于XBAP应用程序所占用的 ClickOnce 缓存中文件夹根目录的文件夹中。 通过执行以下操作,可以在 Visual Studio 中实现该配置:
-
右键单击 XBAP 项目,依次单击“属性”、“发布”,然后单击“应用程序文件”按钮。
-
在“应用程序文件”对话框中,将每个管道和外接程序 DLL 的“发布状态”都设置为“包括(自动)”,并将每个管道和外接程序 DLL 的“下载组”都设置为“(必需)”。
从应用程序基使用管道和外接程序
为 ClickOnce 部署配置管道和外接程序时, 会将它们下载到与相同的 ClickOnce 缓存文件夹XBAP中。 若要从 XBAP 中使用管道和外接程序,XBAP 代码必须从应用程序基获取它们。 使用管道和外接程序的 .NET Framework 外接程序模型的各种类型和成员为此方案提供特殊支持。 首先, 路径由xref:System.AddIn.Hosting.PipelineStoreLocation.ApplicationBase枚举值标识。 将此值用于使用管道的相关外接程序成员的重载,这些成员包括:
访问宿主的源站点
为确保外接程序可以引用源站点的文件,必须使用等效于主机应用程序的安全隔离来加载外接程序。 此安全级别由xref:System.AddIn.Hosting.AddInSecurityLevel.Host?displayProperty=nameWithType枚举值标识, 并在激活外接程序时传递xref:System.AddIn.Hosting.AddInToken.Activate*给方法。
WPF 外接程序体系结构
正如我们所看到的, 在最高级别, WPF 允许 .NET Framework xref:System.Windows.FrameworkElement外接程序使用xref:System.AddIn.Contract.INativeHandleContract、 xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*和xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*实现用户界面 (直接或间接从派生)。 结果是, 主机应用程序返回了一个xref:System.Windows.FrameworkElement , 它从主机应用程序的 UI 中显示。
对于简单的 UI 外接程序方案, 这是开发人员所需的详细信息。 对于更复杂的方案 (尤其是那些尝试使用其他 WPF 服务 (如布局、资源和数据绑定) 的方案, 需要 WPF 如何扩展带有 UI 支持的 .NET Framework 外接程序模型, 以了解其优势和限制。
从根本上讲, WPF 不会将 UI 从外接程序传递到主机应用程序;而是使用 WPF 互操作性为 UI 传递 Win32 窗口句柄。 因此, 当外接程序中的 UI 被传递到主机应用程序时, 将发生以下情况:
-
在外接程序端, WPF 会为将由主机应用程序显示的 UI 获取一个窗口句柄。 窗口句柄由派生自xref:System.Windows.Interop.HwndSource并实现xref:System.AddIn.Contract.INativeHandleContract的内部 WPF 类封装。 此类的实例由xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*返回, 并从外接程序的应用程序域封送到主机应用程序的应用程序域。
-
在宿主应用程序端, wpf 将xref:System.Windows.Interop.HwndSource作为从xref:System.Windows.Interop.HwndHost派生并使用xref:System.AddIn.Contract.INativeHandleContract的内部 WPF 类重新打包。 此类的实例由xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*向宿主应用程序返回。
xref:System.Windows.Interop.HwndHost存在, 用于显示 WPF 用户界面中由窗口句柄标识的用户界面。 有关详细信息,请参阅 WPF 和 Win32 互操作。
xref:System.AddIn.Contract.INativeHandleContract摘要、 xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*、和xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*存在, 以允许将 WPF UI 的窗口句柄从外接xref:System.Windows.Interop.HwndHost程序传递到主机应用程序, 在该应用程序中, 它由进行封装并显示宿主应用程序的 UI。
Note: 由于宿主应用程序获取xref:System.Windows.Interop.HwndHost, 因此主机应用程序无法将返回的对象转换为由xref:System.AddIn.Pipeline.FrameworkElementAdapters.ContractToViewAdapter*外接程序实现的类型xref:System.Windows.Controls.UserControl(例如)。
本质上, xref:System.Windows.Interop.HwndHost具有某些限制, 它们会影响主机应用程序使用它们的方式。 不过, WPF 扩展xref:System.Windows.Interop.HwndHost了多个外接程序方案的功能。 下面介绍这些优点和限制。
WPF 外接程序的优点
因为 wpf 外接程序用户界面是使用派生自xref:System.Windows.Interop.HwndHost的内部类从主机应用程序显示的, 所以这些用户界面受xref:System.Windows.Interop.HwndHost与 WPF UI 服务 (如布局) 有关的功能的限制。呈现、数据绑定、样式、模板和资源。 不过, WPF 通过其他功能xref:System.Windows.Interop.HwndHost增强了其内部子类, 其中包括:
-
在宿主应用程序的 UI 和外接程序的 UI 之间进行 tab 键切换。 请注意, "外接程序是 UI" 编程模型要求外接程序端适配器进行重写xref:System.AddIn.Pipeline.ContractBase.QueryContract* , 以启用 tab 键切换, 无论外接程序是完全信任的还是部分信任的。
-
满足从主机应用程序用户界面中显示的外接程序用户界面的辅助功能要求。
-
允许 WPF 应用程序在多个应用程序域方案中安全运行。
-
当外接程序以安全隔离 (即部分信任的安全沙盒) 运行时, 防止非法访问外接程序 UI 窗口句柄。 调用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*可确保安全:
-
对于 "外接程序返回 UI" 编程模型, 传递跨隔离边界的外接程序 UI 的窗口句柄的唯一方法是调用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter*。
-
对于 "外接程序是 UI" 编程模型, 需要在外xref:System.AddIn.Pipeline.ContractBase.QueryContract*接程序端适配器上重写并调用xref:System.AddIn.Pipeline.FrameworkElementAdapters.ViewToContractAdapter* (如前面的示例所示), 就像调用外接程序端适配器的
QueryContract实现时,主机端适配器。
-
-
提供多个应用程序域执行保护。 由于应用程序域的限制,因此即使存在隔离边界,外接程序应用程序域中引发的未经处理的异常也会导致整个应用程序出现故障。 不过, WPF 和 .NET Framework 外接程序模型提供一种简单的方法来解决此问题并提高应用程序的稳定性。 如果主机应用程序是 wpf 应用程序, 则显示xref:System.Windows.Threading.Dispatcher UI 的 WPF 外接程序将为运行应用程序域的线程创建。 通过处理xref:System.Windows.Threading.Dispatcher.UnhandledException WPF 外接程序的xref:System.Windows.Threading.Dispatcher事件, 可以检测应用程序域中发生的所有未经处理的异常。 xref:System.Windows.Threading.Dispatcher 可以xref:System.Windows.Threading.Dispatcher.CurrentDispatcher*从属性获取。
WPF 外接程序限制
除了 WPF 添加到xref:System.Windows.Interop.HwndSource、 xref:System.Windows.Interop.HwndHost和窗口句柄提供的默认行为以外, 还存在从主机应用程序显示的外接程序用户界面的限制:
-
宿主应用程序显示的外接程序用户界面不遵守主机应用程序的剪辑行为。
-
互操作性方案中的“空域”概念也适用于外接程序(请参阅技术区概述)。
-
宿主应用程序的 UI 服务 (如资源继承、数据绑定和命令) 不会自动提供给外接程序用户界面。 若要向外接程序提供这些服务,需要更新管道。
-
外接程序 UI 不能旋转、缩放、倾斜或以其他方式受转换的影响 (请参阅转换概述)。
-
由xref:System.Drawing命名空间的绘图操作呈现的外接程序用户界面内的内容可以包含 alpha 混合。 但是, 加载项 UI 和包含它的主机应用程序 UI 必须是 100% 不透明;换言之, 两者上的
Opacity属性必须设置为1。 -
如果宿主xref:System.Windows.Window.AllowsTransparency*应用程序中包含外接程序 UI 的窗口的属性设置为
true, 则外接程序将不可见。 即使外接程序 UI 为 100% 不透明 (也就是说,Opacity属性的值为 1), 也是如此。 -
外接程序 UI 必须出现在同一顶级窗口中的其他 WPF 元素之上。
-
外接程序的 UI 不能使用xref:System.Windows.Media.VisualBrush呈现。 相反, 外接程序可能会拍摄生成的 UI 的快照, 以创建一个可以使用协定所定义的方法传递到主机应用程序的位图。
-
xref:System.Windows.Controls.MediaElement在外接程序 UI 中, 无法从中播放媒体文件。
-
为外接程序 ui 生成的鼠标事件既不是由宿主应用程序接收也不会引发
IsMouseOver, 主机应用程序 ui 的属性的false值为。 -
当焦点在外接程序 UI 中的控件之间移动时
GotFocus,LostFocus和事件既不会接收, 也不会由主机应用程序引发。 -
在打印时, 包含外接程序 UI 的主机应用程序部分显示为白色。
-
如果主机应用程序xref:System.Windows.Threading.Dispatcher继续执行, 则在卸载 owner 外接程序之前, 必须手动关闭外接程序 UI 创建的所有调度程序 (请参见)。 协定可以实现一些方法, 这些方法允许主机应用程序在外接程序卸载之前通知外接程序, 从而允许外接程序 UI 关闭其调度程序。
-
如果外接程序 UI 是xref:System.Windows.Controls.InkCanvas或xref:System.Windows.Controls.InkCanvas包含, 则不能卸载外接程序。
性能优化
默认情况下, 当使用多个应用程序域时, 每个应用程序所需的各种 .NET Framework 程序集都将加载到该应用程序的域中。 因此,创建新应用程序域和在应用程序域中启动应用程序所需的时间可能会影响性能。 不过, 通过指示应用程序在已加载的应用程序域之间共享程序集, .NET Framework 提供了一种减少开始时间的方法。 为xref:System.LoaderOptimizationAttribute此, 需要使用属性, 该属性必须应用于入口点方法 (Main)。 这种情况下,只能使用代码来实现应用程序定义(请参阅应用程序管理概述)。
请参阅
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
