ASP.NET MVC升級到ASP.NET Core MVC踩坑小結

寫在前面

ASP.NET Core是微軟新推出的支持跨平台、高性能、開源的開發框架，它的優勢不必多說，因為已經說得太多了。當然，現在依然有着數量龐大的系統運行於.NET Framework上，由於有大量的Break Changes，很多項目項目團隊也不敢貿然升級，其中的考量也不全部是技術原因，更多的可能還是業務推進因素。

小編自年前開始考慮升級一套電商系統，原先是基於.NET Framework 4.5的，打算直接升級到.NET Core 3.1，由於系統規模比較龐大，所以一旦開工就是一個漫長的工程，我的博客也在很長時間沒有再更新，有點對不起讀者了。

年前第一次重構時，由於低估這套系統的復雜性再加上有些冒進，步子邁得有點大，出現了很多問題，不得不重新開始。這一次重構先易后難，步步為營，難題統一在后面解決，到現在已經完成了全部工程的百分之八十，后面的也沒有太困難了，所以特地抽出時間小結一下。

詳細內容

類庫部分

類庫部分的遷移應該是最簡單的了，我是創建了一個新的類庫，然后把代碼copy過去，很少有地方需要修改，當然了有一些引用的第三方類庫需要特殊對待，如Automapper、Autofac、FluentValidation等，這些也很簡單，看看文檔就行。

.NET Framework中，會有一些常用的封裝庫，如Session、Cookie和HttpRuntime等，這些變化比較大，所以自己在Startup中啟用。

• Session：
• Startup.Configure:

  app.UseSession(new SessionOptions
  {
      Cookie = new CookieBuilder
      {
  
      },
      IdleTimeout = TimeSpan.FromSeconds(1),
      IOTimeout = Timeout.InfiniteTimeSpan
  });

• • • Startup.ConfigureServices:

      services.AddSession();

• 使用Session，可以通過HttpContext調用：

  HttpContext.Session.SetString("sessionId", sessionValue);
  HttpContext.Session.GetString("sessionId");
  context.Session.Remove("sessionId");

• Cookie：

• Response.Cookies.Append("User", "1", new CookieOptions()
   {
       Expires = DateTime.Now.AddMinutes(10)
   });
  Response.Cookies.Delete("User");

• HttpRuntime的使用，可以通過IMemoryCache替換，具體的使用方法可參考MSDN

• System.Drawing已經不存在了，我使用的是ZKWeb.System.Drawing，基本上類名、枚舉名沒變化，只是命名空間Drawing變成了DrawingCore
• 依賴注入部分全部遷移到Startup.ConfigureServices

Controller部分

順便說一下，靜態資源部分，如JS、CSS、Image、Font這些復制到wwwroot目錄上，另外app.UseStaticFiles();會在模板中出現。

1、獲取Controller及Action信息，可以通過RouteData.Values["controller"].ToString()，RouteData.Values["action"].ToString()

2、很多的信息都放到了Request.Header[“”]中，如果之前可以用過Request直接點出來的，但是現在點不出來了，可以嘗試使用這種方式，說不准會有意外驚喜。另外有一個相關的常量在這里出示一下，使用方式即Request.Header[HeaderNames.Authority]，當然Request.HttpMethod 改為了 Request.Method。

public static class HeaderNames
  {
    public static readonly string Accept;
    public static readonly string AcceptCharset;
    public static readonly string AcceptEncoding;
    public static readonly string AcceptLanguage;
    public static readonly string AcceptRanges;
    public static readonly string AccessControlAllowCredentials;
    public static readonly string AccessControlAllowHeaders;
    public static readonly string AccessControlAllowMethods;
    public static readonly string AccessControlAllowOrigin;
    public static readonly string AccessControlExposeHeaders;
    public static readonly string AccessControlMaxAge;
    public static readonly string AccessControlRequestHeaders;
    public static readonly string AccessControlRequestMethod;
    public static readonly string Age;
    public static readonly string Allow;
    public static readonly string Authority;
    public static readonly string Authorization;
    public static readonly string CacheControl;
    public static readonly string Connection;
    public static readonly string ContentDisposition;
    public static readonly string ContentEncoding;
    public static readonly string ContentLanguage;
    public static readonly string ContentLength;
    public static readonly string ContentLocation;
    public static readonly string ContentMD5;
    public static readonly string ContentRange;
    public static readonly string ContentSecurityPolicy;
    public static readonly string ContentSecurityPolicyReportOnly;
    public static readonly string ContentType;
    public static readonly string Cookie;
    public static readonly string CorrelationContext;
    public static readonly string Date;
    public static readonly string DNT;
    public static readonly string ETag;
    public static readonly string Expect;
    public static readonly string Expires;
    public static readonly string From;
    public static readonly string Host;
    public static readonly string IfMatch;
    public static readonly string IfModifiedSince;
    public static readonly string IfNoneMatch;
    public static readonly string IfRange;
    public static readonly string IfUnmodifiedSince;
    public static readonly string KeepAlive;
    public static readonly string LastModified;
    public static readonly string Location;
    public static readonly string MaxForwards;
    public static readonly string Method;
    public static readonly string Origin;
    public static readonly string Path;
    public static readonly string Pragma;
    public static readonly string ProxyAuthenticate;
    public static readonly string ProxyAuthorization;
    public static readonly string Range;
    public static readonly string Referer;
    public static readonly string RequestId;
    public static readonly string RetryAfter;
    public static readonly string Scheme;
    public static readonly string SecWebSocketAccept;
    public static readonly string SecWebSocketKey;
    public static readonly string SecWebSocketProtocol;
    public static readonly string SecWebSocketVersion;
    public static readonly string Server;
    public static readonly string SetCookie;
    public static readonly string Status;
    public static readonly string StrictTransportSecurity;
    public static readonly string TE;
    public static readonly string TraceParent;
    public static readonly string TraceState;
    public static readonly string Trailer;
    public static readonly string TransferEncoding;
    public static readonly string Translate;
    public static readonly string Upgrade;
    public static readonly string UpgradeInsecureRequests;
    public static readonly string UserAgent;
    public static readonly string Vary;
    public static readonly string Via;
    public static readonly string Warning;
    public static readonly string WebSocketSubProtocols;
    public static readonly string WWWAuthenticate;
    public static readonly string XFrameOptions;
  }

3、Request.IsAjaxRequest

這個已經不存在了，可以自行實現。

public static bool IsAjaxRequest(this HttpRequest request)
{
    if (request == null)
        throw new ArgumentNullException("request");

    if (request.Headers != null)
        return request.Headers["X-Requested-With"] == "XMLHttpRequest";
    return false;
}

4、Area注冊

之前的AreaRegistration已經不存在，如果需要設置Area，可以在每個Controller上設置[Area(“Admin”)]，路由處的注冊可以考慮如下方式

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(
        name: "default",
        pattern: "{controller=Home}/{action=Index}/{id?}");

    endpoints.MapControllerRoute(
            name: "areas",
            pattern: "{area:exists}/{controller=Home}/{action=Index}/{id?}"
        );
});

5、AbsoluteUri也已經不存在了，但是可以通過如下方式取代：

/// <summary>
/// Returns the combined components of the request URL in a fully un-escaped form (except for the QueryString)
/// suitable only for display. This format should not be used in HTTP headers or other HTTP operations.
/// </summary>
/// <param name="request">The request to assemble the uri pieces from.</param>
/// <returns>The combined components of the request URL in a fully un-escaped form (except for the QueryString)
/// suitable only for display.</returns>
public static string GetDisplayUrl(this HttpRequest request);

/// <summary>Returns the relative URI.</summary>
/// <param name="request">The request to assemble the uri pieces from.</param>
/// <returns>The path and query off of <paramref name="request" />.</returns>
public static string GetEncodedPathAndQuery(this HttpRequest request);

/// <summary>
/// Returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers
/// and other HTTP operations.
/// </summary>
/// <param name="request">The request to assemble the uri pieces from.</param>
/// <returns>The encoded string version of the URL from <paramref name="request" />.</returns>
public static string GetEncodedUrl(this HttpRequest request);

6、過濾器

之前繼承ActionFilterAttribute，現在實現IActionFilter，注冊方式為services.AddMvc(o=>o.Filters.Add(new XX()))，當然之前的很多過濾器或者Controller基類方法已經不存在了，如Controller OnAuthentication。

IResultFilter中的OnResultExecuting(ResultExecutingContext filterContext)需要通過filterContext.Controller as Controller來獲取默認的Controller。

最后有一個比較重要的類ActionDescriptor，ControllerDescriptor繼承自ActionDescriptor，這里可以通過類型轉換獲取相關信息。

之前有很多的FilterAttribute也可以通過中間件來取代。

7、Action上被去掉的Attribute，如[ValidateInput(false)]，[ChildActionOnly]

View部分

1、頁面基類型及擴展

之前我們創建頁面基類型，是通過繼承System.Web.Mvc.WebViewPage<TModel>來實現，現在我們可以通過RazorPage<TModel>來取代。

擴展HtmlHelper也換成了IHtmlHelper接口。HtmlString也替換了MvcHtmlString，更上層也以接口方式來取代IHtmlContent。

public static IHtmlContent XXX(this IHtmlHelper _html, string xxxxx)
{
    //your code
    return new HtmlString(html.ToString());
}

2、Ajax.BeginForm換成了<form asp-controller="DistributorGrade" asp-action="Save" id="addform" data-ajax="true" data-ajax-method="post" data-ajax-begin="begin" data-ajax-success="success">。當前.NET Core 依然支持Html.BeginForm，不過我建議大家有時間的時候都替換一下，具體請參考下一條。

3、第2條出現的asp-action等是通過Razor Tag Helpers來實現的，很多的自定義需要加入到_ViewImports.cshtml，當然一些引用也可以統一放到這里，如@using Microsoft.AspNetCore.Routing，這樣就可以在當前的Area中作為全局引用了。

Razor Tag Help是一個十分重要的功能，它使得.NET Core MVC的開發更像是在寫Html語言，更加的清晰，更加具有生產力。

如@Html.TextBoxFor()可以用通過<input asp-for=””/>替換，以下圖片摘自MSDN：

Framework MVC的寫法

Core MVC的寫法

一些Tag Help集錦：

Built-in ASP.NET Core Tag Helpers

Anchor Tag Helper

Cache Tag Helper

Component Tag Helper

Distributed Cache Tag Helper

Environment Tag Helper

Form Tag Helper

Form Action Tag Helper

Image Tag Helper

Input Tag Helper

Label Tag Helper

Link Tag Helper

Partial Tag Helper

Script Tag Helper

Select Tag Helper

Textarea Tag Helper

Validation Message Tag Helper

Validation Summary Tag Helper

4、@Html.Action和@Html.RenderAction可以通過ViewComponents來取代

public class XXXXViewComponent : ViewComponent
{
    public IViewComponentResult Invoke()
    {
        return this.View("");
    }
}

調用方式是await Component.InvokeAsync(“XXXXViewComponent“)，詳情請點擊鏈接

5、@MvcHtmlString.Create()可以使用new Microsoft.AspNetCore.Html.HtmlString()取代

6、IP地址可以通過HttpRequest.HttpContext.Connection.RemoteIpAddress獲取

7、之前通過@helper 定義頁面的函數，這個已經被去掉了，現在可以通過@functions來取代

小結

限於篇幅，先總結這么多，系統尚未完全結束，不過升級到.NET Core是一個非常棒的過程，可以更好地體驗.NET Core的強大。如果小伙伴在升級過程中也遇到了很多問題，希望這篇文章可以給大家一些幫助，另外我沒有寫到的，大家可以留個言，我統一收集一下。