WCF UriTemplate UrlEncode

时间:2013-04-23 13:19:45

标签: wcf rest urlencode uritemplate

想象一下,我想使用WCF调用外部(意味着我无法控制合同)REST服务。 我有以下合同

[ServiceContract]
public interface ISomeRestApi
{
    [OperationContract]
    [WebInvoke(Method = "PUT", UriTemplate = "blablabla/{parameter1}/{parameter2}")]
    void PutSomething(string parameter1, string parameter2);
}

假设我的一个参数是正斜杠(/)

public class Test{

    [Fact]
    public void TestPutSomething()
    {
        ISomeRestApi api = CreateApi();

        //this results in the url: http://server/blablabla///someotherparam
        api.PutSomething("/", "someotherparam");

        //this also results in the url: http://server/blablabla///someotherparam
        api.PutSomething(HttpUtility.UrlEncode("/"), "someotherparam");

        //but i want: http://server/blablabla/%2F/someotherparam
    }
}

如何强制WCF对我的UriTemplate路径参数进行UrlEncode?

1 个答案:

答案 0 :(得分:0)

经过大量的反复试验,我发现了一个非常丑陋且完全不合逻辑的解决方案。但仍然......也许这篇文章可以帮助将来的某个人。 请注意,这个“解决方案”适用于.NET 4.5。我不保证它对你有用。

问题归结为:

  • 在.NET中的Uri中放置一个转义正斜杠是不可能的(AFAIK)
  • 用于与外部服务(RabbitMQ)通信我真的需要能够在我的请求中放置%2f(即正斜杠)Url

以下帖子让我处于“正确”的方向:How to stop System.Uri un-escaping forward slash characters

我尝试了帖子中提出的解决方案,但是......无济于事

然后经过大量的诅咒,谷歌搜索,逆向工程等等,我想出了以下代码:

/// <summary>
/// Client enpoint behavior that enables the use of a escaped forward slash between 2 forward slashes in a url
/// </summary>
public class EncodeForwardSlashBehavior:IEndpointBehavior
{
    public void Validate(ServiceEndpoint endpoint)
    {

    }

    public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
    {

    }

    public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
    {

    }

    public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
    {
        clientRuntime.ClientMessageInspectors.Add(new ForwardSlashUrlInspector());
    }
}

/// <summary>
/// Inspector that modifies a an Url replacing /// with /%2f/
/// </summary>
public class ForwardSlashUrlInspector:IClientMessageInspector
{
    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
        string uriString = request.Headers.To.ToString().Replace("///", "/%2f/");
        request.Headers.To = new Uri(uriString);
        AddAllowAnyOtherHostFlagToHttpUriParser();

        return null;
    }

    /// <summary>
    /// This is one of the weirdest hacks I ever had to do, so no guarantees can be given to this working all possible scenarios
    /// What this does is, it adds the AllowAnyOtherHost flag to the private field m_Flag on the UriParser for the http scheme.
    /// Replacing /// with /%2f/ in the request.Headers.To uri BEFORE calling this method will make sure %2f remains unescaped in your Uri
    /// Why does this work, I don't know!
    /// </summary>
    private void AddAllowAnyOtherHostFlagToHttpUriParser()
    {
        var getSyntaxMethod =
            typeof(UriParser).GetMethod("GetSyntax", BindingFlags.Static | BindingFlags.NonPublic);
        if (getSyntaxMethod == null)
        {
            throw new MissingMethodException("UriParser", "GetSyntax");
        }
        var uriParser = getSyntaxMethod.Invoke(null, new object[] { "http" });

        var flagsField =
            uriParser.GetType().BaseType.GetField("m_Flags", BindingFlags.Instance|BindingFlags.NonPublic);
        if (flagsField == null)
        {
            throw new MissingFieldException("UriParser", "m_Flags");
        }
        int oldValue = (int)flagsField.GetValue(uriParser);
        oldValue += 4096;
        flagsField.SetValue(uriParser, oldValue);
    }


    public void AfterReceiveReply(ref Message reply, object correlationState)
    {

    }
}

所以基本上我正在创建一个自定义的EndpointBehavior,它使用反射向UriParser中的私有变量添加枚举标志。这显然可以防止我的请求中逃脱的正斜线.Headers.To uri from unescaped。