能否让 Unity 始终不抛出 SynchronizationLockException？

Question

Unity 依赖注入容器存在一个众所周知的问题，即 SynchronizedLifetimeManager 通常会导致 Monitor.Exit 方法抛出 SynchronizationLockException，然后该异常会被捕获并忽略。这对我来说是一个问题，因为我喜欢使用 Visual Studio 进行调试，设置为在任何引发的异常上中断，因此每次我的应用程序启动时，我都会无缘无故地多次中断此异常。

如何防止抛出此异常？

无论网络上其他地方提到此问题，建议通常都会涉及更改调试器设置以忽略它。这类似于去找医生说：“医生，医生，我举起手臂时会疼”，然后医生告诉他：“好吧，别再举起它了。”我正在寻找一种解决方案，可以首先阻止抛出异常。

异常发生在 SetValue 方法中，因为它假设首先调用 GetValue，然后调用 Monitor.Enter。但是，LifetimeStrategy 和 UnityDefaultBehaviorExtension 类都会定期调用 SetValue，而不调用 GetValue。

我不想更改源代码并维护我自己的 Unity 版本，因此我希望有一个解决方案，可以在其中向容器添加一些扩展、策略或策略的组合，以确保，如果生命周期管理器是一个 SynchronizedLifetimeManager，GetValue 总是在其他任何事情之前被调用。

Answer 1

我确信代码可以通过很多方式调用 SynchronizedLifetimeManager 或像 ContainerControlledLifetimeManager 这样的后代，但是有两种情况特别给我带来了问题。

第一个是我自己的错误 - 我使用构造函数注入来提供对容器的引用，并且在该构造函数中，我还将该类的新实例添加到容器中以供将来使用。这种向后方法的效果是将生命周期管理器从 Transient 更改为 ContainerControlled，以便 Unity 调用 GetValue 的对象与其调用 SetValue 的对象不同。吸取的教训是在构建过程中不要执行任何可能更改对象生命周期管理器的操作。

第二种情况是每次调用RegisterInstance 时，UnityDefaultBehaviorExtension 都会调用SetValue，而不先调用GetValue。幸运的是，Unity 具有足够的可扩展性，只要有足够的热心，您就可以解决这个问题。

从这样的新行为扩展开始：

/// <summary>
/// Replaces <see cref="UnityDefaultBehaviorExtension"/> to eliminate 
/// <see cref="SynchronizationLockException"/> exceptions that would otherwise occur
/// when using <c>RegisterInstance</c>.
/// </summary>
public class UnitySafeBehaviorExtension : UnityDefaultBehaviorExtension
{
    /// <summary>
    /// Adds this extension's behavior to the container.
    /// </summary>
    protected override void Initialize()
    {
        Context.RegisteringInstance += PreRegisteringInstance;

        base.Initialize();
    }

    /// <summary>
    /// Handles the <see cref="ExtensionContext.RegisteringInstance"/> event by
    /// ensuring that, if the lifetime manager is a 
    /// <see cref="SynchronizedLifetimeManager"/> that its 
    /// <see cref="SynchronizedLifetimeManager.GetValue"/> method has been called.
    /// </summary>
    /// <param name="sender">The object responsible for raising the event.</param>
    /// <param name="e">A <see cref="RegisterInstanceEventArgs"/> containing the
    /// event's data.</param>
    private void PreRegisteringInstance(object sender, RegisterInstanceEventArgs e)
    {
        if (e.LifetimeManager is SynchronizedLifetimeManager)
        {
            e.LifetimeManager.GetValue();
        }
    }
}

然后您需要一种方法来替换默认行为。 Unity 没有删除特定扩展的方法，因此您必须删除所有内容并再次将其他扩展放回原处：

public static IUnityContainer InstallCoreExtensions(this IUnityContainer container)
{
    container.RemoveAllExtensions();
    container.AddExtension(new UnityClearBuildPlanStrategies());
    container.AddExtension(new UnitySafeBehaviorExtension());

#pragma warning disable 612,618 // Marked as obsolete, but Unity still uses it internally.
    container.AddExtension(new InjectedMembers());
#pragma warning restore 612,618

    container.AddExtension(new UnityDefaultStrategiesExtension());

    return container;
}

注意到 UnityClearBuildPlanStrategies 了吗？ RemoveAllExtensions 清除了容器的所有内部策略和策略列表（除了一个），因此我不得不使用另一个扩展来避免在恢复默认扩展时插入重复项：

/// <summary>
/// Implements a <see cref="UnityContainerExtension"/> that clears the list of 
/// build plan strategies held by the container.
/// </summary>
public class UnityClearBuildPlanStrategies : UnityContainerExtension
{
    protected override void Initialize()
    {
        Context.BuildPlanStrategies.Clear();
    }
}

现在您可以安全地使用 RegisterInstance，而不必担心被逼到崩溃的边缘。疯狂。为了确定起见，这里有一些测试：

[TestClass]
public class UnitySafeBehaviorExtensionTests : ITest
{
    private IUnityContainer Container;
    private List<Exception> FirstChanceExceptions;

    [TestInitialize]
    public void TestInitialize()
    {
        Container = new UnityContainer();
        FirstChanceExceptions = new List<Exception>();
        AppDomain.CurrentDomain.FirstChanceException += FirstChanceExceptionRaised;
    }

    [TestCleanup]
    public void TestCleanup()
    {
        AppDomain.CurrentDomain.FirstChanceException -= FirstChanceExceptionRaised;
    }

    private void FirstChanceExceptionRaised(object sender, FirstChanceExceptionEventArgs e)
    {
        FirstChanceExceptions.Add(e.Exception);
    }

    /// <summary>
    /// Tests that the default behavior of <c>UnityContainer</c> leads to a <c>SynchronizationLockException</c>
    /// being throw on <c>RegisterInstance</c>.
    /// </summary>
    [TestMethod]
    public void UnityDefaultBehaviorRaisesExceptionOnRegisterInstance()
    {
        Container.RegisterInstance<ITest>(this);

        Assert.AreEqual(1, FirstChanceExceptions.Count);
        Assert.IsInstanceOfType(FirstChanceExceptions[0], typeof(SynchronizationLockException));
    }

    /// <summary>
    /// Tests that <c>UnitySafeBehaviorExtension</c> protects against <c>SynchronizationLockException</c>s being
    /// thrown during calls to <c>RegisterInstance</c>.
    /// </summary>
    [TestMethod]
    public void SafeBehaviorPreventsExceptionOnRegisterInstance()
    {
        Container.RemoveAllExtensions();
        Container.AddExtension(new UnitySafeBehaviorExtension());
        Container.AddExtension(new InjectedMembers());
        Container.AddExtension(new UnityDefaultStrategiesExtension());

        Container.RegisterInstance<ITest>(this);

        Assert.AreEqual(0, FirstChanceExceptions.Count);
    }
}

public interface ITest { }

Answer 2

已修复 在最新版本的 Unity (2.1.505.2) 中。通过 NuGet 获取它。

Answer 3

不幸的是，你的问题的答案是否定的。我与 Microsoft 模式与开发团队的开发团队跟进了此事。实践小组（直到最近我还是那里的开发负责人），我们将此作为 EntLib 5.0 需要考虑的错误。我们做了一些调查，得出的结论是，这是由我们的代码和调试器之间的一些意外交互引起的。我们确实考虑过修复，但事实证明这比现有代码更复杂。最后，这件事的优先级低于其他事情，并且没有达到 5 分的标准。

抱歉，我没有更好的答案给你。如果说这有什么安慰的话，我也觉得很烦人。

Answer 4

我使用这个简短的解决方案：

/// <summary>
/// KVV 20110502
/// Fix for bug in Unity throwing a synchronizedlockexception at each register
/// </summary>
class LifeTimeManager : ContainerControlledLifetimeManager
{
    protected override void SynchronizedSetValue(object newValue)
    {
        base.SynchronizedGetValue();
        base.SynchronizedSetValue(newValue);
    }
}

并像这样使用它：

private UnityContainer _container;
...
_container.RegisterInstance(instance, new LifeTimeManager());

问题是ContainerControlledLifetimeManager的基类期望SynchronizedSetValue通过base.GetValue执行monitor.Enter()，但是ContainerControlledLifetimeManager类无法做到这一点（显然是它的开发人员）没有启用“异常中断”？）。

问候，
科恩

Answer 5

罗里的解决方案很棒 - 谢谢。解决了每天困扰我的问题！
我对 Rory 的解决方案做了一些小调整，以便它可以处理注册的任何扩展（在我的例子中，我有一个 WPF Prism/Composite 扩展）。

    public static void ReplaceBehaviourExtensionsWithSafeExtension(IUnityContainer container)
    {
        var extensionsField = container.GetType().GetField("extensions", BindingFlags.Instance | BindingFlags.NonPublic);
        var extensionsList = (List<UnityContainerExtension>)extensionsField.GetValue(container);
        var existingExtensions = extensionsList.ToArray();
        container.RemoveAllExtensions();
        container.AddExtension(new UnitySafeBehaviorExtension());
        foreach (var extension in existingExtensions)
        {
            if (!(extension is UnityDefaultBehaviorExtension))
            {
                container.AddExtension(extension);
            }
        }
    }

Answer 6

请注意 Zubin Appoo 的回答中的一个错误：他的代码中缺少 UnityClearBuildPlanStrategies。

正确的代码片段是：

FieldInfo extensionsField = container.GetType().GetField("extensions", BindingFlags.Instance | BindingFlags.NonPublic);
List<UnityContainerExtension> extensionsList = (List<UnityContainerExtension>)extensionsField.GetValue(container);
UnityContainerExtension[] existingExtensions = extensionsList.ToArray();
container.RemoveAllExtensions();
container.AddExtension(new UnityClearBuildPlanStrategiesExtension());
container.AddExtension(new UnitySafeBehaviorExtension());

foreach (UnityContainerExtension extension in existingExtensions)
{
   if (!(extension is UnityDefaultBehaviorExtension))
   {
       container.AddExtension(extension);
   }
}

Answer 7

Unity 2.1 - 2012年8月更新修复bug

1. 解决线程安全问题：
   http://unity.codeplex.com/discussions/328841

2. 改善系统调试体验.Threading.SynchronizationLockException：
   https://entlib.uservoice.com /forums/89245-general/suggestions/2377307-fix-the-system-threading-synchronizationlockexcep

3. 在无法加载类型时通过更好的错误消息传递来改善调试体验：
   http://unity.codeplex.com/workitem/9223

4. 支持执行场景没有公共构造函数的类的现有实例上的 BuildUp()：
   http://unity.codeplex.com/workitem/9460

让更新体验变得如此简单对于用户而言，为了避免程序集绑定重定向的需要，我们选择仅增加程序集文件版本，而不是 .NET 程序集版本。

Answer 8

这可能对您有帮助：

• 转到“调试”->“异常...
• 找到真正让你烦恼的异常，比如 SynchronizationLockException

瞧。