F#升级至FSharp.Core9.0后单例模式初始化错误及相关问题咨询

问题描述 #

在FSharp.Core 8.0.400 + Windows .NET Core 3.1环境下，以下懒加载单例代码可正常运行并被C#调用，但升级到FSharp.Core 9.0.201 + net6.0-windows后，访问instance.Value时抛出System.InvalidOperationException，提示类型静态初始化时递归访问未完全初始化的静态数据。将项目改为Class Library而非F# Library后，原代码恢复正常但丢失4个项目引用；改用双重检查锁定实现的单例代码则可正常运行，需解释该现象的原因及解决办法。

原单例代码 #

[<AutoOpen>]
module AppointmentEventManager

open Stargate.XI.Client.Domain.Models

type public AEM private() =
  let appointmentEvent = new Event<Appointment option>()          
  let cellEvent = new Event<Cell>()    

  static let mutable instance = lazy(new AEM())
  static member Instance with get() = instance.Value

  [<CLIEvent>]
  member x.AppointmentEvent = appointmentEvent.Publish                      
  member x.RaiseAppointmentEvent(arg) = appointmentEvent.Trigger(arg)

  // these members are public.
  // CellEvent -- used by ColumnModule (Column.fs) to tell Registration.fs what is current selected cell/appointment
  [<CLIEvent>]
  member x.CellEvent = cellEvent.Publish
  member x.RaiseCellEvent(arg) = cellEvent.Trigger(arg)

C#调用代码 #

private void Appointments_Loaded(object sender, RoutedEventArgs e)
{
    AppointmentEventManager = AEM.Instance;
    AppointmentEventManager.AppointmentEvent += cellSelected;
}

修改后的双重检查锁定单例代码 #

type AEM private () =
    static let instanceLock = obj()
    static let mutable instance: AEM option = None
    let appointmentEvent = new Event<Appointment option>()          
    let cellEvent = new Event<Cell>()   

    static member GetInstance() =
        lock instanceLock (fun () ->
            if instance.IsNone then
                instance <- Some (AEM())
        )
        instance.Value

    [<CLIEvent>]
    member x.AppointmentEvent = appointmentEvent.Publish                      
    member x.RaiseAppointmentEvent(arg) = appointmentEvent.Trigger(arg)

    [<CLIEvent>]
    member x.CellEvent = cellEvent.Publish
    member x.RaiseCellEvent(arg) = cellEvent.Trigger(arg)

原因分析 #

1. FSharp.Core版本升级后的静态初始化逻辑变化
   FSharp.Core 9.x针对.NET 6+环境优化了静态成员的初始化时序，严格遵循.NET官方的静态构造函数执行规则。原代码中static let mutable instance = lazy(new AEM())在类型静态初始化阶段就会创建Lazy<AEM>实例，当首次访问Instance属性触发lazy.Value时，会尝试构造AEM实例，但此时AEM的静态初始化过程尚未完成（因为instance本身是静态字段，属于类型初始化的一部分），从而触发递归初始化检测，抛出异常。而旧版本FSharp.Core + .NET Core 3.1中，静态初始化的检测逻辑相对宽松，未捕捉到这种递归场景。

2. F# Library与Class Library的项目类型差异
   F# Library项目默认启用了F#专属的编译选项与类型初始化策略，而Class Library项目更贴近.NET通用类库的编译规则，静态初始化的执行路径不同，避开了递归检测的触发条件。但这种方式会丢失F#项目特有的引用（比如FSharp.Core相关依赖或项目间的F#专属引用），导致项目依赖缺失。

解决办法 #

方案1：使用.NET原生Lazy<T>替代F# lazy关键字（推荐） #

F#的lazy关键字在静态字段场景下的初始化时序与.NET原生Lazy<T>存在差异，改用.NET原生Lazy<T>（默认线程安全模式）可规避递归初始化问题：

type public AEM private() =
  let appointmentEvent = new Event<Appointment option>()          
  let cellEvent = new Event<Cell>()    

  static let instance = Lazy<AEM>(fun () -> AEM())
  static member Instance with get() = instance.Value

  [<CLIEvent>]
  member x.AppointmentEvent = appointmentEvent.Publish                      
  member x.RaiseAppointmentEvent(arg) = appointmentEvent.Trigger(arg)

  [<CLIEvent>]
  member x.CellEvent = cellEvent.Publish
  member x.RaiseCellEvent(arg) = cellEvent.Trigger(arg)

方案2：保留双重检查锁定实现 #

你已经验证的双重检查锁定方案完全手动控制实例创建时机，避开了F#静态初始化的时序问题，适合需要精确控制单例创建逻辑的场景，可直接沿用。

方案3：调整F# Library编译选项（谨慎使用） #

若要继续使用原代码并保留F# Library项目类型，可在项目文件中添加编译选项关闭静态初始化递归检测：

<PropertyGroup>
  <FSharpCompileFlags>--no-static-init-check</FSharpCompileFlags>
</PropertyGroup>

注意：该选项会关闭静态初始化的安全检测，可能引入其他潜在问题，需全面测试后使用。

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