CA1834:对单字符字符串使用 StringBuilder.Append(char)

项目
09/07/2023

属性	值
规则 ID	CA1834
标题	对单字符字符串使用 StringBuilder.Append(char)
类别	“性能”
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	作为建议

原因

将单位长度字符串传递给 Append 方法时，将触发此规则。

规则说明

使用单位长度字符串调用 StringBuilder.Append 时，请考虑使用 const char 而不是单位长度 const string 来提高性能。

如何解决冲突

可以手动解决冲突，在某些情况下，也使用快速操作来修复 Visual Studio 中的代码。示例：

示例 1

使用单位长度的字符串文本的 StringBuilder.Append 调用：

using System;
using System.Text;

namespace TestNamespace
{
    class TestClass
    {
        private void TestMethod()
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("a");
        }
    }
}

提示

Visual Studio 中为此规则提供了代码修补程序。若要使用它，请将光标置于冲突上，然后按“Ctrl+.”（句点）。从显示的选项列表中选择“考虑在适用的情况下使用 'StringBuilder.Append(char)'”。

Code fix for CA1834 - Use StringBuilder.Append(char) for single character strings

Visual Studio 应用的修补程序：

using System;
using System.Text;

namespace TestNamespace
{
    class TestClass
    {
        private void TestMethod()
        {
            StringBuilder sb = new StringBuilder();
            sb.Append('a');
        }
    }
}

在某些情况下，例如使用单位长度 const string 类字段时，Visual Studio 不建议使用代码修补程序（但分析器仍会触发）。这些实例需要手动修复。

示例 2

使用单位长度的 const string 类字段的 StringBuilder.Append 调用：

using System;
using System.Text;

namespace TestNamespace
{
    public class Program
    {
        public const string unitString = "a";

        static void Main(string[] args)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append(unitString);
        }
    }
}

仔细分析后，此处的 unitString 可以更改为 char，而不会导致任何生成错误。

using System;
using System.Text;

namespace TestNamespace
{
    public class Program
    {
        public const char unitString = 'a';

        static void Main(string[] args)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append(unitString);
        }
    }
}

何时禁止显示警告

如果你不关心在使用 StringBuilder 时提高性能，可以禁止显示此规则的冲突。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA1834
// The code that's violating the rule is on this line.
#pragma warning restore CA1834

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

[*.{cs,vb}]
dotnet_diagnostic.CA1834.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅

性能规则

通过