CA1512: ArgumentOutOfRangeException throw 도우미 사용
속성 | 값 |
---|---|
규칙 ID | CA1512 |
제목 | ArgumentOutOfRangeException throw 도우미 사용 |
범주 | 유지 관리 |
수정 사항이 주요 변경인지 여부 | 작업을 중단하지 않는 변경 |
.NET 9에서 기본적으로 사용 | 제안 사항 |
원인
코드는 인수가 지정된 값보다 작거나 큰지 확인한 다음 조건부로 ArgumentOutOfRangeExceptionthrow합니다.
규칙 설명
인수 검사는 코드 크기에 상당한 영향을 미치며 작은 함수 및 속성 setter에 대한 코드를 지배하는 경우가 많습니다. 이러한 검사는 인라인을 방지하고 상당한 명령 캐시 오염을 유발합니다. 이와 같은 ArgumentOutOfRangeException.ThrowIfGreaterThan Throw 도우미 메서드는 새 예외 인스턴스를 생성하는 블록보다 if
더 간단하고 효율적입니다.
예시
다음 코드 조각은 CA1512 위반을 보여 줍니다.
void M(int arg)
{
if (arg is 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg < 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg <= 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg <= 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg < 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg > 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg >= 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg == 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg != 42)
throw new ArgumentOutOfRangeException(nameof(arg));
}
다음 코드 조각은 수정 사항을 보여줍니다.
void M(int arg)
{
ArgumentOutOfRangeException.ThrowIfZero(arg);
ArgumentOutOfRangeException.ThrowIfNegative(arg);
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(arg);
ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfLessThan(arg, 42);
ArgumentOutOfRangeException.ThrowIfGreaterThan(arg, 42);
ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfNotEqual(arg, 42);
}
위반 문제를 해결하는 방법
예외를 if
throw하는 블록을 다음 throw 도우미 메서드 중 하나에 대한 호출로 바꿉니다.
- ArgumentOutOfRangeException.ThrowIfZero<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfNegative<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfNegativeOrZero<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfLessThanOrEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfLessThan<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfGreaterThan<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfNotEqual<T>(T, T, String)
또는 Visual Studio에서 전구 메뉴를 사용하여 코드를 자동으로 수정합니다.
경고를 표시하지 않는 경우
코드의 유지 관리가 중요하지 않은 경우 이 규칙의 위반을 표시하지 않아도 됩니다. 가양성으로 식별된 위반을 중지해도 괜찮습니다.
경고 표시 안 함
단일 위반만 표시하지 않으려면 원본 파일에 전처리기 지시문을 추가하여 규칙을 사용하지 않도록 설정한 후 다시 사용하도록 설정합니다.
#pragma warning disable CA1512
// The code that's violating the rule is on this line.
#pragma warning restore CA1512
파일, 폴더 또는 프로젝트에 대한 규칙을 사용하지 않도록 설정하려면 구성 파일에서 심각도를 none
으로 설정합니다.
[*.{cs,vb}]
dotnet_diagnostic.CA1512.severity = none
자세한 내용은 방법: 코드 분석 경고 표시 안 함을 참조하세요.
.NET