起動後にMVC6のルートコレクションを変更する
MVC-5では、最初の起動後にRouteTable.Routesにアクセスして、routetableを編集できました。実行時にルートを追加/削除できるように、MVC-6でも同じことをしたいと思います（CMSに役立ちます）。
MVC-5でそれを行うためのコードは次のとおりです。
using (RouteTable.Routes.GetWriteLock())
{
RouteTable.Routes.Clear();
RouteTable.Routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
RouteTable.Routes.MapRoute(
name: "Default",
url: "{controller}/{action}/{id}",
defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);
}
しかし、MVC-6でRouteTable.Routesなどが見つかりません。実行時にルートコレクションを変更する方法はありますか？
この原則を使用して、たとえば、CMSでページが作成されたときにURLを追加したいと思います。
次のようなクラスがある場合：
public class Page
{
public int Id { get; set; }
public string Url { get; set; }
public string Html { get; set; }
}
そして次のようなコントローラー：
public class CmsController : Controller
{
public ActionResult Index(int id)
{
var page = DbContext.Pages.Single(p => p.Id == id);
return View("Layout", model: page.Html);
}
}
次に、ページがデータベースに追加されると、routecollectionを再作成します。
var routes = RouteTable.Routes;
using (routes.GetWriteLock())
{
routes.Clear();
foreach(var page in DbContext.Pages)
{
routes.MapRoute(
name: Guid.NewGuid().ToString(),
url: page.Url.TrimEnd('/'),
defaults: new { controller = "Cms", action = "Index", id = page.Id }
);
}
var defaultRoute = routes.MapRoute(
name: "Default",
url: "{controller}/{action}/{id}",
defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);
}
このようにして、規則や厳密なテンプレートに属さないページをCMSに追加できます。 URL /contactのページを追加できますが、URL /help/faq/how-does-this-workのページも追加できます。
答えは、これを行うための合理的な方法はなく、方法を見つけたとしても、それは良い習慣ではないということです。
問題への誤ったアプローチ
基本的に、過去のMVCバージョンのルート構成は、DI構成のように機能することを目的としていました。つまり、すべてを composition root に配置し、実行時にその構成を使用します。問題は、実行時に可能オブジェクトを構成にプッシュすることでした（そして多くの人がそうしました）。これは正しいアプローチではありません。
構成が真のDIコンテナーに置き換えられたため、このアプローチは機能しなくなります。登録手順は、アプリケーションの起動時にのみ実行できるようになりました。
正しいアプローチ
過去のMVCバージョンでRouteクラスが実行できたものをはるかに超えてルーティングをカスタマイズする正しいアプローチは、 RouteBase またはRouteを継承することでした。
AspNetCore（以前はMVC 6と呼ばれていました）にも同様の抽象化があり、 IRouter と INamedRouter が同じ役割を果たします。その前身と同じように、IRouterには実装するメソッドが2つだけあります。
namespace Microsoft.AspNet.Routing
{
public interface IRouter
{
// Derives a virtual path (URL) from a list of route values
VirtualPathData GetVirtualPath(VirtualPathContext context);
// Populates route data (including route values) based on the
// request
Task RouteAsync(RouteContext context);
}
}
このインターフェースは、ルーティングの双方向の性質を実装する場所です。つまり、URLから値をルーティングし、値をURLにルーティングします。
例： CachedRoute<TPrimaryKey>
これは、主キーからURLへの1-1マッピングを追跡してキャッシュする例です。これは汎用であり、主キーがintまたはGuidのどちらであるかをテストしました。
データベースのクエリを実装できるICachedRouteDataProviderを挿入する必要のあるプラグ可能な部分があります。また、コントローラーとアクションを指定する必要があるため、このルートは、複数のインスタンスを使用して複数のデータベースクエリを複数のアクションメソッドにマップするのに十分な汎用性があります。
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Caching.Memory;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
public class CachedRoute<TPrimaryKey> : IRouter
{
private readonly string _controller;
private readonly string _action;
private readonly ICachedRouteDataProvider<TPrimaryKey> _dataProvider;
private readonly IMemoryCache _cache;
private readonly IRouter _target;
private readonly string _cacheKey;
private object _lock = new object();
public CachedRoute(
string controller,
string action,
ICachedRouteDataProvider<TPrimaryKey> dataProvider,
IMemoryCache cache,
IRouter target)
{
if (string.IsNullOrWhiteSpace(controller))
throw new ArgumentNullException("controller");
if (string.IsNullOrWhiteSpace(action))
throw new ArgumentNullException("action");
if (dataProvider == null)
throw new ArgumentNullException("dataProvider");
if (cache == null)
throw new ArgumentNullException("cache");
if (target == null)
throw new ArgumentNullException("target");
_controller = controller;
_action = action;
_dataProvider = dataProvider;
_cache = cache;
_target = target;
// Set Defaults
CacheTimeoutInSeconds = 900;
_cacheKey = "__" + this.GetType().Name + "_GetPageList_" + _controller + "_" + _action;
}
public int CacheTimeoutInSeconds { get; set; }
public async Task RouteAsync(RouteContext context)
{
var requestPath = context.HttpContext.Request.Path.Value;
if (!string.IsNullOrEmpty(requestPath) && requestPath[0] == '/')
{
// Trim the leading slash
requestPath = requestPath.Substring(1);
}
// Get the page id that matches.
TPrimaryKey id;
//If this returns false, that means the URI did not match
if (!GetPageList().TryGetValue(requestPath, out id))
{
return;
}
//Invoke MVC controller/action
var routeData = context.RouteData;
// TODO: You might want to use the page object (from the database) to
// get both the controller and action, and possibly even an area.
// Alternatively, you could create a route for each table and hard-code
// this information.
routeData.Values["controller"] = _controller;
routeData.Values["action"] = _action;
// This will be the primary key of the database row.
// It might be an integer or a GUID.
routeData.Values["id"] = id;
await _target.RouteAsync(context);
}
public VirtualPathData GetVirtualPath(VirtualPathContext context)
{
VirtualPathData result = null;
string virtualPath;
if (TryFindMatch(GetPageList(), context.Values, out virtualPath))
{
result = new VirtualPathData(this, virtualPath);
}
return result;
}
private bool TryFindMatch(IDictionary<string, TPrimaryKey> pages, IDictionary<string, object> values, out string virtualPath)
{
virtualPath = string.Empty;
TPrimaryKey id;
object idObj;
object controller;
object action;
if (!values.TryGetValue("id", out idObj))
{
return false;
}
id = SafeConvert<TPrimaryKey>(idObj);
values.TryGetValue("controller", out controller);
values.TryGetValue("action", out action);
// The logic here should be the inverse of the logic in
// RouteAsync(). So, we match the same controller, action, and id.
// If we had additional route values there, we would take them all
// into consideration during this step.
if (action.Equals(_action) && controller.Equals(_controller))
{
// The 'OrDefault' case returns the default value of the type you're
// iterating over. For value types, it will be a new instance of that type.
// Since KeyValuePair<TKey, TValue> is a value type (i.e. a struct),
// the 'OrDefault' case will not result in a null-reference exception.
// Since TKey here is string, the .Key of that new instance will be null.
virtualPath = pages.FirstOrDefault(x => x.Value.Equals(id)).Key;
if (!string.IsNullOrEmpty(virtualPath))
{
return true;
}
}
return false;
}
private IDictionary<string, TPrimaryKey> GetPageList()
{
IDictionary<string, TPrimaryKey> pages;
if (!_cache.TryGetValue(_cacheKey, out pages))
{
// Only allow one thread to poplate the data
lock (_lock)
{
if (!_cache.TryGetValue(_cacheKey, out pages))
{
pages = _dataProvider.GetPageToIdMap();
_cache.Set(_cacheKey, pages,
new MemoryCacheEntryOptions()
{
Priority = CacheItemPriority.NeverRemove,
AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(this.CacheTimeoutInSeconds)
});
}
}
}
return pages;
}
private static T SafeConvert<T>(object obj)
{
if (typeof(T).Equals(typeof(Guid)))
{
if (obj.GetType() == typeof(string))
{
return (T)(object)new Guid(obj.ToString());
}
return (T)(object)Guid.Empty;
}
return (T)Convert.ChangeType(obj, typeof(T));
}
}
CmsCachedRouteDataProvider
これは、基本的にCMSで実行する必要があるデータプロバイダーの実装です。
public interface ICachedRouteDataProvider<TPrimaryKey>
{
IDictionary<string, TPrimaryKey> GetPageToIdMap();
}
public class CmsCachedRouteDataProvider : ICachedRouteDataProvider<int>
{
public IDictionary<string, int> GetPageToIdMap()
{
// Lookup the pages in DB
return (from page in DbContext.Pages
select new KeyValuePair<string, int>(
page.Url.TrimStart('/').TrimEnd('/'),
page.Id)
).ToDictionary(pair => pair.Key, pair => pair.Value);
}
}
使用法
ここでは、デフォルトルートの前にルートを追加し、そのオプションを構成します。
// Add MVC to the request pipeline.
app.UseMvc(routes =>
{
routes.Routes.Add(
new CachedRoute<int>(
controller: "Cms",
action: "Index",
dataProvider: new CmsCachedRouteDataProvider(),
cache: routes.ServiceProvider.GetService<IMemoryCache>(),
target: routes.DefaultHandler)
{
CacheTimeoutInSeconds = 900
});
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
// Uncomment the following line to add a route for porting Web API 2 controllers.
// routes.MapWebApiRoute("DefaultApi", "api/{controller}/{id?}");
});
それがその要点です。あなたはまだ物事を少し改善することができます。
たとえば、ファクトリパターンを個人的に使用して、リポジトリをCmsCachedRouteDataProviderのコンストラクタに挿入します。たとえば、どこでもDbContextをハードコーディングします。
簡単な方法の1つは、404エラーが発生した場合、次の条件を確認することです。
URLがルーティングリストに存在する場合は、それにリダイレクトします
サンプルの.netコアはStartup.cs（プロジェクトルート）に移動し、Configureメソッドでボトムコードを追加します。
public void Configure(IApplicationBuilder app, IWebHostEnvironment env){
app.UseStatusCodePages(async context =>
{
var redirctPage = pageToRedirect(context);
context.HttpContext.Response.Redirect(redirctPage);
}
...
}
private string pageToRedirect(StatusCodeContext context)
{
var def = "";
if(context.HttpContext.Response.StatusCode==404){
if (context.HttpContext.Request.Path.ToString().ToLower().Contains("/product/"))
{
def = "/Home/Product";
def += context.HttpContext.Request.QueryString;
}
else if (context.HttpContext.Request.Path.ToString().ToLower()=="/news")//or you can call class that load info from DB to redirect
{
def = "/Home/News";
def += context.HttpContext.Request.QueryString;
}
else//404 error page
def = "/Home/Error?statusCode=" + context.HttpContext.Response.StatusCode;
}else //other errors code
def = "/Home/Error?statusCode=" + context.HttpContext.Response.StatusCode;
return def;
}