ASP.NET Core 實戰：將 .NET Core 2.0 項目升級到 .NET Core 2.1

一、前言最近一兩個星期，加班，然後回去後弄自己的博客，把自己的電腦從 Windows 10 改到 Ubuntu 18.10 又弄回 Windows 10，原本計劃的學習 Vue 中生命周期的相關知識目前也沒有任何的進展，嗯，罪過罪過。看了眼時間，11月也快要結束了，準備補上一篇如何將我們的 .NE ...

一、前言

　　最近一兩個星期，加班，然後回去後弄自己的博客，把自己的電腦從 Windows 10 改到 Ubuntu 18.10 又弄回 Windows 10，原本計劃的學習 Vue 中生命周期的相關知識目前也沒有任何的進展，嗯，罪過罪過。看了眼時間，11月也快要結束了，準備補上一篇如何將我們的 .NET Core 2.0 版本的程式升級到 .NET Core 2.1 版本，好歹也算多學了一點。

　　在上一篇的博客中（ASP.NET Core 實戰：Linux 小白的 .NET Core 部署之路），試著將我之前寫的 ASP.NET Core 2.0 的項目部署到 Linux 伺服器上，採用的是微軟官方推薦的 Nginx + Supervisor 的方式，評論區的小伙伴提出了使用 Docker 的方式可以更便捷的實現，同時對於新手來說也會更好上手。嗯，新手向的使用 Docker 部署 ASP.NET Core 項目也會在之後的文章中體現。歡迎多多關註啊。

二、起因

　　 .NET Core 2.1 發佈於今年的5月30號，從版本號我們可以看出這隻是一個小版本的升級，從微軟官方發佈的更新信息來看，對比於 .NET Core 2.0 版本，更多的是進行性能的優化、對於 .NET Core Runtime、.NET Core tools 的更改以及增加 API 或是增加更多的系統支持。

　　在上一篇的文章中，我們在 Linux 伺服器上構建我們的 .NET Core 運行環境時，安裝的是最新版本的 .NET Core Runtime，而部署的程式 .NET Core 版本則是 .NET Core 2.0（項目源碼地址：https://github.com/Lanesra712/Danvic.PSU），因為並沒有採取 Docker 部署的緣故，這裡程式與運行環境的版本差異，可能導致某些我們的程式產生某些我們並不能復現的問題，所以，升級我們的程式就顯得很有必要了。

　　PS：如果你要在實際的生產項目升級你的 .NET Core 版本，慎重，慎重，再慎重！！！

三、Step by Step

　　1、修改我們的項目目標框架

　　在更新 VS 2017 的過程中，我們的 .NET Core 版本也會進行更新，當然，如果你的電腦中沒有安裝 .NET Core 2.1 SDK，則需要你從官網上下載最新版的 SDK 進行安裝。當我們已經安裝好 .NET Core 2.1 SDK 後，就可以將我們原來程式的目標框架更改為 .NET Core 2.1。

　　右鍵我們的項目，我們可以直接編輯 csproj 文件或者通過打開屬性選項進行可視化的修改。其實這裡我們通過屬性頁面進行編輯實質上就是編輯我們的 csproj 文件。

　　同時，為了保持我們的項目框架的一致性，我們需要將我們引用的類庫的目標框架同樣修改成 .NET Core 2.1。

　　2、替換 Nuget 包引用

　　在 .NET Core 2.1 版本中微軟將 Microsoft.AspNetCore.All 這個 .NET Core 的基礎 DLL 更換成了 Microsoft.AspNetCore.App，因此，在更新了程式的目標框架後我們還需要將我們程式刪除對於 Microsoft.AspNetCore.All 的引用，同時添加對於 Microsoft.AspNetCore.App 的引用。

　　在 Microsoft.AspNetCore.App 中不包含了以下 Nuget package，如果你對於這些 package 有需要的話，你可以在項目中引用這些 package。

Microsoft.AspNetCore.ApplicationInsights.HostingStartup
Microsoft.AspNetCore.AzureAppServices.HostingStartup
Microsoft.AspNetCore.AzureAppServicesIntegration
Microsoft.AspNetCore.DataProtection.AzureKeyVault
Microsoft.AspNetCore.DataProtection.AzureStorage
Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv
Microsoft.AspNetCore.SignalR.Redis
Microsoft.Data.Sqlite
Microsoft.Data.Sqlite.Core
Microsoft.EntityFrameworkCore.Sqlite
Microsoft.EntityFrameworkCore.Sqlite.Core
Microsoft.Extensions.Caching.Redis
Microsoft.Extensions.Configuration.AzureKeyVault
Microsoft.Extensions.Logging.AzureAppServices
Microsoft.VisualStudio.Web.BrowserLink

　　在引用 Microsoft.AspNetCore.App 的時候，可能會提示缺少某些依賴項或者提示我們原來引用的 Nuget 包版本不滿足 Microsoft.AspNetCore.App，我們只需要根據提示的錯誤信息將我們缺少的依賴項添加上或者將不滿足要求的版本升級就可以了。

　　例如我在升級 PSU.EFCore 這個類庫中時，發現引用的程式集版本不滿足我們我們使用 2.1.6 版本的 Microsoft.AspNetCore.App ，我們只需要將這些引用的 DLL 進行升級，再安裝我們最新版本的 Microsoft.AspNetCore.App。

　　在安裝 .NET Core 2.1 SDK 之後，下列的 tools 已經被包含在最新版本的 .NET Core CLI 中，因此，我們可以在 csproj 文件中刪除 DotNetCliToolReference 節點下的這些引用的 Nuget 包。

Microsoft.DotNet.Watcher.Tools (dotnet watch)
Microsoft.EntityFrameworkCore.Tools.DotNet (dotnet ef)
Microsoft.Extensions.Caching.SqlConfig.Tools (dotnet sql-cache)
Microsoft.Extensions.SecretManager.Tools (dotnet user-secrets)

　　對於 DotNetCliToolReference 節點下的 dotnet-aspnet-codegenerator（用於生成 MVC中的 controllers 和 views 模板） Nuget 包，你同樣可以選擇刪除這個引用，同時使用全局安裝 tool 來代替它。

dotnet tool install -g dotnet-aspnet-codegenerator

　　3、基於 ASP.NET Core 2.1 代碼慣例的更改

　　在 .NET Core 升級到 2.1 版本後，ASP.NET Core 相應的也進行了一些更新，我們創建的模板中的一些基礎代碼也進行了修改。例如在下麵示例中，我們使用 .NET Core 2.0 版本創建的 MVC 項目中的 Program.cs 代碼結構與使用 .NET Core 2.1 生成的模板代碼是有一定差異的。

//ASP.NET Core 2.0
namespace WebApp1
{
    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>()
                .Build();
    }
}

//ASP.NET Core 2.1
namespace WebApp1
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateWebHostBuilder(args).Build().Run();
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>();
    }
}

　　這裡我們按照最新版本的模板代碼對我們的 Program.cs 代碼結構進行修改。

　　同樣的，在 Startup.cs 文件中，ASP.NET Core 2.1 版本增加了對於 GDPR 的支持（歐盟的一項政策，當我們需要收集用戶的數據時，必須以「簡潔、透明且易懂的形式，清晰和平白的語言」向用戶說明，例如這裡我們使用了 cookie、session 來存儲用戶的數據，我們就需要提前告知用戶），對於 HTTPS 的重定向支持以及增加了 SetCompatibilityVersion 方法允許應用程式選擇加入或退出ASP.NET MVC Core 2.1+中引入的可能中斷的行為更改（嗯，看了一圈還是不明白到底是乾什麼的）。

　　4、其它修改

　　在 ASP.NET Core MVC 框架版本的更新中，同樣對於引用的一些 JS 類庫進行了升級，這裡我就不升級了，主要為我們的程式添加對於 GDPR 政策的提示。以及要求我們的程式以 HTTPS 的形式進行訪問。

　　首先我們創建一個分佈視圖 _CookieConsentPartial 用來提示我們需要收集用戶的信息，在 SecretController 控制器中添加一個 Action 用來顯示我們的隱私政策，同時在我們的模板頁面中引用創建的分佈視圖，這裡的樣式就不做任何的調整了，只是做個示例。

@using Microsoft.AspNetCore.Http.Features

@{
    var consentFeature = Context.Features.Get<ITrackingConsentFeature>();
    var showBanner = !consentFeature?.CanTrack ?? false;
    var cookieString = consentFeature?.CreateConsentCookie();
}

@if (showBanner)
{
    <nav id="cookieConsent" class="navbar navbar-default navbar-fixed-top" role="alert">
        <div class="container">
            <div class="navbar-header">
                <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#cookieConsent .navbar-collapse">
                    <span class="sr-only">Toggle cookie consent banner</span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                </button>
                <span class="navbar-brand"><span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span></span>
            </div>
            <div class="collapse navbar-collapse">
                <p class="navbar-text">
                    Use this space to summarize your privacy and cookie use policy.
                </p>
                <div class="navbar-right">
                    <a asp-controller="Secret" asp-action="Privacy" class="btn btn-info navbar-btn">Learn More</a>
                    <button type="button" class="btn btn-default navbar-btn" data-cookie-string="@cookieString">Accept</button>
                </div>
            </div>
        </div>
    </nav>
    <script>
        (function () {
            document.querySelector("#cookieConsent button[data-cookie-string]").addEventListener("click", function (el) {
                document.cookie = el.target.dataset.cookieString;
                document.querySelector("#cookieConsent").classList.add("hidden");
            }, false);
        })();
    </script>
}

//在網站的首頁（登錄頁面）中引用分佈視圖
<partial name="_CookieConsentPartial" />

/// <summary>
/// 隱私政策
/// </summary>
/// <returns></returns>
[AllowAnonymous]
public IActionResult Privacy()
{
    return View();
}

　　在之前的步驟中，我們在代碼中支持了使用 HTTPS 請求訪問，現在我們就可以啟用 SSL 來使我們通過 HTTPS 請求來訪問我們的項目。

四、總結

　　從 .NET Core 2.0 升級到 .NET Core 2.1的整個過程來看，項目整體改動不多，在發佈項目時，我們可以發現，發佈後的項目的大小縮小了很多，同時還提供了對於獨立部署的支持，不用做過多的操作，就可以獲得一些新的優秀特性，總的來說還是很值得升級的。

　　註：

　　1、依賴部署（FDD）：項目依賴於目標伺服器系統上的存在的系統級 .NET Core 環境，發佈後的應用僅包含其自己的代碼和其它位於 .NET Core 系統級庫外的第三方依賴項。

　　2、獨立部署（SCD）：發佈後的項目需要包含發佈後的程式所需要的全部組件（.NET Core 環境、第三方依賴項、程式代碼），不依賴於目標伺服器系統上的 .NET Core 環境。