共用方式為

CA1030:建議在適當時使用事件

屬性 值
規則識別碼 CA1030
職稱 建議在適當時使用事件
類別 設計
修正程式是中斷或非中斷 不中斷
在 .NET 10 中預設啟用 No

原因

方法名稱開頭為下列其中一項：

  • AddOn
  • RemoveOn
  • Fire
  • 提報

根據預設，此規則只會查看外部可見的方法，但這是可設定的。

檔案描述

此規則會偵測具有事件常用名稱的方法。 事件遵循 Observer 或 Publish-Subscribe 設計模式;當某個物件中的狀態變更必須傳達給其他物件時，就會使用它們。 如果方法在響應明確定義的狀態變更時呼叫，則事件處理程式應該叫用方法。 呼叫方法的物件應該要引發事件，而不是直接呼叫方法。

在使用者介面應用程式中，有一些常見的事件範例，例如按鍵會導致程式代碼區段執行。 .NET 事件模型不限於使用者介面。 它應該用於您必須將狀態變更傳達給一或多個物件的任何位置。

如何修正違規

如果在對象狀態變更時呼叫 方法，請考慮變更設計以使用 .NET 事件模型。

Example

// This class violates the rule.
public class BadButton
{
    private readonly List<Action> _clickHandlers = new List<Action>();

    public void AddOnClick(Action handler)
    {
        // Some internal logic...

        _clickHandlers.Add(handler);
    }

    public void RemoveOnClick(Action handler)
    {
        // Some internal logic...

        _clickHandlers.Remove(handler);
    }

    public void FireClick()
    {
        foreach (Action handler in _clickHandlers)
        {
            handler();
        }
    }
}

// This class satisfies the rule.
public class GoodButton
{
    private EventHandler? _clickHandler;

    public event EventHandler? ClickHandler
    {
        add
        {
            // Some internal logic...

            _clickHandler += value;
        }
        remove
        {
            // Some internal logic...

            _clickHandler -= value;
        }
    }

    protected virtual void OnClick(EventArgs e)
    {
        _clickHandler?.Invoke(this, e);
    }

    public void Click()
    {
        OnClick(EventArgs.Empty);
    }
}

隱藏警告的時機

如果 方法不適用於 .NET 事件模型，請隱藏此規則的警告。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則，請在組態檔none

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

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

您可以只針對此規則、針對它套用的所有規則，或針對套用至此類別的所有規則，或針對它套用的所有規則，設定此選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。

包含特定 API 介面

您可以藉由設定 [api_surface] 選項，根據程式代碼基底的存取範圍，設定執行此規則的哪些部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

注意

以適用規則的標識碼取代 XXXX 的 CAXXXX 部分。

  • Last updated on