ASP.NET Core 基于控制器、Action与[FromQuery]对象生成URL的实现
问题解答
内置实现方案(优先推荐)
ASP.NET Core 框架本身已经提供了完全符合模型绑定规则的URL生成内置能力,无需手动实现底层逻辑。
场景1:在Controller/View中使用
你可以直接使用Controller基类自带的IUrlHelper实例(也就是Url属性)直接生成目标URL:
// 在MyController内部调用 var url = Url.Action("Get", "My", new MyQueryObject{ Param1 = "Something"}); // 输出格式:/My/Get?Param1=Something
注意:默认路由约定下控制器名称需要去掉
Controller后缀,比如MyController对应的控制器名参数传My即可。
场景2:在服务层/脱离Controller上下文使用
.NET Core 2.2及以上版本提供了LinkGenerator服务,可以在任意业务层注入使用,你的GetUrl方法可以封装为如下实现:
using Microsoft.AspNetCore.Routing; public class UrlGeneratorService { private readonly LinkGenerator _linkGenerator; // 构造函数注入LinkGenerator public UrlGeneratorService(LinkGenerator linkGenerator) { _linkGenerator = linkGenerator; } public string GetUrl(string controllerName, string actionName, object queryParamsObject) { // 自动根据路由规则和参数对象生成符合绑定要求的URL var processedControllerName = controllerName.TrimEnd("Controller"); return _linkGenerator.GetPathByAction(actionName, processedControllerName, queryParamsObject); } }
内置实现会自动处理以下逻辑,完全对齐ASP.NET Core模型绑定规则:
- 自动过滤值为null的属性,不会出现在查询字符串中
- 自动处理
[FromQuery(Name = "自定义参数名")]的参数别名 - 自动支持嵌套对象、集合、枚举等复杂类型的查询参数拼接
- 自动对参数值进行URL编码
手动实现方案(不推荐,仅做原理说明)
如果需要自己实现核心逻辑,步骤如下:
- 裁剪控制器名后缀:按照默认约定去掉控制器名末尾的
Controller字符串 - 解析参数对象:
- 遍历参数对象的所有公共可读写属性
- 跳过值为null的属性
- 读取属性上
[FromQuery]的Name值作为查询参数key,没有则用属性名作为key - 将属性值转换为字符串,进行URL编码
- 拼接URL:
/{控制器名}/{Action名}?{key1}={value1}&{key2}={value2}...
简单实现示例:
using System.Reflection; using Microsoft.AspNetCore.Mvc; using System.Web; public string GetUrl(string controllerName, string actionName, object queryParamsObject) { // 处理控制器名后缀 var controller = controllerName.EndsWith("Controller") ? controllerName[..^"Controller".Length] : controllerName; var path = $"/{controller}/{actionName}"; if (queryParamsObject == null) return path; var queryParams = new List<string>(); // 遍历所有公共属性 foreach (var prop in queryParamsObject.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance)) { var value = prop.GetValue(queryParamsObject); if (value == null) continue; // 读取FromQuery的自定义名称 var fromQueryAttr = prop.GetCustomAttribute<FromQueryAttribute>(); var key = string.IsNullOrEmpty(fromQueryAttr?.Name) ? prop.Name : fromQueryAttr.Name; var encodedValue = HttpUtility.UrlEncode(value.ToString()); queryParams.Add($"{key}={encodedValue}"); } return queryParams.Any() ? $"{path}?{string.Join('&', queryParams)}" : path; }
注意:以上简单实现仅支持一级扁平对象,如需支持嵌套对象、集合等复杂类型,需要按照ASP.NET Core模型绑定的参数命名规则扩展逻辑。
内容的提问来源于stack exchange,提问作者Mátyás Székely
相关产品推荐
相关产品推荐

