AppBox升级进行时 - Attach陷阱（Entity Framework）

AppBox 是基于 FineUI 的通用权限管理框架，包括用户管理、职称管理、部门管理、角色管理、角色权限管理等模块。

Attach方法

前面我们已经多次使用Attach方法，上一次使用Attach方法修改用户所属部门的代码如下所示：

if (String.IsNullOrEmpty(hfSelectedDept.Text))
{
    item.Dept = null;
}
else
{
    int newDeptID = Convert.ToInt32(hfSelectedDept.Text);
    if (item.Dept.DeptID != newDeptID)
    {
        Dept newDept = new Dept { DeptID = newDeptID };
        DB.Depts.Attach(newDept);
        item.Dept = newDept;
    }
}

其中 newDeptID 是通过弹出窗口或者下拉列表选择的部门ID，也就是说这个 newDeptID 其实是存在于数据库中的，只不过还没有被加载到内存中。

这种情况非常适合使用 Attach 方法，从而避免了一次数据库查询来生成Dept对象：

Dept dept = DB.Depts.Where(d => d.ID == newDeptID).FirstOrDefault();

取而代之，我么使用Attach方法，就好像这个部门已经被加载到内存中一样：

Dept newDept = new Dept { DeptID = newDeptID };
DB.Depts.Attach(newDept);

官方对Attach的解释：http://msdn.microsoft.com/en-us/library/system.data.entity.dbset.attach(v=vs.103).aspx

Attach is used to repopulate a context with an entity that is known to already exist in the database. SaveChanges will therefore not attempt to insert an attached entity into the database because it is assumed to already be there. Entities that are already in the context in some other state will have their state set to unchanged. Attach is a no-op if the entity is already in the context in the unchanged state.　　

简单的翻译：Attach用来将某个已知存在于数据库中的实体重新加载到上下文中。SaveChanges不会尝试将Attached的实体插入到数据库中，因为这个实体假设已经存在于数据库中。　　

　　

Attach陷阱

为了更好的说明使用Attach过程中可能会遇到的问题，我么从如下简单的例子入手：

User admin = DB.Users.Where(u => u.Name == "admin").FirstOrDefault();

Dept dept = new Dept { ID = 1 };
DB.Depts.Attach(dept);

admin.Dept = dept;
DB.SaveChanges();

这个示例完成了如下操作：

1. 从数据库中加载用户名为 admin 的用户；

2. 将ID为1的部门附加到EF上下文中；

3. 设置admin用户所属的部门为上述部门；

4. 保存改变。

如果第一次执行这段代码，会有两个对数据库的操作，如下图所示：

　　

如果第二次执行这段代码，由于已经将用户数据加载到EF上下文，所以对用户部门的更新不会做任何改变，数据库操作只有一次查询操作：

　　

一切看似没有任何问题，直到我们遇到如下代码：

DB.Depts.Find(1);

User admin = DB.Users.Where(u => u.Name == "admin").FirstOrDefault();

Dept dept = new Dept { ID = 1 };
DB.Depts.Attach(dept);

admin.Dept = dept;
DB.SaveChanges();

在这段代码中，ID为1的部门已经被加载到EF上下文中，此时再次Attach同一个对象，就会出错：

　　

跳出Attach陷阱

解决办法也很简单，我们需要现在EF的Local缓存中查找对象，如果找不到再Attach新对象。关于Local对象的详细信息：http://msdn.microsoft.com/en-us/data/jj592872

为了方便代码调用，我们在页面基类PageBase中增加了一个Attach方法：

// 附加实体到数据库上下文中（首先在Local中查找实体是否存在，不存在才Attach，否则会报错）
protected T Attach<T>(int keyID) where T : class, IKeyID, new()
{
	T t = DB.Set<T>().Local.Where(x => x.ID == keyID).FirstOrDefault();
	if (t == null)
	{
		t = new T { ID = keyID };
		DB.Set<T>().Attach(t);
	}
	return t;
}

　　

因此完成上述示例正确的代码为：

DB.Depts.Find(1);

User admin = DB.Users.Where(u => u.Name == "admin").FirstOrDefault();

Dept dept = Attach<Dept>(1);
admin.Dept = dept;
DB.SaveChanges();

　　

你可能也注意到了，我们为实体类增加了一个 IKeyID 的接口，这是我们手工增加的：

public interface IKeyID
{
	int ID { get; set; }

}

Dept实体类实现了 IKeyID 接口，定义如下所示：

public class Dept : IKeyID
{
	[Key]
	public int ID { get; set; }

	[Required, StringLength(50)]
	public string Name { get; set; }

	[Required]
	public int SortIndex { get; set; }

	[StringLength(500)]
	public string Remark { get; set; }

	public virtual Dept Parent { get; set; }
	public virtual ICollection<Dept> Children { get; set; }

	public virtual ICollection<User> Users { get; set; }

}

　　

深入理解Attach

1. DBContext的作用域 

大家要理解一点，之所以出现上述异常，是因为我们将 DBContext 的实例保存在 HttpContext 中，在本系列的第一篇文章就有描述（One DbContext per Request）。

因此，我们很难在Attach时得知此对象是否已经被加载到EF的上下文中。相反，如果使用如下代码，则可能就不会遇到那个异常了（我们明确知道DBContext的作用域，并知道其中加载了哪些实体对象）：

using(var db = new AppBoxContext())
{
	db.Depts.Find(1);
}

using(var db = new AppBoxContext())
{
	User admin = db.Users.Where(u => u.Name == "admin").FirstOrDefault();

	Dept dept = new Dept { ID = 1 };
	db.Depts.Attach(dept);
	admin.Dept = dept;

	db.SaveChanges();
}

　　

2. 不要对Attach抱有过多幻想

有些时候，我们可能对Attach的期望值过高了，比如下面代码：

User admin = DB.Users.Where(u => u.Name == "admin").FirstOrDefault();

Dept dept = new Dept { Name = "研发部" };
DB.Depts.Attach(dept);

admin.Dept = dept;
DB.SaveChanges();

我们本来希望是将admin用户的部门设为“研发部”，可惜这段代码会报错：

看错误提示，我们知道是执行的SQL语句违反了外键约束。

查看执行的SQL语句，我们会发现EF试图将ID为0的部门更新到用户表。实际上，Depts表不存在ID为0的部门！

其实，我们创建部门的代码：

Dept dept = new Dept { Name = "研发部" };

创建了一个ID为0的部门。EF并不会对此有效性进行检查，更不会查询数据库获取此部门的ID。EF的会假设这个实体已经存在于数据库中了，而我们开发人员需要保证这个假设成立！　　

　

下载或捐赠AppBox

1. AppBox v2.0 是免费软件，免费提供下载：http://fineui.com/bbs/forum.php?mod=viewthread&tid=3788

2. AppBox v3.0 是捐赠软件，你可以通过捐赠作者来获取AppBox v3.0的全部源代码（http://fineui.com/donate/）。