Architecture with .NET Core 3.1, ASP.NET Core 3.1, Entity Framework Core 3.1, C#, Angular 9.1, Clean Code, SOLID, DDD, Code Analysis, Docker and more.
Technologies
Practices
Internet Information Services (IIS) 10.0 Express is a free, simple and
self-contained version of IIS that is optimized for developers. IIS 10.0
Express makes it easy to use the most current version of IIS to develop
and test websites. IIS 10.0 Express has all the core capabilities of
IIS 10.0 and additional features to ease website development.
The benefits of using IIS 10.0 Express include:
در ویژوال استودیو 2013 پروژه جدیدی از نوع ASP.NET Web Application بسازید و نام آن را "ProductsApp" انتخاب کنید.
در دیالوگ New ASP.NET Project قالب Empty را انتخاب کنید و در قسمت "Add folders and core references for" گزینه Web API را انتخاب نمایید.
می توانید از قالب Web API هم استفاده کنید. این قالب با استفاده از ASP.NET MVC صفحات راهنمای API را خواهد ساخت. در این مقاله از قالب Empty استفاده میکنیم تا تمرکز اصلی، روی خود فریم ورک Web API باشد. بطور کلی برای استفاده از این فریم ورک لازم نیست با ASP.NET MVC آشنایی داشته باشید.
یک مدل (model) آبجکتی است که داده اپلیکیشن شما را معرفی میکند. ASP.NET Web API می‌تواند بصورت خودکار مدل شما را به JSON, XML و برخی فرمت‌های دیگر مرتب (serialize) کند، و سپس داده مرتب شده را در بدنه پیام HTTP Response بنویسد. تا وقتی که یک کلاینت بتواند فرمت مرتب سازی داده‌ها را بخواند، می‌تواند آبجکت شما را deserialize کند. اکثر کلاینت‌ها می‌توانند XML یا JSON را تفسیر کنند. بعلاوه کلاینت‌ها می‌توانند فرمت مورد نظرشان را با تنظیم Accept header در پیام HTTP Request مشخص کنند.
بگذارید تا با ساختن مدلی ساده که یک محصول (product) را معرفی میکند شروع کنیم.
کلاس جدیدی در پوشه Models ایجاد کنید.
نام کلاس را به "Product" تغییر دهید، و خواص زیر را به آن اضافه کنید.
namespace ProductsApp.Models
{
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public string Category { get; set; }
public decimal Price { get; set; }
}
} در Web API کنترلرها آبجکت هایی هستند که درخواست‌های HTTP را مدیریت کرده و آنها را به اکشن متدها نگاشت می‌کنند. ما کنترلری خواهیم ساخت که می‌تواند لیستی از محصولات، یا محصولی بخصوص را بر اساس شناسه برگرداند. اگر از ASP.NET MVC استفاده کرده اید، با کنترلرها آشنا هستید. کنترلرهای Web API مشابه کنترلرهای MVC هستند، با این تفاوت که بجای ارث بری از کلاس Controller از کلاس ApiController مشتق می‌شوند.
کنترلر جدیدی در پوشه Controllers ایجاد کنید.
در دیالوگ Add Scaffold گزینه Web API Controller - Empty را انتخاب کرده و روی Add کلیک کنید.
در دیالوگ Add Controller نام کنترلر را به "ProductsController" تغییر دهید و روی Add کلیک کنید.
توجه کنید که ملزم به ساختن کنترلرهای خود در پوشه Controllers نیستید، و این روش صرفا قراردادی برای مرتب نگاه داشتن ساختار پروژه‌ها است. کنترلر ساخته شده را باز کنید و کد زیر را به آن اضافه نمایید.
using ProductsApp.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Web.Http;
namespace ProductsApp.Controllers
{
public class ProductsController : ApiController
{
Product[] products = new Product[]
{
new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 },
new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M },
new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M }
};
public IEnumerable<Product> GetAllProducts()
{
return products;
}
public IHttpActionResult GetProduct(int id)
{
var product = products.FirstOrDefault((p) => p.Id == id);
if (product == null)
{
return NotFound();
}
return Ok(product);
}
} همین! حالا یک Web API ساده دارید. هر یک از متدهای این کنترلر، به یک یا چند URI پاسخ می‌دهند:
| URI | Controller Method |
| api/products/ | GetAllProducts |
| api/products/id/ | GetProductById |
برای اطلاعات بیشتر درباره نحوه نگاشت درخواست‌های HTTP به اکشن متدها توسط Web API به این لینک مراجعه کنید.
در این قسمت یک صفحه HTML خواهیم ساخت که با استفاده از AJAX متدهای Web API را فراخوانی میکند. برای ارسال درخواست‌های آژاکسی و بروز رسانی صفحه بمنظور نمایش نتایج دریافتی از jQuery استفاده میکنیم.
در پنجره Solution Explorer روی نام پروژه کلیک راست کرده و گزینه Add, New Item را انتخاب کنید.
در دیالوگ Add New Item قالب HTML Page را انتخاب کنید و نام فایل را به "index.html" تغییر دهید.
حال محتوای این فایل را با لیست زیر جایگزین کنید.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Product App</title>
</head>
<body>
<div>
<h2>All Products</h2>
<ul id="products" />
</div>
<div>
<h2>Search by ID</h2>
<input type="text" id="prodId" size="5" />
<input type="button" value="Search" onclick="find();" />
<p id="product" />
</div>
<script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script>
<script>
var uri = 'api/products';
$(document).ready(function () {
// Send an AJAX request
$.getJSON(uri)
.done(function (data) {
// On success, 'data' contains a list of products.
$.each(data, function (key, item) {
// Add a list item for the product.
$('<li>', { text: formatItem(item) }).appendTo($('#products'));
});
});
});
function formatItem(item) {
return item.Name + ': $' + item.Price;
}
function find() {
var id = $('#prodId').val();
$.getJSON(uri + '/' + id)
.done(function (data) {
$('#product').text(formatItem(data));
})
.fail(function (jqXHR, textStatus, err) {
$('#product').text('Error: ' + err);
});
}
</script>
</body>
</html> برای گرفتن لیستی از محصولات، یک درخواست HTTP GET به آدرس "api/products/" ارسال کنید.
تابع getJSON یک درخواست آژاکسی ارسال میکند. پاسخ دریافتی هم آرایه ای از آبجکت‌های JSON خواهد بود. تابع done در صورت موفقیت آمیز بودن درخواست، اجرا می‌شود. که در این صورت ما DOM را با اطلاعات محصولات بروز رسانی میکنیم.
$(document).ready(function () {
// Send an AJAX request
$.getJSON(apiUrl)
.done(function (data) {
// On success, 'data' contains a list of products.
$.each(data, function (key, item) {
// Add a list item for the product.
$('<li>', { text: formatItem(item) }).appendTo($('#products'));
});
});
}); برای گرفتن یک محصول توسط شناسه (ID) آن کافی است یک درخواست HTTP GET به آدرس "api/products/id/" ارسال کنید.
function find() {
var id = $('#prodId').val();
$.getJSON(apiUrl + '/' + id)
.done(function (data) {
$('#product').text(formatItem(data));
})
.fail(function (jqXHR, textStatus, err) {
$('#product').text('Error: ' + err);
});
} اپلیکیشن را با F5 اجرا کنید. صفحه وب باز شده باید چیزی مشابه تصویر زیر باشد.
برای گرفتن محصولی مشخص، شناسه آن را وارد کنید و روی Search کلیک کنید.
اگر شناسه نامعتبری وارد کنید، سرور یک خطای HTTP بر می‌گرداند.
هنگام کار با سرویس‌های HTTP، مشاهده‌ی درخواست‌های ارسال شده و پاسخ‌های دریافتی بسیار مفید است. برای اینکار می‌توانید از ابزار توسعه دهندگان وب استفاده کنید، که اکثر مرورگرهای مدرن، پیاده سازی خودشان را دارند. در اینترنت اکسپلورر می‌توانید با F12 به این ابزار دسترسی پیدا کنید. به برگه Network بروید و روی Start Capturing کلیک کنید. حالا صفحه وب را مجددا بارگذاری (reload) کنید. در این مرحله اینترنت اکسپلورر ترافیک HTTP بین مرورگر و سرور را تسخیر میکند. می‌توانید تمام ترافیک HTTP روی صفحه جاری را مشاهده کنید.
به دنبال آدرس نسبی "api/products/" بگردید و آن را انتخاب کنید. سپس روی Go to detailed view کلیک کنید تا جزئیات ترافیک را مشاهده کنید. در نمای جزئیات، می‌توانید headerها و بدنه درخواست‌ها و پاسخ‌ها را ببینید. مثلا اگر روی برگه Request headers کلیک کنید، خواهید دید که اپلیکیشن ما در Accept header داده‌ها را با فرمت "application/json" درخواست کرده است.
اگر روی برگه Response body کلیک کنید، می‌توانید ببینید چگونه لیست محصولات با فرمت JSON سریال شده است. همانطور که گفته شده مرورگرهای دیگر هم قابلیت‌های مشابهی دارند. یک ابزار مفید دیگر Fiddler است. با استفاده از این ابزار می‌توانید تمام ترافیک HTTP خود را مانیتور کرده، و همچنین درخواست‌های جدیدی بسازید که این امر کنترل کاملی روی HTTP headers به شما میدهد.
//returns the file content as an array of bytes
public FileContentResult FileContentActionResult()
{
var file = System.IO.File.ReadAllBytes(@"C:\path\dir1\HomeController.cs");
return File(file, "text/plain", "HomeController.cs");
} public IActionResult TestFileContentActionResult()
{
var file = System.IO.File.ReadAllBytes(@"C:\path\dir1\HomeController.cs");
return new FileContentResult(file, "text/plain") { FileDownloadName = "HomeController.cs" };
} //return the file as a stream
public FileStreamResult FileStreamActionResult()
{
//var file = System.IO.File.ReadAllBytes(@"C:\path\dir1\HomeController.cs");
//var stream = new MemoryStream(file, writable:true);
var fileStream = new FileStream(@"C:\path\dir1\HomeController.cs", FileMode.Open, FileAccess.Read);
return File(fileStream, "text/plain", "HomeController.cs");
} public IActionResult TestFileStreamActionResult()
{
//var file = System.IO.File.ReadAllBytes(@"C:\path\dir1\HomeController.cs");
//var stream = new MemoryStream(file, writable:true);
var fileStream = new FileStream(@"C:\path\dir1\HomeController.cs", FileMode.Open, FileAccess.Read);
return new FileStreamResult(fileStream, "text/plain") { FileDownloadName = "HomeController.cs" };
} //returns a file specified with a virtual path
public VirtualFileResult VirtualFileActionResult()
{
return File("/css/site.css", "text/plain", "site.css");
} public IActionResult TestVirtualFileActionResult()
{
return new VirtualFileResult("/css/site.css", "text/plain") { FileDownloadName = "site.css" };
} //returns the specified file on disk, that is it's physical address
public PhysicalFileResult PhysicalFileActionResult()
{
return PhysicalFile(@"C:\path\dir1\HomeController.cs", "text/plain", "HomeController.cs");
} public IActionResult TestPhysicalFileActionResult()
{
return new PhysicalFileResult(@"C:\path\dir1\HomeController.cs", "text/plain")
{
FileDownloadName = "HomeController.cs"
};
} This release contains the following improvements and enhancements:
These are the customer-reported issues addressed in 15.7.6:
public static void PrintNumbers()
{
var numbers = new[] { 1,2,3,5,7,90 }; // from a data source
foreach(var item in numbers)
{
Console.WriteLine(item);
}
}
public static void PrintNumbers(Func<int,string> formula)
{
var numbers = new[] { 1,2,3,5,7,90 }; // from a data source
foreach(var item in numbers)
{
var data = formula(item);
Console.WriteLine(data);
}
}
PrintNumbers(number => string.Format("{0:n0}",number));
PrintNumbers((number) =>{ return string.Format("{0:n0}",number); });
using System;
using System.Web;
using System.Web.Caching;
using System.Collections.Generic;
namespace WebToolkit
{
public static class CacheManager
{
public static void CacheInsert(this HttpContextBase httpContext, string key, object data, int durationMinutes)
{
if (data == null) return;
httpContext.Cache.Add(
key,
data,
null,
DateTime.Now.AddMinutes(durationMinutes),
TimeSpan.Zero,
CacheItemPriority.AboveNormal,
null);
}
}
}
var item = httpContext.Cache[key];
if (item == null)
{
item = ReadDataFromDataSource();
if (item == null)
return null;
CacheInsert(httpContext, key, item, durationMinutes);
}
using System;
using System.Web;
using System.Web.Caching;
using System.Collections.Generic;
namespace WebToolkit
{
public static class CacheManager
{
public static void CacheInsert(this HttpContextBase httpContext, string key, object data, int durationMinutes)
{
if (data == null) return;
httpContext.Cache.Add(
key,
data,
null,
DateTime.Now.AddMinutes(durationMinutes),
TimeSpan.Zero,
CacheItemPriority.AboveNormal,
null);
}
public static T CacheRead<T>(this HttpContextBase httpContext, string key, int durationMinutes, Func<T> ifNullRetrievalMethod)
{
var item = httpContext.Cache[key];
if (item == null)
{
item = ifNullRetrievalMethod();
if (item == null)
return default(T);
CacheInsert(httpContext, key, item, durationMinutes);
}
return (T)item;
}
}
}
var user = HttpContext.CacheRead(
"Key1",
15,
() => _usersService.FindUser(userId));
public IExpectPrimaryContactPersonBuilder WithSurname(string surname)
{
return new PersonBuilder {
Name = this.Name;
Surname = surname;
}
} class ExpectSurname : IExpectSurnamePersonBuilder
{
private string Name { get; }
public ExpectSurname(string name)
{
this.Name = name;
}
public IExpectPrimaryContactPersonBuilder WithSurname(string surname)
{
if (string.IsNullOrEmpty(surname))
throw new ArgumentException(nameof(surname));
return new ExpectPrimaryContact(this.Name, surname);
}
} PM> install-package EntityFrameworkWithHierarchyId
public class Employee
{
public int Id { get; set; }
[Required, MaxLength(100)]
public string Name { get; set; }
[Required]
public HierarchyId Node { get; set; } // نوع داده جدید
} public class MyContext : DbContext
{
public DbSet<Employee> Employees { get; set; }
public MyContext()
: base("Connection1")
{
this.Database.Log = log => Console.WriteLine(log);
}
}
public class Configuration : DbMigrationsConfiguration<MyContext>
{
public Configuration()
{
AutomaticMigrationsEnabled = true;
AutomaticMigrationDataLossAllowed = true;
}
protected override void Seed(MyContext context)
{
if (context.Employees.Any())
return;
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] ADD NodePath as Node.ToString() persisted");
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] ADD Level AS Node.GetLevel() persisted");
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] ADD ManagerNode as Node.GetAncestor(1) persisted");
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] ADD ManagerNodePath as Node.GetAncestor(1).ToString() persisted");
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] ADD CONSTRAINT [UK_EmployeeNode] UNIQUE NONCLUSTERED (Node)");
context.Database.ExecuteSqlCommand(
"ALTER TABLE [dbo].[Employees] WITH CHECK ADD CONSTRAINT [EmployeeManagerNodeNodeFK] " +
"FOREIGN KEY([ManagerNode]) REFERENCES [dbo].[Employees] ([Node])");
context.Employees.Add(new Employee { Name = "Root", Node = new HierarchyId("/") });
context.Employees.Add(new Employee { Name = "Emp1", Node = new HierarchyId("/1/") });
context.Employees.Add(new Employee { Name = "Emp2", Node = new HierarchyId("/2/") });
context.Employees.Add(new Employee { Name = "Emp3", Node = new HierarchyId("/1/1/") });
context.Employees.Add(new Employee { Name = "Emp4", Node = new HierarchyId("/1/1/1/") });
context.Employees.Add(new Employee { Name = "Emp5", Node = new HierarchyId("/2/1/") });
context.Employees.Add(new Employee { Name = "Emp6", Node = new HierarchyId("/1/2/") });
base.Seed(context);
}
} using (var context = new MyContext())
{
Console.WriteLine("\ngetItems OrderByDescending(employee => employee.Node)");
var employees = context.Employees.OrderByDescending(employee => employee.Node).ToList();
foreach (var employee in employees)
{
Console.WriteLine("{0} {1}", employee.Id, employee.Node);
}
} SELECT
[Extent1].[Id] AS [Id],
[Extent1].[Name] AS [Name],
[Extent1].[Node] AS [Node]
FROM [dbo].[Employees] AS [Extent1]
ORDER BY [Extent1].[Node] DESC
6 /2/1/
3 /2/
7 /1/2/
5 /1/1/1/
4 /1/1/
2 /1/
1 / using (var context = new MyContext())
{
Console.WriteLine("\nGetAncestor(1) of /1/");
var firstItem = context.Employees.Single(employee => employee.Node == new HierarchyId("/1/"));
foreach (var item in context.Employees.Where(employee => firstItem.Node == employee.Node.GetAncestor(1)))
{
Console.WriteLine("{0} {1}", item.Id, item.Name);
}
} SELECT TOP (2)
[Extent1].[Id] AS [Id],
[Extent1].[Name] AS [Name],
[Extent1].[Node] AS [Node]
FROM [dbo].[Employees] AS [Extent1]
WHERE cast('/1/' as hierarchyid) = [Extent1].[Node]
SELECT
[Extent1].[Id] AS [Id],
[Extent1].[Name] AS [Name],
[Extent1].[Node] AS [Node]
FROM [dbo].[Employees] AS [Extent1]
WHERE (@p__linq__0 = ([Extent1].[Node].GetAncestor(1))) OR ((@p__linq__0 IS
NULL) AND ([Extent1].[Node].GetAncestor(1) IS NULL))
-- p__linq__0: '/1/' (Type = Object)
4 Emp3
7 Emp6 var list = context.Employees.Where(
employee => employee.Node.IsDescendantOf(new HierarchyId("/1/")) &&
employee.Node.GetLevel() == 2).ToList(); SELECT
[Extent1].[Id] AS [Id],
[Extent1].[Name] AS [Name],
[Extent1].[Node] AS [Node]
FROM [dbo].[Employees] AS [Extent1]
WHERE (([Extent1].[Node].IsDescendantOf(cast('/1/' as hierarchyid))) = 1)
AND (2 = ([Extent1].[Node].GetLevel())) var items = context.Employees.Where(employee => employee.Node.IsDescendantOf(new HierarchyId("/1/")))
.Select(employee => new
{
Id = employee.Id,
OrigPath = employee.Node,
ReparentedValue = employee.Node.GetReparentedValue(new HierarchyId("/1/"), HierarchyId.GetRoot()),
Level = employee.Node.GetLevel()
}).ToList();
foreach (var item in items)
{
Console.WriteLine("Id:{0}; OrigPath:{1}; ReparentedValue:{2}; Level:{3}", item.Id, item.OrigPath, item.ReparentedValue, item.Level);
} SELECT
[Extent1].[Id] AS [Id],
[Extent1].[Node] AS [Node],
[Extent1].[Node].GetReparentedValue(cast('/1/' as hierarchyid), hierarchyid::GetRoot()) AS [C1],
[Extent1].[Node].GetLevel() AS [C2]
FROM [dbo].[Employees] AS [Extent1]
WHERE ([Extent1].[Node].IsDescendantOf(cast('/1/' as hierarchyid))) = 1
Id:2; OrigPath:/1/; ReparentedValue:/; Level:1
Id:4; OrigPath:/1/1/; ReparentedValue:/1/; Level:2
Id:5; OrigPath:/1/1/1/; ReparentedValue:/1/1/; Level:3
Id:7; OrigPath:/1/2/; ReparentedValue:/2/; Level:2