[小技巧]EF Core中如何获取上下文中操作过的实体

Posted 2020-11-22 lwqlun

原文:[小技巧]EF Core中如何获取上下文中操作过的实体

原文地址：https://www.cnblogs.com/lwqlun/p/10576443.html
作者：Lamond Lu
源代码：https://github.com/lamondlu/EFCoreFindSample

背景介绍#

当我们在工作单元(UnitOfWork)中使用EF/EF Core的时候，为了要保持事务，一个用户操作只能调用一次SaveChange方法，但是有时候一个用户操作需要调用多个Repository，并且他们操作的实体是关联的。这时候在一个Repository中获取另外一个Repository中添加/修改/删除的实体就变成了一个问题。

问题说明#

当前我们做一个学生管理系统，学生和班之间是多对多关系，一个学生可以属于多个班， 因此我们创建了如下的EF上下文。

Copy
    public class TestDbContext : DbContext
    {

        public TestDbContext(DbContextOptions<TestDbContext> options) : base(options)
        {

        }

        public DbSet<Student> Students { get; set; }

        public DbSet<Group> Groups { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<StudentGroup>().HasKey(p => new { p.GroupId, p.StudentId });

            base.OnModelCreating(modelBuilder);
        }
    }


    [Table("Student")]
    public class Student
    {
        public Student()
        {
            StudentGroups = new List<StudentGroup>();
        }

        [Key]
        public Guid StudentId { get; set; }

        public string Name { get; set; }

        public int Credits { get; set; }

        public virtual ICollection<StudentGroup> StudentGroups { get; set; }
    }

    [Table("Group")]
    public class Group
    {
        [Key]
        public Guid GroupId { get; set; }

        public string GroupName { get; set; }
    }

    [Table("StudentGroup")]
    public class StudentGroup
    {
        public Guid StudentId { get; set; }

        public Guid GroupId { get; set; }

        [ForeignKey("StudentId")]
        public virtual Student Student { get; set; }

        [ForeignKey("GroupId")]
        public virtual Group Group { get; set; }
    }

在用户界面上，我们允许用户在添加学生的时候，同时将学生分配到一个班级中。

因此我们的控制器代码如下：

Copy
    public class StudentController : ControllerBase
    {
        private StudentManager _studentManager = null;

        public StudentController(StudentManager studentManager)
        {
            _studentManager = studentManager;
        }

        // GET api/values
        [HttpPost]
        public IActionResult Post([FromBody]AddStudentDTO dto)
        {
            try
            {
                _studentManager.AddStudent(dto.Name, dto.GroupId);

                return StatusCode(201);
            }
            catch
            {
                return StatusCode(500, new { message = "Unexpected Issue." });
            }
        }
    }

为了完成我们的业务，在StudentManager的AddStudent方法中，我们需要完成两步操作

1. 添加学生信息
2. 将学生分配给指定班

Copy
    public class StudentManager
    {
        private IUnitOfWork _unitOfWork;

        public StudentManager(IUnitOfWork unitOfWork)
        {
            _unitOfWork = unitOfWork;
        }

        public void AddStudent(string studentName, Guid groupId)
        {
            var newStudentId = Guid.NewGuid();

            _unitOfWork.StudentRepository.AddStudent(newStudentId, studentName);
            _unitOfWork.GroupRepository.AssignStudentToGroup(newStudentId, groupId);

            _unitOfWork.Commit();
            
        }
    }

这里我们使用StudentRepository的AddStudent方法来完成保存学生信息，使用GroupRepository的AssignStudentToGroup方法来将学生分配给班级。

这里，其实不应该将保存学生信息和分配班级都放在这里，可以使用事件发布/订阅将其分配班级的逻辑移动到别处。

针对保存学生信息的操作，代码很简单。

Copy
    public class StudentRepository : IStudentRepository
    {
        private TestDbContext _dbContext;

        public StudentRepository(TestDbContext dbContext)
        {
            _dbContext = dbContext;
        }

        public void AddStudent(Guid studentId, string name)
        {
            _dbContext.Students.Add(new Student
            {
                StudentId = studentId,
                Name = name,
                Credits = 0
            });
        }
    }

但是当我们继续编写AssignStudentToGroup方法时就会遇到问题，我们该如何获取到前面方法中添加的Student实体？

这时候，有同学会去尝试

_dbContext.Students.Where(p=>p.StudentId = studentId)

你会发现它获取不到你想要的对象，原因是这条语句进行的是数据库查询，当前新增的Student对象还没有保存到数据库

那么如何解决这个问题呢？这里有2种解决方案

• 从ChangeTracker上获取
• 使用Find方法获取

从ChangeTracker上获取#

ChangeTracker是EF/EF Core中的核心对象，在这个对象中记录了当前EF上下文，操作过的所有实体，实体状态及实体属性的变更。

ChangeTracker中的Entries泛型方法可以帮助我们获取到当前上下文中操作过的指定类型实体集合。

Copy
    public void AssignStudentToGroup(Guid studentId, Guid groupId)
    {
        Student student = _dbContext.ChangeTracker.Entries<Student>().FirstOrDefault(p => p.Entity.StudentId == studentId).Entity;;

        if (student == null)
        {
            throw new KeyNotFoundException("The student id could not be found.");
        }

        student.StudentGroups.Add(new StudentGroup
        {       
            StudentId = studentId,
            GroupId = groupId
        });
    }

但是这样写会出现一个问题，如果我想为一个数据库中已经存在的学生分配班级，调用这个方法就会出现问题，因为该实体还未加载到ChangeTracker中, 所以我们这里还需要使用_dbContext.Students.First方法进行数据库查询.

Copy
    public void AssignStudentToGroup(Guid studentId, Guid groupId)
    {
        Student student;

        if (_dbContext.ChangeTracker.Entries<Student>().Any(p => p.Entity.StudentId == studentId))
        {
            student = _dbContext.ChangeTracker.Entries<Student>().First(p => p.Entity.StudentId == studentId).Entity;
        }
        else if (_dbContext.Students.Any(p => p.StudentId == studentId))
        {
            student = _dbContext.Students.First(p => p.StudentId == studentId);
        }
        else
        {
            throw new KeyNotFoundException("The student id could not be found.");
        }

        student.StudentGroups.Add(new StudentGroup
        {
            StudentId = studentId,
            GroupId = groupId
        });
    }

至此，整个方法的修改就完成了。如果你觉着这种方式比较繁琐，请继续看下面的Find方法。

使用Find方法#

EF/EF Core中其实还提供了一个Find方法，以下是该方法的方法签名。

Copy
    // Summary:
    //     Finds an entity with the given primary key values. If an entity with the given
    //     primary key values is being tracked by the context, then it is returned immediately
    //     without making a request to the database. Otherwise, a query is made to the database
    //     for an entity with the given primary key values and this entity, if found, is
    //     attached to the context and returned. If no entity is found, then null is returned.
    //
    // Parameters:
    //   keyValues:
    //     The values of the primary key for the entity to be found.
    //
    // Returns:
    //     The entity found, or null.
    public virtual TEntity Find([CanBeNullAttribute] params object[] keyValues);

从这个Find方法的注释中，我们可以了解到，Find方法可以根据实体主键查询实体。但是它的优点是，它会优先去ChangeTracker中查找，如果查找不到才会生成查询语句，进行数据库查询。

由此，我们可以使用Find方法修改AssignStudentToGroup方法，看起来比之前的代码简化了不少

Copy
    public void AssignStudentToGroup(Guid studentId, Guid groupId)
    {
        Student student = _dbContext.Students.Find(studentId);

        if (student == null)
        {
            throw new KeyNotFoundException("The student id could not be found.");
        }

        student.StudentGroups.Add(new StudentGroup
        {
            StudentId = studentId,
            GroupId = groupId
        });
    }