Организация контроллеров WebApi в одной корневой папке и маршрутизация к ним - PullRequest
Новая
       22

Организация контроллеров WebApi в одной корневой папке и маршрутизация к ним

0 голосов
/ 09 сентября 2018

Фон

В большинстве MVC и WebApi приложений мы обычно видим следующую структуру: 

/Controllers
  HomeController.cs
/Models

Обычно это генерируется из шаблона MVC.

Затем будет сгенерировано отображение маршрута в Startup.cs: 

app.UseMvc(routes =>
{
    routes.MapRoute(
    name: "default",
    template: "{controller=Home}/{action=Index}/{id?}");
});

Добавлена ​​сложность

Наши веб-приложения действительно начинают усложняться, когда мы добавляем к нему другие части, такие как настраиваемые ActionResults, Фильтры и Области, среди прочего. Внезапно папка верхнего уровня может чувствовать себя немного загроможденной, даже если она организована хорошо.

Вопрос

Обычно, когда мы добавляем Area из коробки, создается новая папка верхнего уровня с именем Areas.

Я бы предпочел, чтобы в него была перемещена папка проекта со всеми функциями, связанными с контроллером, например папка api.

Например: 

/api
  /Home
    /Controllers
      HomeController.cs
    /Models
  /SomeArea1
    /Controllers
    /Models

Проблема в том, что теперь вам нужно изменить конфигурацию маршрута и включить в маршрут api - что я НЕ хочу. 

app.UseMvc(routes =>
{
    routes.MapRoute(
        name: "areaRoute",
        template: "{area:exists}/{controller=Home}/{action=Index}/{id?}");

    routes.MapRoute(
        name: "default",
        template: "{controller=Home}/{action=Index}/{id?}");
});

Возможно ли иметь указанную выше структуру папок в проекте и иметь маршрут к ней, как показано ниже? 

http://localhost/ maps to /api/Home 
http://localhost/customer maps to /api/Customer

Ответы [ 2 ]

0 голосов
/ 12 сентября 2018

Из раздела Мадс о маршрутах контроллера ( см. Здесь - настройка маршрутов )

NamespaceRoutingConvention.cs 

public class NamespaceRoutingConvention : IControllerModelConvention
{
    private readonly string _baseNamespace;

    public NamespaceRoutingConvention(string baseNamespace)
    {
        _baseNamespace = baseNamespace;
    }

    public void Apply(ControllerModel controller)
    {
        var hasRouteAttributes = controller.Selectors.Any(selector =>
            selector.AttributeRouteModel != null);
        if (hasRouteAttributes)
        {
            // This controller manually defined some routes, so treat this 
            // as an override and not apply the convention here.
            return;
        }

        // Use the namespace and controller name to infer a route for the controller.
        //
        // Example:
        //
        //  controller.ControllerTypeInfo ->    "My.Application.Admin.UsersController"
        //  baseNamespace ->                    "My.Application"
        //
        //  template =>                         "Admin/[controller]"
        //
        // This makes your routes roughly line up with the folder structure of your project.
        //
        if (controller.ControllerType.Namespace == null)
            return;

        var template = new StringBuilder(GetControllerNamespace(controller.ControllerType.Namespace));

        template.Replace('.', '/');
        template.Append("/[controller]");

        foreach (var selector in controller.Selectors)
        {
            selector.AttributeRouteModel = new AttributeRouteModel()
            {
                Template = template.ToString()
            };
        }
    }

    private string GetControllerNamespace(string controllerNamespace)
    {
        return controllerNamespace == _baseNamespace
            ? ""
            : controllerNamespace.Substring(
                _baseNamespace.Length + 1,
                controllerNamespace.Length -
                _baseNamespace.Length - 1);
    }
}

Startup.cs 

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options => 
        options.Conventions.Add(new NamespaceRoutingConvention("Enter the route namespace of the api folder")))
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
 }

Структура папок API

В папке API у меня теперь есть следующая структура: 

/api
  /Ploop
    HelloController.cs
  HelloController.cs
  TestController.cs

Пример кода контроллера

Таким образом, каждый код контроллера выглядит следующим образом: 

public class HelloController : ControllerBase
{
    [HttpGet]
    public JsonResult Index()
    {
        return new JsonResult(new
        {
            message = "hello from XXX controller"
        });
    }

    [HttpGet("{id?}")]
    public JsonResult Index(int? id)
    {
        return new JsonResult(new
        {
            message = "Hello from XXX controller with index",
            id
        });
    }
}

Вызов контроллеров

Поэтому, когда мы вызываем каждый контроллер, мы получаем следующие выходные данные в браузере:

апи / Ploop / HelloController.cs

http://localhost:51248/Ploop/Hello

{"message":"Hello from Ploop HelloController"}

http://localhost:51248/Ploop/Hello/12

{"message":"Hello from Ploop HelloController with index","id":12}

апи / HelloController.cs

http://localhost:51248/Hello

{"message":"Hello from root HelloController"}

http://localhost:51248/Hello/12

{"message":"Hello from root HelloController with index","id":12}

апи / TestController.cs

http://localhost:51248/Test

{"message":"Hello from TestController"}

http://localhost:51248/Test/12

{"message":"Hello from TestController with index","id":12}
0 голосов
/ 11 сентября 2018

Вы можете направить что-то вроде проделанного в коде ниже 

app.UseMvc(routes =>
{
   routes.MapRoute("blog", "blog/{*article}",
               defaults: new { controller = "Blog", action = "Article" });
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

Пожалуйста, проверьте документацию здесь

https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/routing?view=aspnetcore-2.1#route-names

...