[NETCore] ASP.NET Core 啟動失敗 - 嘗試存取通訊端被拒絕，因為存取權限不足 ~ m@rcus 學習筆記

問題
接獲同事詢問專案無法正常啟用，專案是使用 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 網頁伺服器實作

[NETCore] 使用 Dotnet Watch 自動編譯 ASP.NET Core 應用程式前言在開發完代碼的時候，為了確保代碼在應用程式執行的狀況，會在 Visual Studio IDE 使用偵錯模式 F5 或是 Ctrl+F5 進行偵錯，如果執行狀況不如預期時就會關閉偵錯，重新修改代碼在編譯再重新進行偵錯，簡單來說流程像是改 Code > 編譯 Ctrl + Shift + B > 測試 F5 or Ctrl + F5 > 不如預期 > 改 Code ，仔細想… Read More
[NETCore] 使用 Polly 實現重試 (Retry) 策略介紹在開發時常常都會遇到串接其他 Server 或是第三方服務 API 的需求，當對方伺服器或是第三方服務發生問題時，或許可以在 Log 中看到回應的 HTTP 狀態碼是 404 (Not Found)、503(Service Unavailable)、504(Gateway Timeout)、500(Too Many Requests)...等當下無法正常執行的錯誤訊息，可能發生原因是因為對方 Server 不穩定，或是正在部署新版應用程式，… Read More
[.NETCore] Windows 如何更新環境變數 Environment Variable問題在上一篇 ASP.NET Core - ENVIRONMENT 提到可以設定環境變數 ASPNETCORE_ENVIRONMENT ，然後代碼中可以依據所設定的環境變數作相對應的邏輯處理，舉例來說如果是 Production 環境的話就關閉錯誤訊息畫面、產生系統監控...等行為，一般來說設定完環境變數 Environment Variable 都需要重啟電腦讓設定值生效，但是如果在 Pr… Read More
[NETCore] Polly 重試機制搭配 jitter 策略Jitter 策略上一篇 [NETCore] 使用 Polly 實現重試 (Retry) 策略分享了使用 Polly 的重試 API 幫助我們達到重試的功能，後續在尋找相關文件時看到重試時的一種策略 Jitter strategy，在高併發的情境下如果使用重試策略可能會影響到系統，若要解決用戶端因為同時間重試造成伺服器資源高峰的狀況，可以透過添加隨機時間來改善，另外在 Jitter: Making Things Bette… Read More
[NETCore] ASP.NET Core 設定 JSON 序列化格式前言 JSON.NET 是十分好用的套件，在 ASP.NET Core 1.0 開始內建 JSON.NET方便開發者快速使用，建立 ASP.NET Core 範本專案時會在 ConfigureServices 中的 addMVC 就可以開始使用，這篇介紹如何在 ASP.NET Core 中定義 JSON.NET 統一輸出格式的設定，若有問題歡迎留言一起討論。範例代碼首先建立 ASP.NET C… Read More

m@rcus 學習筆記

只有累積，沒有奇蹟

2023年9月18日星期一