ASP.NET Core中如何使用表達式樹創建URL詳解

這篇文章主要給大家介紹了關於ASP.NET Core中如何使用表達式樹創建URL的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨着小編來一起學習學習吧

表達式樹（Expression Tree）

表達式樹是不可執行的代碼，它只是用於表示一種樹狀的數據結構，樹上的每一個節點都表示爲某種表達式類型，大概有25種表達式類型，它們都派生自Expression類。創建表達式樹具體有兩個優勢：

1.對表達式樹的代碼進行編輯修改，使表達式樹中的代碼變成動態代碼，根據不同的數據庫修改樹上的代碼邏輯從而達到動態切換數據庫查詢語句的目的，用表達式樹可以動態構建針對不同數據庫的查詢語句。

2.完成類似反射訪問未知對象的屬性，通過動態構造表達式樹，生成委託。

當我們在ASP.NET Core中生成一個action的url會這樣寫：

var url=_urlHelper.Action("Index", "Home");

這樣的寫法存在的問題在於我們傳遞了兩個字符串類型的參數，而我們又無法避免對action和controller做重命名操作, 例如將index重命名爲default, 你無法通過IDE在重命名action的過程中，將

_urlHelper.Action("Index", "Home");

重構爲

UrlHelper.Action("Default", "Home");

所以我們的目標是：設計出具有靜態檢查的API，讓IDE提示出這個錯誤來，甚至是重命名時直接把相關代碼都能重命名。

目標

設計出類似兩組API:

var url = _urlHelper.Action((HomeController c) => c.Index());
//期待輸出 /home/index
var link = _urlHelper.Link((ProductController c) => c.Details(10));
//期待輸出 http://locahost/product/details/10

設計API

根據上面的需求，定義兩組API:

public static string Action<TController>(this IUrlHelper helper, 
Expression<Action<TController>> action)
where TController : Controller
{
 //實現
}

public static string Link<TController>(this IUrlHelper helper, 
Expression<Action<TController>> action,
string protocal = null, string host = null)
where TController : Controller
{
 //實現
}

實現API

我們實際上最終還是要依賴ASP.NET Core提供的API：

var link = helper.Action(action: actionName, controller: 
controllerName, values: routes);

所以問題變成了如何根據(HomeController c) => c.Index()這樣的表達式來解析出actionName, ControllerName以及routeValues。

1. 解析ControllerName

解析ControllerName比較簡單粗暴，因爲我們已經從表達式樹中得到了HomeController這個類型，直接取 Home 字符串即可：

private static string GetControllerName(Type controllerType)
{
 var controllerName = controllerType.Name.EndsWith("Controller")
 ? controllerType.Name.Substring(0,
 controllerType.Name.Length - "Controller".Length)
 : controllerType.Name;
 return controllerName;
}

2. 解析ActionName

由於表達式 (HomeController c) => c.Index() 是一個 MethodCallExpression 類型，而Action的名字就是方法名：

private static MethodCallExpression
GetMethodCallExpression<TController>(
Expression<Action<TController>> actionSelector)
{
 var call = actionSelector.Body as MethodCallExpression;
 if (call == null)
 {
 throw new ArgumentException("You must call a method on " +
 typeof(TController).Name, "actionSelector");
 }
 
 return call;
}

var methodCallExpression = GetMethodCallExpression(action);
var actionName = methodCallExpression.Method.Name;

3. 解析RouteValues

上面兩步已經解析出了ControllerName和ActionName，也就是說通過上面的分析已經能完成下面的調用：

var action = helper.Action(action: "index", controller: "home", values: null);
//等價於
var url = _urlHelper.Action((HomeController c) => c.Index());
//輸出 /home/index

但是考慮下面的Action：

[HttpGet,Route("product/{id}")]
public IActionResult Details(int id)
{
 //...
}

這個Action期待傳入一個int類型的id，也就是說你要通過這樣的方式來生成url:

var action = helper.Action(action: "details", controller: 
"product", values: new { id = 10 });

所以要想讓我們的API正常工作，還需要生成一個object類型：new { id = 10 } 。而這個object類型裏面的屬性正好可以來自於表達式樹的方法調用參數：

var action = _urlHelper.Action((ProductController c) => c.Details(10));

要想生成這個匿名對象，需要遍歷方法調用表達式的所有參數，分別解析出屬性名，例如id; 以及值，例如10。最後再把解析出來的參數字典生成爲dynamic類型的對象：

如何解析表達式樹請查看expression-trees 。

public class RouteValueExtractor
{
 public static object GetRouteValues(MethodCallExpression call)
 {
 var routes = new Dictionary<string, object>();

 var parameters = call.Method.GetParameters();
 var pairs = call.Arguments.Select((a, i) => new
 {
  Argument = a,
  ParamName = parameters[i].Name
 });
 foreach (var item in pairs)
 {
  string name = item.ParamName;
  object value = GetValue(item.Argument);
  if (value != null)
  {
  var valueType = value.GetType();
  if (valueType.IsValueType)
  {
   routes.Add(name, value);
  }
  else
  {
   throw new NotSupportedException("Unsupported parameter type {0}");
  }

  }
 }

 return DictionaryToObject(routes);
 }

 private static object GetValue(Expression expression)
 {
 if (expression.NodeType == ExpressionType.Constant)
 {
  return ((ConstantExpression) expression).Value;
 }

 throw new NotSupportedException("Unsupported parameter expression");
 }

 private static dynamic DictionaryToObject(IDictionary<string, object> dictionary)
 {
 var expandoObj = new ExpandoObject();
 var expandoObjCollection = (ICollection<KeyValuePair<string, object>>) expandoObj;

 foreach (var keyValuePair in dictionary)
 {
  expandoObjCollection.Add(keyValuePair);
 }

 dynamic eoDynamic = expandoObj;
 return eoDynamic;
 }
}

一個完整的API實現：

public static string Action<TController>(this IUrlHelper helper, 
Expression<Action<TController>> action)
where TController : Controller
{
 var controllerName = GetControllerName(typeof(TController));
 var methodCallExpression = GetMethodCallExpression(action);
 var actionName = methodCallExpression.Method.Name;

 var routes = RouteValueExtractor.GetRouteValues(methodCallExpression);

 var link = helper.Action(action: actionName, controller: 
 controllerName, values: routes);

 return link;
}

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對神馬文庫的支持。