如何開始閱讀ASP.NET Core源代碼

来源:https://www.cnblogs.com/wenhx/archive/2020/02/17/Build-ASP-NET-Core-from-Source.html

背景 當我們對ASP.Net Core內部的某些方法、類的實現感興趣時,有很多方法可以去瞭解,看書,看各種文章,但是最直接也是最深入的辦法就是去閱讀源代碼。ASP.NET Core的源代碼托管在Github,項目地址是:https://github.com/dotnet/aspnetcore。如果只 ...


背景

當我們對ASP.Net Core內部的某些方法、類的實現感興趣時,有很多方法可以去瞭解,看書,看各種文章,但是最直接也是最深入的辦法就是去閱讀源代碼。
ASP.NET Core的源代碼托管在Github,項目地址是:https://github.com/dotnet/aspnetcore
如果只是簡單的想看某個方法是如何實現的,我們可以直接在github網站上瀏覽。
但是通過網頁閱讀源代碼會遇到一些問題,首先是找到指定的類或方法並不容易,其次代碼的展示效果並不友好。
因此最佳的方式就是下載源代碼到我們本機。

下載源代碼

在GitHub上托管的項目的源代碼提供了幾種下載方式:

使用git、SVN、GitHub的客戶端,或者直接下載GitHub打包好的源代碼壓縮包。
如果是簡單的項目,你可以直接下載GitHub打包好的源代碼壓縮包。

但是對於ASP.NET Core這種大型項目,下載的源代碼壓縮包由於缺少子模塊的代碼,無法通過編譯。
不能通過編譯的代碼,下麵這些功能無法使用:IDE提供的類和方法間的快速導航(F12),針對某個屬性、方法等查找它被哪些代碼所引用。
對於大型項目來說,缺少這些功能幾乎沒辦法深入閱讀該項目的源代碼。
尤其是ASP.NET Core這種大量使用了擴展方法的項目,擴展方法可能定義在一個不起眼的角落,通過手工查找繁瑣且困難。
所以強烈推薦使用git來克隆ASP.NET Core項目的倉庫:

git clone --recursive https://github.com/dotnet/aspnetcore


編譯的準備工作

現在,我們已經有源代碼了,但是由於ASP.NET Core項目使用了很多其他技術,所以編譯源代碼之前需要準備編譯環境。
不同的操作系統需求不一樣,以Windows環境下使用Visual Stuido舉例,當前官方文檔(3.1.1版本)上面列出的需求是:

  • Windows 10 version 1803 或更新版本
  • Visual Studio 2019
    版本雖然沒有要求,但是實際依賴的部分組件會在更新版本的更新中包含。
    例如,如果你編譯3.1.0版本的代碼,需要更新到16.4.4以上版本(包含新版本的MSBuild)。
    如果使用VS Code,請看後面的介紹。
  • Git https://git-scm.org
  • NodeJS 10.14.2或更新版本 https://nodejs.org
  • Java Development Kit 11 或更新版本
  • Chrome 基於Selenium的測試要用到

如果你使用的是其它環境(Linux或macOS, VS Code等),請查看詳細的安裝文檔(源代碼中的docs/BuildFromSource.md文件),按照其中Install pre-requisites部分的指引準備編譯環境。
更細節的內容,比如編譯時怎麼查找JDK的(如果你本機已經安裝過了,但是腳本提示找不到),你可以直接查看編譯腳本,.\build.ps1(或.\build.sh)文件。

還原

當編譯環境準備好以後,記得開啟新的命令行視窗,因為新增的環境變數只在安裝後啟動的命令行中生效。
前面克隆到本機的是最新的代碼(更新頻繁),但是對於大多數人來說,我們只關註自己目前正在使用的版本。
ASP.NET Core所有版本的發佈都打了標簽(tag)。
因此,我們可以先使用git命令列出所有的版本。

git tag

然後根據標簽名稱,切換到我們的目標版本,比如3.1.0版本。

git checkout v3.1.0

在你使用Visual Studio或VS Code瀏覽代碼之前需要運行.\restore.cmd(Windows環境,Linux和macOS請使用對應的.sh文件,下同)來還原編譯所依賴的運行環境和各種組件。
每次源代碼有大的更新時,你都需要重新運行.\restore.cmd。
運行.\restore.cmd後,腳本會立即開始檢查編譯所依賴的運行環境並下載各種組件(第一次運行時),
由於伺服器都在國外,因此有些組件下載速度很慢。(如果某個組件下載速度很慢,kexue上網會有極大的改善)

首先會下載dotnet運行環境,這個是最大也是最慢的,做好心理準備。
它被存放在根目錄的.dotnet目錄下,差不多有1GB。

接下來開始下載各個項目所依賴的組件,這部分是通過nuget工具來下載的,
因為網路的原因,下載常常會出錯,在我的中國電信寬頻下反覆重試依然如此。
因為nuget會在本地緩存曾經下載過的組件,所以一旦發生上面的情況,你可以通過下麵這種方式解決:
在VS中新建一個ASP.NET Core的項目,然後在管理NuGet包界面來下載這個包(這時候就能下載了,問號臉),
之後因為本地有緩存了,再次通過命令行下載的時候就無需網路了。

在我本機編譯的過程中,遇到了找不到某個包的情況:Microsoft.Internal.AspNetCore.H2Spec.All 2.1.1。
手工在nuget.org上搜索居然沒有。後來在myget上找到了,還是先在Visual Studio的Package Manager Console中使用下麵的這個命令先安裝在上面新建的項目中:

PM> Install-Package Microsoft.Internal.AspNetCore.H2Spec.All -Version 2.1.1 -Source https://dotnet.myget.org/F/aspnetcore-tools/api/v3/index.json

再次運行命令就能找到包了。
運行圖:
 


打開解決方案

由於ASP.NET Core項目實在太大了——包含單元測試在內有626個csproj文件,8207個cs文件——所以並沒有一個包含所有子項目的解決方案(.sln文件)。
在.\src目錄下麵有很多子目錄,每一個子目錄都是一個子項目,每個子項目中都包含了一個解決方案(.sln文件)。
和我們平常打開自己的項目不一樣,ASP.NET Core的解決方案文件(.sln)由於需要設置環境變數因此需要使用腳本命令來打開。
運行子目錄中的startvs.cmd即可啟動Visual Studio打開相應的子項目。

根據電腦配置,第一次啟動可能需要耗費相當長的時間,下次就快了。
下圖是MVC項目的解決方案,巨大無比吧。

現在,讓我們開始好好享受閱讀的樂趣吧。(手動狗頭)

如果你需要編譯源代碼的話,修改源代碼以後運行.\build.cmd文件,然後你可以去泡茶了,回來應該就差不多了。(再次狗頭)


您的分享是我們最大的動力!

更多相關文章
  • 通過上一章的學習,Geometry抽象類表示形狀或路徑。Drawing抽象類扮演了互補的角色,它表示2D圖畫(Drawing)——換句話說,它包含了顯示矢量圖像或點陣圖需要的所有信息。 儘管有幾類畫圖類,但只有GeometryDrawing類能使用已經學習過的幾何圖形。它增加了決定如何繪製圖形的畫筆和 ...
  • String類型很簡單,就不做示例演示了,這裡只貼出Helper類 /// <summary> /// 判斷key是否存在 /// </summary> /// <param name="key"></param> /// <param name="db"></param> /// <returns ...
  • 過濾漢字 Regex.Replace(inputStr,@"[\u4e00-\u9fa5]",string.Empty); 提取漢字: Regex.Replace(inputStr,@"[^\u4e00-\u9fa5]",string.Empty);//註意這裡多了個^符號 ...
  • //從第1個開始,依次向左插入值。如果鍵不存在,先創建再插入值 隊列形式 先進後出,後進先出 //插入後形式 <-- 10,9,8,7,6,5,4,3,2,1 <-- 方向向左依次進行 stopwatch.Start(); for (int i = 0; i < 10; i++) { var get ...
  • 前言 IdentityServer4(以下簡稱 Id4) 是 Asp.Net Core 中一個非常流行的 OpenId Connect 和 OAuth 2.0 框架,可以輕鬆集成到 Asp.Net Core 應用中,並且與 Asp.Net Core Identity 也可以輕鬆集成。博客園也有大佬發 ...
  • 文章出處: https://www.cnblogs.com/dotnet261010/p/6275821.html 一、WPF簡介 WPF:WPF即Windows Presentation Foundation,翻譯為中文“Windows呈現基礎”,是微軟推出的基於Windows Vista的用戶界 ...
  • 定義委托 委托實例化 定義具體執行的方法 綁定方法 觸發委托 ...
  • 1. 前言 Xceed wpftoolkit提供了一個 "CheckListBox" ,效果如下: 不過它用起來不怎麼樣,與其這樣還不如參考UWP的ListView實現,而且動畫效果也很好看: 它的樣式如下: 屬性是很多了,但這裡沒有自定義CheckBox樣式的方法,而且也沒法參考它的動畫如何實現。 ...
一周排行
  • 一、引言 按照專用隊列解釋: MachineName\Private$\QueueName,只針對於本機的程式才可以調用的隊列,有些情況下為了安全起見定義為私有隊列。所以剛開始的時候認為,要想訪問遠程消息隊列,只能使用公共隊列。但是後來發現,公共隊列依賴Domain Controller(域控),在 ...
  • 本文只對api介面,header請求參數進行簡單驗證,起到拋磚引玉使用,需要深入驗證,請自行擴展 項目目錄結構如圖 中間件類 using ApiMiddleware.Common.DataEnityModel; using ApiMiddleware.Common.DbContext; using ...
  • 前言:由於公司占時沒有運維,出於微服務的需要,Apollo只能先裝在windows 阿裡雲上跑起來,由於環境及網路等問題,在安裝過程中遇到很多坑,算是一個個坑填完後,最終實現。 一. java jdk環境 java jdk 1.8下載地址: https://www.oracle.com/java/t ...
  • 前言 nuget 是 .net 的常用包管理器,目前已經內置到 Visual Studio 2012 以後的版本。大多數 .net 包都托管在 nuget.org,包括 .net core 框架基礎包,得益於 .net core 的模塊化設計,很多非核心包都可以進行一定程度的獨立升級。 製作並上傳 ...
  • 簡單的介紹一下集合,通俗來講就是用來保管多個數據的方案。比如說我們是一個公司的倉庫管理,公司有一堆貨物需要管理,有同類的,有不同類的,總而言之就是很多、很亂。我們對照集合的概念對倉庫進行管理的話,那麼 數組就是將一堆貨整整齊齊的碼在倉庫的某個地方,普通列表也是如此;Set就是在倉庫里有這麼一個貨架, ...
  • 中間件分類 ASP.NET Core 中間件的配置方法可以分為以上三種,對應的Helper方法分別是:Run(), Use(), Map()。 Run(),使用Run調用中間件的時候,會直接返回一個響應,所以後續的中間件將不會被執行了。 Use(),它會對請求做一些工作或處理,例如添加一些請求的上下 ...
  • 字元串的常用操作 很好理解 字元串可以用 ' + ' 連接,或者乘一個常數重覆輸出字元串 字元串的索引操作 通過一對中括弧可以找到字元串中的某個字元 可以通過正負數雙向操作噢 用一個中括弧來實現 為什麼沒有-0??去清醒腦子想想 -0 和 0 有差嗎? 還有一個切片操作 就像切菜那樣簡單,同樣是中括 ...
  • title: Java基礎語法(3) 運算符 blog: "CSDN" data: "Java學習路線及視頻" 1.算術運算符 算術運算符的註意問題 如果對負數取模,可以把模數負號忽略不記,如:5% 2=1。 但被模數是負數則不可忽略。此外,取模運算的結果不一定總是整數。 對於除號“/”,它的整數除 ...
  • 下麵是互相轉換的代碼: 有想要瞭解更多關於python知識的請在下方評論或私信小編 ...
  • 引言 構建分散式系統並不容易。然而,人們日常所使用的應用大多基於分散式系統,在短時間內依賴於分散式系統的現狀並不會改變。ApacheZooKeeper旨在減輕構建健壯的分散式系統的任務。ZooKeeper基於 分散式計算的核心概念而設計,主要目的是給開發人員提供一套容易理解和開發的介面,從而簡化分佈 ...
x