如何避免在C#中忘记为IDisposable对象使用using语句？

我编写代码时经常忘记在获取IDisposable对象时使用using语句，CA2000分析器存在较大局限性，比如以下代码中，pngImage是IDisposable类型且未被释放，但CA2000未触发告警，SonarAnalyzer.CSharp也未给出提示：

public (RgbaPixel32[] Pixels, int Width, int Height) LoadPngToPixels(byte[] pngFileBytes) {
    //using Image<Rgba32> pngImage = Image.Load<Rgba32>(pngFileBytes);

    Image<Rgba32> pngImage = Image.Load<Rgba32>(pngFileBytes);
    uint count = (uint)pngImage.Width * (uint)pngImage.Height;
    RgbaPixel32[] pixels = new RgbaPixel32[count];
    count = 0;

    pngImage.ProcessPixelRows(imgAccessor => {
        for (int y = 0; y < imgAccessor.Height; y++) {
            var rowImg = imgAccessor.GetRowSpan(y);
            for (int x = 0; x < imgAccessor.Width; x++) {
                pixels[count].R = rowImg[x].R;
                pixels[count].G = rowImg[x].G;
                pixels[count].B = rowImg[x].B;
                pixels[count].A = rowImg[x].A;
                count++;
            }
        }
    });

    return (pixels, pngImage.Width, pngImage.Height);
}

可行的解决方法 #

1. 启用IDE0067代码样式规则 #

IDE0067是针对IDisposable对象释放的代码样式规则，覆盖场景比CA2000更广泛，能检测到这类局部未释放的IDisposable对象：

• 在项目文件中开启强制代码样式检查：

<PropertyGroup>
  <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
</PropertyGroup>

• 确保.editorconfig中启用该规则：dotnet_diagnostic.IDE0067.severity = warning

2. 自定义Roslyn分析器 #

如果需要更精准的检测逻辑，可以编写自定义Roslyn分析器：

• 定位所有局部声明的IDisposable类型变量
• 检查变量是否被using包裹，或是否有显式的.Dispose()调用
• 针对你的场景，可以排除被作为返回值的对象（此案例仅返回对象属性，而非对象本身，可精准触发告警）

3. 借助JetBrains工具的分析能力 #

ReSharper或Rider的资源泄漏检测功能比原生分析器更灵敏，能识别这类局部IDisposable对象未释放的情况，还支持一键自动添加using语句修复问题。

4. 养成代码编写习惯 #

• 声明IDisposable对象时直接添加using，避免后续遗漏
• 利用代码片段快速生成using var [varName] = [init];结构，减少手动编写的疏忽
• 写完方法后快速扫一遍局部变量，确认所有IDisposable对象都已正确释放

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