ASP.NET MVC 使用 Entity Framework Code First - 基礎入門

最近看到 Bibby 與 KKBruce 都寫了 Code First 的相關文章，所以也就跟著來寫一篇，

Bibby - Simple Thoughts on Everything: Code First 紀錄

KingKong Bruce記事: 使用Entity Framework Code first建立多對多關係

用我的角度與敘述方式來為大家簡單說明，而這一篇文章所建立好的範例也將會在後續的其他主題的文章繼續沿用。

 

---

2013-10-15 更新：

目前作者「Hans Wolff」已將「ASP.NET MVC 4 Bootstrap Layout Template (VS2012)」與「ASP.NET MVC 4 Bootstrap Layout Template (VS2013)」從 Visual Studio Gallery 上給移除了，所以現在無法從 Visual Studio 的「擴充功能和更新」裡安裝，可以改使用另一個 Extensions「Bootstrap3 For Mvc4」，這邊有文章介紹「Visual Studio Extensions - Bootstrap3 For Mvc4」。

此篇文章所說明的 Entity Framework Code First 功能，不是只有在「ASP.NET MVC 4 Bootstrap Layout Template (VS2012)」專案範本裡才能使用，在 Visual Studio 預設的 ASP.NET MVC 4 專案範本裡就可以使用。

 

 

「Code First」是 Entity Framework 三種建置方式的其中一種，其他兩種分別是「Database First」與「Model First」，而「Database First」是最被大家所熟悉以及應用在專案上，至於「Model First」就比較少看到有人採用這種建置方式。

以簡單的方式來說就是，我們在開發專案的時候，先定義好系統內所使用的類別，而 EF Code First 會依照程式裡類別的定義在指定的資料庫表格以及欄位，這麼一來程式開發人員只需要專案於系統的開發，而不需要花時間先在資料庫裡建表格及欄位。而因為需求變更而要修改類別時，使用 Code First 只需要變更屬性設定，接著下指令執行後就會去修改資料庫裡的表格欄位，另外雖然 Code First 有比較多且複雜的操作，但與 Database First 或 Model First 相較，Code First 對程式開發人員來說是提供了比較多的彈性與操作。

這邊並不是說 Database First 不好，Code First 與 Database First 各有各的優點與好處，如果開發人員對於物件導向觀念清楚，而且有充分的全力能夠控管專案所使用的資料庫時，在一個新的開發專案裡可以考慮使用 Code First，而如果所開發專案的資料庫是使用既有的內容，或者開發人員並沒有資料庫比較高的權限時，使用 Database First 則是比較適當。

所以依據開發專案的實際情況來判別並選擇要用那一種 Entity Framework 建置策略方式，並沒有說一定要用那一種比較好，都有各自的好處。

前面廢話了一堆，下面就直接進入實作的部份，要實作的範式是要建立後台最基本的兩個物件，一個是「系統使用人員」而另一個是「系統角色」，兩者是多對多「many to many」的關係，一個系統使用人員可以有多個系統角色，而一個系統角色也會有多個系統使用人員，我們就針對這樣的情境來使用 Code First 進行開發。

 

Step.1

於 VS2012 裡建立一個 ASP.NET MVC 4 專案，這裡所使用的是之前有介紹過得「ASP.NET MVC 4 Bootstrap Layout Template (VS2012)」專案範本，

 

Step.2

使用 ASP.NET MVC 4 Bootstrap Layout Template (VS2012) 並沒有加入 EntityFramework，所以在建立網站專案之後就需要使用 NuGet 加入 EntityFramewwork，

 

Step.3

然後在專案裡的 App_Data 目錄裡加入一個 SQL Server 資料庫，這個範例要使用 LocalDB 來完成，Code First 可以使用在 LocalDB, SQL Server Express 以及 SQL Server 上，

再來開啟根目錄下的 Web.Config 檔案，加入資料庫連接字串，

<connectionStrings>

    <add

        name="DefaultConnection"

        connectionString="data source=(LocalDB)\v11.0;attachdbfilename=|DataDirectory|\Sample.mdf;integrated security=True;"

        providerName="System.Data.SqlClient" />

</connectionStrings>

 

Step.4

在 Models 目錄下分別建立 SystemUser.cs, SystemRole.cs, SampleContext.cs 三個類別，

SystemUser.cs

public class SystemUser

{

    [DisplayName("ID")]

    [Key]

    [Required]

    public Guid ID { get; set; }

    [DisplayName("帳號")]

    [Required]

    [StringLength(50)]

    [MinLength(5, ErrorMessage = "長度不可小於 5")]

    [MaxLength(50, ErrorMessage = "長度不可超過 50")]

    public string Account { get; set; }

    [DisplayName("密碼")]

    [Required]

    [StringLength(200)]

    [MinLength(5, ErrorMessage = "長度不可小於 5")]

    [MaxLength(200, ErrorMessage = "長度不可超過 200")]

    public string Password { get; set; }

    [DisplayName("名稱")]

    [Required]

    [StringLength(50)]

    [MinLength(2, ErrorMessage = "長度不可小於 2")]

    [MaxLength(50, ErrorMessage = "長度不可超過 50")]

    public string Name { get; set; }

    [DisplayName("Email")]

    [Required]

    [StringLength(200)]

    [MinLength(2, ErrorMessage = "長度不可小於 2")]

    [MaxLength(200, ErrorMessage = "長度不可超過 200")]

    public string Email { get; set; }

    [DisplayName("是否使用")]

    [Required]

    public bool IsEnable { get; set; }

    [DisplayName("建立者")]

    [Required]

    public Guid CreateBy { get; set; }

    [DisplayName("建立時間")]

    [Required]

    [DatabaseGenerated(DatabaseGeneratedOption.Computed)]

    public DateTime CreateOn { get; set; }

    [DisplayName("更新者")]

    public Guid? UpdateBy { get; set; }

    [DisplayName("更新時間")]

    public DateTime? UpdateOn { get; set; }

    public SystemUser()

    {

        this.ID = Guid.NewGuid();

        this.IsEnable = false;

        this.CreateBy = new Guid();

        this.SystemRoles = new List<SystemRole>();

    }

    public ICollection<SystemRole> SystemRoles { get; set; }

}

SystemRole.cs

public class SystemRole

{

    [DisplayName("ID")]

    [Key]

    [Required]

    public Guid ID { get; set; }

    [DisplayName("名稱")]

    [Required]

    [StringLength(50)]

    [MinLength(2, ErrorMessage = "長度不可小於 2")]

    [MaxLength(50, ErrorMessage = "長度不可超過 50")]

    public string Name { get; set; }

    [DisplayName("排序")]

    [Required]

    public int Sort { get; set; }

    [DisplayName("是否使用")]

    [Required]

    public bool IsEnable { get; set; }

    [DisplayName("建立者")]

    [Required]

    public Guid CreateBy { get; set; }

    [DisplayName("建立時間")]

    [Required]

    [DatabaseGenerated(DatabaseGeneratedOption.Computed)]

    public DateTime CreateOn { get; set; }

    [DisplayName("更新者")]

    public Guid? UpdateBy { get; set; }

    [DisplayName("更新時間")]

    public DateTime? UpdateOn { get; set; }

    public SystemRole()

    {

        this.ID = Guid.NewGuid();

        this.IsEnable = false;

        this.CreateBy = new Guid();

        this.SystemUsers = new List<SystemUser>();

    }

    public ICollection<SystemUser> SystemUsers { get; set; }

}

SystemUser 與 SystemRole 為多對多關係，所以兩個類別裡都有定義對方類別的集合物件屬性，

SampleContext.cs

namespace BlogSample.Models

{

    public class SampleContext : DbContext

    {

        public DbSet<SystemUser> SystemUsers { get; set; }

        public DbSet<SystemRole> SystemRoles { get; set; }

        public SampleContext()

            : base("name=DefaultConnection")

        {

        }

    }

}

其中 SampleContext 建構式裡呼叫基底類別建構函式所傳入的值，這是只我們在 Web.Config 裡建立的資料庫連結字串名稱，

 

Step.5

接著我們要使用「套件管理器主控台」下指令的方式來進行建立資料庫的操作，

如果開啟的方案裡有多個專案時，請記得要選擇「預設專案」，

 

第一個指令：啟用資料庫移轉

enable-migrations

如果專案裡不只一個 DbContext 類別的話，可以原本的指令後面 DbContext 類別名稱
enable-migrations –ContextTypeName BlogSample.Models.SampleContext

執行 enable-migrations 指令之後會在專案裡建立一個「Migrations」目錄以及「Configuration.cs」檔案，

 

第二個指令：新增執行資料庫移轉

add-migration 移轉名稱

移轉名稱可以標示每次移轉的版本編號或是具有意義的名稱，

第一次執行新增資料庫移轉，可以參考 Bibby 文章裡所寫的，使用「add-migration Init」

指令執行完成之後，在 Migrations 目錄裡會新增一個檔案，這個移轉資料庫命令的檔案是等一下執行更新資料庫更新移轉時所要執行的內容，會比對系統內所定義的類別與資料庫表格的差異，然後載明需要變化的內容，

 

第三個指令：執行更新資料庫移轉

update-database

執行 update-database 時，系統有出現訊息「Specify the '-Verbose' flag to view the SQL statements being applied to the target database.」，在 update-database 指令後面再加上 –Verbose 參數，這樣就可以看「Code First 移轉」 所執行的 SQL Statement 內容，如果是執行「update-database –Verbose」指令的話，在套件管理器主控台裡就可以看到以下的內容，

執行完「update-datebase」指令後，可以開啟 SSMS 或是直接在 VS2012 的伺服器總管查看 LocalDB 的內容，能夠看到有建立 SystemRole 與 SystemUser 這兩個 Table 之外，另外也有建立除存多對多關係的 SystemRolesSystemUsers 這個 Table，這個存放多對多關係的 Table 並不需要我們另外在專案理去建立類別，而是系統根據我們在類別裡所定義的類別而建立的，

 

使用 Code First 的步驟就如同上述的過程，在開發階段時，如果類別有更動或是新增，那麼就是再重新執行「add-migration 定義名稱」與「update-database」指令。

 

---

Entity Framework Power Tools Beta 4

http://visualstudiogallery.msdn.microsoft.com/72a60b14-1581-4b9b-89f2-846072eff19d

使用 Code First 進行開發時，我們可以在 Visual Studio 2012 裡安裝 Entity Framework Power Tool，

EF Power Tools 提供許多功能，例如：從現有資料庫進行反向工程，產生資料庫表格相對應的類別、自訂反向工程範本、檢視實體資料模型、檢視實體資料庫模型 XML、檢視實體資料庫模型 DDL SQL、產生檢視等。

在專案項目上按下滑鼠右鍵，在選單裡的「Entity Framework」所看到的項目，

在專案裡所建立的 DbContext 檔案項目按下滑鼠右鍵，選單的「Entity Framework」所看到的項目，

在 SampleContext.cs 選擇檢視實體資料模型， SampleContext 內所定義的類別與關聯，就如同我們使用 Database First 時所看到的檢視實體資料模型一樣，差別在於 Code First 的檢視只能單純的查看而無法編輯，

另外也可以選擇「Generate Views (產生檢視)」，產生 EF 執行階段所要使用的先行編譯檢視以改善啟動效能。

產生 Entity Framework 執行階段要用的先行編譯檢視，以改善啟動效能。產生的檢視檔案會加入至專案。

注意：如果所定義的類別有所更動並且重新執行更新移轉，請記得要在執行更新移轉後重新產生檢視檔案，否則會出現錯誤。

 

有關 Entity Framework Power Tools 的詳細說明，可以詳閱以下連結的文章：

MSDN - Data Access and Storage > 學習園地 > Entity Framework > 開始使用 > EF Power Tools

MSDN - Data Access and Storage > 學習園地 > Entity Framework > 開始使用 > EF5 的效能考量

快快樂樂學 Code First 開發，以現有資料庫為例 - 積沙成塔- 點部落

 

---

Entity Framework Code First 還有很多進階的操作處理，這一篇所說的只是最基本的一小段而已，建議各位可以到「MSDN > Data Access and Storage > 學習園地 > Entity Framework (EF) 使用者入門」將「使用 Code First 建立模型」單元內的教學內容看過一遍， Code First 有大致的了解，但還是需要多多練習。

 

參考連結：

Bibby - Simple Thoughts on Everything: Code First 紀錄

KingKong Bruce記事: 使用Entity Framework Code first建立多對多關係

MSDN > Data Access and Storage > 學習園地 > Entity Framework (EF) 使用者入門

MSDN - 新資料庫的 Entity Framework Code First

MSDN - Entity Framework Code First 移轉

 

以上