CA2231:重写 ValueType.Equals 时应重载相等运算符
| 属性 | 值 |
|---|---|
| 规则 ID | CA2231 |
| 标题 | 重写 ValueType.Equals 时应重载相等运算符 |
| 类别 | 使用情况 |
| 修复是中断修复还是非中断修复 | 非中断 |
| 在 .NET 8 中默认启用 | 作为建议 |
原因
值类型重写 System.Object.Equals，但不实现相等运算符。
默认情况下，此规则仅查看外部可见的类型，但这是可配置的。
规则说明
在大多数编程语言中，对值类型不存在默认的相等运算符 (==) 的实现。 如果编程语言支持运算符重载，则应考虑实现相等运算符。 其行为应与 Equals 的行为相同。
不能在相等运算符的重载实现中使用默认的相等运算符。 这样做将导致堆栈溢出。 若要实现相等运算符，请在实现中使用 Object.Equals 方法。 例如：
If (Object.ReferenceEquals(left, Nothing)) Then
Return Object.ReferenceEquals(right, Nothing)
Else
Return left.Equals(right)
End If
if (Object.ReferenceEquals(left, null))
return Object.ReferenceEquals(right, null);
return left.Equals(right);
如何解决冲突
若要解决与此规则的冲突，请实现相等运算符。
何时禁止显示警告
可以安全地禁止显示此规则发出的警告；但是，我们建议尽可能提供相等运算符。
抑制警告
如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。
#pragma warning disable CA2231
// The code that's violating the rule is on this line.
#pragma warning restore CA2231
若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。
[*.{cs,vb}]
dotnet_diagnostic.CA2231.severity = none
有关详细信息，请参阅如何禁止显示代码分析警告。
配置代码以进行分析
使用下面的选项来配置代码库的哪些部分要运行此规则。
可以仅为此规则、为适用的所有规则或为适用的此类别（使用情况）中的所有规则配置此选项。 有关详细信息，请参阅代码质量规则配置选项。
包含特定的 API 图面
你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：
dotnet_code_quality.CAXXXX.api_surface = private, internal
示例
下面的示例定义了违反此规则的类型：
public struct PointWithoutHash
{
private int x, y;
public PointWithoutHash(int x, int y)
{
this.x = x;
this.y = y;
}
public override string ToString()
{
return String.Format("({0},{1})", x, y);
}
public int X { get { return x; } }
public int Y { get { return x; } }
// Violates rule: OverrideGetHashCodeOnOverridingEquals.
// Violates rule: OverrideOperatorEqualsOnOverridingValueTypeEquals.
public override bool Equals(object? obj)
{
if (obj?.GetType() != typeof(PointWithoutHash))
return false;
PointWithoutHash p = (PointWithoutHash)obj;
return ((this.x == p.x) && (this.y == p.y));
}
}
