WCF Rest 4.0 中不带尾部斜杠的简单 URL 路由

Question

我有一个基于 WCF REST 服务模板 40(CS) 的 WCF REST 4.0 项目。我想公开简单的服务端点 URL，没有尾部斜杠。例如：

1. CarService.cs
   • http://www.domain.com/cars - GET 返回所有汽车的列表
   • http://www.domain.com/cars/123 - GET 返回一辆 ID 为 123 的汽车< /里>
2. http://www.domain.com/cars/123">http://www.domain.com/cars/123 - GET 返回 ID 为 123 TruckService.cs 的
   • http://www.domain.com/trucks - GET 返回所有卡车的列表
   • http://www.domain.com/trucks/456 - GET 返回一辆 ID 为 456 的卡车< /里>

我将上述 URL 视为资源请求（不是目录），这就是为什么我认为尾随斜杠在这里不合适。

不幸的是，我似乎无法获得我想要的行为，因为我总是被重定向到 /cars/ 和 /trucks/ 带有尾部斜杠。

以下是我定义“汽车”路线和服务方法的方式 - 请注意，我没有在任何路线或 URI 模板定义中包含任何斜杠：

// Global.asax.cs
RouteTable.Routes.Add(new ServiceRoute("cars", new WebServiceHostFactory(), typeof(CarService)));

// CarService.cs
[WebGet(UriTemplate = "")]
public List<Car> GetCollection()
{
    return DataContext.GetAllCars();
}

请注意，MVC 不能以这种方式工作。使用 MapRoute 方法，我可以将请求直接路由到 http://www.domain.com/about ，而无需重定向到 /about/ 。如何在 WCF REST 4.0 中获得相同的行为？

Answer 1

您遇到的主要问题是，当 WebGet 属性中的 UriTemplate 为空字符串时，当前版本的 WCF REST 会导致 307 重定向（到“/”）。据我所知，当前版本无法解决此问题。

但是，如果您想要一个解决方案，1) 允许您区分服务，2) 具有（相对）短的 URI，那么您的问题有几个“中间立场”解决方案。

第一个解决方案
您可以将其放入您的 global.asax 文件中（根据 此示例）。您可以为每项服务制定一条服务路线：

RouteTable.Routes.Add(new ServiceRoute("cars", new WebServiceHostFactory(), typeof(CarService)));
RouteTable.Routes.Add(new ServiceRoute("trucks", new WebServiceHostFactory(), typeof(TruckService)));

此时，您可以在每项服务中填充您的 UriTemplate：

[WebGet(UriTemplate = "all")]
CarPool GetAllCars();

[WebGet(UriTemplate = "{carName}")]
Car GetCar(string carName);

这将允许您使用以下 URI：

www.domain.com/cars/all
www.domain.com/cars/123 or www.domain.com/cars/honda

与卡车类似：

www.domain.com/trucks/all
www.domain.com/trucks/123 or www.domain.com/trucks/ford

第二个解决方案
使用 REST 入门工具包 中的服务主机（即 WebServiceHost2Factory）。

RouteTable.Routes.Add(new ServiceRoute("cars", new WebServiceHost2Factory(), typeof(CarService)));

当您使用上面尝试使用的 URI 时，这不会导致 307 重定向，因此可以准确满足您的需要。尽管我意识到使用该服务主机工厂而不是 WCF 4 附带的服务主机工厂感觉有点奇怪。

Answer 2

你需要一个 UriTemplate，尝试这样的事情：

 [ServiceContract()]
 public interface ICarService
 {

     [OperationContract]
     [WebGet(UriTemplate = "/Car")]
     CarPool GetAllCars();

     [OperationContract]
     [WebGet(UriTemplate = "/Car/{carName}")]
     Car GetCar(string carName);

 }

Answer 3

尝试将其放入 Global.asax.cs

    protected void Application_BeginRequest(object sender, EventArgs e)
    {
        string rawUrl = HttpContext.Current.Request.RawUrl.ToLower();

        if (rawUrl.EndsWith("/cars"))
        {
            HttpContext.Current.RewritePath(rawUrl + "/");  // append trailing slash
        }
    }

Answer 4

我正在处理这个确切的问题，并在 MS 在线文档中遇到了这个片段：

默认情况下，路由不处理映射到 Web 服务器上现有物理文件的请求。例如，请求 http://server/application/Products/Beverages/Coffee.aspx。即使请求与定义的模式匹配，例如 {controller}/{action}/{id}，路由也不会处理该请求。

我意识到我的路由模式与我的服务所在的目录相匹配。看起来目录被视为与物理文件相同，并且与目录匹配的路由模式也被忽略。因此，按照文档，我将 RouteCollection 上的 RouteExistingFiles 属性设置为“true”。我的服务现在似乎可以正确路由请求，并且我已经能够保留我非常喜欢的 REST 语法。

Answer 5

较旧的问题，但这是我如何使用 WCF4 REST 服务解决问题（使用 Global.asax 中的 RouteTable 添加 ServiceRoutes）。配置 IIS7 以便在调用服务时我有一个空的相对路径，因此处理方法的 UriTemplate 是空的，就像 Will 的 Car 示例一样。如果需要，我在服务的 web.config 文件中使用重写规则添加“/”。它始终与路径匹配，然后检查原始 URI ({REQUEST_URI}) 以查看它是否包含不带尾部“/”的路径。

    <rewrite>
        <rules>
            <!--
            This rule will append a "/" after "/car" if
            the client makes a request without a trailing "/".
            ASP however must have a trailing "/" to find
            the right handler.
            -->
            <rule name="FixCarPath" stopProcessing="true">
                <match url=".*" />
                <conditions>
                    <add input="{REQUEST_URI}" pattern="/car\?" />
                </conditions>
                <action type="Rewrite" url="{PATH_INFO}/" />
            </rule>
        </rules>
    </rewrite>

Answer 6

更具可重用性：

public class Global : NinjectHttpApplication
{

    protected override void OnApplicationStarted()
    {
        base.OnApplicationStarted();
        RegisterRoutes();
    }

    private void RegisterRoutes()
    {
        RouteTable.Routes.Add(new ServiceRoute("login", new NinjectWebServiceHostFactory(), typeof(LoginService)));
        RouteTable.Routes.Add(new ServiceRoute("incidents", new NinjectWebServiceHostFactory(), typeof(IncidentService)));
        SetRoutePrefixes();
    }
    //This is a workaround for WCF forcing you to end with "/" if you dont have a urlTemplate and redirecting if you dont have
    protected void Application_BeginRequest(object sender, EventArgs e)
    {
        string rawUrl = HttpContext.Current.Request.RawUrl.ToLower();


        if (_routePrefixes.Any(rawUrl.EndsWith))
        {
            HttpContext.Current.RewritePath(rawUrl + "/");  // append trailing slash
        }
    }


    private static List<string> _routePrefixes; 
    private static void SetRoutePrefixes()
    {
        _routePrefixes = new List<string>();
        foreach (var route in RouteTable.Routes)
        {
            var r = route as Route;
            var routePrefix = r.Url.Split('/').First();
            _routePrefixes.Add(routePrefix);
        }
    }

Answer 7

尝试将 Global.asax 中的代码从...

Routes.Add(new ServiceRoute("cars", new WebServiceHostFactory(), typeof(CarService)));
RouteTable.Routes.Add(new ServiceRoute("trucks", new WebServiceHostFactory(), typeof(TruckService)));

...到...

WebServiceHostFactory factory = new WebServiceHostFactory();

Routes.Add(new ServiceRoute("cars",factory, typeof(CarService)));
RouteTable.Routes.Add(new ServiceRoute("trucks",factory, typeof(TruckService)));