在之前的教學中,你使用了一個由三個實體組成的簡單資料模型。 在這個教學中,你將新增更多實體和關係,並透過指定格式、驗證和資料庫映射規則來自訂資料模型。
當您完成時,實體類別會構成如下列圖例中所顯示的完整資料模型:
在本教學課程中,您會:
- 自訂資料模型
- 變更學生實體類型
- 建立教師實體
- 建立 OfficeAssignment 實體
- 修改課程 Entity
- 建立部門實體
- 修改 Enrollment 實體
- 更新資料庫內容
- 使用測試資料初始化資料庫
- 新增移轉
- 更改連線字串
- 更新資料庫
Prerequisites
自訂資料模型
在本節中,您會了解到如何使用指定格式、驗證和資料庫對應規則的屬性來自訂資料模型。 接著在接下來的幾個章節中,你會透過為已建立的類別新增屬性,並為模型中剩餘的實體類型建立新的類別,來建立完整的學校資料模型。
DataType 屬性
針對學生登記日期,所有網頁目前都同時顯示時間和日期,但此欄位您只需要日期。 使用資料註解屬性,您可以透過僅對一個程式碼進行變更,來修正每個顯示資料的檢視上的顯示格式。 為了查看如何進行此操作的範例,您將會新增一個屬性至 EnrollmentDate 類別中的 Student 屬性。
在 Models/Student.cs 中,為 System.ComponentModel.DataAnnotations 命名空間加入 using 陳述式,並在 EnrollmentDate 屬性中加入 DataType 和 DisplayFormat 屬性,如下列範例所示:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
namespace ContosoUniversity.Models
{
public class Student
{
public int ID { get; set; }
public string LastName { get; set; }
public string FirstMidName { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
public DateTime EnrollmentDate { get; set; }
public ICollection<Enrollment> Enrollments { get; set; }
}
}
DataType 屬性可用於指定比資料庫內建類型更特定的資料類型。 在此案例中,我們只想要追蹤日期,而非日期和時間。
DataType列舉提供多種資料類型,如日期、時間、電話號碼、貨幣、電子郵件地址等。
DataType 屬性也可讓應用程式自動提供類型的特定功能。 例如,可建立 mailto: 的 DataType.EmailAddress 連結,而且可以在支援 HTML5 的瀏覽器中提供 DataType.Date 的日期選擇器。 該 DataType 屬性會產生 HTML 5 data- (發音為 data dash)屬性,而 HTML 5 瀏覽器可識別這些屬性。 屬性 DataType 本身並不能提供任何驗證。
DataType.Date 未指定顯示日期的格式。 預設情況下,資料欄位會依據伺服器 CultureInfo 的預設格式顯示。
DisplayFormat 屬性用來明確指定日期格式:
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
ApplyFormatInEditMode 設定可指定在文字方塊中顯示值以供編輯時,也應該套用的格式。 (有些欄位你可能不希望有這種設定——例如貨幣值,你可能不想在文字框裡有貨幣符號以便編輯。)
你可以單獨使用 DisplayFormat 屬性,但通常也用 DataType 屬性是個好主意。 這個 DataType 屬性傳達的是資料的語意,而非如何在螢幕上呈現,並提供以下你無法獲得 DisplayFormat的好處:
瀏覽器可支援 HTML5 功能(例如顯示行事曆控制項、當地貨幣符號、電子郵件連結、部分用戶端輸入驗證等)。
根據預設,瀏覽器將根據您的地區設定,使用正確的格式呈現資料。
欲了解更多資訊,請參閱 <輸入> 標籤協助程式文件。
啟動應用程式,前往學生索引頁面,發現報名日期的時間不再顯示。 任何使用 Student 模型的檢視都會如此。
StringLength 屬性
你也可以用屬性指定資料驗證規則和驗證錯誤訊息。 「StringLength」屬性會設定資料庫中的最大長度,並提供 ASP.NET Core MVC 的用戶端與伺服器端驗證。 您也可以在此屬性中指定最小字串長度,但最小值不會對資料庫結構描述造成任何影響。
假設您想要確保使用者不會在名稱中輸入超過 50 個字元。 若要新增此限制,請將 FirstMidName 屬性加入至 StringLength 和 LastName 屬性,如下列範例所示:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
namespace ContosoUniversity.Models
{
public class Student
{
public int ID { get; set; }
[StringLength(50)]
public string LastName { get; set; }
[StringLength(50)]
public string FirstMidName { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
public DateTime EnrollmentDate { get; set; }
public ICollection<Enrollment> Enrollments { get; set; }
}
}
這個 StringLength 屬性不會阻止使用者在名稱中輸入空白字元。 你可以用屬性 RegularExpression 來對輸入施加限制。 例如,下列程式碼會要求第一個字元必須是大寫,其餘字元則必須是英文字母:
[RegularExpression(@"^[A-Z]+[a-zA-Z]*$")]
屬性 MaxLength 提供類似該 StringLength 屬性的功能,但不提供用戶端驗證。
資料庫模型現在已經改變,需要改變資料庫結構。 你會用遷移功能更新結構,同時不會遺失你透過應用程式介面加入資料庫的資料。
儲存您的變更並建置專案。 接著在專案資料夾中開啟指令視窗,輸入以下指令:
dotnet ef migrations add MaxLengthOnNames
dotnet ef database update
migrations add 命令警告可能會發生資料遺失,因為變更使兩欄的最大長度變短。 遷移會建立一個名為 <timeStamp>_MaxLengthOnNames.cs 的檔案。 此檔案包含在 Up 方法中的程式碼,將更新資料庫以符合目前的資料模型。
database update 指令執行了那段程式碼。
加在遷移檔案名稱前面的時間戳記由 Entity Framework 用來排序遷移。 你可以先建立多個遷移,再執行 update-database 指令,然後所有遷移都會依照建立順序套用。
啟動應用程式,選擇 學生 標籤,點選 建立新資料,嘗試在任一個姓名欄位中輸入超過 50 個字元。 應用程式應該會阻止你這樣做。
Column 屬性
您也可以使用屬性控制您的類別和屬性對應到資料庫的方式。 假設您已針對名字欄位使用 FirstMidName 作為名稱,因為欄位中可能也會包含中間名。 但您想要將資料庫資料行命名為 FirstName,因為撰寫臨機操作查詢資料庫的使用者比較習慣該名稱。 若要進行此對應,您可以使用 Column 屬性。
Column 屬性指定當建立資料庫時,Student 資料表中對應到 FirstMidName 屬性的資料行會命名為 FirstName。 換句話說,當您的程式碼參照 Student.FirstMidName 時,資料便會來自 FirstName 資料表中的 Student 資料行或在其中更新。 如果你沒指定欄位名稱,欄位名稱會和屬性名稱一樣。
在 Student.cs 檔案中,新增一個用於 System.ComponentModel.DataAnnotations.Schema 的 using 陳述式,並在 FirstMidName 屬性中加入欄位名稱屬性,如下列反白顯示的程式碼所示:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class Student
{
public int ID { get; set; }
[StringLength(50)]
public string LastName { get; set; }
[StringLength(50)]
[Column("FirstName")]
public string FirstMidName { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
public DateTime EnrollmentDate { get; set; }
public ICollection<Enrollment> Enrollments { get; set; }
}
}
新增這個 Column 屬性會改變 SchoolContext 的後端模型,因此它不會與資料庫匹配。
儲存您的變更並建置專案。 接著在專案資料夾中開啟指令視窗,輸入以下指令來建立另一個遷移:
dotnet ef migrations add ColumnFirstName
dotnet ef database update
在 SQL Server 物件總管 中,雙擊 Student 資料表以開啟學生資料表設計器。
在你套用前兩次遷移之前,名稱欄位的類型是 nvarchar(MAX)。 現在為 nvarchar(50),欄位名稱也從 FirstMidName 改成了 FirstName。
Note
如果你在完成後續章節所有實體類別建立前嘗試編譯,可能會遇到編譯錯誤。
學生實體變更
在 Models/Student.cs中,將你先前加入的程式碼替換成以下程式碼。 這些變更已標示。
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class Student
{
public int ID { get; set; }
[Required]
[StringLength(50)]
[Display(Name = "Last Name")]
public string LastName { get; set; }
[Required]
[StringLength(50)]
[Column("FirstName")]
[Display(Name = "First Name")]
public string FirstMidName { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
[Display(Name = "Enrollment Date")]
public DateTime EnrollmentDate { get; set; }
[Display(Name = "Full Name")]
public string FullName
{
get
{
return LastName + ", " + FirstMidName;
}
}
public ICollection<Enrollment> Enrollments { get; set; }
}
}
必要屬性
Required 屬性會讓名稱屬性成為必要欄位。 對於不可空的類型(如 DateTime、int、double、float 等)則不需要這個 Required 屬性。 不可為 Null 的類型會自動視為必要欄位。
Required 屬性必須搭配 MinimumLength 使用,才能使 MinimumLength 生效。
[Display(Name = "Last Name")]
[Required]
[StringLength(50, MinimumLength=2)]
public string LastName { get; set; }
Display 屬性
該 Display 屬性規定文字框的說明文字應為「名字」、「姓氏」、「全名」和「註冊日期」,而非每個實例中的屬性名稱(該名稱沒有空格分隔)。
該計算屬性 FullName
FullName 為一個計算屬性,會傳回藉由串連兩個其他屬性而建立的值。 因此它只有 get 存取子,因此資料庫中不會產生 FullName 欄位。
建立教師實體
建立 Models/Instructor.cs,並以以下程式碼取代範本程式碼:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class Instructor
{
public int ID { get; set; }
[Required]
[Display(Name = "Last Name")]
[StringLength(50)]
public string LastName { get; set; }
[Required]
[Column("FirstName")]
[Display(Name = "First Name")]
[StringLength(50)]
public string FirstMidName { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
[Display(Name = "Hire Date")]
public DateTime HireDate { get; set; }
[Display(Name = "Full Name")]
public string FullName
{
get { return LastName + ", " + FirstMidName; }
}
public ICollection<CourseAssignment> CourseAssignments { get; set; }
public OfficeAssignment OfficeAssignment { get; set; }
}
}
請注意,學生與講師實體中有多個屬性相同。 在本系列後面的實作繼承教學中,你會重構這段程式碼以消除冗餘。
你可以在一行上放多個屬性,因此你也可以如下撰寫 HireDate 的屬性:
[DataType(DataType.Date),Display(Name = "Hire Date"),DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
CourseAssignments 和 OfficeAssignment 導覽屬性
CourseAssignments 和 OfficeAssignment 屬性為導覽屬性。
由於講師可以教授任何數量的課程,因此將 CourseAssignments 定義為集合。
public ICollection<CourseAssignment> CourseAssignments { get; set; }
如果一個導覽屬性可以容納多個實體,其型別必須是一個清單,可以新增、刪除和更新條目。 您可以指定 ICollection<T> 或如 List<T> 或 HashSet<T> 等類型。 若您指定了 ICollection<T>,EF 會根據預設建立一個 HashSet<T> 集合。
這些為何會成為 CourseAssignment 實體,將在下方關於多對多關係的章節中說明。
Contoso 大學的商業規定規定,講師最多只能擁有一個辦公室,因此該 OfficeAssignment 屬性擁有單一的 OfficeAssignment 實體(若未分配辦公室,該實體可能為 null)。
public OfficeAssignment OfficeAssignment { get; set; }
建立 OfficeAssignment 實體
使用下列程式碼建立 Models/OfficeAssignment.cs:
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class OfficeAssignment
{
[Key]
public int InstructorID { get; set; }
[StringLength(50)]
[Display(Name = "Office Location")]
public string Location { get; set; }
public Instructor Instructor { get; set; }
}
}
該 Key 屬性
在 Instructor 和 OfficeAssignment 實體之間有一對零或一的關係。 辦公室指派只有在有指派的講師時才會存在,因此其主鍵也是其指派到 Instructor 實體的外鍵。 但實體框架無法自動識別 InstructorID 為該實體的主鍵,因為它的名稱不遵循 ID OR classnameID 命名慣例。 因此,使用 Key 屬性將其識別為鍵:
[Key]
public int InstructorID { get; set; }
如果實體有自己的主鍵,但你想把屬性命名成 classnameID 或 ID 以外的名稱,也可以使用該 Key 屬性。
預設情況下,EF 將該鍵視為非資料庫產生,因為該欄位是用於識別關係的。
Instructor 導覽屬性
Instructor 實體擁有可為 Null 的 OfficeAssignment 導航屬性(因為講師可能沒有辦公室指派),而 OfficeAssignment 實體則有不可為 Null 的 Instructor 導航屬性(因為辦公室指派沒有講師就無法存在——InstructorID 是不可為 Null 的)。 當一個講師實體擁有相關的 OfficeAssignment 實體時,每個實體在其導覽屬性中都會有彼此的參考。
你可以在 Instructor 導航屬性上加 [Required] 屬性,指定必須有相關的 Instructor,但你不必這麼做,因為 InstructorID 外鍵(同時也是這個表格的鍵)是不可空的。
修改課程 Entity
在 Models/Course.cs中,將你先前加入的程式碼替換成以下程式碼。 這些變更已標示。
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class Course
{
[DatabaseGenerated(DatabaseGeneratedOption.None)]
[Display(Name = "Number")]
public int CourseID { get; set; }
[StringLength(50, MinimumLength = 3)]
public string Title { get; set; }
[Range(0, 5)]
public int Credits { get; set; }
public int DepartmentID { get; set; }
public Department Department { get; set; }
public ICollection<Enrollment> Enrollments { get; set; }
public ICollection<CourseAssignment> CourseAssignments { get; set; }
}
}
課程實體有一個指向相關部門實體的外鍵屬性 DepartmentID,並具有 Department 導覽屬性。
當您針對相關實體具有一個導覽屬性時,Entity Framework 便不需要您為資料模型新增一個外部索引鍵屬性。 EF 會自動在資料庫中建立所需的外鍵,並為它們建立 陰影特性。 但在資料模型中擁有外部索引鍵,可讓更新變得更為簡單和有效率。 舉例來說,當你抓取一個 Course 實體來編輯時,如果你不載入它,該 Department 實體就是 null,所以當你更新該 Course 實體時,你必須先抓取 Department 實體。 當外部索引鍵屬性 DepartmentID 包含在資料模型中時,您便不需要在更新前擷取 Department 實體。
DatabaseGenerated 屬性
在 CourseID 屬性上,帶有 None 參數的 DatabaseGenerated 屬性會指定主鍵值由使用者提供,而非由資料庫產生。
[DatabaseGenerated(DatabaseGeneratedOption.None)]
[Display(Name = "Number")]
public int CourseID { get; set; }
預設情況下,Entity Framework 假設主要鍵值是由資料庫產生的。 這是您在大多數案例下所希望的情況。 然而,針對 Course 實體,您會使用使用者定義的課程號碼,例如讓一個部門使用 1000 系列,另一個部門則使用 2000 系列等等。
屬性 DatabaseGenerated 也可用來產生預設值,例如用於記錄資料列建立或更新日期的資料庫欄位。 如需詳細資訊,請參閱產生的屬性。
外部鍵及導覽屬性
Course 實體中的外部索引鍵屬性和導覽屬性反映了下列關聯性:
課程會指派給一個部門,因此基於上述理由,會有一個 DepartmentID 外部索引鍵和一個 Department 導覽屬性。
public int DepartmentID { get; set; }
public Department Department { get; set; }
由於課程可由任何數量的學生進行註冊,因此 Enrollments 導覽屬性為一個集合:
public ICollection<Enrollment> Enrollments { get; set; }
一門課可能由多位講師授課,因此 CourseAssignments 導覽屬性是一個集合(類型 CourseAssignment 將於 稍後 說明):
public ICollection<CourseAssignment> CourseAssignments { get; set; }
建立部門實體
使用下列程式碼建立 Models/Department.cs:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class Department
{
public int DepartmentID { get; set; }
[StringLength(50, MinimumLength = 3)]
public string Name { get; set; }
[DataType(DataType.Currency)]
[Column(TypeName = "money")]
public decimal Budget { get; set; }
[DataType(DataType.Date)]
[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
[Display(Name = "Start Date")]
public DateTime StartDate { get; set; }
public int? InstructorID { get; set; }
public Instructor Administrator { get; set; }
public ICollection<Course> Courses { get; set; }
}
}
Column 屬性
你之前用這個 Column 屬性來更改資料行名稱對應。 在實體Department的程式碼中,屬性Column被用來更改 SQL 資料型別映射,使欄位會以資料庫中的 SQL Server money 類型來定義:
[Column(TypeName="money")]
public decimal Budget { get; set; }
欄位映射通常不是必須的,因為實體框架會根據你為該屬性定義的 CLR 類型,選擇適當的 SQL Server 資料型別。 CLR decimal 類型會對應到 SQL Server 的 decimal 類型。 但在這種情況下,你知道欄位會記錄貨幣金額,而貨幣資料型別更適合這個欄位。
外部鍵及導覽屬性
** 外鍵與導覽屬性反映了下列關聯:
部門可以有或沒有一位系統管理員,而系統管理員一律為講師。 因此,該 InstructorID 屬性會被包含為 Instructor 實體的外鍵,並在 int 類型指定後加上問號,以標記該屬性為可空。 導覽屬性的名稱為 Administrator,但持有一個 Instructor 實體:
public int? InstructorID { get; set; }
public Instructor Administrator { get; set; }
部門中可能包含許多課程,因此當中包含了一個 Courses 導覽屬性:
public ICollection<Course> Courses { get; set; }
Note
根據慣例,Entity Framework 會為非空的外鍵和多對多關係啟用連鎖刪除。 這可能導致循環式連鎖刪除規則,當你嘗試新增遷移時會產生例外。 舉例來說,如果你沒有把 Department.InstructorID 屬性定義為可空,EF 會設定一個連鎖刪除規則,當你刪除講師時也會刪除該系,這不是你想要的結果。 如果你的商業規則要求 InstructorID 屬性必須是不可空的,你必須使用以下流暢的 API 語句來停用關係上的連鎖刪除:
modelBuilder.Entity<Department>()
.HasOne(d => d.Administrator)
.WithMany()
.OnDelete(DeleteBehavior.Restrict)
修改 Enrollment 實體
在 Models/Enrollment.cs中,將你先前加入的程式碼替換為以下程式碼:
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public enum Grade
{
A, B, C, D, F
}
public class Enrollment
{
public int EnrollmentID { get; set; }
public int CourseID { get; set; }
public int StudentID { get; set; }
[DisplayFormat(NullDisplayText = "No grade")]
public Grade? Grade { get; set; }
public Course Course { get; set; }
public Student Student { get; set; }
}
}
外部鍵及導覽屬性
外來鍵屬性及導覽屬性反映了下列關聯性:
註冊記錄乃針對單一課程,因此當中包含了一個 CourseID 外部索引鍵屬性及一個 Course 導覽屬性:
public int CourseID { get; set; }
public Course Course { get; set; }
註冊記錄乃針對單一學生,因此當中包含了一個 StudentID 外部索引鍵屬性及一個 Student 導覽屬性:
public int StudentID { get; set; }
public Student Student { get; set; }
多對多關係
Student 和 Course 實體之間存在一個多對多關聯性,且 Enrollment 實體的功能便是多對多聯結資料表,其在資料庫中帶有承載。 「帶有效載荷」意指該 Enrollment 資料表除了連接資料表的外鍵外,還包含額外的資料(在此例中包含主鍵與 Grade 屬性)。
下列圖例展示了在實體圖表中這些關聯性的樣子。 (此圖是使用 EF 6.x 的 Entity Framework Power Tools 製作的;製作圖並非教學內容,僅作為示範使用。)
每個關聯性線條都在其中一端有一個「1」,並在另外一端有一個「星號 (*)」,顯示其為一對多關聯性。
若 Enrollment 資料表並未包含成績資訊,則其便只需要包含兩個外部索引鍵:CourseID 和 StudentID。 在這種情況下,資料庫中將是一個沒有有效載荷的多對多連接表(或純連接表)。
Instructor 和 Course 實體具有這種多對多關係,下一步是建立一個實體類別,作為沒有有效載荷的連接表。
EF Core 支援多對多關係的隱式連接表,但本教學尚未更新以使用隱含連接表。 請參閱「多對多關係」,這是已更新的 Razor Pages 版本教學。
CourseAssignment 實體
使用下列程式碼建立 Models/CourseAssignment.cs:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ContosoUniversity.Models
{
public class CourseAssignment
{
public int InstructorID { get; set; }
public int CourseID { get; set; }
public Instructor Instructor { get; set; }
public Course Course { get; set; }
}
}
合併實體名稱
在講師與課程多對多關係中,資料庫中需要一個連接表,且必須以實體集合表示。 通常會將連接實體命名為 EntityName1EntityName2,在此情況下為 CourseInstructor。 不過,我們建議你選擇一個能描述這段關係的名字。 資料模型起初很簡單,並會逐漸演進,而不含 payload 的聯結後來往往會加入 payload。 如果你一開始就用描述性實體名稱,之後就不需要更改名稱。 理想情況下,聯結實體在業務領域中會有自己的自然(可能為一個單字)名稱。 例如,書籍與顧客可透過評分連結。 對於這種關係,CourseAssignment 是比 CourseInstructor 更好的選擇。
複合鍵
由於外鍵不可空,且能唯一識別表格的每一列,因此不需要另外的主鍵。
CourseID 和 InstructorID 屬性應該作為複合主鍵運作。 唯一能辨識 EF 複合主鍵的方法就是使用 Fluent API (無法用屬性來辨識)。 你會在下一節看到如何設定複合主鍵。
複合鍵確保雖然你可以為同一門課有多列,也可以為一位講師多列,但不能為同一講師和課程設置多列。
Enrollment join 實體會定義自己的主鍵,因此這類重複項目是可能的。 為了防止此類重複,你可以在外鍵欄位新增唯一索引,或將 Enrollment 設定為類似 CourseAssignment 的主複合鍵。 如需詳細資訊,請參閱索引。
更新資料庫內容
在 Data/SchoolContext.cs 檔案中新增以下標示的程式碼:
using ContosoUniversity.Models;
using Microsoft.EntityFrameworkCore;
namespace ContosoUniversity.Data
{
public class SchoolContext : DbContext
{
public SchoolContext(DbContextOptions<SchoolContext> options) : base(options)
{
}
public DbSet<Course> Courses { get; set; }
public DbSet<Enrollment> Enrollments { get; set; }
public DbSet<Student> Students { get; set; }
public DbSet<Department> Departments { get; set; }
public DbSet<Instructor> Instructors { get; set; }
public DbSet<OfficeAssignment> OfficeAssignments { get; set; }
public DbSet<CourseAssignment> CourseAssignments { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Course>().ToTable("Course");
modelBuilder.Entity<Enrollment>().ToTable("Enrollment");
modelBuilder.Entity<Student>().ToTable("Student");
modelBuilder.Entity<Department>().ToTable("Department");
modelBuilder.Entity<Instructor>().ToTable("Instructor");
modelBuilder.Entity<OfficeAssignment>().ToTable("OfficeAssignment");
modelBuilder.Entity<CourseAssignment>().ToTable("CourseAssignment");
modelBuilder.Entity<CourseAssignment>()
.HasKey(c => new { c.CourseID, c.InstructorID });
}
}
}
此程式碼會新增實體並配置 CourseAssignment 實體的複合主鍵。
關於流暢 API 替代方案
OnModelCreating 類別的 DbContext 方法中的程式碼使用 Fluent API 來配置 EF 行為。 這個 API 之所以稱為「Fluent」,是因為它常常藉由將一系列方法呼叫串連成一個陳述式來使用,正如 EF Core文件中的這個範例所示:
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Blog>()
.Property(b => b.Url)
.IsRequired();
}
在這個教學中,你只用 Fluent API 來做資料庫映射,而這點是屬性無法做到的。 然而,您也可以使用 Fluent API 指定大部分透過屬性可完成的格式、驗證及對應規則。 某些屬性 (例如 MinimumLength) 無法使用 Fluent API 來套用。 如前所述,MinimumLength 不會改變結構,只會套用客戶端和伺服器端的驗證規則。
某些開發人員偏好單獨使用 Fluent API,使其實體類別保持「整潔」。若想要的話,您也可以混合使用屬性和 Fluent API,並且有一些自訂項目只能使用 Fluent API 完成。但一般來說,建議的做法是在這兩種方法中選擇其中一項,然後盡可能的一致使用該方法。 如果你同時使用兩個,請注意只要有衝突,Fluent API 會覆蓋屬性。
如需屬性與 Fluent API 的比較詳細資訊,請參閱組態方法。
實體關係圖表
下列圖例顯示了 Entity Framework Power Tools 為完成的 School 模型建立的圖表。
除了一對多關係線(1 到 *)外,你還可以看到 OfficeAssignment 和 Instructor 實體之間的 1 對 0 或 1 的關係線(1 到 0..1),以及講師與系所實體之間的 0 或 1 對多關係線(0..1 到 *)。
使用測試資料初始化資料庫
請將 Data/DbInitializer.cs 檔案中的程式碼替換成以下程式碼,以便提供你新建立實體的種子資料。
using System;
using System.Linq;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using ContosoUniversity.Models;
namespace ContosoUniversity.Data
{
public static class DbInitializer
{
public static void Initialize(SchoolContext context)
{
//context.Database.EnsureCreated();
// Look for any students.
if (context.Students.Any())
{
return; // DB has been seeded
}
var students = new Student[]
{
new Student { FirstMidName = "Carson", LastName = "Alexander",
EnrollmentDate = DateTime.Parse("2010-09-01") },
new Student { FirstMidName = "Meredith", LastName = "Alonso",
EnrollmentDate = DateTime.Parse("2012-09-01") },
new Student { FirstMidName = "Arturo", LastName = "Anand",
EnrollmentDate = DateTime.Parse("2013-09-01") },
new Student { FirstMidName = "Gytis", LastName = "Barzdukas",
EnrollmentDate = DateTime.Parse("2012-09-01") },
new Student { FirstMidName = "Yan", LastName = "Li",
EnrollmentDate = DateTime.Parse("2012-09-01") },
new Student { FirstMidName = "Peggy", LastName = "Justice",
EnrollmentDate = DateTime.Parse("2011-09-01") },
new Student { FirstMidName = "Laura", LastName = "Norman",
EnrollmentDate = DateTime.Parse("2013-09-01") },
new Student { FirstMidName = "Nino", LastName = "Olivetto",
EnrollmentDate = DateTime.Parse("2005-09-01") }
};
foreach (Student s in students)
{
context.Students.Add(s);
}
context.SaveChanges();
var instructors = new Instructor[]
{
new Instructor { FirstMidName = "Kim", LastName = "Abercrombie",
HireDate = DateTime.Parse("1995-03-11") },
new Instructor { FirstMidName = "Fadi", LastName = "Fakhouri",
HireDate = DateTime.Parse("2002-07-06") },
new Instructor { FirstMidName = "Roger", LastName = "Harui",
HireDate = DateTime.Parse("1998-07-01") },
new Instructor { FirstMidName = "Candace", LastName = "Kapoor",
HireDate = DateTime.Parse("2001-01-15") },
new Instructor { FirstMidName = "Roger", LastName = "Zheng",
HireDate = DateTime.Parse("2004-02-12") }
};
foreach (Instructor i in instructors)
{
context.Instructors.Add(i);
}
context.SaveChanges();
var departments = new Department[]
{
new Department { Name = "English", Budget = 350000,
StartDate = DateTime.Parse("2007-09-01"),
InstructorID = instructors.Single( i => i.LastName == "Abercrombie").ID },
new Department { Name = "Mathematics", Budget = 100000,
StartDate = DateTime.Parse("2007-09-01"),
InstructorID = instructors.Single( i => i.LastName == "Fakhouri").ID },
new Department { Name = "Engineering", Budget = 350000,
StartDate = DateTime.Parse("2007-09-01"),
InstructorID = instructors.Single( i => i.LastName == "Harui").ID },
new Department { Name = "Economics", Budget = 100000,
StartDate = DateTime.Parse("2007-09-01"),
InstructorID = instructors.Single( i => i.LastName == "Kapoor").ID }
};
foreach (Department d in departments)
{
context.Departments.Add(d);
}
context.SaveChanges();
var courses = new Course[]
{
new Course {CourseID = 1050, Title = "Chemistry", Credits = 3,
DepartmentID = departments.Single( s => s.Name == "Engineering").DepartmentID
},
new Course {CourseID = 4022, Title = "Microeconomics", Credits = 3,
DepartmentID = departments.Single( s => s.Name == "Economics").DepartmentID
},
new Course {CourseID = 4041, Title = "Macroeconomics", Credits = 3,
DepartmentID = departments.Single( s => s.Name == "Economics").DepartmentID
},
new Course {CourseID = 1045, Title = "Calculus", Credits = 4,
DepartmentID = departments.Single( s => s.Name == "Mathematics").DepartmentID
},
new Course {CourseID = 3141, Title = "Trigonometry", Credits = 4,
DepartmentID = departments.Single( s => s.Name == "Mathematics").DepartmentID
},
new Course {CourseID = 2021, Title = "Composition", Credits = 3,
DepartmentID = departments.Single( s => s.Name == "English").DepartmentID
},
new Course {CourseID = 2042, Title = "Literature", Credits = 4,
DepartmentID = departments.Single( s => s.Name == "English").DepartmentID
},
};
foreach (Course c in courses)
{
context.Courses.Add(c);
}
context.SaveChanges();
var officeAssignments = new OfficeAssignment[]
{
new OfficeAssignment {
InstructorID = instructors.Single( i => i.LastName == "Fakhouri").ID,
Location = "Smith 17" },
new OfficeAssignment {
InstructorID = instructors.Single( i => i.LastName == "Harui").ID,
Location = "Gowan 27" },
new OfficeAssignment {
InstructorID = instructors.Single( i => i.LastName == "Kapoor").ID,
Location = "Thompson 304" },
};
foreach (OfficeAssignment o in officeAssignments)
{
context.OfficeAssignments.Add(o);
}
context.SaveChanges();
var courseInstructors = new CourseAssignment[]
{
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Chemistry" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Kapoor").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Chemistry" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Harui").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Microeconomics" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Zheng").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Macroeconomics" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Zheng").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Calculus" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Fakhouri").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Trigonometry" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Harui").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Composition" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Abercrombie").ID
},
new CourseAssignment {
CourseID = courses.Single(c => c.Title == "Literature" ).CourseID,
InstructorID = instructors.Single(i => i.LastName == "Abercrombie").ID
},
};
foreach (CourseAssignment ci in courseInstructors)
{
context.CourseAssignments.Add(ci);
}
context.SaveChanges();
var enrollments = new Enrollment[]
{
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alexander").ID,
CourseID = courses.Single(c => c.Title == "Chemistry" ).CourseID,
Grade = Grade.A
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alexander").ID,
CourseID = courses.Single(c => c.Title == "Microeconomics" ).CourseID,
Grade = Grade.C
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alexander").ID,
CourseID = courses.Single(c => c.Title == "Macroeconomics" ).CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alonso").ID,
CourseID = courses.Single(c => c.Title == "Calculus" ).CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alonso").ID,
CourseID = courses.Single(c => c.Title == "Trigonometry" ).CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Alonso").ID,
CourseID = courses.Single(c => c.Title == "Composition" ).CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Anand").ID,
CourseID = courses.Single(c => c.Title == "Chemistry" ).CourseID
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Anand").ID,
CourseID = courses.Single(c => c.Title == "Microeconomics").CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Barzdukas").ID,
CourseID = courses.Single(c => c.Title == "Chemistry").CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Li").ID,
CourseID = courses.Single(c => c.Title == "Composition").CourseID,
Grade = Grade.B
},
new Enrollment {
StudentID = students.Single(s => s.LastName == "Justice").ID,
CourseID = courses.Single(c => c.Title == "Literature").CourseID,
Grade = Grade.B
}
};
foreach (Enrollment e in enrollments)
{
var enrollmentInDataBase = context.Enrollments.Where(
s =>
s.Student.ID == e.StudentID &&
s.Course.CourseID == e.CourseID).SingleOrDefault();
if (enrollmentInDataBase == null)
{
context.Enrollments.Add(e);
}
}
context.SaveChanges();
}
}
}
如你在第一個教學中看到的,大部分程式碼只是建立新的實體物件,並將範例資料載入屬性以供測試。 注意多對多關係的處理方式:程式碼透過在 CourseAssignment 和 Enrollments 聯結實體集中建立實體來建立關係。
新增移轉
儲存您的變更並建置專案。 接著在專案資料夾裡開啟指令視窗並輸入該 migrations add 指令(先不要用 update-database 指令):
dotnet ef migrations add ComplexDataModel
你會收到可能的資料遺失警告。
An operation was scaffolded that may result in the loss of data. Please review the migration for accuracy.
Done. To undo this action, use 'ef migrations remove'
如果你在這個時候嘗試執行這個 database update 指令(暫時不要做),你會收到以下錯誤:
ALTER TABLE 語句與 FOREIGN KEY 限制 "FK_dbo.Course_dbo.Department_DepartmentID" 發生衝突。 衝突發生在 "ContoseUniversity" 資料庫、"dbo.Department" 資料表、"DepartmentID" 資料行中。
有時候當你用現有資料執行遷移時,需要在資料庫中插入佔位資料以滿足外鍵限制。 該方法中Up產生的程式碼會將不可空的DepartmentID外鍵加入 Course 資料表。 如果程式執行AddColumn時課程資料表中已有列,操作會失敗,因為 SQL Server 不知道該在不可為 null 的欄位中放入什麼值。 這個教學你會在新的資料庫上執行遷移,但在生產應用程式中,你必須讓遷移處理現有資料,以下說明會示範如何做這件事。
要讓這個遷移能用現有資料,你必須修改程式碼,讓新欄位設定預設值,並建立一個名為「Temp」的佔位部門作為預設部門。 因此,現有的課程列在 Up 方法執行後都會與「臨時」部門相關聯。
開啟
{timestamp}_ComplexDataModel.cs檔案。註解掉新增 DepartmentID 欄位到 Course 資料表的那行程式碼。
migrationBuilder.AlterColumn<string>( name: "Title", table: "Course", maxLength: 50, nullable: true, oldClrType: typeof(string), oldNullable: true); //migrationBuilder.AddColumn<int>( // name: "DepartmentID", // table: "Course", // nullable: false, // defaultValue: 0);在建立部門資料表的程式碼後,新增以下標示的程式碼:
migrationBuilder.CreateTable( name: "Department", columns: table => new { DepartmentID = table.Column<int>(nullable: false) .Annotation("SqlServer:ValueGenerationStrategy", SqlServerValueGenerationStrategy.IdentityColumn), Budget = table.Column<decimal>(type: "money", nullable: false), InstructorID = table.Column<int>(nullable: true), Name = table.Column<string>(maxLength: 50, nullable: true), StartDate = table.Column<DateTime>(nullable: false) }, constraints: table => { table.PrimaryKey("PK_Department", x => x.DepartmentID); table.ForeignKey( name: "FK_Department_Instructor_InstructorID", column: x => x.InstructorID, principalTable: "Instructor", principalColumn: "ID", onDelete: ReferentialAction.Restrict); }); migrationBuilder.Sql("INSERT INTO dbo.Department (Name, Budget, StartDate) VALUES ('Temp', 0.00, GETDATE())"); // Default value for FK points to department created above, with // defaultValue changed to 1 in following AddColumn statement. migrationBuilder.AddColumn<int>( name: "DepartmentID", table: "Course", nullable: false, defaultValue: 1);
在生產應用程式中,你會寫程式碼或腳本來新增系所列,並將課程列與新的系所列關聯起來。 這樣你就不再需要「Temp」部門或「Course.DepartmentID」欄上的預設值了。
儲存您的變更並建置專案。
更改連線字串
你現在有了在 DbInitializer 類別中的新程式碼,會將新實體的種子資料加入空白資料庫。 要讓 EF 建立一個新的空資料庫,請把在 appsettings.json 中的 連接字串 裡的資料庫名稱改成 ContosoUniversity3 或其他你在所使用的電腦上還沒用過的名稱。
{
"ConnectionStrings": {
"DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=ContosoUniversity3;Trusted_Connection=True;MultipleActiveResultSets=true"
},
將你的變更儲存為 appsettings.json。
Note
除了更改資料庫名稱外,你可以刪除資料庫。 請使用 SQL Server 物件總管(SSOX)或 database drop CLI 指令:
dotnet ef database drop
更新資料庫
在你更改資料庫名稱或刪除資料庫後,在命令視窗中執行 database update 命令,以執行遷移。
dotnet ef database update
執行應用程式讓該 DbInitializer.Initialize 方法執行並初始化新的資料庫。
像之前一樣在 SSOX 開啟資料庫,並展開 Tables 節點,看到所有資料表都已建立。 (如果你之前的 SSOX 仍然開啟,請點擊 重新整理 按鈕。)
執行應用程式以觸發初始化器程式碼,為資料庫植入種子資料。
右鍵點選 CourseAssignment 表格,選擇 檢視資料 以確認其中是否有資料。
取得程式碼
下一步
在本教學課程中,您會:
- 自訂資料模型
- 已對 Student 實體進行變更
- 已建立講師實體
- 已建立 OfficeAssignment 實體
- 已修改的課程實體
- 已建立的部門實體
- 已修改的註冊實體
- 更新資料庫內容
- 已使用測試資料初始化資料庫
- 新增移轉
- 已變更連線字串
- 更新資料庫
請繼續閱讀下一個教學,了解如何存取相關資料。