CA1062: Genel yöntemlerin bağımsız değişkenlerini doğrulayın

Neden

Dışarıdan görünür bir yöntem, bu bağımsız değişkenin (null Visual Basic'te) olup olmadığını doğrulamadan başvuru bağımsız değişkenlerinden Nothing birini başvurudan çıkartır.

Bu kuralı, belirli türleri ve parametreleri analizden dışlamak için yapılandırabilirsiniz. Null denetimi doğrulama yöntemlerini de belirtebilirsiniz.

Kural açıklaması

Dışarıdan görünen yöntemlere geçirilen tüm başvuru bağımsız değişkenleri ile denetlenmelidir null. Uygunsa, bağımsız değişken olduğunda ArgumentNullExceptionbir null at.

Bir yöntem genel veya korumalı olarak bildirildiği için bilinmeyen bir derlemeden çağrılabiliyorsa, yöntemin tüm parametrelerini doğrulamanız gerekir. yöntemi yalnızca bilinen derlemeler tarafından çağrılacak şekilde tasarlanmışsa, yöntemini işaretleyin ve yöntemini internal içeren derlemeye özniteliğini uygulayın InternalsVisibleToAttribute .

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için her başvuru bağımsız değişkenini ile nulldoğrulayın.

Uyarıların ne zaman bastırılması gerekiyor?

Başvurulmayan parametrenin işlevdeki başka bir yöntem çağrısı tarafından doğrulandığından eminseniz, bu kuraldan gelen bir uyarıyı gizleyebilirsiniz.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Çözümlemek için kod yapılandırma

Bu kuralın kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırmak için aşağıdaki seçenekleri kullanın.

• Belirli API yüzeylerini ekleme
• Belirli simgeleri hariç tutma
• Belirli türleri ve türetilmiş türlerini dışlama
• Uzantı yöntemi 'this' parametresini dışla
• Null denetim doğrulama yöntemleri

Ayrıca, bu kural için aşağıdaki diğer veri akışı analiziyle ilgili seçenekler geçerlidir:

• interprocedural_analysis_kind
• max_interprocedural_lambda_or_local_function_call_chain
• max_interprocedural_method_call_chain
• points_to_analysis_kind
• copy_analysis
• sufficient_IterationCount_for_weak_KDF_algorithm

Bu seçenekler yalnızca bu kural için, uyguladıkları tüm kurallar için veya bu kategorideki (Tasarım) geçerli oldukları tüm kurallar için yapılandırılabilir. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Belirli API yüzeylerini ekleme

api_surface seçeneğini ayarlayarak, bu kuralın erişilebilirliği temelinde kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırabilirsiniz. Örneğin, kuralın yalnızca genel olmayan API yüzeyinde çalıştırılması gerektiğini belirtmek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Belirli simgeleri hariç tutma

excluded_symbol_names seçeneğini ayarlayarak türler ve yöntemler gibi belirli simgeleri analizden hariç tutabilirsiniz. Örneğin, kuralın adlı MyTypetürlerdeki herhangi bir kodda çalışmaması gerektiğini belirtmek için, projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Seçenek değerinde izin verilen simge adı biçimleri (ile |ayrılmış):

• Yalnızca sembol adı (içeren tür veya ad alanı ne olursa olsun, ada sahip tüm simgeleri içerir).
• Simgenin belge kimliği biçimindeki tam adlar. Her simge adı için yöntemlerM:, türler ve T: ad alanları gibi N: bir sembol türü ön eki gerekir.
• .ctor oluşturucular ve .cctor statik oluşturucular için.

Örnekler:

Belirli türleri ve türetilmiş türlerini dışlama

excluded_type_names_with_derived_types seçeneğini ayarlayarak belirli türleri ve türetilmiş türlerini analizden dışlayabilirsiniz. Örneğin, kuralın adlı MyType ve türetilmiş türleri içindeki hiçbir yöntemde çalışmaması gerektiğini belirtmek için, projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Seçenek değerinde izin verilen simge adı biçimleri (ile |ayrılmış):

• Yalnızca tür adı (içeren tür veya ad alanına bakılmaksızın adı olan tüm türleri içerir).
• Simgenin belge kimliği biçiminde, isteğe bağlı T: ön ek içeren tam adlar.

Örnekler:

Uzantı yöntemi 'this' parametresini dışla

Varsayılan olarak, bu kural uzantı yöntemleri için parametresini this analiz eder ve bayraklar. Projenizdeki bir this dosyasına aşağıdaki anahtar-değer çiftini ekleyerek uzantı yöntemleri için parametresinin analizini dışlayabilirsiniz:

dotnet_code_quality.CA1062.exclude_extension_method_this_parameter = true

Null denetim doğrulama yöntemleri

Bu kural, kodunuz başvuruda bulunılan kitaplıklarda veya projelerde özel null-check doğrulama yöntemlerini çağırırsa hatalı pozitiflere yol açabilir. Null denetim doğrulama yöntemlerinin adını veya imzasını belirterek bu hatalı pozitif sonuçları önleyebilirsiniz. Çözümleme, bu yöntemlere geçirilen bağımsız değişkenlerin çağrıdan sonra null olmadığını varsayar. Örneğin, null-check doğrulama yöntemleri olarak adlandırılan Validate tüm yöntemleri işaretlemek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CA1062.null_check_validation_methods = Validate

Seçenek değerinde izin verilen yöntem adı biçimleri (ile |ayrılmış):

• Yalnızca yöntem adı (içeren tür veya ad alanı ne olursa olsun, ada sahip tüm yöntemleri içerir).
• Simgenin belge kimliği biçiminde, isteğe bağlı M: ön ek içeren tam adlar.

Örnekler:

Örnek 1

Aşağıdaki örnekte kuralı ihlal eden bir yöntem ve kuralı karşılayan bir yöntem gösterilmektedir.

using System;

namespace DesignLibrary
{
    public class Test
    {
        // This method violates the rule.
        public void DoNotValidate(string input)
        {
            if (input.Length != 0)
            {
                Console.WriteLine(input);
            }
        }

        // This method satisfies the rule.
        public void Validate(string input)
        {
            if (input == null)
            {
                throw new ArgumentNullException(nameof(input));
            }
            if (input.Length != 0)
            {
                Console.WriteLine(input);
            }
        }
    }
}

Imports System

Namespace DesignLibrary

    Public Class Test

        ' This method violates the rule.
        Sub DoNotValidate(ByVal input As String)

            If input.Length <> 0 Then
                Console.WriteLine(input)
            End If

        End Sub

        ' This method satisfies the rule.
        Sub Validate(ByVal input As String)

            If input Is Nothing Then
                Throw New ArgumentNullException(NameOf(input))
            End If

            If input.Length <> 0 Then
                Console.WriteLine(input)
            End If

        End Sub

    End Class

End Namespace

Örnek 2

Başvuru nesneleri olan alanları veya özellikleri dolduran kopya oluşturucuları da CA1062 kuralını ihlal edebilir. Kopya oluşturucuya geçirilen kopyalanan nesne (null Visual Basic'te) olabileceğinden Nothing ihlal oluşur. İhlali çözmek için, kopyalanan nesnenin null olmadığını denetlemek için ( staticShared Visual Basic'te) yöntemini kullanın.

Aşağıdaki Person sınıf örneğinde, other kopya oluşturucusunun Person geçirilen nesnesi olabilir null.

public class Person
{
    public string Name { get; private set; }
    public int Age { get; private set; }

    public Person(string name, int age)
    {
        Name = name;
        Age = age;
    }

    // Copy constructor CA1062 fires because other is dereferenced
    // without being checked for null
    public Person(Person other)
        : this(other.Name, other.Age)
    {
    }
}

Örnek 3

Aşağıdaki düzeltilmiş Person örnekte, other kopya oluşturucuya geçirilen nesne ilk olarak yönteminde PassThroughNonNull null olarak denetlendi.

public class Person
{
    public string Name { get; private set; }
    public int Age { get; private set; }

    public Person(string name, int age)
    {
        Name = name;
        Age = age;
    }

    // Copy constructor
    public Person(Person other)
        : this(PassThroughNonNull(other).Name, other.Age)
    {
    }

    // Null check method
    private static Person PassThroughNonNull(Person person)
    {
        if (person == null)
            throw new ArgumentNullException(nameof(person));
        return person;
    }
}