Нечистий метод викликається для поля тільки для читання

Я використовую Visual Studio 2010 + Resharper, і він відображає попередження щодо такого коду:

if (rect.Contains(point))
{
    ...
}

rectце readonly Rectangleполе, і Resharper показує мені це попередження:

"Нечистий метод викликається для поля лише для читання типу значення."

Що таке нечисті методи і чому мені показують це попередження?

По-перше, відповіді Джона, Майкла та Джареда по суті правильні, але я маю ще кілька речей, які я хотів би до них додати.

Що мається на увазі під "нечистим" методом?

Легше охарактеризувати чисті методи. "Чистий" метод має такі характеристики:

• Його вихід повністю визначається вхідними даними; його вихід не залежить від зовнішніх факторів, таких як час доби або біти на жорсткому диску. Результат його роботи не залежить від його історії; виклик методу із заданим аргументом двічі повинен дати однаковий результат.
• Чистий метод не дає спостережуваних мутацій у навколишньому світі. Чистий метод може вибрати мутацію приватного стану заради ефективності, але чистий метод, скажімо, не мутує поле свого аргументу.

Наприклад, Math.Cosце чистий метод. Його вихід залежить лише від його вводу, і вхід не змінюється під час дзвінка.

Нечистий метод - це метод, який не є чистим.

Які небезпеки передачі нечистим методам конструкцій лише для читання?

Є два, що спадають на думку. Перший - це той, на який вказали Джон, Майкл та Джаред, і це той, про який вас попереджає Решарпер. Коли ви викликаєте метод у структурі, ми завжди передаємо посилання на змінну, яка є одержувачем, на випадок, якщо метод хоче змінити змінну.

То що, якщо ви викликаєте такий метод за значенням, а не змінною? У цьому випадку ми робимо тимчасову змінну, копіюємо в неї значення і передаємо посилання на змінну.

Змінна лише для читання вважається значенням, оскільки вона не може бути мутована поза конструктором. Отже, ми копіюємо змінну в іншу змінну, і нечистий метод, можливо, мутує копію, коли ви маєте намір змінити її.

Ось небезпека передачі структури для читання як приймача . Також існує небезпека передачі структури, що містить поле лише для читання. Структура, що містить поле лише для читання, є загальноприйнятою практикою, але по суті, це написання чека про те, що система типу не має коштів для готівки; "лише читання" певної змінної визначається власником сховища. Екземпляр посилального типу "володіє" власним сховищем, але екземпляр типу значення - ні!

struct S
{
  private readonly int x;
  public S(int x) { this.x = x; }
  public void Badness(ref S s)
  {
    Console.WriteLine(this.x);   
    s = new S(this.x + 1);
    // This should be the same, right?
    Console.WriteLine(this.x);   
  }
}

Можна думати, що this.xце не зміниться, оскільки x - це поле лише для читання і Badnessне є конструктором. Але ...

S s = new S(1);
s.Badness(ref s);

... наочно демонструє хибність цього. thisі sпосилаються на ту саму змінну, і ця змінна не лише для читання!

Нечистий метод - це метод, який не гарантує залишення значення таким, яким воно було.

У .NET 4 ви можете прикрасити методи та типи, [Pure]щоб оголосити їх чистими, і R # це помітить. На жаль, ви не можете застосувати його до чужих членів, і ви не можете переконати R #, що тип / член є чистим у проекті .NET 3.5, наскільки мені відомо. (Це постійно кусає мене в Noda Time .)

Ідея в тому , що якщо ви викликаєте метод , який мутує змінної, але ви викликаєте його на поле тільки для читання, це, ймовірно , НЕ робити те , що ви хочете, так що R # попередить вас про це. Наприклад:

public struct Nasty
{
    public int value;

    public void SetValue()
    {
        value = 10;
    }
}

class Test
{
    static readonly Nasty first;
    static Nasty second;

    static void Main()
    {
        first.SetValue();
        second.SetValue();
        Console.WriteLine(first.value);  // 0
        Console.WriteLine(second.value); // 10
    }
}

Це було б дуже корисним попередженням, якби кожен метод, який насправді був чистим, був оголошений таким чином. На жаль, це не так, тому є багато помилкових спрацьовувань :(

Коротка відповідь полягає в тому, що це помилково позитивний результат, і ви можете сміливо ігнорувати попередження.

Більш довга відповідь полягає в тому, що доступ до типу значення лише для читання створює його копію , так що будь-які зміни значення, внесені методом, впливатимуть лише на копію. ReSharper не усвідомлює, що Containsце чистий метод (тобто він не має побічних ефектів). Ерік Ліпперт розповідає про це тут: Мутація структур, призначених лише для читання

Схоже, Решапрер вважає, що метод Containsможе мутувати rectзначення. Оскільки rectце readonly structкомпілятор С # робить захисні копії значення , щоб запобігти метод з мутує в readonlyполе. По суті остаточний код виглядає так

Rectangle temp = rect;
if (temp.Contains(point)) {
  ...
}

Resharper попереджає вас тут, що Containsможе мутувати rectтаким чином, що буде негайно втрачено, оскільки це сталося тимчасово.

Нечистий метод - це метод, який може мати побічні ефекти. У цьому випадку Решарпер, здається, думає, що це може змінитися rect. Можливо, ні, але ланцюг доказів порушений.