WebApi2 - UrlEncoded uri作为uri段/控制器操作参数

WebApi2 中使用 UrlEncoded URI 作为 URI 段/控制器操作参数

基础概念

在 ASP.NET Web API 2 中，URL 编码的 URI 作为路由参数传递时，可能会遇到解析和处理的问题。这是因为 URL 编码的字符串包含特殊字符（如 %、/、?、& 等），这些字符在路由系统中具有特殊含义。

问题原因

当 URL 编码的字符串作为路由参数传递时，主要会遇到以下问题：

路由解析冲突：编码后的字符串可能包含斜杠(/)或问号(?)，这些字符会被路由系统解释为路径分隔符或查询字符串起始符
双重编码问题：客户端可能已经对参数进行了编码，服务器端再次解码可能导致数据损坏
长度限制：URL 编码会增加字符串长度，可能超过 URL 长度限制

解决方案

1. 使用 Base64 编码替代 URL 编码

// 客户端编码
string originalUri = "http://example.com/path?param=value";
string encoded = Convert.ToBase64String(Encoding.UTF8.GetBytes(originalUri));

// 服务器端解码
[HttpGet]
[Route("api/process/{encodedUri}")]
public IHttpActionResult ProcessUri(string encodedUri)
{
    string decodedUri = Encoding.UTF8.GetString(Convert.FromBase64String(encodedUri));
    // 处理解码后的URI
    return Ok(decodedUri);
}

2. 使用查询字符串参数而非路由参数

// 客户端请求
// GET /api/process?uri=http%3A%2F%2Fexample.com%2Fpath%3Fparam%3Dvalue

// 服务器端
[HttpGet]
[Route("api/process")]
public IHttpActionResult ProcessUri([FromUri] string uri)
{
    // 自动解码的uri参数
    return Ok(uri);
}

3. 自定义路由约束

public class EncodedUriRouteConstraint : IHttpRouteConstraint
{
    public bool Match(HttpRequestMessage request, IHttpRoute route, string parameterName, 
        IDictionary<string, object> values, HttpRouteDirection routeDirection)
    {
        if (values.TryGetValue(parameterName, out object value) && value != null)
        {
            return true; // 或者添加更复杂的验证逻辑
        }
        return false;
    }
}

// 注册路由
config.Routes.MapHttpRoute(
    name: "EncodedUriApi",
    routeTemplate: "api/{controller}/{action}/{*encodedUri}",
    defaults: null,
    constraints: new { encodedUri = new EncodedUriRouteConstraint() }
);

4. 使用 POST 方法传递 URI

// 客户端
POST /api/process
Content-Type: application/json
{
    "uri": "http://example.com/path?param=value"
}

// 服务器端
[HttpPost]
[Route("api/process")]
public IHttpActionResult ProcessUri([FromBody] UriModel model)
{
    return Ok(model.Uri);
}

public class UriModel
{
    public string Uri { get; set; }
}