如何使用简单注入器注册 Windows 窗体
本文关键字:Windows 窗体 注册 注入器 何使用 简单 | 更新日期: 2023-09-27 17:57:11
Background
我正在构建一个 winforms 应用程序,其中我使用 IoC 容器(SimpleInjector)来注册我的类型。在我的应用程序中,大多数屏幕(即表单)在任何给定时间都只有一个实例。
问题
对于在任何给定时间只需要一个实例的表单,我可以将它们注册为单例:
container.Register<IHomeView, HomeView>(Lifestyle.Singleton);
这允许我使用容器来跟踪所有表单。但是,在这种情况下,当表单关闭时,它将被释放(表单实现 IDisposable)。如果应用程序尝试使用容器再次打开该窗体,则将释放该窗体的容器实例,并引发异常。
问题
处理这个问题的正确方法是什么?我目前看到两种解决方案:
- 对于每个窗体,覆盖窗体关闭
- 以隐藏窗体,而不是实际关闭窗体。我真的不喜欢这个想法。我觉得我宁愿每次都关闭表单,然后从一个新的/新的表单开始。
- 使用短暂的生活方式而不是单例注册表单。在这种情况下,容器实际上更像是一个工厂。我遇到了两个问题:a) 我失去了通过容器跟踪表单的能力,b) 容器在验证期间抛出异常,指出一次性类型不应注册为瞬态(我不明白为什么会这样)。这些问题也适用于我一次需要多个实例的表单。
我可以通过在验证期间抑制诊断警告来绕过问题 b)。
registration = container.GetRegistration(typeof(ILoginView)).Registration;
registration.SuppressDiagnosticWarning(
DiagnosticType.DisposableTransientComponent,
"Winforms registration supression.");
在这里采取的正确方法是什么?我错过了什么吗?
理想情况下,您希望将表单注册为 Singleton
.但是,根据我的经验,这将导致难以调试的错误,尤其是当您使用BindingSource
将数据绑定到任何内容时。
使用Singleton
作为生活方式的第二个问题是,如果您的应用程序使用无模式窗口,则此窗口在第二次打开时将引发ObjectDisposedException
,因为 Windows 窗体应用程序框架将在第一次关闭时释放窗体,而简单注入器应负责此。因此,简单注入器将创建一个 - 并且正好是一个 - 实例,如果注册为单例。如果其他人(例如您的应用程序,Windows 窗体框架)将释放该对象,则不会重新创建该对象。
最简单的解决方案也很容易理解,是将您的表单注册为 Transient
.是的,您需要禁止显示诊断警告。根据文档显示此诊断警告的原因:
实现
IDisposable
的组件通常需要确定性清理,但简单注入器不会隐式跟踪和处置注册到瞬态生活方式的组件。
简单注入器无法释放瞬态组件,因为它无法确定何时应释放对象。然而,这意味着,以模态方式打开并调用.ShowDialog()
的表单将永远不会被处理掉!由于 Windows 窗体应用程序通常运行很长时间,甚至可能运行一周或一个月,这最终将导致"Win32Exception",并显示一条消息:"创建窗口句柄时出错"。这实质上意味着您耗尽了计算机的所有资源。
因此,处理表格很重要。尽管如果您使用Scope,Simple Injector能够完成这项工作,但这是Windows窗体不太容易实现的。因此,您自己必须注意处理已使用ShowDialog()
显示的已关闭表单。
根据您的特定用例,有几种方法可以实现FormOpener
或NavigationService
。一种方法是:
public interface IFormOpener
{
void ShowModelessForm<TForm>() where TForm : Form;
DialogResult ShowModalForm<TForm>() where TForm : Form;
}
public class FormOpener : IFormOpener
{
private readonly Container container;
private readonly Dictionary<Type, Form> openedForms;
public FormOpener(Container container)
{
this.container = container;
this.openedForms = new Dictionary<Type, Form>();
}
public void ShowModelessForm<TForm>() where TForm : Form
{
Form form;
if (this.openedForms.ContainsKey(typeof(TForm)))
{
// a form can be held open in the background, somewhat like
// singleton behavior, and reopened/reshown this way
// when a form is 'closed' using form.Hide()
form = this.openedForms[typeof(TForm)];
}
else
{
form = this.GetForm<TForm>();
this.openedForms.Add(form.GetType(), form);
// the form will be closed and disposed when form.Closed is called
// Remove it from the cached instances so it can be recreated
form.Closed += (s, e) => this.openedForms.Remove(form.GetType());
}
form.Show();
}
public DialogResult ShowModalForm<TForm>() where TForm : Form
{
using (var form = this.GetForm<TForm>())
{
return form.ShowDialog();
}
}
private Form GetForm<TForm>() where TForm : Form
{
return this.container.GetInstance<TForm>();
}
}
此类必须注册为 Singleton
:
container.RegisterSingleton<IFormOpener, FormOpener>();
并且可以通过将此服务注入例如应用程序的根形式来使用:
public partial class RootForm : Form
{
private readonly IFormOpener formOpener;
public RootForm(IFormOpener formOpener)
{
this.formOpener = formOpener;
this.InitializeComponent();
}
private void ShowCustomers_Click(object sender, EventArgs e)
{
this.formOpener.ShowModelessForm<AllCustomersForm>();
}
private void EditCustomer_Click(object sender, EventArgs e)
{
var result = this.formOpener.ShowModalForm<EditCustomerForm>();
// do something with result
}
}