C# - 代码分析 2227 混乱

Question

我有一个类属性，如下所示：

public List<Recipe> RecipeList
{
    get { return this._recipeList; }

    set
    {
        this._recipeList = value;
        OnPropertyChanged("RecipeList");
    }
}

在另一种方法中，我有以下引用上面的属性的方法。

private void RecipeSearch()
{
            this.RecipeList = RecipeManagerService.SearchByUnit(SearchCriteria)
                               .Where(recipe => recipe.IsApproved == true && !recipe.IsHidden).ToList();
}

代码分析发出 CA 2227 警告：通过删除设置器将 RecipeList 更改为只读。谁能告诉我为什么？

Answer 1

在 List 对象上添加公共 setter 是危险的。您可以通过将 setter 设置为私有来消除此警告：

public List<Recipe> RecipeList
{
    get { return this._recipeList; }

    private set
    {
        this._recipeList = value;
        OnPropertyChanged("RecipeList");
    }
}

这仍然允许您的类更改此方法，但不允许外部源。

Answer 2

我认为这表明通常集合属性本身不应该是可变的 - 集合更常见的是可变的，并且只能通过 setter 访问。

不过，这只是一个建议:)

在这种情况下，您可以使用：

RecipeList.Clear();
RecipeList.AddRange(RecipeManagerService
                              .SearchByUnit(SearchCriteria)
                              .Where(r => r.IsApproved && !r.IsHidden));

请注意，这不会触发更改事件...您可能想改用 ObservableCollection。

这也意味着任何人都可以更改食谱列表的内容...您确实想要这样吗？另一种选择是公开 ReadOnlyCollection属性或类似的内容，并且仅在您自己的类中进行更改。这实际上取决于您想要做什么。

Answer 3

您想要另一个实例来扰乱 RecipeList 吗？一般来说，除了拥有该集合的实例之外，我不会让任何东西更改我的集合实例。您可以将其设为私有。

Answer 4

MSDN 描述相当清楚：

可写集合属性允许
用于替换集合的用户
完全不同的集合

如果你的班级的客户可以将列表更改为完全不同的食谱列表，那么面向对象就不太好了。这是反对封装的。

确保客户只是添加或删除项目是您可能想要做的。

Answer 5

我不认为代码有任何非法之处，但通常的做法是没有集合类型属性的公共设置器。您的私有 RecipeSearch 方法应该只设置 _recipeList 并引发事件，或者您可以将 _recipeList 本身设置为处理该事件的受保护属性。

Answer 6

允许列表属性以两种方式发生变化（通过它自己的 Add 和 Remove 方法以及整个列表实例）会为使用该属性的人创建一个不明确的接口。这会混淆职责并产生更大的技术债务/维护开销。

相反，更好的做法通常是将这些问题分开，以便该属性提供对列表的单个实例的访问。如果列表实例必须是可更改的，则这样做的单独机制可以更清楚地表明与属性交互的操作和更改属性指向的列表实例的操作是不同的。