Code First Entity Framework 6化被動為主動之explicit loading模式實戰分析( 附源碼)

在使用Entity Framework加載關聯實體時，可以有三種方式：

1.懶加載(lazy Loading);

 2.貪婪加載(eager loading);  

3.顯示加載(explicit loading)。

EF默認使用的是懶加載(lazy Loading)。一切由EF自動處理。

這種方式會導致應用程序多次連接數據庫，這種情況推薦在數據量較大的情況下使用。當我們需要加載數據較少時，一次性全部加載數據會相對更高效。

我們來看看EF的顯示加載(explicit loading)如何讓我們完全掌控數據的加載(非自動化)。

這里我們使用Code First模式。

數據表：商品表，商品分類表，品牌表

Step1：新建控制台應用程序，添加EF6引用(可以使用NuGet獲取)

 

 

Step2：創建三個實體對象：Product、Category 、Brand

Product實體類：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EFExplicitLoading.Models {
  public  class Product {
      public int ProductId { get; set; }
      public String Title { get; set; }
      public int CategoryId { get; set; }

      public virtual Category Category { get; set; }

      public virtual Brand Brand { get; set; }

  }
}

 

 

Category實體類：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EFExplicitLoading.Models {
  public  class Category {

      public Category() {
          Products = new HashSet<Product>();
      }

      public int CategoryId { get; set; }
      public String Name { get; set; }

      public virtual ICollection<Product> Products { get; set; } 
  }
}

 

 

 

Brand實體類：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EFExplicitLoading.Models {
  public  class Brand {

      public Brand() {
          Products = new HashSet<Product>();
      }

      public int BrandId { get; set; }

      public String Name { get; set; }

      public virtual ICollection<Product> Products { get; set; } 
  }
}

 

Step3：創建派生自DbContext的類(ExplicitContext)

using System.Data.Entity;
using EFExplicitLoading.Models;

namespace EFExplicitLoading {

    public class ExplicitContext : DbContext {
        public ExplicitContext()
            : base("ExplicitConnectionString") {
        }

        public DbSet<Product> Products { get; set; }

        public DbSet<Category> Categories { get; set; }

        public DbSet<Brand> Brands { get; set; }

        protected override void OnModelCreating(DbModelBuilder modelBuilder) {
            modelBuilder.Entity<Product>().ToTable("Product");
            modelBuilder.Entity<Brand>().ToTable("Brand");
            modelBuilder.Entity<Category>().ToTable("Category");
        }
    }

}

 

Step4：在App.config中添加connectionStrings節點

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

 

准備工作已就緒，當我們使用ExplicitContext類時，EF會根據實體自動創建數據庫和表

 

下面回到控制台入口函數處：

Step5：添加測試數據

            using (var context = new ExplicitContext()) {
                //先清空數據
                context.Database.ExecuteSqlCommand("delete from product");
                context.Database.ExecuteSqlCommand("delete from brand");
                context.Database.ExecuteSqlCommand("delete from category");

                var category1 = new Category {Name = "服裝"};
                var category2 = new Category {Name = "家電"};
                var brand1 = new Brand {Name = "品牌1"};
                var brand2 = new Brand {Name = "品牌2"};

                context.Products.Add(new Product {Brand = brand1, Category = category1, Title = "產品1"});
                context.Products.Add(new Product {Brand = brand1, Category = category2, Title = "產品2"});
                context.Products.Add(new Product {Brand = brand1, Category = category2, Title = "產品3"});
                context.Products.Add(new Product {Brand = brand2, Category = category2, Title = "產品4"});
                context.Products.Add(new Product {Brand = brand2, Category = category2, Title = "產品5"});
                context.Products.Add(new Product {Brand = brand2, Category = category2, Title = "產品6"});
                context.SaveChanges();
            }

 

 

Step6：開始測試explicit loading

using (var context = new ExplicitContext()) {
                //禁用懶加載
                context.Configuration.LazyLoadingEnabled = false;

                var category = context.Categories.First(c => c.Name == "家電");

                //判斷分類關聯的產品是否已經被加載
                if (!context.Entry(category).Collection(x => x.Products).IsLoaded) {
                    context.Entry(category).Collection(x => x.Products).Load();
                    Console.WriteLine("分類{0}的產品被顯示加載...", category.Name);
                }

                Console.Write("分類{0}下的共有{1}件產品", category.Name, category.Products.Count());

                foreach (var product in context.Products) {
                    if (!context.Entry(product).Reference(x => x.Category).IsLoaded) {
                        context.Entry(product).Reference(x => x.Category).Load();
                        Console.WriteLine("分類{0}被顯示加載.", product.Category.Name);
                    }
                    else {
                        Console.WriteLine("分類{0}已經加載過了.", product.Category.Name);
                    }
                }

                //重新使用category計算 產品數量
                Console.WriteLine("產品加載完后，分類{0}下有{1}件產品", category.Name, category.Products.Count());

                category.Products.Clear();
                Console.WriteLine("產品集合被清空了.");
                Console.WriteLine("此時分類{0}下有{1}件產品", category.Name, category.Products.Count());


                context.Entry(category).Collection(x => x.Products).Load();
                Console.WriteLine("重新顯示加載產品");
                Console.WriteLine("此時分類{0}下有{1}件產品", category.Name, category.Products.Count());

                //使用ObjectContext刷新實體
                var objectContext = ((IObjectContextAdapter) context).ObjectContext;
                var objectSet = objectContext.CreateObjectSet<Product>();
                objectSet.MergeOption = MergeOption.OverwriteChanges;
                objectSet.Load();
                //MergeOption.AppendOnly
                //MergeOption.OverwriteChanges
                //MergeOption.NoTracking
                //MergeOption.PreserveChanges
                

                Console.WriteLine("產品集合以MergeOption.OverwriteChanges的方式重新加載");
                Console.WriteLine("此時分類{0}下有{1}件產品", category.Name, category.Products.Count());
            }


            Console.WriteLine("測試部分加載...");
            //測試部分加載，然后加載所有
            using (var context = new ExplicitContext()) {
                //禁用懶加載
                context.Configuration.LazyLoadingEnabled = false;
                var category = context.Categories.First(c => c.Name == "家電");
                //先加載1條數據
                Console.WriteLine("先加載1條數據");
                context.Entry(category).Collection(x => x.Products).Query().Take(1).Load();
                Console.WriteLine("分類{0}下共有{1}件產品", category.Name, category.Products.Count());

                //加載所有
                context.Entry(category).Collection(x => x.Products).Load();
                Console.WriteLine("加載所有數據");

                Console.WriteLine("此時分類{0}下有{1}件產品", category.Name, category.Products.Count());
            }

            Console.ReadKey();

 

 

執行結果：

  禁用懶加載(lazy loading)            

要想測試我們的explict loading，必須先禁用懶加載，有2種方式可以禁用懶加載：

1.設置Context.Configuration.LazyLoadingEnabled的值為false   或

2.移除每一個實體類中的關聯實體屬性(導航屬性)的virtual訪問修飾符，這種方法可以更精確控制懶加載，即只禁用移除virtual修飾符實體的懶加載

 

  IsLoaded屬性和Load方法            

接下來，我們利用EF獲取一條Name為家電的分類實體數據，由於Category與Product是一對多的關系，此時我們可以使用IsLoaded屬性來測試此分類下的Products集合是否被加載

context.Entry(category).Collection(x => x.Products).IsLoaded

若沒有加載，我們使用Load方法來加載關聯的Products，在接下來的foreach遍歷中，我們可以看到，Category關聯的Product已經全部被加載完畢

PS：當使用Take(n)方法Load數據時，IsLoaded屬性依然為False，因為只有當關聯的所有數據加載完，IsLoaded才為true

  關系修復(relationship fixup)      

這里Entity Framework使用稱為"關系修復"的技術(relationship fixup)，即當我們單獨加載關聯實體的時候(Product)，這些數據會自動掛載到已經載入的實體(Category)，但這種關系修復並不是總是會生效，比如在多對多的關系中就不會這樣處理。

  關於Clear()                                 

然后我們打印出來Category中有多少Product，之后使用Clear()方法清空category對象的關聯集合Products。

Clear方法會移除Category和Product的關聯關系，但Product集合數據並沒有刪除，依然存在上下文的內存中，只是它不再與Category關聯。

后面我們又重新使用Load加載Product但category.Products.Count()的值依然為0。這正好說明Clear方法的本質。

這是因為Load默認使用MergeOption.AppendOnly的方式加載數據，找不到Product實例了(被Clear了)。然后我們使用MergeOption.OverwriteChanges的方式才將數據重新關聯

 

  關於MergeOption(實體合並選項) 

MergeOption枚舉共有4個選項

1.MergeOption.AppendOnly

　　在現有的關系基礎上合並
2.MergeOption.OverwriteChanges

　　OverwriteChanges模式，會從數據庫中更新當前上下文實例的值(使用同一個實體對象的實例，如category)。

　　當你想要恢復實體在上下文的改變，從數據庫刷新實體時，使用這個模式就非常有用。

3.MergeOption.NoTracking

　　無追蹤模式不會跟蹤對象的變化，也不會意識到對象已經被加載到當前上下文

　　NoTracking可以應用到一個實體的導航屬性(關聯實體屬性)，但這個實體也必須使用NoTracking

　　反過來，NoTracking應用到某個實體時，這個實體的導航屬性會忽略默認的AppendOnly模式而使用NoTracking模式
4.MergeOption.PreserveChanges

　　PreserveChanges選項本質上與OverwriteChanges選項相反，

　　PreserveChanges模式會更新查詢結果集(若數據庫中有變化)，但不會更新在當前上下文內存中的值

PS： 也許你已經注意到，這里我們使用了ObjectContext對象，而不是context對象，這是因為DbContext不能直接使用MergeOption類型，所以必須使用ObjectContext對象

  關於性能提升                                

在任何時候，關聯實體集合的數量被限制時，使用Load方法，會有助於我們提升程序的性能，比如加載一個Category中的5條Product。

在少量場景中，我們需要整個關聯集合時，也可以使用Load

PS：當一個實體在Added(添加)、Deleted(刪除)、Detected(分離)狀態時，Load方法無法使用。

關於Entity Framework性能提升的方法還有很多，當然，我們必須根據自己的項目實際情況來做優化。不同的應用場景，選擇不同的優化方案

 

示例代碼：點此下載