[NETCore] ASP.NET Core 啟動失敗 - 嘗試存取通訊端被拒絕，因為存取權限不足

問題 
接獲同事詢問專案無法正常啟用，專案是使用 ASP.NET Core 2.2 開發並搭配 Kestrel 使用，在過去開發時都正常運作但今天忽然就遭遇啟動異常的狀況，在啟用時會跳出錯誤訊息為 'Unable to bind to http://localhost:5000 on the IPv4 loopback interface: '嘗試存取通訊端被拒絕，因為存取權限不足。''  ，這篇文章就針對此問題的解決方式做分享，若是有不清楚或是錯誤的地方歡迎討論予糾正。

異常現場
異常發生時畫面如下

Log 中紀錄的詳細錯誤訊息如下

info: Microsoft.AspNetCore.DataProtection.KeyManagement.XmlKeyManager[0]
      User profile is available. Using 'C:\Users\user\AppData\Local\ASP.NET\DataProtection-Keys' as key repository and Windows DPAPI to encrypt keys at rest.
warn: Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to bind to http://localhost:5000 on the IPv4 loopback interface: '嘗試存取通訊端被拒絕，因為存取權限不足。'.
warn: Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to bind to http://localhost:5000 on the IPv6 loopback interface: '嘗試存取通訊端被拒絕，因為存取權限不足。'.
crit: Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to start Kestrel.
System.IO.IOException: Failed to bind to address http://localhost:5000. ---> System.AggregateException: One or more errors occurred. (嘗試存取通訊端被拒絕，因為存取權限不足。) (嘗試存取通訊端被拒絕，因為存取權限不足。) ---> System.Net.Sockets.SocketException: 嘗試存取通訊端被拒絕，因為存取權限不足。
   at System.Net.Sockets.Socket.UpdateStatusAfterSocketErrorAndThrowException(SocketError error, String callerName)
   at System.Net.Sockets.Socket.DoBind(EndPoint endPointSnapshot, SocketAddress socketAddress)
   at System.Net.Sockets.Socket.Bind(EndPoint localEP)
   at Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransport.BindAsync()
   at Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServer.<>c__DisplayClass21_0`1.<<StartAsync>g__OnBind|0>d.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.AddressBinder.BindEndpointAsync(ListenOptions endpoint, AddressBindContext context)
   at Microsoft.AspNetCore.Server.Kestrel.Core.LocalhostListenOptions.BindAsync(AddressBindContext context)
   --- End of inner exception stack trace ---
   --- End of inner exception stack trace ---
   at Microsoft.AspNetCore.Server.Kestrel.Core.LocalhostListenOptions.BindAsync(AddressBindContext context)
   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.AddressBinder.AddressesStrategy.BindAsync(AddressBindContext context)
   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.AddressBinder.BindAsync(IServerAddressesFeature addresses, KestrelServerOptions serverOptions, ILogger logger, Func`2 createBinding)
   at Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServer.StartAsync[TContext](IHttpApplication`1 application, CancellationToken cancellationToken)

C:\Program Files\dotnet\dotnet.exe (process 31468) exited with code -1.
To automatically close the console when debugging stops, enable Tools->Options->Debugging->Automatically close the console when debugging stops.
Press any key to close this window . . . 

根據錯誤訊息提供的線索，異常原因可能是因為 Kestrel 在啟動時失敗造成 (Startup failure)，Kestrel 預設是使用 5000 port，懷疑該已被占用造成啟用時使用該 port 號卻無法正常執行，才跳出 嘗試存取通訊端被拒絕，因為存取權限不足 錯誤訊息，首先先來釐清推測是否正確，查詢 port 使用狀況可以透過以下兩種方式

命令提示字元
開啟 Windows Terminal 使用命令提示字元，輸入  netstat -nat | findstr 5000  指令查看 port 使用狀況 

PS C:\> netstat -nat | findstr 5000 

查詢後可以看到目前系統中 5000 port 已被占用

TCPView
TCPView 是一個非常實用的小工具，可以顯示目前系統中 TCP 與 UDP 連接的狀態，不用在命令提示字元下指令就可以看到需要的資訊，之前用過此工具幫忙在 Production 解決不少問題，如果之前未使用過強烈建議可以下載使用看看，在微軟官方就有提供下載連結 : 傳送門，解完壓縮之後直接執行 TCPView.exe 執行檔，可以看到 5000 Port 已被其他應用程式所占用

解決方案
透過上述步驟可以看到，主要原因是因為 Kestrel 所要用的 Port 已被其他應用程式所佔用，占用的應用程式 ProcessID 是 4，可以透過以下幾種方式解決

設定 IIS
在過去的經驗中告訴我們 system ProcessID 為 4 時候 87% 是 IIS，推測可能是因為在 IIS 中某一個 Application 中有設定使用到該機器的 5000 Port，可以開啟 IIS 檢查在建立 Application 所設定到的 Port 號，有與 5000 衝突的部分替換為新的 Port 號即可，果然在同事的電腦中發現測是的應用程式已將指定 Port 占用，調整後 ASP.NET Core 專案即可正常運行。

設定 Kestrel 
另外一種方式是調整 Kestrel 的指定 Port，在 ASP.NET Core 預設是使用 5000 port，如果電腦中應用程式的 5000 Port 是無法調整的，及可以透過設定的方式將預設的 Port 改用其他指定 port 避免衝突的狀況發生，如果是使用 ASP.NET Core Web template 建立專案，其中  CreateDefaultBuilder  方法會呼叫 serverOptions.Configure(context.Configuration.GetSection("Kestrel")) 載入設定，因此我們可以到 appsettings.json 調整，以下列設定為例是將 Kestrel port 指定為 5050

{
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "http://localhost:5050"
      }
    }
  }, 
  ....other settings
} 

以上兩種方式都可以解決當 Kestrel 預設 Port 被占用，造成應用程式啟動失敗的問題，各位看官可以依據情境選擇適合是自己的解決方案，若是有更好的方法也歡迎提出來一起討論，Thanks & Happy Coding :)

參考
ASP.NET Core 中的 Kestrel 網頁伺服器實作

Read More

[NETCore] ASP.NET Core 建立與解析 QueryString 參數

說明
之前介紹過在 .NET 中可以使用 Utility.ParseQueryString 處理 Url 中的參數，傳送門 : 使用 ParseQueryString 取得網址參數，但所使用的 System.Web 命名空間僅存在於 ASP.NET Framework 不支援 ASP.NET Core，在搜尋更好的解決方案中發現了在 ASP.NET Core 提供新的 API - QueryHelpers 可以達到同樣效果，此篇介紹如何使用 queryHelpers 建立與解析 querystring 參數，若有問題歡迎留言討論

下載
QueryHelpers 從 .NET Core 1.0 RC2 就開始支援，命名空間為 Microsoft.AspNetCore.WebUtilities，使用前須先透過 Nuget Package Manager 下載

Install-Package Microsoft.AspNetCore.WebUtilities -Version 2.2.0

在 Visual Studio 2019 專案點擊 Project 檔案可直接開啟，確認是否有安裝成功

產生 QueryString

QueryHelpers 使用  AddQueryString  產生 querystring 內容，使用方式相當簡單直接看 Sample Code 

string url = QueryHelpers.AddQueryString("/api/demo", "key1", "value1");
// result : api/demo?key1=value1

有多個參數需求時可以傳入 Dictionary

var queryParams = new Dictionary<string, string>()
{
    {"key1", "value1" },
    {"key2", "value2" },
    {"key3", "value3" }
};
url = QueryHelpers.AddQueryString("/api/demo/list", queryParams); 
// result : api/demo/list?key1=value1&key2=value2&key3=value3

輸入中文字，會自動 url Encode (覺得實用，好棒棒!!!)

url = QueryHelpers.AddQueryString("/api/demo/list", "高雄", "發大財");
// result : api/demo/list?%E9%AB%98%E9%9B%84=%E7%99%BC%E5%A4%A7%E8%B2%A1

解析 QueryString

QueryHelpers 使用  ParseQuery  解析 Url 的 querystring 內容，以下範例為透過 ParseQuery 解析 QueryString 內容，並使用 selectMany 反序列化為 KeyValuePairs 方便後續操作

ar rawurl = "https://marcusblog.com/api/product/list?key1=value1&key2=value2&key3=value3&key1=value1&key5=";

var uri = new Uri(rawurl);
var baseUri = uri.GetComponents(UriComponents.Scheme | UriComponents.Host | UriComponents.Port | UriComponents.Path, UriFormat.UriEscaped);

var query = QueryHelpers.ParseQuery(uri.Query);

var items = query.SelectMany(x => x.Value, (col, value) => new KeyValuePair<string, string>(col.Key, value)).ToList();

// result : 
//      key1/value1
//      key2/value2
//      key3/value3

同場加映 - QueryBuilder

在 ASP.NET Core 中產生 QueryString 也可以透過 Microsoft.AspNetCore.Http.Extensions 中的  Querybuilder  方法，透過 Add 方法將參數帶入並使用  ToQueryString 輸出

var qs = new QueryBuilder();
qs.Add("key1", "test");
qs.Add("key2", "1111");
var result = qs.ToQueryString();

// result : ?key1=test&key2=1111

上面介紹兩種在 ASP.NET Core API 產生 QueryString 的方式，都可以達到目的，各位在使用上可以依據喜好來決定使用哪一種 :)

參考

QueryHelpers Class
QueryBuilder Class
Parse and Modify Query Strings in ASP.NET Core

Read More