CA1869: 'JsonSerializerOptions' 인스턴스 캐시 및 재사용

원인

로컬 인스턴스 JsonSerializerOptions 는 한 번 또는 Deserialize 호출의 Serialize 인수로 options 사용됩니다.

규칙 설명

System.Text.Json이 내부적으로 serialization 관련 메타데이터를 제공된 인스턴스에 캐시하기 때문에 코드가 여러 번 실행되는 경우 직렬화 또는 역직렬화에 로컬 인스턴스 JsonSerializerOptions 를 사용하면 애플리케이션 성능이 크게 저하될 수 있습니다.

위반 문제를 해결하는 방법

싱글톤 패턴을 사용하여 코드가 실행될 때마다 새 JsonSerializerOptions 인스턴스를 만들지 않도록 할 수 있습니다.

예시

다음 코드 조각은 CA1869의 두 가지 위반을 보여 줍니다.

static string Serialize<T>(T value)
{
    JsonSerializerOptions jsonOptions = new()
    {
        WriteIndented = true
    };

    return JsonSerializer.Serialize(value, jsonOptions);
}

static T Deserialize<T>(string json)
{
    return JsonSerializer.Deserialize<T>(json, new JsonSerializerOptions { AllowTrailingCommas = true });
}

다음 코드 조각은 위반을 해결합니다.

private static readonly JsonSerializerOptions s_writeOptions = new()
{
    WriteIndented = true
};

private static readonly JsonSerializerOptions s_readOptions = new()
{
    AllowTrailingCommas = true
};

static string Serialize<T>(T value)
{
    return JsonSerializer.Serialize(value, s_writeOptions);
}

static T Deserialize<T>(string json)
{
    return JsonSerializer.Deserialize<T>(json, s_readOptions);
}

추가 호출 Serialize 이 Deserializes_writeOptions s_readOptions 있거나 다시 사용되어야 하는 경우 각각.

경고를 표시하지 않는 경우

코드가 JsonSerializerOptions 인스턴스를 두 번 이상 인스턴스화하지 않는다는 것을 알고 있으면 이 경고를 표시하지 않는 것이 안전합니다.

경고 표시 안 함

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

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

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

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

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