.NET单元测试Release模式下静态配置实例访问异常问题排查

问题描述 #

我在.NET平台使用单元测试框架编写测试用例，部分测试用例均通过类静态属性AppConfig.Current访问同一个配置对象。
我在启动流程中先初始化该配置对象，紧接着调用后续代码，示例代码如下：

[AssemblyInitialize]
public static void AssemblyInitialize(TestContext context)
{
    var appCfg = AppConfig.Current;
    string path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "conf/app.settings.xml");
    appCfg.Load(path);
    var _ = AccountingContext.Current; // <= AccountingContext通过AppConfig.Current读取配置完成自身初始化，但仅在Release模式下我获取到的是另一个未加载配置的实例……
}

加载配置后，下一行代码调用AccountingContext.Current，期望它基于已加载的配置完成初始化。但实际表现为：测试在Debug模式下运行完全正常，Release模式下获取到的配置实例却是未加载过配置的新实例。

问题原因与解决方案 #

问题根源 #

问题出在AccountingContext类的初始化逻辑上，初始实现采用了静态属性内联赋值的写法：

public static AccountingContext Current { get; set; } = new AccountingContext();
public AccountingContext()
{
    CompanyAccessContext = _CreateCompanyAccessContext();
}

这种写法下，CLR会给该类添加beforefieldinit标记，Release模式的JIT优化会允许在首次访问该类的任意成员之前的任意时间点执行静态属性的初始化，极大概率会早于[AssemblyInitialize]方法中加载配置的操作，最终导致AccountingContext初始化时读取到的是未加载的空配置。
Debug模式下为了方便调试，JIT会关闭这类时序优化，静态成员只会在首次访问时才初始化，因此运行符合预期。

解决方案 #

将静态属性的初始化逻辑移到显式定义的静态构造函数中即可：

public static AccountingContext Current { get; set; } 

static AccountingContext()
{
    Current = new AccountingContext();
}

public AccountingContext()
{
    CompanyAccessContext = _CreateCompanyAccessContext();
}

显式定义静态构造函数后，CLR会移除该类的beforefieldinit标记，严格保证静态构造函数只会在首次访问该类的静态成员、或是首次实例化该类的时候才会执行，刚好在配置加载完成后、调用AccountingContext.Current时触发初始化，符合预期逻辑。

内容的提问来源于stack exchange，提问作者ActiveX