CA1863: 'CompositeFormat' 사용

속성	값
규칙 ID	CA1863
타이틀	CompositeFormat 사용
범주	성능
수정 사항이 주요 변경인지 여부	주요 변경 아님
.NET 8에서 기본적으로 사용	아니요

원인

인스턴스에 static 캐시되지 않은 형식 문자열을 사용하여 호출하거나 StringBuilder.AppendFormat(String, Object[]) 코드를 호출 String.Format(String, Object[]) 합니다CompositeFormat.

규칙 설명

런타임에 형식 문자열을 구문 분석하는 데 비용이 많이 듭니다. 이 규칙은 원래 형식 문자열을 전달하는 대신 인스턴스를 캐시하고 서식 작업에 대한 인수로 사용할 CompositeFormat 수 있는 위치를 코드에서 찾습니다. 인스턴스는 CompositeFormat 만들 때 복합 형식 문자열을 구문 분석합니다. 즉, 문자열 서식의 "핫 경로"가 훨씬 더 빠르게 실행됩니다.

위반 문제를 해결하는 방법

인스턴스를 CompositeFormat 호출 CompositeFormat.Parse(String) 하여 만들고 원래 형식 문자열 대신 전달 String.Format(IFormatProvider, CompositeFormat, Object[]) 합니다 StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) .

예시

다음 예제에서는 규칙의 두 가지 위반을 보여 줍니다.

class C
{
    private static readonly string StaticField = "Format one value: {0}";

    static void Main()
    {
        _ = string.Format(StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(StaticField, 42);
    }
}

다음 예제에서는 두 위반을 모두 해결하는 코드를 보여 줍니다.

class C
{
    private static readonly CompositeFormat StaticField = CompositeFormat.Parse("Format one value: {0}");

    static void Main()
    {
        _ = string.Format(null, StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(null, StaticField, 42);
    }
}

경고를 표시하지 않는 경우

성능이 중요하지 않은 경우 이 규칙에서 진단 표시하지 않는 것이 안전합니다.

경고 표시 안 함

단일 위반만 표시하지 않으려면 원본 파일에 전처리기 지시문을 추가하여 규칙을 사용하지 않도록 설정한 후 다시 사용하도록 설정합니다.

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

파일, 폴더 또는 프로젝트에 대한 규칙을 사용하지 않도록 설정하려면 구성 파일에서 심각도를 none으로 설정합니다.

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

자세한 내용은 방법: 코드 분석 경고 표시 안 함을 참조하세요.