title | author | description | ms.author | monikerRange | ms.custom | ms.date | uid |
---|---|---|---|---|---|---|---|
Part 2, Razor Pages with EF Core in ASP.NET Core - CRUD |
tdykstra |
Part 2 of Razor Pages and Entity Framework tutorial series. |
tdykstra |
>= aspnetcore-3.1 |
mvc |
11/11/2021 |
data/ef-rp/crud |
By Tom Dykstra, Jeremy Likness, and Jon P Smith
[!INCLUDE about the series]
:::moniker range=">= aspnetcore-6.0"
In this tutorial, the scaffolded CRUD (create, read, update, delete) code is reviewed and customized.
Some developers use a service layer or repository pattern to create an abstraction layer between the UI (Razor Pages) and the data access layer. This tutorial doesn't do that. To minimize complexity and keep the tutorial focused on EF Core, EF Core code is added directly to the page model classes.
The scaffolded code for the Students pages doesn't include enrollment data. In this section, enrollments are added to the Details
page.
To display a student's enrollment data on the page, the enrollment data must be read. The scaffolded code in Pages/Students/Details.cshtml.cs
reads only the Student
data, without the Enrollment
data:
[!code-csharpMain]
Replace the OnGetAsync
method with the following code to read enrollment data for the selected student. The changes are highlighted.
[!code-csharpMain]
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.Include%2A and ThenInclude methods cause the context to load the Student.Enrollments
navigation property, and within each enrollment the Enrollment.Course
navigation property. These methods are examined in detail in the Read related data tutorial.
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.AsNoTracking%2A method improves performance in scenarios where the entities returned are not updated in the current context. AsNoTracking
is discussed later in this tutorial.
Replace the code in Pages/Students/Details.cshtml
with the following code to display a list of enrollments. The changes are highlighted.
[!code-cshtmlMain]
The preceding code loops through the entities in the Enrollments
navigation property. For each enrollment, it displays the course title and the grade. The course title is retrieved from the Course
entity that's stored in the Course
navigation property of the Enrollments entity.
Run the app, select the Students tab, and click the Details link for a student. The list of courses and grades for the selected student is displayed.
The generated code uses FirstOrDefaultAsync to read one entity. This method returns null if nothing is found; otherwise, it returns the first row found that satisfies the query filter criteria. FirstOrDefaultAsync
is generally a better choice than the following alternatives:
- SingleOrDefaultAsync - Throws an exception if there's more than one entity that satisfies the query filter. To determine if more than one row could be returned by the query,
SingleOrDefaultAsync
tries to fetch multiple rows. This extra work is unnecessary if the query can only return one entity, as when it searches on a unique key. - FindAsync - Finds an entity with the primary key (PK). If an entity with the PK is being tracked by the context, it's returned without a request to the database. This method is optimized to look up a single entity, but you can't call
Include
withFindAsync
. So if related data is needed,FirstOrDefaultAsync
is the better choice.
The URL for the Details page is https://localhost:<port>/Students/Details?id=1
. The entity's primary key value is in the query string. Some developers prefer to pass the key value in route data: https://localhost:<port>/Students/Details/1
. For more information, see Update the generated code.
The scaffolded OnPostAsync
code for the Create page is vulnerable to overposting. Replace the OnPostAsync
method in Pages/Students/Create.cshtml.cs
with the following code.
[!code-csharpMain]
The preceding code creates a Student object and then uses posted form fields to update the Student object's properties. The TryUpdateModelAsync method:
- Uses the posted form values from the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.PageContext%2A property in the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.
- Updates only the properties listed (
s => s.FirstMidName, s => s.LastName, s => s.EnrollmentDate
). - Looks for form fields with a "student" prefix. For example,
Student.FirstMidName
. It's not case sensitive. - Uses the model binding system to convert form values from strings to the types in the
Student
model. For example,EnrollmentDate
is converted toDateTime
.
Run the app, and create a student entity to test the Create page.
Using TryUpdateModel
to update fields with posted values is a security best practice because it prevents overposting. For example, suppose the Student entity includes a Secret
property that this web page shouldn't update or add:
[!code-csharpMain]
Even if the app doesn't have a Secret
field on the create or update Razor Page, a hacker could set the Secret
value by overposting. A hacker could use a tool such as Fiddler, or write some JavaScript, to post a Secret
form value. The original code doesn't limit the fields that the model binder uses when it creates a Student instance.
Whatever value the hacker specified for the Secret
form field is updated in the database. The following image shows the Fiddler tool adding the Secret
field, with the value "OverPost", to the posted form values.
The value "OverPost" is successfully added to the Secret
property of the inserted row. That happens even though the app designer never intended the Secret
property to be set with the Create page.
View models provide an alternative way to prevent overposting.
The application model is often called the domain model. The domain model typically contains all the properties required by the corresponding entity in the database. The view model contains only the properties needed for the UI page, for example, the Create page.
In addition to the view model, some apps use a binding model or input model to pass data between the Razor Pages page model class and the browser.
Consider the following StudentVM
view model:
[!code-csharpMain]
The following code uses the StudentVM
view model to create a new student:
[!code-csharpMain]
The SetValues method sets the values of this object by reading values from another xref:Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues object. SetValues
uses property name matching. The view model type:
- Doesn't need to be related to the model type.
- Needs to have properties that match.
Using StudentVM
requires the Create page use StudentVM
rather than Student
:
[!code-cshtmlMain]
In Pages/Students/Edit.cshtml.cs
, replace the OnGetAsync
and OnPostAsync
methods with the following code.
[!code-csharpMain]
The code changes are similar to the Create page with a few exceptions:
FirstOrDefaultAsync
has been replaced with xref:Microsoft.EntityFrameworkCore.DbSet%601.FindAsync%2A. When you don't have to include related data,FindAsync
is more efficient.OnPostAsync
has anid
parameter.- The current student is fetched from the database, rather than creating an empty student.
Run the app, and test it by creating and editing a student.
The database context keeps track of whether entities in memory are in sync with their corresponding rows in the database. This tracking information determines what happens when SaveChangesAsync is called. For example, when a new entity is passed to the xref:Microsoft.EntityFrameworkCore.DbContext.AddAsync%2A method, that entity's state is set to xref:Microsoft.EntityFrameworkCore.EntityState.Added. When SaveChangesAsync
is called, the database context issues a SQL INSERT
command.
An entity may be in one of the following states:
-
Added
: The entity doesn't yet exist in the database. TheSaveChanges
method issues anINSERT
statement. -
Unchanged
: No changes need to be saved with this entity. An entity has this status when it's read from the database. -
Modified
: Some or all of the entity's property values have been modified. TheSaveChanges
method issues anUPDATE
statement. -
Deleted
: The entity has been marked for deletion. TheSaveChanges
method issues aDELETE
statement. -
Detached
: The entity isn't being tracked by the database context.
In a desktop app, state changes are typically set automatically. An entity is read, changes are made, and the entity state is automatically changed to Modified
. Calling SaveChanges
generates a SQL UPDATE
statement that updates only the changed properties.
In a web app, the DbContext
that reads an entity and displays the data is disposed after a page is rendered. When a page's OnPostAsync
method is called, a new web request is made and with a new instance of the DbContext
. Rereading the entity in that new context simulates desktop processing.
In this section, a custom error message is implemented when the call to SaveChanges
fails.
Replace the code in Pages/Students/Delete.cshtml.cs
with the following code:
[!code-csharpMain]
The preceding code:
- Adds Logging.
- Adds the optional parameter
saveChangesError
to theOnGetAsync
method signature.saveChangesError
indicates whether the method was called after a failure to delete the student object.
The delete operation might fail because of transient network problems. Transient network errors are more likely when the database is in the cloud. The saveChangesError
parameter is false
when the Delete page OnGetAsync
is called from the UI. When OnGetAsync
is called by OnPostAsync
because the delete operation failed, the saveChangesError
parameter is true
.
The OnPostAsync
method retrieves the selected entity, then calls the Remove method to set the entity's status to Deleted
. When SaveChanges
is called, a SQL DELETE
command is generated. If Remove
fails:
- The database exception is caught.
- The Delete pages
OnGetAsync
method is called withsaveChangesError=true
.
Add an error message to Pages/Students/Delete.cshtml
:
[!code-cshtmlMain]
Run the app and delete a student to test the Delete page.
[!div class="step-by-step"] Previous tutorial Next tutorial
:::moniker-end
:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"
In this tutorial, the scaffolded CRUD (create, read, update, delete) code is reviewed and customized.
Some developers use a service layer or repository pattern to create an abstraction layer between the UI (Razor Pages) and the data access layer. This tutorial doesn't do that. To minimize complexity and keep the tutorial focused on EF Core, EF Core code is added directly to the page model classes.
The scaffolded code for the Students pages doesn't include enrollment data. In this section, enrollments are added to the Details
page.
To display a student's enrollment data on the page, the enrollment data must be read. The scaffolded code in Pages/Students/Details.cshtml.cs
reads only the Student
data, without the Enrollment
data:
[!code-csharpMain]
Replace the OnGetAsync
method with the following code to read enrollment data for the selected student. The changes are highlighted.
[!code-csharpMain]
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.Include%2A and ThenInclude methods cause the context to load the Student.Enrollments
navigation property, and within each enrollment the Enrollment.Course
navigation property. These methods are examined in detail in the Read related data tutorial.
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.AsNoTracking%2A method improves performance in scenarios where the entities returned are not updated in the current context. AsNoTracking
is discussed later in this tutorial.
Replace the code in Pages/Students/Details.cshtml
with the following code to display a list of enrollments. The changes are highlighted.
[!code-cshtmlMain]
The preceding code loops through the entities in the Enrollments
navigation property. For each enrollment, it displays the course title and the grade. The course title is retrieved from the Course
entity that's stored in the Course
navigation property of the Enrollments entity.
Run the app, select the Students tab, and click the Details link for a student. The list of courses and grades for the selected student is displayed.
The generated code uses FirstOrDefaultAsync to read one entity. This method returns null if nothing is found; otherwise, it returns the first row found that satisfies the query filter criteria. FirstOrDefaultAsync
is generally a better choice than the following alternatives:
- SingleOrDefaultAsync - Throws an exception if there's more than one entity that satisfies the query filter. To determine if more than one row could be returned by the query,
SingleOrDefaultAsync
tries to fetch multiple rows. This extra work is unnecessary if the query can only return one entity, as when it searches on a unique key. - FindAsync - Finds an entity with the primary key (PK). If an entity with the PK is being tracked by the context, it's returned without a request to the database. This method is optimized to look up a single entity, but you can't call
Include
withFindAsync
. So if related data is needed,FirstOrDefaultAsync
is the better choice.
The URL for the Details page is https://localhost:<port>/Students/Details?id=1
. The entity's primary key value is in the query string. Some developers prefer to pass the key value in route data: https://localhost:<port>/Students/Details/1
. For more information, see Update the generated code.
The scaffolded OnPostAsync
code for the Create page is vulnerable to overposting. Replace the OnPostAsync
method in Pages/Students/Create.cshtml.cs
with the following code.
[!code-csharpMain]
The preceding code creates a Student object and then uses posted form fields to update the Student object's properties. The TryUpdateModelAsync method:
- Uses the posted form values from the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.PageContext%2A property in the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.
- Updates only the properties listed (
s => s.FirstMidName, s => s.LastName, s => s.EnrollmentDate
). - Looks for form fields with a "student" prefix. For example,
Student.FirstMidName
. It's not case sensitive. - Uses the model binding system to convert form values from strings to the types in the
Student
model. For example,EnrollmentDate
is converted toDateTime
.
Run the app, and create a student entity to test the Create page.
Using TryUpdateModel
to update fields with posted values is a security best practice because it prevents overposting. For example, suppose the Student entity includes a Secret
property that this web page shouldn't update or add:
[!code-csharpMain]
Even if the app doesn't have a Secret
field on the create or update Razor Page, a hacker could set the Secret
value by overposting. A hacker could use a tool such as Fiddler, or write some JavaScript, to post a Secret
form value. The original code doesn't limit the fields that the model binder uses when it creates a Student instance.
Whatever value the hacker specified for the Secret
form field is updated in the database. The following image shows the Fiddler tool adding the Secret
field, with the value "OverPost", to the posted form values.
The value "OverPost" is successfully added to the Secret
property of the inserted row. That happens even though the app designer never intended the Secret
property to be set with the Create page.
View models provide an alternative way to prevent overposting.
The application model is often called the domain model. The domain model typically contains all the properties required by the corresponding entity in the database. The view model contains only the properties needed for the UI page, for example, the Create page.
In addition to the view model, some apps use a binding model or input model to pass data between the Razor Pages page model class and the browser.
Consider the following StudentVM
view model:
[!code-csharpMain]
The following code uses the StudentVM
view model to create a new student:
[!code-csharpMain]
The SetValues method sets the values of this object by reading values from another xref:Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues object. SetValues
uses property name matching. The view model type:
- Doesn't need to be related to the model type.
- Needs to have properties that match.
Using StudentVM
requires the Create page use StudentVM
rather than Student
:
[!code-cshtmlMain]
In Pages/Students/Edit.cshtml.cs
, replace the OnGetAsync
and OnPostAsync
methods with the following code.
[!code-csharpMain]
The code changes are similar to the Create page with a few exceptions:
FirstOrDefaultAsync
has been replaced with xref:Microsoft.EntityFrameworkCore.DbSet%601.FindAsync%2A. When you don't have to include related data,FindAsync
is more efficient.OnPostAsync
has anid
parameter.- The current student is fetched from the database, rather than creating an empty student.
Run the app, and test it by creating and editing a student.
The database context keeps track of whether entities in memory are in sync with their corresponding rows in the database. This tracking information determines what happens when SaveChangesAsync is called. For example, when a new entity is passed to the xref:Microsoft.EntityFrameworkCore.DbContext.AddAsync%2A method, that entity's state is set to xref:Microsoft.EntityFrameworkCore.EntityState.Added. When SaveChangesAsync
is called, the database context issues a SQL INSERT
command.
An entity may be in one of the following states:
-
Added
: The entity doesn't yet exist in the database. TheSaveChanges
method issues anINSERT
statement. -
Unchanged
: No changes need to be saved with this entity. An entity has this status when it's read from the database. -
Modified
: Some or all of the entity's property values have been modified. TheSaveChanges
method issues anUPDATE
statement. -
Deleted
: The entity has been marked for deletion. TheSaveChanges
method issues aDELETE
statement. -
Detached
: The entity isn't being tracked by the database context.
In a desktop app, state changes are typically set automatically. An entity is read, changes are made, and the entity state is automatically changed to Modified
. Calling SaveChanges
generates a SQL UPDATE
statement that updates only the changed properties.
In a web app, the DbContext
that reads an entity and displays the data is disposed after a page is rendered. When a page's OnPostAsync
method is called, a new web request is made and with a new instance of the DbContext
. Rereading the entity in that new context simulates desktop processing.
In this section, a custom error message is implemented when the call to SaveChanges
fails.
Replace the code in Pages/Students/Delete.cshtml.cs
with the following code:
[!code-csharpMain]
The preceding code:
- Adds Logging.
- Adds the optional parameter
saveChangesError
to theOnGetAsync
method signature.saveChangesError
indicates whether the method was called after a failure to delete the student object.
The delete operation might fail because of transient network problems. Transient network errors are more likely when the database is in the cloud. The saveChangesError
parameter is false
when the Delete page OnGetAsync
is called from the UI. When OnGetAsync
is called by OnPostAsync
because the delete operation failed, the saveChangesError
parameter is true
.
The OnPostAsync
method retrieves the selected entity, then calls the Remove method to set the entity's status to Deleted
. When SaveChanges
is called, a SQL DELETE
command is generated. If Remove
fails:
- The database exception is caught.
- The Delete pages
OnGetAsync
method is called withsaveChangesError=true
.
Add an error message to Pages/Students/Delete.cshtml
:
[!code-cshtmlMain]
Run the app and delete a student to test the Delete page.
[!div class="step-by-step"] Previous tutorial Next tutorial
:::moniker-end
:::moniker range="< aspnetcore-5.0"
In this tutorial, the scaffolded CRUD (create, read, update, delete) code is reviewed and customized.
Some developers use a service layer or repository pattern to create an abstraction layer between the UI (Razor Pages) and the data access layer. This tutorial doesn't do that. To minimize complexity and keep the tutorial focused on EF Core, EF Core code is added directly to the page model classes.
The scaffolded code for the Students pages doesn't include enrollment data. In this section, enrollments are added to the Details page.
To display a student's enrollment data on the page, the enrollment data needs to be read. The scaffolded code in Pages/Students/Details.cshtml.cs
reads only the Student data, without the Enrollment data:
[!code-csharpMain]
Replace the OnGetAsync
method with the following code to read enrollment data for the selected student. The changes are highlighted.
[!code-csharpMain]
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.Include%2A and ThenInclude methods cause the context to load the Student.Enrollments
navigation property, and within each enrollment the Enrollment.Course
navigation property. These methods are examined in detail in the Reading related data tutorial.
The xref:Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions.AsNoTracking%2A method improves performance in scenarios where the entities returned are not updated in the current context. AsNoTracking
is discussed later in this tutorial.
Replace the code in Pages/Students/Details.cshtml
with the following code to display a list of enrollments. The changes are highlighted.
[!code-cshtmlMain]
The preceding code loops through the entities in the Enrollments
navigation property. For each enrollment, it displays the course title and the grade. The course title is retrieved from the Course entity that's stored in the Course
navigation property of the Enrollments entity.
Run the app, select the Students tab, and click the Details link for a student. The list of courses and grades for the selected student is displayed.
The generated code uses FirstOrDefaultAsync to read one entity. This method returns null if nothing is found; otherwise, it returns the first row found that satisfies the query filter criteria. FirstOrDefaultAsync
is generally a better choice than the following alternatives:
- SingleOrDefaultAsync - Throws an exception if there's more than one entity that satisfies the query filter. To determine if more than one row could be returned by the query,
SingleOrDefaultAsync
tries to fetch multiple rows. This extra work is unnecessary if the query can only return one entity, as when it searches on a unique key. - FindAsync - Finds an entity with the primary key (PK). If an entity with the PK is being tracked by the context, it's returned without a request to the database. This method is optimized to look up a single entity, but you can't call
Include
withFindAsync
. So if related data is needed,FirstOrDefaultAsync
is the better choice.
The URL for the Details page is https://localhost:<port>/Students/Details?id=1
. The entity's primary key value is in the query string. Some developers prefer to pass the key value in route data: https://localhost:<port>/Students/Details/1
. For more information, see Update the generated code.
The scaffolded OnPostAsync
code for the Create page is vulnerable to overposting. Replace the OnPostAsync
method in Pages/Students/Create.cshtml.cs
with the following code.
[!code-csharpMain]
The preceding code creates a Student object and then uses posted form fields to update the Student object's properties. The TryUpdateModelAsync method:
- Uses the posted form values from the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.PageContext%2A property in the xref:Microsoft.AspNetCore.Mvc.RazorPages.PageModel.
- Updates only the properties listed (
s => s.FirstMidName, s => s.LastName, s => s.EnrollmentDate
). - Looks for form fields with a "student" prefix. For example,
Student.FirstMidName
. It's not case sensitive. - Uses the model binding system to convert form values from strings to the types in the
Student
model. For example,EnrollmentDate
has to be converted to DateTime.
Run the app, and create a student entity to test the Create page.
Using TryUpdateModel
to update fields with posted values is a security best practice because it prevents overposting. For example, suppose the Student entity includes a Secret
property that this web page shouldn't update or add:
[!code-csharpMain]
Even if the app doesn't have a Secret
field on the create or update Razor Page, a hacker could set the Secret
value by overposting. A hacker could use a tool such as Fiddler, or write some JavaScript, to post a Secret
form value. The original code doesn't limit the fields that the model binder uses when it creates a Student instance.
Whatever value the hacker specified for the Secret
form field is updated in the database. The following image shows the Fiddler tool adding the Secret
field (with the value "OverPost") to the posted form values.
The value "OverPost" is successfully added to the Secret
property of the inserted row. That happens even though the app designer never intended the Secret
property to be set with the Create page.
View models provide an alternative way to prevent overposting.
The application model is often called the domain model. The domain model typically contains all the properties required by the corresponding entity in the database. The view model contains only the properties needed for the UI that it is used for (for example, the Create page).
In addition to the view model, some apps use a binding model or input model to pass data between the Razor Pages page model class and the browser.
Consider the following Student
view model:
[!code-csharpMain]
The following code uses the StudentVM
view model to create a new student:
[!code-csharpMain]
The SetValues method sets the values of this object by reading values from another xref:Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues object. SetValues
uses property name matching. The view model type doesn't need to be related to the model type, it just needs to have properties that match.
Using StudentVM
requires Create.cshtml be updated to use StudentVM
rather than Student
.
In Pages/Students/Edit.cshtml.cs
, replace the OnGetAsync
and OnPostAsync
methods with the following code.
[!code-csharpMain]
The code changes are similar to the Create page with a few exceptions:
FirstOrDefaultAsync
has been replaced with xref:Microsoft.EntityFrameworkCore.DbSet%601.FindAsync%2A. When included related data is not needed,FindAsync
is more efficient.OnPostAsync
has anid
parameter.- The current student is fetched from the database, rather than creating an empty student.
Run the app, and test it by creating and editing a student.
The database context keeps track of whether entities in memory are in sync with their corresponding rows in the database. This tracking information determines what happens when SaveChangesAsync is called. For example, when a new entity is passed to the xref:Microsoft.EntityFrameworkCore.DbContext.AddAsync%2A method, that entity's state is set to xref:Microsoft.EntityFrameworkCore.EntityState.Added. When SaveChangesAsync
is called, the database context issues a SQL INSERT command.
An entity may be in one of the following states:
-
Added
: The entity doesn't yet exist in the database. TheSaveChanges
method issues an INSERT statement. -
Unchanged
: No changes need to be saved with this entity. An entity has this status when it's read from the database. -
Modified
: Some or all of the entity's property values have been modified. TheSaveChanges
method issues an UPDATE statement. -
Deleted
: The entity has been marked for deletion. TheSaveChanges
method issues a DELETE statement. -
Detached
: The entity isn't being tracked by the database context.
In a desktop app, state changes are typically set automatically. An entity is read, changes are made, and the entity state is automatically changed to Modified
. Calling SaveChanges
generates a SQL UPDATE statement that updates only the changed properties.
In a web app, the DbContext
that reads an entity and displays the data is disposed after a page is rendered. When a page's OnPostAsync
method is called, a new web request is made and with a new instance of the DbContext
. Rereading the entity in that new context simulates desktop processing.
In this section, you implement a custom error message when the call to SaveChanges
fails.
Replace the code in Pages/Students/Delete.cshtml.cs
with the following code. The changes are highlighted (other than cleanup of using
statements).
[!code-csharpMain]
The preceding code adds the optional parameter saveChangesError
to the OnGetAsync
method signature. saveChangesError
indicates whether the method was called after a failure to delete the student object. The delete operation might fail because of transient network problems. Transient network errors are more likely when the database is in the cloud. The saveChangesError
parameter is false when the Delete page OnGetAsync
is called from the UI. When OnGetAsync
is called by OnPostAsync
(because the delete operation failed), the saveChangesError
parameter is true.
The OnPostAsync
method retrieves the selected entity, then calls the Remove method to set the entity's status to Deleted
. When SaveChanges
is called, a SQL DELETE command is generated. If Remove
fails:
- The database exception is caught.
- The Delete page's
OnGetAsync
method is called withsaveChangesError=true
.
Add an error message to the Delete Razor Page (Pages/Students/Delete.cshtml
):
[!code-cshtmlMain]
Run the app and delete a student to test the Delete page.
[!div class="step-by-step"] Previous tutorial Next tutorial
:::moniker-end