Question

我有以下两个控制器：

OrderProvider(IOrderService service) {
}

所有这三个行动实际上都有三条不同的路线：

private IStockService _stockService; public IStockService StockService { get { return _stockService ?? (_stockService = new StockService()); } } Stock GetStock(string orderNumber) { return StockService.Get(orderNumber); }
[RoutePrefix("/some-resources") class CreationController : ApiController { [HttpPost, Route] public ... CreateResource(CreateData input) { // ... } } [RoutePrefix("/some-resources") class DisplayController : ApiController { [HttpGet, Route] public ... ListAllResources() { // ... } [HttpGet, Route("{publicKey:guid}"] public ... ShowSingleResource(Guid publicKey) { // ... } }
GET /some-resources

如果我将它们放入单个控制器中，一切正常，但如果我将它们分开（如上所示），WebApi将引发异常：

找到了与URL匹配的多种控制器类型。这个可以如果多个控制器上的属性路由匹配请求，则会发生 URL。

这条消息非常明显。在寻找适合控制器/操作的候选者时，WebApi似乎没有考虑HTTP方法。

我怎样才能达到预期的行为？

更新：我已经在Web API内部挖掘了一些内容，我理解它的默认工作方式。我的目标是分离代码和逻辑 - 在现实世界中，这些控制器具有不同的依赖关系并且更复杂一些。为了维护，可测试性，项目组织等，他们应该是不同的对象（SOLID和东西）。

我认为我可以覆盖一些WebAPI服务（POST /some-resources等）但是这对于这个简单而且 - 正如我所假设的 - 通常情况似乎是一种有点风险和非标准的方法。

Answer 1

<强>更新

根据您的评论，更新的问题和此处提供的答案

Multiple Controller Types with same Route prefix ASP.NET Web Api

可以通过应用于控制器操作的HTTP方法的自定义路由约束来实现所需的结果。

在检查默认的Http {动词}属性，即[HttpGet]，[HttpPost]和RouteAttribute，顺便说一下，我意识到他们的功能可以组合成一个类与它们在Asp.Net-Core中的实现方式类似。

以下是GET和POST，但要为控制器应用其他HTTP方法PUT, DELETE...etc创建约束并不困难。

class HttpGetAttribute : MethodConstraintedRouteAttribute {
    public HttpGetAttribute(string template) : base(template, HttpMethod.Get) { }
}

class HttpPostAttribute : MethodConstraintedRouteAttribute {
    public HttpPostAttribute(string template) : base(template, HttpMethod.Post) { }
}

重要的类是路由工厂和约束本身。该框架已经有基类来处理大部分路由工厂工作，还有一个HttpMethodConstraint所以只需要应用所需的路由功能。

class MethodConstraintedRouteAttribute 
    : RouteFactoryAttribute, IActionHttpMethodProvider, IHttpRouteInfoProvider {
    public MethodConstraintedRouteAttribute(string template, HttpMethod method)
        : base(template) {
        HttpMethods = new Collection<HttpMethod>(){
            method
        };
    }

    public Collection<HttpMethod> HttpMethods { get; private set; }

    public override IDictionary<string, object> Constraints {
        get {
            var constraints = new HttpRouteValueDictionary();
            constraints.Add("method", new HttpMethodConstraint(HttpMethods.ToArray()));
            return constraints;
        }
    }
}

因此，给定以下控制器应用自定义路径约束...

[RoutePrefix("api/some-resources")]
public class CreationController : ApiController {
    [HttpPost("")]
    public IHttpActionResult CreateResource(CreateData input) {
        return Ok();
    }
}

[RoutePrefix("api/some-resources")]
public class DisplayController : ApiController {
    [HttpGet("")]
    public IHttpActionResult ListAllResources() {
        return Ok();
    }

    [HttpGet("{publicKey:guid}")]
    public IHttpActionResult ShowSingleResource(Guid publicKey) {
        return Ok();
    }
}

内存单元测试是否确认功能并且有效。

[TestClass]
public class WebApiRouteTests {
    [TestMethod]
    public async Task Multiple_controllers_with_same_URL_routes_but_different_HTTP_methods() {
        var config = new HttpConfiguration();
        config.MapHttpAttributeRoutes();
        var errorHandler = config.Services.GetExceptionHandler();

        var handlerMock = new Mock<IExceptionHandler>();
        handlerMock
            .Setup(m => m.HandleAsync(It.IsAny<ExceptionHandlerContext>(), It.IsAny<System.Threading.CancellationToken>()))
            .Callback<ExceptionHandlerContext, CancellationToken>((context, token) => {
                var innerException = context.ExceptionContext.Exception;

                Assert.Fail(innerException.Message);
            });
        config.Services.Replace(typeof(IExceptionHandler), handlerMock.Object);


        using (var server = new HttpTestServer(config)) {
            string url = "http://localhost/api/some-resources/";

            var client = server.CreateClient();
            client.BaseAddress = new Uri(url);

            using (var response = await client.GetAsync("")) {
                Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
            }

            using (var response = await client.GetAsync("3D6BDC0A-B539-4EBF-83AD-2FF5E958AFC3")) {
                Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
            }

            using (var response = await client.PostAsJsonAsync("", new CreateData())) {
                Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
            }
        }
    }

    public class CreateData { }
}

原始回答

参考：Routing and Action Selection in ASP.NET Web API

那是因为它使用路由表中的路由首先找到控制器，然后检查Http {Verb}以选择一个动作。这就是为什么它们都在同一个控制器中的原因。如果找到与两个不同控制器相同的路由，则不知道何时选择一个，因此错误。

如果目标是简单的代码组织，那么就利用部分类

ResourcesController.cs

[RoutePrefix("/some-resources")]
partial class ResourcesController : ApiController { }

ResourcesController_Creation.cs

partial class ResourcesController {
    [HttpPost, Route]
    public ... CreateResource(CreateData input) {
        // ...
    }
}

ResourcesController_Display.cs

partial class ResourcesController {
    [HttpGet, Route]
    public ... ListAllResources() {
        // ...
    }

    [HttpGet, Route("{publicKey:guid}"]
    public ... ShowSingleResource(Guid publicKey) {
        // ...
    }
}

多个控制器具有相同的URL路由但不同的HTTP方法

1 个答案: