اندازه‌ی قلم متن
تخمین مدت زمان مطالعه‌ی مطلب:
چهار دقیقه
پیشتر مطلب «نحوه صحیح تولید Url در ASP.NET MVC» را در این سایت مطالعه کرده‌اید و خلاصه‌ی آن به این صورت است که اگر در جائی از برنامه‌ی خود، مسیر Home/Details/1 را به صورت دستی وارد کرده‌اید، با تغییر الگوی مسیریابی برنامه برای مثال به صورت "uni/{controller=Home}/{action=Index}/{id?}" در آینده، مسیر یاد شده دیگر معتبر و قابل دسترسی نبوده و نیاز خواهید داشت تمام مسیرهای دستی وارد شده‌ی اینگونه را در سراسر برنامه اصلاح کنید. به همین جهت در این مطلب روش جدید تولید خودکار URLها را در برنامه‌های ASP.NET Core بررسی می‌کنیم.
تولید URLهای منتهی به اکشن متدها در کنترلرها
هنوز هم در اکشن متدهای ASP.NET Core می‌توان از متد Url.Action برای تولید لینکی به سایر اکشن متدهای کنترلرهای دیگر استفاده کرد. البته اینبار مقادیر مسیریابی آن به عنوان پارامتر سوم باید وارد شوند و همچنین می‌توان بر اساس Scheme جاری، به صورت خودکار http و یا https را در ابتدای URL درج کرد (البته ذکر Scheme سبب تولید URLهای مطلق می‌شود؛ اگر نیاز به مسیرهای نسبی است، آن‌را ذکر نکنید):
اما اگر در اکشن متدهای کنترلرها قرار نداشتیم چطور؟
در هر قسمتی از برنامه که دسترسی به httpContext وجود دارد، می‌توان به سرویس IUrlHelper آن نیز دسترسی یافت (this.Url در یک اکشن متد، وهله‌ای از IUrlHelper است):
و پس از آن برای نمونه متد urlHelper.Action یاد شده (معادل this.Url.Action) در دسترس می‌باشد.
تولید URLهای منتهی به اکشن متدها در خارج از کنترلرها
فرض کنید می‌خواهید در متد Configure فایل آغازین برنامه، آدرس منتهی به یک اکشن متد خاصی را تولید کنید و یا در یک میان‌افزار که عملکرد آن باتوجه به محل قرارگیری آن، پیش از رخ‌دادن و اجرای میان‌افزار MVC است. در این حالت دیگر روش IUrlHelper یاد شده کار نمی‌کند؛ چون در این مکان‌ها دسترسی به Action Context میان‌افزار MVC وجود ندارد و هنوز این میان‌افزار اجرا نشده‌است.
برای رفع این مشکل، از زمان ASP.NET Core 2.2 به بعد، سرویس توکار جدیدی به نام LinkGenerator اضافه شده‌است که الزاما برای کار کردن، نیازی به Http Context و همچنین Action Context را ندارد. برای مثال اگر در متد void Configure(IApplicationBuilder app, IWebHostEnvironment env)، دسترسی به app وجود دارد، توسط آن می‌توان سرویس LinkGenerator را دریافت کرد و سپس با کمک متد GetPathByAction آن، مسیر منتهی به یک اکشن متد خاص را به صورت خودکار تولید کرد:
بدیهی است اگر در قسمتی از برنامه امکان تزریق وابستگی‌ها در سازنده‌ی کلاس مدنظر وجود داشته باشد، می‌توان LinkGenerator را به آن تزریق کرد (بدون نیاز به تنظیم خاصی) و از امکانات آن استفاده کرد. طول عمر LinkGenerator به صورت پیش‌فرض به Singleton تنظیم شده‌است. بنابراین می‌توان آن‌را به سازنده‌ی یک میان‌افزار نیز تزریق کرد (چون طول عمر میان‌افزاها نیز Singleton است):
و یا حتی روش ()<var linkGenerator = httpContext.RequestServices.GetService<LinkGenerator نیز در اینجا برای دسترسی به سرویس LinkGenerator کار می‌کند. به علاوه امکان تزریق مستقیم آن به Viewها و صفحات Razor نیز وجود دارد
یک نکته: متد GetUriByAction امکان دریافت HttpContext را نیز دارد:
مانند:
در این مثال accessor همان IHttpContextAccessor تزریق شده‌ی به یک سرویس خاص است. مزیت این روش، عدم نیاز به تکمیل سایر پارامترهای متد GetUriByAction است. اگر متد GetUriByAction را بدون HttpContext استفاده کنید، نیاز خواهید داشت تعداد پارامترهای بیشتری از آن‌را برای راهنمایی به آن تکمیل کنید:
تولید URLهای منتهی به اکشن متدها در کنترلرها
هنوز هم در اکشن متدهای ASP.NET Core می‌توان از متد Url.Action برای تولید لینکی به سایر اکشن متدهای کنترلرهای دیگر استفاده کرد. البته اینبار مقادیر مسیریابی آن به عنوان پارامتر سوم باید وارد شوند و همچنین می‌توان بر اساس Scheme جاری، به صورت خودکار http و یا https را در ابتدای URL درج کرد (البته ذکر Scheme سبب تولید URLهای مطلق می‌شود؛ اگر نیاز به مسیرهای نسبی است، آن‌را ذکر نکنید):
var url = this.Url.Action("About", "Home", new { id = 1 }, this.Request.Scheme); اما اگر در اکشن متدهای کنترلرها قرار نداشتیم چطور؟
در هر قسمتی از برنامه که دسترسی به httpContext وجود دارد، می‌توان به سرویس IUrlHelper آن نیز دسترسی یافت (this.Url در یک اکشن متد، وهله‌ای از IUrlHelper است):
var urlHelper = httpContext.RequestServices.GetRequiredService<IUrlHelper>()
تولید URLهای منتهی به اکشن متدها در خارج از کنترلرها
فرض کنید می‌خواهید در متد Configure فایل آغازین برنامه، آدرس منتهی به یک اکشن متد خاصی را تولید کنید و یا در یک میان‌افزار که عملکرد آن باتوجه به محل قرارگیری آن، پیش از رخ‌دادن و اجرای میان‌افزار MVC است. در این حالت دیگر روش IUrlHelper یاد شده کار نمی‌کند؛ چون در این مکان‌ها دسترسی به Action Context میان‌افزار MVC وجود ندارد و هنوز این میان‌افزار اجرا نشده‌است.
برای رفع این مشکل، از زمان ASP.NET Core 2.2 به بعد، سرویس توکار جدیدی به نام LinkGenerator اضافه شده‌است که الزاما برای کار کردن، نیازی به Http Context و همچنین Action Context را ندارد. برای مثال اگر در متد void Configure(IApplicationBuilder app, IWebHostEnvironment env)، دسترسی به app وجود دارد، توسط آن می‌توان سرویس LinkGenerator را دریافت کرد و سپس با کمک متد GetPathByAction آن، مسیر منتهی به یک اکشن متد خاص را به صورت خودکار تولید کرد:
var generator = app.ApplicationServices.GetRequiredService<LinkGenerator>();
var controllerName = nameof(HomeController).Replace("Controller", "");
var url = generator.GetPathByAction(nameof(HomeController.Index), controllerName) public class MyMiddleware
{
private readonly LinkGenerator _linkGenerator;
public MyMiddleware(RequestDelegate next, LinkGenerator linkGenerator)
{
_linkGenerator = linkGenerator;
}
public async Task Invoke(HttpContext httpContext)
{
var url = _linkGenerator.GenerateLink(new { controller = "Store", action = "ListProducts" });
httpContext.Response.ContentType = "text/plain";
return httpContext.Response.WriteAsync($"Go to {url} to see the list of products.");
}
} یک نکته: متد GetUriByAction امکان دریافت HttpContext را نیز دارد:
public static string GetPathByAction(this LinkGenerator generator, HttpContext httpContext, string action = null, string controller = null, object values = null, PathString? pathBase = null, FragmentString fragment = default, LinkOptions options = null);
var url = _linkGenerator.GetUriByAction(_accessor.HttpContext,
action: "GetContentByFileId",
values: new { FileId = 1 }
); public static string GetPathByAction(this LinkGenerator generator, string action, string controller, object values = null, PathString pathBase = default, FragmentString fragment = default, LinkOptions options = null);