来自静态单例内联初始化的 NullReferenceException

Question

根据this question，应该保证我使用的静态字段被初始化：

10.4.5.1静态字段初始化：

类的静态字段变量初始化器对应于 以文本顺序执行的任务序列 它们出现在类声明中。如果是静态构造函数 （10.11节）存在于类中，执行静态字段 初始化器在执行该静态之前立即发生 构造函数。否则，静态字段初始化器在 在第一次使用静态之前的依赖于实现的时间 该类的字段。

我遇到了一个奇怪的情况，这似乎不是真的。我有两个类，它们相互之间存在循环依赖关系，并且抛出了 NullReferenceException。

我能够在以下简化示例中重现此问题，看看：

public class SessionManager
{
    //// static constructor doesn't matter
    //static SessionManager()
    //{
    //    _instance = new SessionManager();
    //}

    private static SessionManager _instance = new SessionManager();
    public static SessionManager GetInstance()
    {
        return _instance;
    }

    public SessionManager()
    {
        Console.WriteLine($"{nameof(SessionManager)} constructor called");
        this.RecoverState();
    }

    public bool RecoverState()
    {
        Console.WriteLine($"{nameof(RecoverState)} called");
        List<SessionInfo> activeSessionsInDb = SessionManagerDatabase.GetInstance().LoadActiveSessionsFromDb();
        // ...
        return true;
    }

    public List<SessionInfo> GetAllActiveSessions()
    {
        Console.WriteLine($"{nameof(GetAllActiveSessions)} called");
        return new List<SessionInfo>();
    }
}

public class SessionManagerDatabase
{
    //// static constructor doesn't matter
    //static SessionManagerDatabase()
    //{
    //    _instance = new SessionManagerDatabase();
    //}

    private static readonly SessionManagerDatabase _instance = new SessionManagerDatabase();
    public static SessionManagerDatabase GetInstance()
    {
        return _instance;
    }

    public SessionManagerDatabase()
    {
        Console.WriteLine($"{nameof(SessionManagerDatabase)} constructor called");
        Synchronize();
    }          

    public void Synchronize()
    {
        Console.WriteLine($"{nameof(Synchronize)} called");
        // NullReferenceException here
        List<SessionInfo> memorySessions = SessionManager.GetInstance().GetAllActiveSessions();  
        //...
    }

    public List<SessionInfo> LoadActiveSessionsFromDb()
    {
        Console.WriteLine($"{nameof(LoadActiveSessionsFromDb)} called");
        return new List<SessionInfo>();
    }
}

public class SessionInfo
{
}

如果您按照其他question 中的建议取消注释静态构造函数，问题仍然存在。使用此代码获取TypeInitializationException 与NullRefernceException 作为InnerException 在Synchronize SessionManager.GetInstance().GetAllActiveSessions()：

static void Main(string[] args)
{
    try
    {
        var sessionManagerInstance = SessionManager.GetInstance();
    }
    catch (TypeInitializationException e)
    {
        Console.WriteLine(e);
        throw;
    }
}

控制台输出：

SessionManager constructor called
RecoverState called
SessionManagerDatabase constructor called
Synchronize called
System.TypeInitializationException: Der Typeninitialisierer für "SessionManager" hat eine Ausnahme verursacht. ---> System.TypeInitializationException: Der Typeninitialisierer für "SessionManagerDatabase" hat eine Ausnahme verursacht. ---> System.NullReferenceException: Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt.
   bei ConsoleApplication_CSharp.Program.SessionManagerDatabase.Synchronize() in ......
   bei ConsoleApplication_CSharp.Program.SessionManagerDatabase..ctor() in ......
   bei ConsoleApplication_CSharp.Program.SessionManagerDatabase..cctor() in ......
   --- Ende der internen Ausnahmestapelüberwachung ---
   bei ConsoleApplication_CSharp.Program.SessionManagerDatabase.GetInstance()
   bei ConsoleApplication_CSharp.Program.SessionManager.RecoverState() in ......
   bei ConsoleApplication_CSharp.Program.SessionManager..ctor() in .....
   bei ConsoleApplication_CSharp.Program.SessionManager..cctor() in ......
   --- Ende der internen Ausnahmestapelüberwachung ---
   bei ConsoleApplication_CSharp.Program.SessionManager.GetInstance()
   bei ConsoleApplication_CSharp.Program.Main(String[] args) in ......

我知道这里存在某种循环依赖（在原始代码中并不那么明显），但我仍然不明白为什么代码无法初始化单例。除了避免循环依赖之外，这个用例的最佳方法是什么？

Answer 1

看看IL：

IL_0001:  newobj     instance void SO.Program/SessionManager::.ctor()
IL_0006:  stsfld     class SO.Program/SessionManager SO.Program/SessionManager::_instance

在这里您可以看到对静态构造函数的调用有两个步骤。它首先初始化一个新实例，然后分配它。这意味着当您进行依赖于实例存在的跨类调用时，您会被卡住。它仍在创建实例的过程中。之后就可以调用了。

您可以通过创建一个静态的Initialize 方法来摆脱这种情况，该方法执行实例化调用。

试试这个：

static SessionManager()
{
    _instance = new SessionManager();

    _instance.RecoverState();
}

static SessionManagerDatabase()
{
    _instance = new SessionManagerDatabase();

    _instance.Synchronize();
}

Answer 2

您正在匆忙执行步骤，并且正在进行某种递归：

1. SessionManager _instance = new SessionManager(); 这一行调用了一些以SessionManagerDatabase.GetInstance() 结束的方法

2. 这也是一样的，并以回调SessionManager.GetInstance()结束

3. 这会导致问题，因为它需要在 SessionManager 中的 _instance 变量中保存一个有效值，但此时您还没有真正完成方法调用链以便为_instance 从而导致NullReferenceException。

Answer 3

在您的示例中发生的是实例构造函数在静态字段初始化期间根据规范被调用。但是构造函数因 NullReferenceExeption 而失败，因为它试图通过 GetInstance() 调用获取对 _instance 的引用。请注意，_instance 尚未初始化 - 初始化过程正在进行中。因此，实例构造函数由于上述问题而失败，因此它不会构造/初始化 _instance 字段。所以简而言之，您应该尝试从您的实例构造函数中获取静态 _instance。

Answer 4

如果你看这个：private static SessionManager _instance = new SessionManager()，它有两个重要的步骤。

1.- Initialization (new SessionManager()). 
2.- The asignation(_instance = the obj). 

如果您尝试在分配之前使用 _instance（如您所做的那样），则它为空。它会影响您的 NRE。您可以像这样拆分构造函数行为来打破这个回调：

public class SessionManager
{
    private static SessionManager _instance;

    static SessionManager() { 
         _instance = new SessionManager();
         _instance.RecoverState();
    }

    public static SessionManager GetInstance()
    {
        return _instance;
    }

    public SessionManager()
    {
        Console.WriteLine($"{nameof(SessionManager)} constructor called");
        // remove RecoverState() call
    }