正确理解c# default关键字

背景

最近QA测试一个我开发的一个Web API时，我意识到之前对C#的default的理解一直是想当然的。具体情况是这样，这个API在某些条件下要返回模型的默认值，写法类似于下面这样

[HttpGet(Name = "GetWeatherForecast")]
public WeatherForecast Get()
{
   return default;
}

实际上，这个API会返回204 No Content，而不是想象中的一个空的WeatherForecast。API返回204，说明default得到值是null，为什么会这样？

正确理解default

查看C#语言规范里的说明，default表达式是产生一个类型的默认值（A default value expression produces the default value of a type），而不是类的默认值（Type和Class都被翻译成类真是不太友好）。 我们知道，C#里引用类型的默认值就是null，因此上面的API会返回204。

通过查看IL，可以发现给一个引用类型赋默认值，就是通过ldnull指令将一个空引用推送到计算堆栈上。

IL_0001: ldnull
IL_0002: stloc.0      // V_0

对于值类型，比如decimal，则是通过initobj指令将位于指定地址的字段初始化为空引用或者0，

IL_0001: ldloca.s     'value'
IL_0003: initobj      [System.Runtime]System.Decimal

与newobj不同， initobj不调用构造函数，只用于初始化值类型。引用类型和值类型的默认值都可以认为是常量。

应用

在linq里，我们常用的FirstOrDefault方法，如果没有找到返回的默认值，内部其实就是返回的default

 private static TSource? TryGetFirst<TSource>(this IEnumerable<TSource> source, out bool found)
 {
     if (source == null)
     {
         ThrowHelper.ThrowArgumentNullException(ExceptionArgument.source);
     }

     if (source is IPartition<TSource> partition)
     {
         return partition.TryGetFirst(out found);
     }

     if (source is IList<TSource> list)
     {
         if (list.Count > 0)
         {
             found = true;
             return list[0];
         }
     }
     else
     {
         using (IEnumerator<TSource> e = source.GetEnumerator())
         {
             if (e.MoveNext())
             {
                 found = true;
                 return e.Current;
             }
         }
     }

     found = false;
     return default;
 }

如果已经厌倦用null判断是否为空，现在多了一个default选项。

if (_settings == default){

}

参考

• https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/expressions#12820-default-value-expressions
• https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/default#default-literal
• https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/default-values