第 6 部分：ASP.NET Core 中具有 EF Core 的 Razor Pages - 讀取相關資料

作者：Tom Dykstra、Jon P Smith 和 Rick Anderson

Contoso 大學 Web 應用程式將示範如何使用 EF Core 和 Visual Studio 來建立 Razor Pages Web 應用程式。 如需教學課程系列的資訊，請參閱第一個教學課程。

如果您遇到無法解決的問題，請下載已完成的應用程式，並遵循本教學課程以將程式碼與您所建立的內容進行比較。

本教學課程說明如何讀取及顯示相關資料。 相關資料是 EF Core 載入到導覽屬性的資料。

下圖顯示本教學課程的已完成頁面：

積極式、明確式和消極式載入

EF Core 有幾種方式可以將相關資料載入到實體的導覽屬性：

• 積極式載入。 積極式載入是指某一類型實體的查詢同時也會載入相關實體。 讀取實體時，將會擷取其相關資料。 這通常會導致單一聯結查詢，其可擷取所有需要的資料。 EF Core 將針對某些類型的積極式載入發出多個查詢。 發出多個查詢可能比大型單一查詢更有效率。 積極式載入是使用 Include 和 ThenInclude 方法加以指定。

  

  當集合導覽包含在內時，積極式載入會傳送多個查詢：

  • 針對主查詢傳送一個查詢
  • 針對負載樹狀結構中的每個集合「邊緣」傳送一個查詢。

• 使用 Load 的個別查詢：資料可以在個別查詢中擷取，而 EF Core 會「修正」導覽屬性。 「修正」表示 EF Core 會自動填入導覽屬性。 使用 Load 的個別查詢更像是明確式載入，而不是積極式載入。

  

  注意：EF Core 會將導覽屬性自動修正為先前已載入至內容執行個體的任何其他實體。 即使「未」明確包含導覽屬性的資料，如果先前已載入某些或所有相關實體，仍然可能會填入該屬性。

• 明確式載入。 第一次讀取實體時，不會擷取相關資料。 必須撰寫程式碼，才能在需要時擷取相關資料。 使用個別查詢的明確式載入會導致多個查詢傳送至資料庫。 透過明確式載入，程式碼會指定要載入的導覽屬性。 請使用 Load 方法來執行明確式載入。 例如：

  

• 消極式載入。 第一次讀取實體時，不會擷取相關資料。 第一次存取導覽屬性時，將會自動擷取該導覽屬性所需的資料。 每當第一次存取導覽屬性時，查詢會傳送至資料庫。 延遲載入可能會損害效能，例如當開發人員使用 N+1 查詢時。 N+1 查詢會載入父系並列舉子系。

建立 Course 頁面

Course 實體包含導覽屬性，其中包含相關的 Department 實體。

若要顯示針對課程指派的部門名稱：

• 將相關的 Department 實體載入 Course.Department 導覽屬性。
• 從 Department 實體的 Name 屬性取得名稱。

Scaffold Course 頁面

Visual Studio

• 遵循 Scaffold Student 頁面中的指示，下列部分除外：

  • 建立 Pages/Courses 資料夾。
  • 使用 Course 作為模型類別。
  • 使用現有內容類別，而非建立新的類別。

Visual Studio Code

• 建立 Pages/Courses 資料夾。

• 執行下列命令來 scaffold Course 頁面。

  在 Windows 上：

  dotnet aspnet-codegenerator razorpage -m Course -dc SchoolContext -udl -outDir Pages\Courses --referenceScriptLibraries
  

  在 Linux 或 MacOS 上：

  dotnet aspnet-codegenerator razorpage -m Course -dc SchoolContext -udl -outDir Pages/Courses --referenceScriptLibraries
  

• 開啟 Pages/Courses/Index.cshtml.cs 並檢查 OnGetAsync 方法。 Scaffolding 引擎已針對 Department 導覽屬性指定積極式載入。 Include 方法可指定積極式載入。

• 執行應用程式並選取課程連結。 部門資料行便會顯示沒有用的 DepartmentID。

顯示部門名稱

使用下列程式碼更新 Pages/Courses/Index.cshtml.cs：

using ContosoUniversity.Models;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.EntityFrameworkCore;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace ContosoUniversity.Pages.Courses
{
    public class IndexModel : PageModel
    {
        private readonly ContosoUniversity.Data.SchoolContext _context;

        public IndexModel(ContosoUniversity.Data.SchoolContext context)
        {
            _context = context;
        }

        public IList<Course> Courses { get; set; }

        public async Task OnGetAsync()
        {
            Courses = await _context.Courses
                .Include(c => c.Department)
                .AsNoTracking()
                .ToListAsync();
        }
    }
}

上述程式碼會將 Course 屬性變更為 Courses，並新增 AsNoTracking。

如果要在唯讀案例中使用結果，則不追蹤的查詢很實用。 其執行速度通常較快，因為不需要設定變更追蹤資訊。 如果從資料庫擷取的實體不需要更新，則不追蹤查詢的執行效能可能會優於追蹤查詢。

在某些情況下，追蹤查詢比不追蹤查詢更有效率。 如需詳細資訊，請參閱追蹤與不追蹤的查詢。 在上述程式碼中會呼叫 AsNoTracking，因為實體不會在目前內容中更新。

以下列程式碼來更新 Pages/Courses/Index.cshtml。

@page
@model ContosoUniversity.Pages.Courses.IndexModel

@{
    ViewData["Title"] = "Courses";
}

<h1>Courses</h1>

<p>
    <a asp-page="Create">Create New</a>
</p>
<table class="table">
    <thead>
        <tr>
            <th>
                @Html.DisplayNameFor(model => model.Courses[0].CourseID)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Courses[0].Title)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Courses[0].Credits)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Courses[0].Department)
            </th>
            <th></th>
        </tr>
    </thead>
    <tbody>
@foreach (var item in Model.Courses)
{
        <tr>
            <td>
                @Html.DisplayFor(modelItem => item.CourseID)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Title)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Credits)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Department.Name)
            </td>
            <td>
                <a asp-page="./Edit" asp-route-id="@item.CourseID">Edit</a> |
                <a asp-page="./Details" asp-route-id="@item.CourseID">Details</a> |
                <a asp-page="./Delete" asp-route-id="@item.CourseID">Delete</a>
            </td>
        </tr>
}
    </tbody>
</table>

已對包含 Scaffold 的程式碼進行下列變更：

• 已將 Course 屬性名稱變更為 Courses。

• 新增顯示 CourseID 屬性值的 [編號] 資料行。 主索引鍵預設不會進行 Scaffold，因為它們對終端使用者通常沒有任何意義。 不過，在此情況下，主索引鍵有意義。

• 變更 [部門] 資料行來顯示部門名稱。 此程式碼會顯示已載入到 Department 導覽屬性之 Department 實體的 Name 屬性：

  @Html.DisplayFor(modelItem => item.Department.Name)
  

執行應用程式，並選取 [Courses] 索引標籤來查看含有部門名稱的清單。

使用 Select 載入相關資料

OnGetAsync 方法使用 Include 方法載入相關資料。 Select 方法是一種替代方案，只會載入所需的相關資料。 如果是單一項目 (例如 Department.Name)，它會使用 SQL INNER JOIN。 如果是集合，它會使用另一種資料庫存取，但集合上的 Include 運算子也是如此。

下列程式碼使用 Select 方法載入相關資料：

public IList<CourseViewModel> CourseVM { get; set; }

public async Task OnGetAsync()
{
    CourseVM = await _context.Courses
    .Select(p => new CourseViewModel
    {
        CourseID = p.CourseID,
        Title = p.Title,
        Credits = p.Credits,
        DepartmentName = p.Department.Name
    }).ToListAsync();
}

上述程式碼不會傳回任何實體類型，因此不會進行任何追蹤。 如需 EF 追蹤的詳細資訊，請參閱追蹤與不追蹤的查詢。

CourseViewModel：

public class CourseViewModel
{
    public int CourseID { get; set; }
    public string Title { get; set; }
    public int Credits { get; set; }
    public string DepartmentName { get; set; }
}

如需完整的 Razor 頁面，請參閱IndexSelectModel。

建立 Instructor 頁面

本節會 scaffold Instructor 頁面，並將相關的課程和註冊新增至 Instructors 索引頁面。

此頁面將以下列方式讀取和顯示相關資料：

• 講師清單會顯示來自 OfficeAssignment 實體 (上述映像中的 Office) 的相關資料。 Instructor 與 OfficeAssignment 實體具有一對零或一關聯性。 積極式載入用於 OfficeAssignment 實體。 若需要顯示相關資料，積極式載入通常更有效率。 在此情況下，將會顯示講師的辦公室指派。
• 當使用者選取講師時，將會顯示相關的 Course 實體。 Instructor 與 Course 實體具有多對多關聯性。 將會針對 Course 實體和其相關 Department 實體使用積極式載入。 在此情況下，個別查詢可能更有效率，因為只需要所選取講師的課程。 這個範例示範如何使用導覽屬性中實體之導覽屬性的積極式載入。
• 當使用者選取課程時，將會顯示來自 Enrollments 實體的相關資料。 在上述映像中，將會顯示學生姓名和年級。 Course 與 Enrollment 實體具有一對多關聯性。

建立檢視模型

講師頁面會顯示下列三個不同資料表的資料。 需要檢視模型，其包含代表三個資料表的三個屬性。

使用下列程式碼建立 Models/SchoolViewModels/InstructorIndexData.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ContosoUniversity.Models.SchoolViewModels
{
    public class InstructorIndexData
    {
        public IEnumerable<Instructor> Instructors { get; set; }
        public IEnumerable<Course> Courses { get; set; }
        public IEnumerable<Enrollment> Enrollments { get; set; }
    }
}

Scaffold Instructor 頁面

Visual Studio

• 遵循 Scaffold Students 頁面中的指示，下列部分除外：

  • 建立 Pages/Instructors 資料夾。
  • 使用 Instructor 作為模型類別。
  • 使用現有內容類別，而非建立新的類別。

Visual Studio Code

• 建立 Pages/Instructors 資料夾。

• 執行下列命令來 Scaffold Instructor 頁面。

  在 Windows 上：

  dotnet aspnet-codegenerator razorpage -m Instructor -dc SchoolContext -udl -outDir Pages\Instructors --referenceScriptLibraries
  

  在 Linux 或 MacOS 上：

  dotnet aspnet-codegenerator razorpage -m Instructor -dc SchoolContext -udl -outDir Pages/Instructors --referenceScriptLibraries
  

執行應用程式並巡覽至講師頁面。

以下列程式碼來更新 Pages/Instructors/Index.cshtml.cs：

using ContosoUniversity.Models;
using ContosoUniversity.Models.SchoolViewModels;  // Add VM
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.EntityFrameworkCore;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ContosoUniversity.Pages.Instructors
{
    public class IndexModel : PageModel
    {
        private readonly ContosoUniversity.Data.SchoolContext _context;

        public IndexModel(ContosoUniversity.Data.SchoolContext context)
        {
            _context = context;
        }

        public InstructorIndexData InstructorData { get; set; }
        public int InstructorID { get; set; }
        public int CourseID { get; set; }

        public async Task OnGetAsync(int? id, int? courseID)
        {
            InstructorData = new InstructorIndexData();
            InstructorData.Instructors = await _context.Instructors
                .Include(i => i.OfficeAssignment)                 
                .Include(i => i.Courses)
                    .ThenInclude(c => c.Department)
                .OrderBy(i => i.LastName)
                .ToListAsync();

            if (id != null)
            {
                InstructorID = id.Value;
                Instructor instructor = InstructorData.Instructors
                    .Where(i => i.ID == id.Value).Single();
                InstructorData.Courses = instructor.Courses;
            }

            if (courseID != null)
            {
                CourseID = courseID.Value;
                IEnumerable<Enrollment> Enrollments = await _context.Enrollments
                    .Where(x => x.CourseID == CourseID)                    
                    .Include(i=>i.Student)
                    .ToListAsync();                 
                InstructorData.Enrollments = Enrollments;
            }
        }
    }
}

OnGetAsync 方法會針對所選取講師的識別碼接受選擇性的路由資料。

檢查 Pages/Instructors/Index.cshtml.cs 檔案中的查詢：

InstructorData = new InstructorIndexData();
InstructorData.Instructors = await _context.Instructors
    .Include(i => i.OfficeAssignment)                 
    .Include(i => i.Courses)
        .ThenInclude(c => c.Department)
    .OrderBy(i => i.LastName)
    .ToListAsync();

這個程式碼會針對下列導覽屬性指定積極式載入：

• Instructor.OfficeAssignment
• Instructor.Courses
  • Course.Department

下列程式碼會在已選取講師時執行，也就是 id != null。

if (id != null)
{
    InstructorID = id.Value;
    Instructor instructor = InstructorData.Instructors
        .Where(i => i.ID == id.Value).Single();
    InstructorData.Courses = instructor.Courses;
}

選取的講師會從檢視模型的講師清單中擷取。 檢視模型的 Courses 屬性會使用 Course 實體從所選講師的 Courses 導覽屬性載入。

Where 方法會傳回集合。 在此情況下，篩選條件會選取單一實體，因此會呼叫 Single 方法，將集合轉換成單一 Instructor 實體。 Instructor 實體提供對 Course 導覽屬性的存取。

當集合只有一個項目時，將會在集合上使用 Single 方法。 如果集合是空的或是有多個項目，Single 方法會擲回例外狀況。 替代方式是 SingleOrDefault，它會在集合是空的時傳回預設值。 針對此查詢，傳回了預設值中的 null。

選取課程時，下列程式碼會填入檢視模型的 Enrollments 屬性：

if (courseID != null)
{
    CourseID = courseID.Value;
    IEnumerable<Enrollment> Enrollments = await _context.Enrollments
        .Where(x => x.CourseID == CourseID)                    
        .Include(i=>i.Student)
        .ToListAsync();                 
    InstructorData.Enrollments = Enrollments;
}

更新 Instructors [索引] 頁面

以下列程式碼來更新 Pages/Instructors/Index.cshtml。

@page "{id:int?}"
@model ContosoUniversity.Pages.Instructors.IndexModel

@{
    ViewData["Title"] = "Instructors";
}

<h2>Instructors</h2>

<p>
    <a asp-page="Create">Create New</a>
</p>
<table class="table">
    <thead>
        <tr>
            <th>Last Name</th>
            <th>First Name</th>
            <th>Hire Date</th>
            <th>Office</th>
            <th>Courses</th>
            <th></th>
        </tr>
    </thead>
    <tbody>
        @foreach (var item in Model.InstructorData.Instructors)
        {
            string selectedRow = "";
            if (item.ID == Model.InstructorID)
            {
                selectedRow = "table-success";
            }
            <tr class="@selectedRow">
                <td>
                    @Html.DisplayFor(modelItem => item.LastName)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.FirstMidName)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.HireDate)
                </td>
                <td>
                    @if (item.OfficeAssignment != null)
                    {
                        @item.OfficeAssignment.Location
                    }
                </td>
                <td>
                    @{
                        foreach (var course in item.Courses)
                        {
                            @course.CourseID @:  @course.Title <br />
                        }
                    }
                </td>
                <td>
                    <a asp-page="./Index" asp-route-id="@item.ID">Select</a> |
                    <a asp-page="./Edit" asp-route-id="@item.ID">Edit</a> |
                    <a asp-page="./Details" asp-route-id="@item.ID">Details</a> |
                    <a asp-page="./Delete" asp-route-id="@item.ID">Delete</a>
                </td>
            </tr>
        }
    </tbody>
</table>

@if (Model.InstructorData.Courses != null)
{
    <h3>Courses Taught by Selected Instructor</h3>
    <table class="table">
        <tr>
            <th></th>
            <th>Number</th>
            <th>Title</th>
            <th>Department</th>
        </tr>

        @foreach (var item in Model.InstructorData.Courses)
        {
            string selectedRow = "";
            if (item.CourseID == Model.CourseID)
            {
                selectedRow = "table-success";
            }
            <tr class="@selectedRow">
                <td>
                    <a asp-page="./Index" asp-route-courseID="@item.CourseID">Select</a>
                </td>
                <td>
                    @item.CourseID
                </td>
                <td>
                    @item.Title
                </td>
                <td>
                    @item.Department.Name
                </td>
            </tr>
        }

    </table>
}

@if (Model.InstructorData.Enrollments != null)
{
    <h3>
        Students Enrolled in Selected Course
    </h3>
    <table class="table">
        <tr>
            <th>Name</th>
            <th>Grade</th>
        </tr>
        @foreach (var item in Model.InstructorData.Enrollments)
        {
            <tr>
                <td>
                    @item.Student.FullName
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Grade)
                </td>
            </tr>
        }
    </table>
}

上述程式碼會進行下列變更：

• 將 page 指示詞更新為 @page "{id:int?}"。 "{id:int?}" 是路由範本。 路由範本將 URL 中的整數查詢字串變更為路由資料。 例如，只有在 @page 指示詞產生如下的 URL 時，按一下講師的 [選取] 連結：

  https://localhost:5001/Instructors?id=2

  頁面指示詞是 @page "{id:int?}" 時，URL 為：https://localhost:5001/Instructors/2

• 新增 [辦公室] 資料行，該資料行只有在 item.OfficeAssignment 不是 Null 時才會顯示 item.OfficeAssignment.Location。 因為這是一對零或一關聯性，所有可能沒有相關的 OfficeAssignment 實體。

  @if (item.OfficeAssignment != null)
  {
      @item.OfficeAssignment.Location
  }
  

• 新增 [課程] 資料行，以顯示每位講師所教授的課程。 若要深入了解此 Razor 語法，請參閱明確的行轉換。

• 新增程式碼，將 class="table-success" 動態新增至所選講師和課程的 tr 項目。 這會使用啟動程序類別設定所選取資料列的背景色彩。

  string selectedRow = "";
  if (item.CourseID == Model.CourseID)
  {
      selectedRow = "table-success";
  }
  <tr class="@selectedRow">
  

• 新增標示為選取的超連結。 此連結會將所選取的講師識別碼傳送至 Index 方法，並設定背景色彩。

  <a asp-action="Index" asp-route-id="@item.ID">Select</a> |
  

• 新增所選講師的課程資料表。

• 新增所選課程的學生註冊資料表。

執行應用程式並選取 [講師] 索引標籤。此頁面會顯示來自相關 OfficeAssignment 實體的 Location (辦公室)。 如果 OfficeAssignment 為 Null，則會顯示空的資料表資料格。

按一下講師的 [選取] 連結。 資料列樣式會變更，並會顯示指派給該講師的課程。

選取課程，以查看已註冊學生和其年級的清單。

下一步

下一個教學課程會示範如何更新相關資料。

上一個教學課程下一個教學課程