萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

C# 偵測 TCP 連接埠是否被佔用:IPGlobalProperties 實作與 HttpListener 驗證範例

場景痛點

啟動 TCP Server 前需確認埠號可用。TcpListener.Start() 直接綁定失敗會拋例外,但**例外處理成本高、錯誤訊息不直觀**。最佳做法:**啟動前主動偵測**,埠被佔用時給予友善提示或自動尋找下一個可用埠。

核心 API:IPGlobalProperties.GetActiveTcpListeners()

System.Net.NetworkInformation.IPGlobalProperties 提供作業系統級 TCP/UDP 監聽端點快照,**無需嘗試綁定即可知曉埠佔用狀態**。

完整實作

using System;
using System.Net;
using System.Net.NetworkInformation;
using System.Net.Sockets;

namespace PortDetector
{
    public static class PortUtility
    {
        /// 
        /// 檢查本機 TCP 埠是否正在被監聽
        /// 
        /// 埠號 (1-65535)
        /// true=已被監聽, false=可用
        public static bool IsTcpPortListening(int port)
        {
            if (port < 1 || port > 65535)
                throw new ArgumentOutOfRangeException(nameof(port), "埠號範圍 1-65535");

            IPGlobalProperties ipProps = IPGlobalProperties.GetIPGlobalProperties();
            IPEndPoint[] listeners = ipProps.GetActiveTcpListeners();

            foreach (IPEndPoint ep in listeners)
            {
                if (ep.Port == port)
                    return true;
            }
            return false;
        }

        /// 
        /// 尋找指定範圍內第一個可用 TCP 埠
        /// 
        public static int FindAvailableTcpPort(int startPort = 10000, int endPort = 65535)
        {
            var usedPorts = new HashSet();
            foreach (var ep in IPGlobalProperties.GetIPGlobalProperties().GetActiveTcpListeners())
                usedPorts.Add(ep.Port);

            for (int p = startPort; p <= endPort; p++)
                if (!usedPorts.Contains(p))
                    return p;

            throw new InvalidOperationException($"範圍 {startPort}-{endPort} 無可用埠");
        }
    }

    // ===== 驗證範例 =====
    class Program
    {
        static void Main()
        {
            const int testPort = 8080;

            Console.WriteLine($"檢查埠 {testPort}:{ (PortUtility.IsTcpPortListening(testPort) ? "已佔用" : "可用") }");

            // 實際佔用埠:啟動 HttpListener
            using (var listener = new HttpListener())
            {
                listener.Prefixes.Add($"https://+:{testPort}/");
                listener.Start();
                Console.WriteLine($"HttpListener 已在埠 {testPort} 啟動");

                Console.WriteLine($"再次檢查:{ (PortUtility.IsTcpPortListening(testPort) ? "已佔用" : "可用") }");

                Console.WriteLine("按任意鍵停止 Listener...");
                Console.ReadKey();
            }

            Console.WriteLine($"Listener 關閉後:{ (PortUtility.IsTcpPortListening(testPort) ? "已佔用" : "可用") }");

            // 尋找可用埠示範
            int freePort = PortUtility.FindAvailableTcpPort(9000, 9100);
            Console.WriteLine($"9000-9100 首個可用埠:{freePort}");
        }
    }
}

進階:同時檢查 TCP 與 UDP

public static bool IsPortListening(int port, bool checkTcp = true, bool checkUdp = true)
{
    var props = IPGlobalProperties.GetIPGlobalProperties();

    if (checkTcp)
        foreach (var ep in props.GetActiveTcpListeners())
            if (ep.Port == port) return true;

    if (checkUdp)
        foreach (var ep in props.GetActiveUdpListeners())
            if (ep.Port == port) return true;

    return false;
}

注意事項與限制

  • 權限:需足夠權限讀取網路資訊(通常標準使用者即可,Container 可能需 NET_ADMIN)。
  • 快照性質:回傳的是**呼叫瞬間**的監聽清單,極短時間內埠狀態可能改變(TOCTOU 競態),關鍵路徑仍需 try-catch 綁定失敗。
  • IPv6:GetActiveTcpListeners 回傳包含 IPv4 (::ffff:0:0/96) 與 IPv6 端點,Port 屬性統一可比較。
  • 非監聽連線:Established 狀態的連線**不在**此清單中,若需查看所有連線用 GetActiveTcpConnections()。

替代方案對比

方法優點缺點
IPGlobalProperties非侵入式、無競態風險、可列舉所有埠需系統權限、快照可能過期
TcpListener.Start() + Catch真實驗證可綁定性例外成本高、佔用埠才知道
P/Invoke GetExtendedTcpTable可取得 Process ID、狀態平台相容複雜、需 P/Invoke
嘗試 Socket.Bind輕量、可設定 ExclusiveAddressUse仍需例外處理、僅單埠測試

結語

IPGlobalProperties.GetActiveTcpListeners() 是 C# **偵測埠佔用的標準非侵入式 API**。搭配 FindAvailableTcpPort 自動尋找可用埠,配合啟動時 try-catch 兜底,即可構建健壯的 TCP Server 啟動邏輯。

copyright © 萬盛學電腦網 all rights reserved