如何使用实体框架将实体加载到私有集合中

Question

我有一个 POCO 域模型，它使用新的 ObjectContext 类连接到实体框架。

public class Product
    {
        private ICollection<Photo> _photos;

        public Product()
        {
            _photos = new Collection<Photo>();         
        }

        public int Id { get; set; }
        public string Name { get; set; }
        public virtual IEnumerable<Photo> Photos
        {
            get
            {
                return _photos;
            }
        }

        public void AddPhoto(Photo photo)
        {
            //Some biz logic
            //...
            _photos.Add(photo);
        }
    }

在上面的示例中，我将照片集合类型设置为 IEnumerable，因为这将使其只读。添加/删除照片的唯一方法是通过公共方法。

这样做的问题是实体框架无法将照片实体加载到 IEnumerable 集合中，因为它不是 ICollection 类型。

通过将类型更改为 ICollection 将允许调用者在集合本身上调用 Add mentod，这是不好的。

我有什么选择？

编辑：

我可以重构代码，这样它就不会公开照片的公共属性：

public class Product
    {
    public Product()
    {
        Photos = new Collection<Photo>();         
    }

    public int Id { get; set; }
    public string Name { get; set; }
    private Collection<Photo> Photos {get; set; }

    public IEnumerable<Photo> GetPhotos()
    {
        return Photos; 
    }

    public void AddPhoto(Photo photo)
    {
        //Some biz logic
        //...
        Photos.Add(photo);
    }

    }

并使用 GetPhotos() 返回集合。该方法的另一个问题是，我将失去更改跟踪能力，因为我无法将集合标记为虚拟 - 不可能将属性标记为私有虚拟。

在 NHibernate 中，我相信可以通过配置将代理类映射到 private 集合。我希望这将成为 EF4 的一个功能。目前我不喜欢无法对收藏品进行任何控制！

Answer 1

执行此操作的方法是拥有一个映射到模型中的受保护虚拟属性和一个返回 IEnumerable 的公共属性。

public class Product
{
    public Product()
    {
        PhotoCollection = new Collcation<Photo>();
    }

    public int Id { get; set; }
    public string Name { get; set; }
    protected virtual ICollection<Photo> PhotoCollection {get; set; }

    public IEnumerable<Photo> Photos
    {
        get { return PhotoCollection ; } 
    }

    public void AddPhoto(Photo photo)
    {
        //Some biz logic
        //...
        PhotoCollection .Add(photo);
    }
}

Answer 2

Anton，如果您能解释为什么您不希望开发人员访问您集合的 Add 方法，这将帮助我更好地理解您的问题。这是因为该列表是严格只读的，还是因为您想在添加新实体时运行一些自定义业务逻辑？

无论如何......我将假设您正在尝试执行后者（即在修改集合时运行自定义业务逻辑）。我在我的一个项目中做了类似的解决方案，其想法如下：

在 EF4 中生成 POCO 的 TT 模板将所有集合创建为 TrackableCollection 列表。此类有一个名为“CollectionChanged”的事件，您可以订阅该事件并侦听集合的任何更改。

因此，您可以执行以下操作：

public class Product
{
    public Product()
    {
        Photos.CollectionChanged += ListCollectionChanged;
    }

    public int Id { get; set; }

    public string Name { get; set; }

    public TrackableCollection<Photo> Photos
    {
        get
        {
            // default code generated by EF4 TT
        }
        set
        {
            // default code generated by EF4 TT
        }
    }

    private void ListCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
    {
        switch (e.Action)
        {
            // A new item has been added to collection
            case NotifyCollectionChangedAction.Add:
                {
                    T newItem = (T) e.NewItems[0];
                    // Run custom business logic
                }
                break;

            // An existing item has been removed
            case NotifyCollectionChangedAction.Remove:
                {
                    T oldItem = (T) e.OldItems[0];
                    // Run custom business logic
                }
                break;
        }
    }
}

上述解决方案的好处是您仍然以“EF”方式使用您的 Product 实体...如果您团队中的任何开发人员都可以简单地访问实体目录的属性并需要运行显式硬类型函数。

Answer 3

虽然有点晚了，但这就是 Observable 对象的用途。让数据结构发挥它最擅长的作用。如果您不想构建自己的集合来执行您需要的操作并从您的属性公开常规 ICollection 类型，请使用 ObservableCollection 作为字段类型。当集合中的相关实体通过 CollectionChanged 事件发生更改时，您可以在所需的父实体中运行任何逻辑。如果您需要有选择地启用或禁用修改，则很容易扩展现有集合类型或编写一个代理集合，该代理集合允许调用方法来切换集合的可变性（ISupportInitialize 可以用来很好地表示这种能力 BTW ）。

Answer 4

（对于我最初的帖子的简洁性表示歉意 - 我是通过手机回答的）

您可以通过 EF 实体集上的 LINQ 查询来构建您的集合。但是，您将结果集合保留为业务类的内部数据成员，并公开通过在实体集上调用 AsEnumerable() 返回的 IEnumerable 作为以下结果：公开照片。

您也可以在内部缓存 IEnumerable，这样您就不会在每次调用者请求集合时都调用 AsEnumerable()。当然，这意味着如果用户需要通过您的公共方法更新集合，您可能必须刷新缓存的 IEnumerable。如果调用者还缓存了指向前一个 IEnumerable 的指针，这可能会带来小问题。

或者，如果您的调用方始终使用完整的实体集，则 EntitySet 类（您的所有 EF 集都将继承该类）实现 IEnumerable，因此您可以直接将实体集返回给调用者。

请注意，如果您希望在业务类的范围之外从 EF 实体集加载集合，则可以在您的类上创建一个采用 ICollection 的构造函数。这样，一旦创建了对象，集合就会被密封在其中，并且仅作为 IEnumerable 公开。

Answer 5

为什么不尝试以下方法并保留使用属性呢？

private ICollection<Photo> photos{get; set;}
public IEnumerable<Photo> Photos
{
    get {return (IEnumberable<Photo>)photos;}
}

或者，您可以使用装饰器模式将类封装到不能直接修改集合的类中。