Sockets: découvrez la disponibilité des ports à l'aide de Java


123

Comment déterminer par programme la disponibilité d'un port sur une machine donnée à l'aide de Java?

ie étant donné un numéro de port, déterminer s'il est déjà utilisé ou non ?.


2
Bien que cette question porte sur la façon de savoir si un port donné est déjà utilisé, vous avez peut-être atterri ici en essayant de trouver un moyen d'obtenir un numéro de port gratuit, qui stackoverflow.com/questions/2675362/… (avec un lien vers mon essence .github.com / 3429822 ) couvre mieux.
vorburger

Dans quel but? Si vous voulez juste trouver une socket libre à écouter, spécifiez simplement zéro. Toute technique de numérisation est sujette à des problèmes de fenêtre de synchronisation: le port peut être vacant lorsque vous scannez et occupé lorsque vous allez réclamer.
Marquis of Lorne

Réponses:


91

Voici l' implémentation issue du projet Apache camel :

/**
 * Checks to see if a specific port is available.
 *
 * @param port the port to check for availability
 */
public static boolean available(int port) {
    if (port < MIN_PORT_NUMBER || port > MAX_PORT_NUMBER) {
        throw new IllegalArgumentException("Invalid start port: " + port);
    }

    ServerSocket ss = null;
    DatagramSocket ds = null;
    try {
        ss = new ServerSocket(port);
        ss.setReuseAddress(true);
        ds = new DatagramSocket(port);
        ds.setReuseAddress(true);
        return true;
    } catch (IOException e) {
    } finally {
        if (ds != null) {
            ds.close();
        }

        if (ss != null) {
            try {
                ss.close();
            } catch (IOException e) {
                /* should not be thrown */
            }
        }
    }

    return false;
}

Ils vérifient également le DatagramSocket pour vérifier si le port est disponible en UDP et TCP.

J'espère que cela t'aides.


5
Une variante intéressante de ceci si vous avez MINA est AvailablePortFinder.getNextAvailable (1024) qui vous donne le prochain port non privilégié.
Alain O'Dea le

9
Cela ne comprend cependant pas tout. J'ai été mordu par un nginx en cours d'exécution sur TCP 8000 alors que la routine ci-dessus signale 8000 comme disponible. Je ne sais pas pourquoi - je soupçonne que nginx fait des trucs sournois (c'est sur OS X). La solution de contournement pour moi est de faire ce qui précède et aussi d'ouvrir un nouveau Socket ("localhost", port) puis de retourner false si nous n'obtenons pas d'exception. Pensées?
Partiellement nuageux le

2
Même problème sur Windows essayant de détecter si le serveur SMTP de papercut est en cours d'exécution. Une solution où vous ouvrez une connexion à un port, plutôt que d'essayer de vous lier à un it (comme suggéré par le commentaire de Partly Clodys et la réponse d'Ivan) semble fonctionner plus fiable.
stian

4
Intéressant. L'appel à setReuseAddress () est complètement inutile une fois que le socket est déjà lié, et il est également complètement contraire à l'objectif du code.
Marquis of Lorne

3
Ce code est sujet à des problèmes de fenêtre de synchronisation. Si l'objectif est de créer une ServerSocketécoute sur un port, c'est ce qu'il doit faire et renvoyer le fichier ServerSocket. Le créer puis le fermer et le renvoyer ne fournit aucune garantie qu'un suivant ServerSocketpuisse être créé en utilisant ce port. Idem pour DatagramSocket.
Marquis of Lorne

41

Pour Java 7, vous pouvez utiliser try-with-resource pour un code plus compact:

private static boolean available(int port) {
    try (Socket ignored = new Socket("localhost", port)) {
        return false;
    } catch (IOException ignored) {
        return true;
    }
}

15
Cela ne teste pas si le port est disponible. Il teste s'il est à l'état LISTEN, si l'adresse IP est accessible, etc.
Marquis of Lorne

1
De plus, ce test est assez lent (près d'une seconde par port).
JMax

ne devrait-il pas retourner false lorsqu'une IOException est interceptée?
Baroudi Safwen

@BaroudiSafwen Cela dépend entièrement de ce qu'est réellement l'exception. Car ConnectException: 'connection refused', oui, il devrait renvoyer false. Pour les délais d'attente, rien de ce qu'il pourrait renvoyer ne serait valide, car la réponse réelle n'est pas connue. C'est pourquoi cette technique est inutile à cet effet.
Marquis of Lorne

36

Il semble qu'à partir de Java 7, la réponse de David Santamaria ne fonctionne plus de manière fiable. Il semble cependant que vous puissiez toujours utiliser de manière fiable un socket pour tester la connexion.

private static boolean available(int port) {
    System.out.println("--------------Testing port " + port);
    Socket s = null;
    try {
        s = new Socket("localhost", port);

        // If the code makes it this far without an exception it means
        // something is using the port and has responded.
        System.out.println("--------------Port " + port + " is not available");
        return false;
    } catch (IOException e) {
        System.out.println("--------------Port " + port + " is available");
        return true;
    } finally {
        if( s != null){
            try {
                s.close();
            } catch (IOException e) {
                throw new RuntimeException("You should handle this error." , e);
            }
        }
    }
}

Je veux vérifier si un serveur proxy est disponible pour passer des appels en son nom.
Dejell

1
La réponse de @ DavidSantamaria n'a jamais fonctionné. Rien à voir avec Java 7.
Marquis of Lorne

35

Si vous n'êtes pas trop préoccupé par les performances, vous pouvez toujours essayer d'écouter sur un port à l'aide de la classe ServerSocket . S'il lève une exception, il y a des chances qu'il soit utilisé.

public static boolean isAvailable(int portNr) {
  boolean portFree;
  try (var ignored = new ServerSocket(portNr)) {
      portFree = true;
  } catch (IOException e) {
      portFree = false;
  }
  return portFree;
}

EDIT: Si tout ce que vous essayez de faire est de sélectionner un port libre, new ServerSocket(0)vous en trouverez un pour vous.


Utilisez finally pour le nettoyage (essayez {...} catch {...} finally {if (socket! = Null) socket.close ();}
Hosam Aly

Vous pouvez également définir "portTaken = (socket == null);" à la fin au lieu de le faire dans la capture.
Hosam Aly

1
Je n'ai pas pensé que cela entrait dans le cadre de la question de l'auteur.
Spencer Ruport

1
Y a-t-il un moyen de le faire sans essayer / attraper? Cela ne me dérangerait pas d'utiliser n'importe quel port disponible à mes fins, mais itérer sur les numéros de port et essayer / attraper chacun jusqu'à ce que je trouve un port gratuit est un peu inutile. N'y a-t-il pas quelque part une méthode 'native boolean available (int)', qui vérifie simplement?
Oren Shalev

27
new SeverSocket (0) sélectionnera automatiquement un port libre.
Spencer Ruport

10

La solution suivante est inspirée de l' implémentation SocketUtils de Spring-core (licence Apache).

Par rapport aux autres solutions qui l'utilisent, Socket(...)c'est assez rapide (tester 1000 ports TCP en moins d'une seconde):

public static boolean isTcpPortAvailable(int port) {
    try (ServerSocket serverSocket = new ServerSocket()) {
        // setReuseAddress(false) is required only on OSX, 
        // otherwise the code will not work correctly on that platform          
        serverSocket.setReuseAddress(false);
        serverSocket.bind(new InetSocketAddress(InetAddress.getByName("localhost"), port), 1);
        return true;
    } catch (Exception ex) {
        return false;
    }
}       

3

Les solutions basées sur le socket try / catch peuvent ne pas donner des résultats précis (l'adresse du socket est "localhost" et dans certains cas, le port peut être "occupé" non par l'interface de bouclage et au moins sur Windows, j'ai vu ce test échouer, c'est-à-dire le prot déclaré à tort comme disponible).

Il existe une bibliothèque sympa nommée SIGAR , le code suivant peut vous connecter:

Sigar sigar = new Sigar();
int flags = NetFlags.CONN_TCP | NetFlags.CONN_SERVER | NetFlags.CONN_CLIENT;             NetConnection[] netConnectionList = sigar.getNetConnectionList(flags);
for (NetConnection netConnection : netConnectionList) {
   if ( netConnection.getLocalPort() == port )
        return false;
}
return true;

J'obtiens: "pas de sigar-x86-winnt.dll dans java.library.path" Malheureusement, cela nécessite le téléchargement d'une DLL supplémentaire qui n'est pas vraiment viable dans l'environnement d'entreprise (je n'ai aucun contrôle sur le système CI). Tellement mauvais ... Merci quand même.
uthomas

@uthomas Je suppose que vous avez toujours le contrôle sur le package de déploiement de votre application, si tel est le cas, vous pouvez toujours fournir des DLL / SO d'exécution natives Sigar à proximité de vos JAR et définir le chemin de la bibliothèque JAVA de manière pragmatique (via un simple hack, vous pouvez l'influencer même après votre app a été lancée par la JVM).
Shmil The Cat

2

Un nettoyage de la réponse soulignée par David Santamaria:

/**
 * Check to see if a port is available.
 *
 * @param port
 *            the port to check for availability.
 */
public static boolean isPortAvailable(int port) {
    try (var ss = new ServerSocket(port); var ds = new DatagramSocket(port)) {
        return true;
    } catch (IOException e) {
        return false;
    }
}

Ceci est toujours soumis à une condition de concurrence signalée par user207421 dans les commentaires de la réponse de David Santamaria (quelque chose pourrait saisir le port après que cette méthode ferme le ServerSocketet DatagramSocketet retourne).


1

Dans mon cas, cela a aidé à essayer de se connecter au port - si le service est déjà présent, il répondrait.

    try {
        log.debug("{}: Checking if port open by trying to connect as a client", portNumber);
        Socket sock = new Socket("localhost", portNumber);          
        sock.close();
        log.debug("{}: Someone responding on port - seems not open", portNumber);
        return false;
    } catch (Exception e) {         
        if (e.getMessage().contains("refused")) {
            return true;
    }
        log.error("Troubles checking if port is open", e);
        throw new RuntimeException(e);              
    }

1
Pas ce qui a été demandé.
Marquis of Lorne

0

Dans mon cas, j'ai dû utiliser la classe DatagramSocket.

boolean isPortOccupied(int port) {
    DatagramSocket sock = null;
    try {
        sock = new DatagramSocket(port);
        sock.close();
        return false;
    } catch (BindException ignored) {
        return true;
    } catch (SocketException ex) {
        System.out.println(ex);
        return true;
    }
}

N'oubliez pas d'importer d'abord

import java.net.DatagramSocket;
import java.net.BindException;
import java.net.SocketException;

Cela fonctionne pour les ports UDP. La question semble concerner les ports TCP.
Marquis of Lorne

-2

J'ai essayé quelque chose comme ça et ça a très bien fonctionné avec moi

            Socket Skt;
            String host = "localhost";
            int i = 8983; // port no.

                 try {
                    System.out.println("Looking for "+ i);
                    Skt = new Socket(host, i);
                    System.out.println("There is a Server on port "
                    + i + " of " + host);
                 }
                 catch (UnknownHostException e) {
                    System.out.println("Exception occured"+ e);

                 }
                 catch (IOException e) {
                     System.out.println("port is not used");

                 }

1
Pas ce qui a été demandé.
Marquis of Lorne

Et aussi une fuite de prise.
Marquis of Lorne
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.