《Entity Framework 6 Recipes》中文翻译系列 (27) ------ 第五章 加载实体和导航属性之关联实体过滤、排序、执行聚合操作

翻译的初衷以及为什么选择《Entity Framework 6 Recipes》来学习，请看本系列开篇

5-9  关联实体过滤和排序

问题

　　你有一实体的实例，你想加载应用了过滤和排序的相关实体。

解决方案

　　假设你有如图5-24所示的概念模型

图5-24 一个酒店预定系统的模型

 

 　　假设我们有一个酒店(Hotel）实体，使用代码清单5-22，获取酒店的商务套房（executive suite)，查看是否被预定，并按房价排序。

代码清单5-22.通过方法Entry()和Query()显式加载实体集合，并对集合过虑和排序

using (var context = new EFRecipesEntities())
            {
                var hotel = new Hotel {Name = "Grand Seasons Hotel"};
                var r101 = new Room {Rate = 79.95M, Hotel = hotel};
                var es201 = new ExecutiveSuite {Rate = 179.95M, Hotel = hotel};
                var es301 = new ExecutiveSuite {Rate = 299.95M, Hotel = hotel};

                var res1 = new Reservation
                    {
                        StartDate = DateTime.Parse("3/12/2010"),
                        EndDate = DateTime.Parse("3/14/2010"),
                        ContactName = "Roberta Jones",
                        Room = es301
                    };
                var res2 = new Reservation
                    {
                        StartDate = DateTime.Parse("1/18/2010"),
                        EndDate = DateTime.Parse("1/28/2010"),
                        ContactName = "Bill Meyers",
                        Room = es301
                    };
                var res3 = new Reservation
                    {
                        StartDate = DateTime.Parse("2/5/2010"),
                        EndDate = DateTime.Parse("2/6/2010"),
                        ContactName = "Robin Rosen",
                        Room = r101
                    };

                es301.Reservations.Add(res1);
                es301.Reservations.Add(res2);
                r101.Reservations.Add(res3);

                hotel.Rooms.Add(r101);
                hotel.Rooms.Add(es201);
                hotel.Rooms.Add(es301);

                context.Hotels.Add(hotel);
                context.SaveChanges();
            }

            using (var context = new EFRecipesEntities())
            {
                // 假设我们拥有一个Hotel实例
                var hotel = context.Hotels.First();

                //使用Load()方法显式加载，给通过Include()获取的关联数据提供过滤的机会
                context.Entry(hotel)
                       .Collection(x => x.Rooms)
                       .Query()
                       .Include(y => y.Reservations)
                       .Where(y => y is ExecutiveSuite && y.Reservations.Any())
                       .Load();

                Console.WriteLine("Executive Suites for {0} with reservations", hotel.Name);

                foreach (var room in hotel.Rooms)
                {
                    Console.WriteLine("
Executive Suite {0} is {1} per night", room.RoomId,
                                      room.Rate.ToString("C"));
                    Console.WriteLine("Current reservations are:");
                    foreach (var res in room.Reservations.OrderBy(r => r.StartDate))
                    {
                        Console.WriteLine("	{0} thru {1} ({2})", res.StartDate.ToShortDateString(),
                                          res.EndDate.ToShortDateString(), res.ContactName);
                    }
                }
            }

            Console.WriteLine("Press <enter> to continue...");
            Console.ReadLine();

代码清单5-22的输出如下：

Executive Suites for Grand Seasons Hotel with reservations
Executive Suite 65 is $299.95 per night
Current reservations are:
1/18/2010 thru 1/28/2010 (Bill Meyers)
3/12/2010 thru 3/14/2010 (Roberta Jones)
Executive Suite 64 is $79.95 per night
Current reservations are:
2/5/2010 thru 2/6/2010 (Robin Rosen)
Executive Suite 66 is $179.95 per night

原理

　　代码清单5-22，使用显式加载来获取关联实体集合，并在对集合进行过滤和排序。

　　和延迟加载、预先加载一起，显式加载（Explicit loading)是加载关联实体的第三种选择。使用显示加载时，你可以对它进行完全的控制。如果你用 它，你可以控制是否，何时，何地将关联实体加载到上下文中。

　　为了使用显示加载，我们使用了Dbcontext上下文对象公布的Entry()方法，它接受一个你希望查询实体的父类作为参数。Entry()方法提供了大量的关于实体的信息，包含通过使用方法collection()和Reference()访问关联实体。

　　在上面的示例中，我们使用父实体Hotel作为Entry()的参数，然后链式调用Collection()方法，并传递导航属性Rooms，作为它的参数。DbCollectionEntry类的Query()方法，产生一个查询，到数据库中去加载room实体。

　　最后，我们使用导航属性Reservations作为Include()方法的参数，为每个room预先加载关联的实体reservations。应用Where从句过滤获取类型为ExecuteiveSuite的，至少有一个预定的Room集合。然后使用OrderBy从句按房价对集合排序。

　　一般地，使用Include()方法为一个父实体返回所有的关联实体，但没有机会过滤和操作结果集。这个规则的一个例外就是，应用了显示加载。如示例演示的那样，我们能对关联的实体Reservations的结果集进行过滤和排序。

　　记住，我们只能使用这种方式对Include()为一个父实体返回的关联实体集进行过滤。这个特性在延迟加载和预先加载中无效。

5-10  在关联实体上执行聚合操作

问题

　　你想在一个关联实体集合上应用一个聚合操作，但是不加载整个集合。另外，你想使用Code-First管理数据访问。

解决方案

　　假设你有如图5-25所示的概念模型

图5-25 包含一个订单和它的订单项的模型

　　

　　在Visual Studio中添加一个名为Recipe10的控制台应用，并确保引用了实体框架6的库，NuGet可以很好的完成这个任务。在Reference目录上右键，并选择 Manage NeGet Packages（管理NeGet包），在Online页，定位并安装实体框架6的包。这样操作后，NeGet将下载，安装和配置实体框架6的库到你的项目中。

　　接下来我们创建两个实体对象：Order和OrderItem，复制代码清单5-23中的属性到这两个类中。

代码清单5-23. 实体类

 public class Order 
    {
        public Order()
        {
            OrderItems = new HashSet<OrderItem>();
        }

        public int OrderId { get; set; }
        public System.DateTime OrderDate { get; set; }
        public string CustomerName { get; set; }

        public virtual ICollection<OrderItem> OrderItems { get; set; }
    }


 public class OrderItem
    {
        public int OrderItemId { get; set; }
        public int OrderId { get; set; }
        public int SKU { get; set; }
        public int Shipped { get; set; }
        public decimal UnitPrice { get; set; }

        public virtual Order Order { get; set; }
    }

　　接下来，创建一个名为Recipe10Context的类，并将代码清单5-24中的代码添加到其中，并确保其派生到DbContext类。

代码清单5-24. 上下文

 public class Recipe10Context : DbContext
    {
        public Recipe10Context()
            : base("Recipe10ConnectionString")
        {
            //禁用实体框架的模型兼容
            Database.SetInitializer<Recipe10Context>(null);
        }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Order>().ToTable("Chapter5.Order");
            modelBuilder.Entity<OrderItem>().ToTable("Chapter5.OrderItem");
        }

        public DbSet<Order> Orders { get; set; }
        public DbSet<OrderItem> OrderItems { get; set; }
    }

接下来添加App.Config文件到项目中，并使用代码清单5-25中的代码添加到文件的ConnectionStrings小节下。

代码清单5-25. 连接字符串

<connectionStrings>
<add name="Recipe10ConnectionString"
connectionString="Data Source=.;
Initial Catalog=EFRecipes;
Integrated Security=True;
MultipleActiveResultSets=True"
providerName="System.Data.SqlClient" />
</connectionStrings>

　　在图5-25中，我们有一个简单的模型，它由一个订单(Order)和订单上的产品（OrderItems集合）组成。为订单计算总价的一种方法是，使用Load()方法加载订单项的整个集合，然后枚举它并对订单项进行求合计算。

　　另一种方法是，将计算的过程放到数据库中去，让它完成计算后返回。第二方法的优点是，它避免了为实现这个唯一的目标而实例化每个订单项的潜在成本。代码清单5-26演示了这种方法。

代码清单5-26.在不加载关联实体的情况下，对其运用聚合函数

 using (var context = new Recipe10Context())
            {
                var order = new Order {CustomerName = "Jenny Craig", OrderDate = DateTime.Parse("3/12/2010")};

                var item1 = new OrderItem {Order = order, Shipped = 3, SKU = 2827, UnitPrice = 12.95M};
                var item2 = new OrderItem {Order = order, Shipped = 1, SKU = 1918, UnitPrice = 19.95M};
                var item3 = new OrderItem {Order = order, Shipped = 3, SKU = 392, UnitPrice = 8.95M};

                order.OrderItems.Add(item1);
                order.OrderItems.Add(item2);
                order.OrderItems.Add(item3);

                context.Orders.Add(order);
                context.SaveChanges();
            }

            using (var context = new Recipe10Context())
            {
                // 假设我们有一个Order实体
                var order = context.Orders.First();

                // 获取订单总价
                var amt = context.Entry(order)
                    .Collection(x => x.OrderItems)
                    .Query()
                    .Sum(y => y.Shipped*y.UnitPrice);

                Console.WriteLine("Order Number: {0}", order.OrderId);
                Console.WriteLine("Order Date: {0}", order.OrderDate.ToShortDateString());
                Console.WriteLine("Order Total: {0}", amt.ToString("C"));
            }

            Console.WriteLine("Press <enter> to continue...");
            Console.ReadLine();

代码清单5-26的输出如下：

Order Number: 6
Order Date: 3/12/2010
Order Total: $85.65

原理

　　在代码清单5-26中，实现了显示加载，一开始，我们使用了DbContext上下文对象中公布的Entry()方法。Entry()方法接受一个Oder对象作为参数，它是我们希望查询对象的父实体。Entry()方法提供了关于Order的大量信息，包含通过方法Collection()和Reference()访问其关联实体对象。

　　在上面的示例中，我们通过链式调用Collection()方法并传递导航属性，OrderItems，作为参数来查询关联的订单项。DbCollectionEntry类中的方法Query()产生一个从数据库中加载订单项的查询。

　　最后，我们应用LINQ扩展方法Sum()，并传递一个lambda表达式来计算订单总价。整个表达式被转换成相应的存储层命令并执行，这样就为我们节省了实例化每一个订单项的成本。

　　这个简单示例演示了，通过灵活组合方法Entry()和Query()来实现显示加载，这两个方法会修改获取关联实体集合（OrderItems)的查询。这样，我们就能凭借这个查询，在不加载订单项的情况下为订单计算订单项的合计金额。

实体框架交流QQ群:  458326058，欢迎有兴趣的朋友加入一起交流

谢谢大家的持续关注，我的博客地址：http://www.cnblogs.com/VolcanoCloud/