Подтвердить что ты не робот

Перенос пользовательского IRouter в ASP.NET 5 (vNext) MVC 6

Я пытаюсь преобразовать этот пример реализации RouteBase для работы с MVC 6. Я разработал большую часть из них, выполнив пример в проекте маршрутизации, но я получаю сообщение о том, как вернуть асинхронный Task из метода. Мне действительно все равно, действительно ли это асинхронно (приветствует любого, кто может предоставить этот ответ), пока я просто хочу, чтобы он работал.

У меня функционирует исходящий маршрут (значение ActionLink отлично работает, когда я добавляю значения маршрута). Проблема заключается в методе RouteAsync.

public 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 that matches.
    var page = GetPageList()
        .Where(x => x.VirtualPath.Equals(requestPath))
        .FirstOrDefault();

    // If we got back a null value set, that means the URI did not match
    if (page != null)
    {
        var routeData = new RouteData();

        // This doesn't work
        //var routeData = new RouteData(context.RouteData);

        // This doesn't work
        //routeData.Routers.Add(this);

        // This doesn't work
        //routeData.Routers.Add(new MvcRouteHandler());

        // 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"] = "CustomPage";
        routeData.Values["action"] = "Details";

        // This will be the primary key of the database row.
        // It might be an integer or a GUID.
        routeData.Values["id"] = page.Id;

        context.RouteData = routeData;

        // When there is a match, the code executes to here
        context.IsHandled = true; 

        // This test works
        //await context.HttpContext.Response.WriteAsync("Hello there");

        // This doesn't work
        //return Task.FromResult(routeData);

        // This doesn't work
        //return Task.FromResult(context);
    }

    // This satisfies the return statement, but 
    // I'm not sure it is the right thing to return.
    return Task.FromResult(0);
}

Весь метод проходит до конца, когда есть совпадение. Но когда он выполняется, он не вызывает метод Details контроллера CustomPage, как и следовало ожидать. Я просто получаю пустую белую страницу в браузере.

Я добавил строку WriteAsync, как это было сделано в этот пост, и он пишет Hello there на пустую страницу, но я могу Не понимаю, почему MVC не вызывает мой контроллер (в предыдущих версиях это работало без сбоев). К сожалению, эта публикация охватывает каждую часть маршрутизации, за исключением того, как реализовать IRouter или INamedRouter.

Как я могу сделать функцию метода RouteAsync?

Выполнение полной реализации CustomRoute

using Microsoft.AspNet.Routing;
using Microsoft.Framework.Caching.Memory;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

public class PageInfo
{
    // VirtualPath should not have a leading slash
    // example: events/conventions/mycon
    public string VirtualPath { get; set; }
    public int Id { get; set; }
}

public interface ICustomRoute : IRouter
{ }


public class CustomRoute : ICustomRoute
{
    private readonly IMemoryCache cache;
    private object synclock = new object();

    public CustomRoute(IMemoryCache cache)
    {
        this.cache = cache;
    }

    public 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 that matches.
        var page = GetPageList()
            .Where(x => x.VirtualPath.Equals(requestPath))
            .FirstOrDefault();

        // If we got back a null value set, that means the URI did not match
        if (page != null)
        {
            var routeData = new 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"] = "CustomPage";
            routeData.Values["action"] = "Details";

            // This will be the primary key of the database row.
            // It might be an integer or a GUID.
            routeData.Values["id"] = page.Id;

            context.RouteData = routeData;
            context.IsHandled = true; 
        }

        return Task.FromResult(0);
    }

    public VirtualPathData GetVirtualPath(VirtualPathContext context)
    {
        VirtualPathData result = null;
        PageInfo page = null;

        // Get all of the pages from the cache.
        var pages = GetPageList();

        if (TryFindMatch(pages, context.Values, out page))
        {
            result = new VirtualPathData(this, page.VirtualPath);
            context.IsBound = true;
        }

        return result;
    }

    private bool TryFindMatch(IEnumerable<PageInfo> pages, IDictionary<string, object> values, out PageInfo page)
    {
        page = null;
        int id;
        object idObj;
        object controller;
        object action;

        if (!values.TryGetValue("id", out idObj))
        {
            return false;
        }

        id = Convert.ToInt32(idObj);
        values.TryGetValue("controller", out controller);
        values.TryGetValue("action", out action);

        // The logic here should be the inverse of the logic in 
        // GetRouteData(). 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("Details") && controller.Equals("CustomPage"))
        {
            page = pages
                .Where(x => x.Id.Equals(id))
                .FirstOrDefault();
            if (page != null)
            {
                return true;
            }
        }
        return false;
    }

    private IEnumerable<PageInfo> GetPageList()
    {
        string key = "__CustomPageList";
        IEnumerable<PageInfo> pages;

        // Only allow one thread to poplate the data
        if (!this.cache.TryGetValue(key, out pages))
        {
            lock (synclock)
            {
                if (!this.cache.TryGetValue(key, out pages))
                {
                    // TODO: Retrieve the list of PageInfo objects from the database here.
                    pages = new List<PageInfo>()
                    {
                        new PageInfo() { Id = 1, VirtualPath = "somecategory/somesubcategory/content1" },
                        new PageInfo() { Id = 2, VirtualPath = "somecategory/somesubcategory/content2" },
                        new PageInfo() { Id = 3, VirtualPath = "somecategory/somesubcategory/content3" }
                    };

                    this.cache.Set(key, pages,
                        new MemoryCacheEntryOptions()
                        {
                            Priority = CacheItemPriority.NeverRemove,
                            AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(15)
                        });
                }
            }
        }

        return pages;
    }
}

Регистрация CustomRoute DI

services.AddTransient<ICustomRoute, CustomRoute>();

Конфигурация маршрута MVC

// Add MVC to the request pipeline.
app.UseMvc(routes =>
{
    routes.Routes.Add(routes.ServiceProvider.GetService<ICustomRoute>());

    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?}");
});

В случае, если это важно, я использую Beta 5, DNX 4.5.1 и DNX Core 5.

Решение

Я создал общее решение, которое можно использовать для простого первичного ключа для URL-адреса 2-way mapping в этом ответе на основе информации, которую я узнал здесь. Контроллер, действие, поставщик данных и тип данных первичного ключа могут быть указаны при подключении к маршрутизатору MVC 6.

4b9b3361

Ответ 1

Как сказал @opiants, проблема в том, что вы ничего не делаете в своем методе RouteAsync.

Если ваше намерение состоит в том, чтобы вызвать метод действия контроллера, вы можете использовать следующий подход, чем маршруты MVC по умолчанию:

По умолчанию MVC использует TemplateRouteс внутренней мишенью IRouter. В RouteAsync TemplateRoute будет делегировать внутренний IRouter. Этот внутренний маршрутизатор устанавливается как MvcRouteHandlerпо умолчанию строитель расширения. В вашем случае начните с добавления IRouter в качестве вашей внутренней цели:

public class CustomRoute : ICustomRoute
{
    private readonly IMemoryCache cache;
    private readonly IRouter target;
    private object synclock = new object();

    public CustomRoute(IMemoryCache cache, IRouter target)
    {
        this.cache = cache;
        this.target = target;
    }

Затем обновите свой запуск, чтобы установить эту цель как MvcRouteHandler, которая уже была установлена ​​как routes.DefaultHandler:

app.UseMvc(routes =>
{
    routes.Routes.Add(
       new CustomRoute(routes.ServiceProvider.GetRequiredService<IMemoryCache>(), 
                       routes.DefaultHandler));

    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?}");
});

Наконец, обновите свой метод AsyncRoute, чтобы вызвать внутренний IRouter, который будет MvcRouteHandler. Вы можете использовать реализацию этого метода в TemplateRoute в качестве руководства. Я быстро использовал этот подход и изменил ваш метод следующим образом:

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 that matches.
    var page = GetPageList()
        .Where(x => x.VirtualPath.Equals(requestPath))
        .FirstOrDefault();

    // If we got back a null value set, that means the URI did not match
    if (page == null)
    {
        return;
    }


    //Invoke MVC controller/action
    var oldRouteData = context.RouteData;
    var newRouteData = new RouteData(oldRouteData);
    newRouteData.Routers.Add(this.target);

    // 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.
    newRouteData.Values["controller"] = "CustomPage";
    newRouteData.Values["action"] = "Details";

    // This will be the primary key of the database row.
    // It might be an integer or a GUID.
    newRouteData.Values["id"] = page.Id;

    try
    {
        context.RouteData = newRouteData;
        await this.target.RouteAsync(context);
    }
    finally
    {
        // Restore the original values to prevent polluting the route data.
        if (!context.IsHandled)
        {
            context.RouteData = oldRouteData;
        }
    }
}

Обновить RC2

Похоже, TemplateRoute больше не работает в RC2 aspnet Routing.

Я исследовал историю и был переименован в RouteBase в commit 36180ab как часть более крупного рефакторинга.

Ответ 2

Основная причина, почему это не работает, - это то, что вы ничего не делаете в методе RouteAsync. Другая причина заключается в том, что работа маршрутизации в MVC 6 очень отличается от того, как работала предыдущая маршрутизация MVC, поэтому вам, вероятно, лучше писать ее с нуля, используя source код в качестве ссылки, поскольку в настоящее время существует очень мало статей, посвященных MVC 6.

ИЗМЕНИТЬ: @Даниэль Ж.Г. ответ дает гораздо больше смысла, чем это, поэтому используйте, если это возможно. Это может подойти кому-то другому, поэтому я оставляю это здесь.

Здесь очень простая реализация IRouter с использованием beta7. Это должно работать, но вам, вероятно, придется заполнить пробелы. Вам нужно удалить page != null и заменить его на код ниже и заменить контроллеры и действия:

if (page == null)
{
    // Move to next router
    return;
}

// TODO: Replace with correct controller
var controllerType = typeof(HomeController);
// TODO: Replace with correct action
var action = nameof(HomeController.Index);

// This is used to locate the razor view
// Remove the trailing "Controller" string
context.RouteData.Values["Controller"] = controllerType.Name.Substring(0, controllerType.Name.Length - 10);

var actionInvoker = context.HttpContext.RequestServices.GetRequiredService<IActionInvokerFactory>();

var descriptor = new ControllerActionDescriptor
{
    Name = action,
    MethodInfo = controllerType.GetTypeInfo().DeclaredMethods.Single(m => m.Name == action),
    ControllerTypeInfo = controllerType.GetTypeInfo(),
    // Setup filters
    FilterDescriptors = new List<FilterDescriptor>(),
    // Setup DI properties
    BoundProperties = new List<ParameterDescriptor>(0),
    // Setup action arguments
    Parameters = new List<ParameterDescriptor>(0),
    // Setup route constraints
    RouteConstraints = new List<RouteDataActionConstraint>(0),
    // This router will work fine without these props set
    //ControllerName = "Home",
    //DisplayName = "Home",
};

var accessor = context.HttpContext.RequestServices.GetRequiredService<IActionContextAccessor>();

accessor.ActionContext = new ActionContext(context.HttpContext, context.RouteData, descriptor);

var actionInvokerFactory = context.HttpContext.RequestServices.GetRequiredService<IActionInvokerFactory>();
var invoker = actionInvokerFactory.CreateInvoker(accessor.ActionContext);

// Render the page
await invoker.InvokeAsync();

// Don't execute the next IRouter
context.IsHandled = true;

return;

Убедитесь, что вы добавили ссылку на пространство имен Microsoft.Framework.DependencyInjection, чтобы разрешить расширение GetRequiredService.

После этого зарегистрируйте IRouter, как показано ниже:

app.UseMvc(routes =>
{
    // Run before any default IRouter implementation
    // or use .Add to run after all the default IRouter implementations
    routes.Routes.Insert(0, routes.ServiceProvider.GetRequiredService<CustomRoute>());

    // .. more code here ...
});

Затем просто зарегистрируйте это в своей IOC,

services.AddSingleton<CustomRoute>();

Другим "чистым" подходом, вероятно, будет создание другой реализации IActionSelector.