如何使用简单注入器注册 Windows 窗体

背景

我正在构建一个 winforms 应用程序，其中使用 IoC 容器 (SimpleInjector) 来注册我的类型。在我的应用程序中，大多数屏幕（即表单）在任何给定时间都只有一个实例。

Problem

对于在任何给定时间只需要一个实例的表单，我可以将它们注册为单例：

container.Register<IHomeView, HomeView>(Lifestyle.Singleton);

这允许我使用容器来跟踪所有表单。然而，在这种情况下，当表单关闭时，它将被释放（表单实现 IDisposable）。如果应用程序尝试使用容器再次打开该表单，则该表单的容器实例将被释放，并引发异常。

Question

处理这个问题的正确方法是什么？我目前看到两种解决方案：

1. 对于每个表单，覆盖表单关闭而不是隐藏表单，而不是实际关闭它。我真的不喜欢这个主意。我觉得我宁愿每次都关闭表单并从新的/新鲜的表单开始。
2. 以短暂的生活方式而非单身人士的身份注册表格。在这种情况下，容器实际上更像是一个工厂。我遇到两个问题：a）我失去了通过容器跟踪表单的能力，b）容器在验证过程中抛出异常，表示一次性类型不应注册为瞬态（我不明白为什么会这样） ）。这些问题都适用于我同时需要多个实例的表单。

我可以通过在验证期间抑制诊断警告来解决问题 b)。

registration = container.GetRegistration(typeof(ILoginView)).Registration;
registration.SuppressDiagnosticWarning(
    DiagnosticType.DisposableTransientComponent,
    "Winforms registration supression.");

这里采取的正确方法是什么？我错过了什么吗？

理想情况下，您希望将表单注册为Singleton。然而，根据我的经验，这将导致难以调试的错误，特别是当您使用BindingSource https://msdn.microsoft.com/en-us/library/system.windows.forms.bindingsource.datasource(v=vs.110).aspx用于将您的数据绑定到任何内容。

使用中的第二个问题Singleton因为生活方式是，如果您的应用程序使用无模式窗口，该窗口将抛出一个ObjectDisposedException第二次打开时，因为 Windows 窗体应用程序框架将在第一次关闭时处理该窗体，而简单注入器应负责该操作。因此，如果注册为 Singleton，Simple Injector 将创建一个（而且恰好是一个）实例。如果其他人（例如您的应用程序、Windows 窗体框架）将处置该对象，则不会重新创建该对象。

最简单的解决方案也很容易理解，是将您的表单注册为Transient。是的，您需要抑制诊断警告。根据该诊断警告的原因文档 https://simpleinjector.org/diadt:

一个实现的组件IDisposable通常需要确定性清理，但简单注入器不会隐式跟踪和处置使用瞬态生活方式注册的组件。

简单注入器无法处置瞬态组件，因为它无法确定何时应处置对象。然而，这意味着通过调用以模式方式打开的表单.ShowDialog()永远不会被处置！而且由于 Windows 窗体应用程序通常会运行很长时间，甚至可能是一周或一个月，因此这最终会导致'Win32异常' https://msdn.microsoft.com/en-us/library/system.componentmodel.win32exception(v=vs.110).aspx并显示一条消息：“创建窗口句柄时出错”。这本质上意味着您耗尽了计算机的所有资源。

因此，处理表格很重要。尽管简单注射器能够完成这项工作，但如果您使用Scope https://simpleinjector.org/lifestyles#scoped，这对于 Windows Forms 来说不是那么容易实现的。因此，您自己必须负责处理已使用显示的封闭表格ShowDialog().

根据您的具体用例，有多种方法可以实现FormOpener or 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
    }
}