كيفية إنشاء تطبيق صفحة واحدة باستخدام صفحات Razor مع Blazor

في هذه المقالة ، سنقوم بإنشاء تطبيق صفحة واحدة (SPA) باستخدام صفحات Razor في Blazor ، بمساعدة النهج الأول لقاعدة بيانات Entity Framework Core.

المقدمة

تطبيق الصفحة الواحدة (SPAs) عبارة عن تطبيقات ويب تقوم بتحميل صفحة HTML واحدة ، وتقوم بتحديث هذه الصفحة ديناميكيًا عندما يتفاعل المستخدم مع التطبيق. سنقوم بإنشاء نموذج لنظام إدارة سجلات الموظفين وتنفيذ عمليات CRUD عليه.

سنستخدم Visual Studio 2017 و SQL Server 2014.

ألق نظرة على التطبيق النهائي.

المتطلبات الأساسية

  • قم بتثبيت NET Core 2.1 Preview 2 SDK من هنا
  • قم بتثبيت Visual Studio 2017 v15.7 أو أعلى من هنا
  • قم بتثبيت ملحق ASP.NET Core Blazor Language Services من هنا
  • SQL Server 2008 أو أعلى

إطار عمل Blazor غير مدعوم في الإصدارات الموجودة أسفل Visual Studio 2017 v15.7.

مصدر الرمز

احصل على الكود المصدري من جيثب.

إنشاء الجدول

سنستخدم جدول قاعدة بيانات لتخزين جميع سجلات الموظفين.

افتح SQL Server واستخدم البرنامج النصي التالي لإنشاء Employeeالجدول.

CREATE TABLE Employee ( EmployeeID int IDENTITY(1,1) PRIMARY KEY, Name varchar(20) NOT NULL , City varchar(20) NOT NULL , Department varchar(20) NOT NULL , Gender varchar(6) NOT NULL )

أنشئ تطبيق الويب Blazor

افتح Visual Studio وحدد "ملف"> "جديد"> "مشروع".

بعد تحديد المشروع ، سيتم فتح مربع حوار "مشروع جديد". في اللوحة اليمنى ، حدد ".NET Core" داخل قائمة Visual C #. ثم حدد "تطبيق ويب ASP.NET Core" من أنواع المشاريع المتاحة. ضع اسم المشروع باسم "BlazorSPA"واضغط على "موافق".

بعد النقر فوق "موافق" ، سيتم فتح مربع حوار جديد يطلب منك تحديد قالب المشروع. يمكنك ملاحظة قائمتين منسدلتين في الجزء العلوي الأيسر من نافذة النموذج. حدد ".NET Core" و "ASP.NET Core 2.0" من هذه القوائم المنسدلة. ثم حدد قالب "Blazor (ASP.NET Core مستضاف)" واضغط على "موافق".

الآن سيتم إنشاء حل Blazor الخاص بنا. يمكنك ملاحظة بنية المجلد في Solution Explorer كما هو موضح في الصورة أدناه.

يمكنك ملاحظة أن لدينا ثلاثة ملفات مشروع تم إنشاؤها داخل هذا الحل.

  1. BlazorSPA.Client - يحتوي على كود العميل ويحتوي على الصفحات التي سيتم عرضها على المتصفح.
  2. BlazorSPA.Server - يحتوي على رموز جانب الخادم مثل العمليات المتعلقة بقاعدة البيانات وواجهة برمجة تطبيقات الويب.
  3. BlazorSPA.Shared - يحتوي على الرمز المشترك الذي يمكن الوصول إليه بواسطة كل من العميل والخادم. يحتوي على فئات نموذجنا.

سقالات النموذج للتطبيق

نحن نستخدم النهج الأول لقاعدة البيانات الأساسية Entity Framework لإنشاء نماذجنا. سننشئ فئة النموذج الخاصة بنا في مشروع "BlazorSPA.Shared" بحيث يمكن الوصول إليها من قبل كل من مشروع العميل والخادم.

انتقل إلى "أدوات"> "مدير حزمة NuGet"> "وحدة تحكم مدير الحزم". حدد "BlazorSPA.Shared" من القائمة المنسدلة "المشروع الافتراضي". الرجوع إلى الصورة أدناه:

أولاً ، سنقوم بتثبيت الحزمة لموفر قاعدة البيانات الذي نستهدفه ، وهو SQL Server في هذه الحالة. قم بتشغيل الأمر التالي:

Install-Package Microsoft.EntityFrameworkCore.SqlServer

نظرًا لأننا نستخدم Entity Framework Tools لإنشاء نموذج من قاعدة البيانات الحالية ، فسنقوم أيضًا بتثبيت حزمة الأدوات. قم بتشغيل الأمر التالي:

Install-Package Microsoft.EntityFrameworkCore.Tools

بعد تثبيت كلتا الحزمتين ، سنقوم بإسناد نموذجنا من جداول قاعدة البيانات باستخدام الأمر التالي:

Scaffold-DbContext "Your connection string here" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models -Tables Employee

لا تنس وضع سلسلة الاتصال الخاصة بك (بالداخل “”). بعد تنفيذ هذا الأمر بنجاح ، يمكنك ملاحظة إنشاء مجلد "نماذج". يحتوي على ملفي فئة ، "myTestDBContext.cs"و "Employee.cs". ومن ثم ، فقد نجحنا في دعم نماذجنا باستخدام نهج قاعدة البيانات الأساسية Entity Framework أولاً.

في هذا الوقت ، سيكون لمجلد الطرازات البنية التالية:

إنشاء طبقة الوصول إلى البيانات للتطبيق

انقر بزر الماوس الأيمن فوق مشروع "BlazorSPA.Server" ثم حدد "إضافة"> "مجلد جديد" وقم بتسمية المجلد باسم "DataAccess". سنضيف صفنا للتعامل مع العمليات المتعلقة بقاعدة البيانات داخل هذا المجلد فقط.

انقر بزر الماوس الأيمن على مجلد "DataAccess" وحدد "Add"> "Class". قم بتسمية فصلك الدراسي "EmployeeDataAccessLayer.cs".

افتح "EmployeeDataAccessLayer.cs"ووضع الكود التالي فيه:

using BlazorSPA.Shared.Models;using Microsoft.EntityFrameworkCore;using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;namespace BlazorSPA.Server.DataAccess{ public class EmployeeDataAccessLayer { myTestDBContext db = new myTestDBContext(); //To Get all employees details public IEnumerable GetAllEmployees() { try { return db.Employee.ToList(); } catch { throw; } } //To Add new employee record public void AddEmployee(Employee employee) { try { db.Employee.Add(employee); db.SaveChanges(); } catch { throw; } } //To Update the records of a particluar employee public void UpdateEmployee(Employee employee) { try { db.Entry(employee).State = EntityState.Modified; db.SaveChanges(); } catch { throw; } } //Get the details of a particular employee public Employee GetEmployeeData(int id) { try { Employee employee = db.Employee.Find(id); return employee; } catch { throw; } } //To Delete the record of a particular employee public void DeleteEmployee(int id) { try { Employee emp = db.Employee.Find(id); db.Employee.Remove(emp); db.SaveChanges(); } catch { throw; } } }}

هنا قمنا بتحديد طرق للتعامل مع عمليات قاعدة البيانات. GetAllEmployeesسيجلب جميع بيانات الموظف من جدول الموظفين. وبالمثل ، AddEmployeeسيتم إنشاء سجل موظف جديد ، UpdateEmployeeوسيتم تحديث سجل الموظف الحالي. GetEmployeeDataسيحضر سجل الموظف المطابق لمعرف الموظف الذي تم تمريره إليه ، DeleteEmployeeوسيحذف سجل الموظف المقابل لمعرف الموظف الذي تم تمريره إليه.

إضافة وحدة تحكم Web API إلى التطبيق

انقر بزر الماوس الأيمن على مجلد "BlazorSPA.Server / Controllers" وحدد "إضافة"> "عنصر جديد". سيتم فتح مربع حوار "إضافة عنصر جديد". حدد "ASP.NET" من اللوحة اليمنى ، ثم حدد "API Controller Class" من لوحة القوالب ، ثم ضع الاسم كـ "EmployeeController.cs". انقر فوق "إضافة".

سيؤدي هذا إلى إنشاء API الخاص بنا EmployeeControllerصف دراسي.

We will call the methods of theEmployeeDataAccessLayerclass to fetch data and pass on the data to the client side.

Open “EmployeeController.cs”file and put the following code into it:

using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;using BlazorSPA.Server.DataAccess;using BlazorSPA.Shared.Models;using Microsoft.AspNetCore.Mvc;namespace BlazorSPA.Server.Controllers{ public class EmployeeController : Controller { EmployeeDataAccessLayer objemployee = new EmployeeDataAccessLayer(); [HttpGet] [Route("api/Employee/Index")] public IEnumerable Index() { return objemployee.GetAllEmployees(); } [HttpPost] [Route("api/Employee/Create")] public void Create([FromBody] Employee employee) { if (ModelState.IsValid) objemployee.AddEmployee(employee); } [HttpGet] [Route("api/Employee/Details/{id}")] public Employee Details(int id) { return objemployee.GetEmployeeData(id); } [HttpPut] [Route("api/Employee/Edit")] public void Edit([FromBody]Employee employee) { if (ModelState.IsValid) objemployee.UpdateEmployee(employee); } [HttpDelete] [Route("api/Employee/Delete/{id}")] public void Delete(int id) { objemployee.DeleteEmployee(id); } }}

At this point of time, our “BlazorSPA.Server” project has the following structure.

We are done with our backend logic. Therefore, we will now proceed to code our client side.

Adding the Razor page to the application

We will add the Razor page into the “BlazorSPA.Client/Pages” folder. By default, we have “Counter” and “Fetch Data” pages provided in our application. These default pages will not affect our application but, for the sake of this tutorial, we will delete the “fetchdata”and “counter” pages from the “BlazorSPA.Client/Pages” folder.

Right click on the “BlazorSPA.Client/Pages” folder and then select “Add” > “New Item”. An “Add New Item” dialog box will open. Select “ASP.NET Core” from the left panel, then select “Razor Page” from the templates panel and name it “EmployeeData.cshtml”. Click “Add”.

This will add an “EmployeeData.cshtml” page to our “BlazorSPA.Client/Pages” folder. This Razor page will have two files, “EmployeeData.cshtml”andEmployeeData.cshtml.cs”.

Now we will add code to these pages.

EmployeeData.cshtml.cs

Open “EmployeeData.cshtml.cs”and put the following code into it:

using System;using System.Collections.Generic;using System.Linq;using System.Net.Http;using System.Threading.Tasks;using BlazorSPA.Shared.Models;using Microsoft.AspNetCore.Blazor;using Microsoft.AspNetCore.Blazor.Components;using Microsoft.AspNetCore.Blazor.Services;namespace BlazorSPA.Client.Pages{ public class EmployeeDataModel : BlazorComponent { [Inject] protected HttpClient Http { get; set; } [Inject] protected IUriHelper UriHelper { get; set; } [Parameter] protected string paramEmpID { get; set; } = "0"; [Parameter] protected string action { get; set; } protected List empList = new List(); protected Employee emp = new Employee(); protected string title { get; set; } protected override async Task OnParametersSetAsync() { if (action == "fetch") { await FetchEmployee(); this.StateHasChanged(); } else if (action == "create") { title = "Add Employee"; emp = new Employee(); } else if (paramEmpID != "0") { if (action == "edit") { title = "Edit Employee"; } else if (action == "delete") { title = "Delete Employee"; } emp = await Http.GetJsonAsync("/api/Employee/Details/" + Convert.ToInt32(paramEmpID)); } } protected async Task FetchEmployee() { title = "Employee Data"; empList = await Http.GetJsonAsync
    
     ("api/Employee/Index"); } protected async Task CreateEmployee() { if (emp.EmployeeId != 0) { await Http.SendJsonAsync(HttpMethod.Put, "api/Employee/Edit", emp); } else { await Http.SendJsonAsync(HttpMethod.Post, "/api/Employee/Create", emp); } UriHelper.NavigateTo("/employee/fetch"); } protected async Task DeleteEmployee() { await Http.DeleteAsync("api/Employee/Delete/" + Convert.ToInt32(paramEmpID)); UriHelper.NavigateTo("/employee/fetch"); } protected void Cancel() { title = "Employee Data"; UriHelper.NavigateTo("/employee/fetch"); } }}
    

Let us understand this code. We have defined a class EmployeeDataModelthat will hold all our methods that we will use in the “EmployeeData.cshtml”page.

We are injecting the HttpClient service to enable web API call and the IUriHelper service to enable URL redirection. After this, we have defined our parameter attributes — paramEmpID and action. These parameters are used in “EmployeeData.cshtml” to define the routes for our page. We have also declared a property title to display the heading to specify the current action that is being performed on the page.

The OnParametersSetAsync method is invoked every time the URL parameters are set for the page. We will check the value of parameter action to identify the current operation on the page.

If the action is set to fetch, then we will invoke the FetchEmployee method to fetch the updated list of employees from the database and refresh the UI using the StateHasChanged method.

We will check if the action attribute of parameter is set to create, then we will set the title of the page to “Add Employee” and create a new object of type Employee. If the paramEmpID is not “0”, then it is either an edit action or a delete action. We will set the title property accordingly and then invoke our web API method to fetch the data for the employee ID as set in the paramEmpID property.

The method FetchEmployee will set the title to “Employee Data” and fetch all the employee data by invoking our web API method.

The CreateEmployee method will check if it is invoked to add a new employee record, or to edit an existing employee record. If the EmployeeId property is set, then it is an edit request and we will send a PUT request to the web API. If EmployeeId is not set, then it is a create request and we will send a POST request to web API. We will set the title property according to the corresponding value of action, and then invoke our web API method to fetch the data for the employee ID as set in the paramEmpIDproperty.

The DeleteEmployee method will delete the employee record for the employee ID as set in the paramEmpID property. After deletion, the user is redirected to the “/employee/fetch” page.

In the Cancel method, we will set the title property to “Employee Data” and redirect the user to “/employee/fetch” page.

EmployeeData.cshtml

Open the “EmployeeData.cshtml” page and put the following code into it:

@page "/employee/{action}/{paramEmpID}"@page "/employee/{action}"@inherits EmployeeDataModel

@title

@if (action == "fetch"){

Create New

}@if (action == "create" || action == "edit"){
Name Department
Gender -- Select Gender -- Male Female City
await CreateEmployee())" value="Save" />
}else if (action == "delete"){
Name @emp.Name
Gender @emp.Gender
Department @emp.Department
City @emp.City
await DeleteEmployee())" value="Delete" /> }@if (empList == null){

Loading...

}else{ @foreach (var emp in empList)
ID Name Gender Department City
@emp.EmployeeId @emp.Name @emp.Gender @emp.Department @emp.City Edit
}

At the top, we have defined the routes for our page. There are two routes defined:

  1. /employee/{action}/{paramEmpID} : This will accept the action name along with employee ID. This route is invoked when we perform an Edit or Deleteoperation. When we call an edit or delete action on a particular employee’s data, the employee ID is also passed as the URL parameter.
  2. /employee/{action} : This will only accept the action name. This route is invoked when we create a new employee’s data, or we fetch the records of all the employees.

We are also inheriting theEmployeeDataModel class, which is defined in the “EmployeeData.cshtml.cs” file. This will allow us to use the methods defined in the EmployeeDataModel class.

After this, we are setting the title that will be displayed on our page. The title is dynamic and changes as per the action that is being executed currently on the page.

We will show the “Create New” link only if the action is fetch. If the action is create or edit then the “Create New” link will be hidden and we will display the form to get the user input. Inside the form, we have also defined the two buttons “Save” and “Cancel”. Clicking on “Save” will invoke the CreateEmployee method whereas clicking on “Cancel” will invoke the Cancel method.

If the action is delete then a table will be displayed with the data of the employee on which the delete action is invoked. We are also displaying two buttons — “Delete” and “Cancel”. Clicking on the “Delete” button will invoke the DeleteEmployee method, and clicking on “Cancel” will invoke the Cancel method.

At the end, we have a table to display all the employee data from the database. Each employee record will also have two action links: “Edit” to edit the employee record and “Delete” to delete the employee record. This table is always displayed on the page, and we will update it after performing every action.

Adding the link to the Navigation menu

The last step is to add the link to our “EmployeeData” page in the navigation menu. Open the “BlazorSPA.Client/Shared/NavMenu.cshtml” page and put the following code into it:

 BlazorSPA 
    
  • Home
  • Employee data
@functions { bool collapseNavMenu = true; void ToggleNavMenu() { collapseNavMenu = !collapseNavMenu; }}

Hence, we have successfully created an SPA using Blazor, with the help of the Entity Framework Core database first approach.

Execution demo

Launch the application.

A web page will open as shown in the image below. The navigation menu on the left is showing the navigation link for the Employee data page.

Clicking on the “Employee data” link will redirect to the “Employee Data” view. Here you can see all the employee data on the page. Notice the URL has “employee/fetch” appended to it.

We have not added any data, hence it is empty. Click on “CreateNew” to open the “Add Employee” form to add new employee data. Notice the URL has “employee/create” appended to it:

After inserting data in all the fields, click on the “Save” button. The new employee record will be created, and the Employee data table will get refreshed.

If we want to edit an existing employee record, then click on the “Edit” action link. It will open Edit view as shown below. Here we can change the employee data. Notice that we have passed the employee ID in the URL parameter.

Here we have changed the City of employee Swati from Mumbai to Kolkatta. Click on “Save” to refresh the employee data table to view the updated changes as highlighted in the image below:

Now we will perform a Delete operation on the employee named Dhiraj. Click on the “Delete” action link, which will open the Delete view asking for a confirmation to delete. Notice that we have passed the employee ID in the URL parameter.

Once we click on the “Delete” button, it will delete the employee record and the employee data table will be refreshed. Here, we can see that the employee with name Dhiraj has been removed from our record.

Deploying the application

To learn how to deploy a Blazor application using IIS, refer to Deploying A Blazor Application On IIS.

Conclusion

We have created a Single Page Application with Razor pages in Blazor using the Entity Framework Core database first approach with the help of Visual Studio 2017 and SQL Server 2014. We have also performed the CRUD operations on our application.

Please get the source code from GitHub and play around to get a better understanding.

Get my book Blazor Quick Start Guide to learn more about Blazor.

You can also read this article at C# Corner

You can check my other articles on Blazor here.

See Also

  • ASP.NET Core — Getting Started With Blazor
  • ASP.NET Core — CRUD Using Blazor And Entity Framework Core
  • Cascading DropDownList In Blazor Using EF Core
  • Razor Page Web Application With ASP.NET Core Using ADO.NET
  • ASP.NET Core - CRUD باستخدام Angular 5 و Entity Framework Core
  • ASP.NET Core - CRUD مع React.js و Entity Framework Core

نُشر في الأصل على //ankitsharmablogs.com/