Не объявляйте изменяемые ссылочные типы, доступные только для чтения

Статья
11/05/2008

Обновлен: Ноябрь 2007

TypeName	DoNotDeclareReadOnlyMutableReferenceTypes
CheckId	CA2104
Категория	Microsoft.Security
Критическое изменение	Не критическое

Причина

Видимый извне тип содержит видимое извне и доступное только для чтение поле, являющееся изменяемым ссылочным типом.

Описание правила

Изменяемый тип — это тип, экземпляр которого может быть изменен. Примером изменяемого ссылочного типа может служить класс System.Text.StringBuilder. Он содержит члены, которые могут изменять значение экземпляра класса. Примером неизменяемого ссылочного типа может служить класс System.String. После создания экземпляра его значение изменить нельзя.

Модификатор доступа только для чтения (readonly (Справочник по C#) в C#, ReadOnly (Visual Basic) в Visual Basic и const (C++) в C++) в поле ссылочного типа (указателя в C++) препятствует замене поля другим экземпляром ссылочного типа, но не препятствует изменению данных экземпляра в поле посредством ссылочного типа.

Это правило не касается доступных только для чтения полей массива; они вызывают нарушение правила Поля массивов не должны быть доступны только для чтения.

Устранение нарушений

Чтобы устранить нарушение этого правила, удалите модификатор доступа только для чтения, или, если возможно критическое изменение, замените поле, используя неизменяемый тип.

Отключение предупреждений

Можно отключать предупреждения этого правила, если тип поля является неизменяемым.

Пример

В следующем примере показано объявление поля, нарушающее это правило.

Imports System
Imports System.Text

Namespace SecurityLibrary

    Public Class MutableReferenceTypes

        Shared Protected ReadOnly SomeStringBuilder As StringBuilder

        Shared Sub New()
            SomeStringBuilder = New StringBuilder()
        End Sub

    End Class

End Namespace

using System;
using System.Text;

namespace SecurityLibrary
{
    public class MutableReferenceTypes
    {
        static protected readonly StringBuilder SomeStringBuilder;

        static MutableReferenceTypes()
        {
            SomeStringBuilder = new StringBuilder();
        }
    }
}

using namespace System;
using namespace System::Text;

namespace SecurityLibrary
{
    public ref class MutableReferenceTypes
    {
    protected:
        static StringBuilder^ const SomeStringBuilder = 
           gcnew StringBuilder();

    private:
        static MutableReferenceTypes()
        {
        }
    };
}

Поделиться через