Weiter zum Inhalt

D) Java-Anwendung nur einmal ausführen

Den SingleInstanceController verwenden

Um den SingleInstanceController in Ihrer Applikation einzusetzen, können Sie sich an dieser Beispielapplikation orientieren:

package de.jbb.sic;

import java.io.File;

public class Example {

  private SingleInstanceController sic = null;

  public Example() {

    this.sic = new SingleInstanceController(new File(System.getProperty("java.io.tmpdir") + "Example.file"), "sic_example_application");
    if (this.sic.isOtherInstanceRunning()) {
      this.sic.sendMessageToRunningApplication("You're still running!?");
      this.sic.sendMessageToRunningApplication("ByeBye");
      System.exit(0);
    }
    else {
      this.sic.registerApplication();
      this.sic.addApplicationStartedListener(new ApplicationStartedListener() {

        public void applicationStarted() {
          System.out.println("First Instance: An other instance started");
        }

        public void foreignApplicationStarted(String name) {
          System.out.println("First Instance: A foreign application started on this port");
        }

        public void messageArrived(Object obj) {
          System.out.println("Other Instance: " + obj.toString());
          if (obj.equals("You're still running!?")) {
            System.out.println("First Instance: Yes, of course!");
          }
          else if (obj.equals("ByeBye")) {
            System.out.println("First Instance: bye ...");
          }
        }
      });
    }
  }

  public static void main(String[] args) {
    new Example();
  }
}

{ 21 } Comments

  1. Illuvatar | 29. Dezember 2008 um 12:31 | Permalink

    Eine kleine Anmerkung zur FileLock-Methode: Seit Java NIO gibt es die Möglichkeit, “echte” File-Locks zu realisieren. Hierzu wird die Methode FileChannel#tryLock verwendet.

    Dadurch fallen ein Großteil der Nachteile weg. Eine Kommunikation ist allerdings immer noch nicht möglich. Solch ein FileLock wird aber eben automatisch aufgehoben sobald das Programm nicht mehr läuft. Das wichtige Kriterium wäre nicht mehr, ob die Datei existiert, sondern ob tryLock ein FileLock oder null zurückgibt. Ob die Datei noch existiert, kann dafür als Kriterium verwendet werden, ob das Programm sauber beendet wurde.

  2. Stefan Kiesel | 29. Dezember 2008 um 12:55 | Permalink

    Hallo Illuvatar,

    vielen Dank für deinen Beitrag. Ich habe die tryLock Methode der Klasse FileChannel nicht angesprochen, da das Verhalten von FileLock sehr systemspezifisch ist, und eine Kommunikation zwischen den beiden Applikationen nicht mehr möglich wird.

    Bei Gelegenheit werde ich dieses Verfahren als kleinen Zusatz aber ergänzen.

    Gruß
    Stefan

  3. pcworld | 16. April 2009 um 15:10 | Permalink

    Super Tutorial!

    Sowas hätte ich denke ich kaum zu Stande gebracht, zumindest nicht so genau :-)

    Gruß,
    pcworld

  4. Stefan | 4. November 2009 um 15:54 | Permalink

    SingleInstanceController.this.client.getInetAddress().getCanonicalHostName()
    liefert bei mir “127.0.0.1″ statt “localhost”. Damit akzeptiert der Server den Client nicht und die Sache geht schief.

    Scheint eine Eigenheit von MS-Vista zu sein? Hab’ verschiedene JDKs probiert.

  5. Stefan Kiesel | 4. November 2009 um 19:42 | Permalink

    Hi Stefan,

    ein solches Problem ist mir nicht bekannt. Ich habe den Quellcode aber einmal ausgebessert. Anstatt von getCanonicalHostName().equals("localhost") wird jetzt einfach isLoopbackAddress() geschrieben.

    Über eine Rückmeldung, ob es jetzt funktioniert oder nicht, würde ich mich freuen.

    Gruß
    Stefan

  6. Stefan | 5. November 2009 um 12:19 | Permalink

    Hi Stefan,

    ja. Das klappt jetzt auch unter Vista.

    Danke und schöne Grüße,
    Stefan

  7. Stefan | 15. Dezember 2009 um 12:14 | Permalink

    Ich muss in main() explizit System.exit() aufrufen sonst hängt das Programm bis ich Ctl-C drücke. Da wartet die JVM bis sich der Thread beendet.
    Könnte helfen: http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html#setDaemon(boolean)

  8. Stefan Kiesel | 15. Dezember 2009 um 12:22 | Permalink

    Hallo Stefan,

    ich kann leider gerade nicht nachvollziehen, wovon Sie reden. Das System.exit(0); in der Example Klasse kann auch ohne Probleme weggelassen werden.

    Grüße
    Stefan

  9. Stefan | 15. Dezember 2009 um 12:53 | Permalink

    Nicht in der Klasse sondern im main() muss ich
    exit-en sonst hängt das Programm.

    public static void main(String[] args) {
    new Example();
    System.exit();
    }

    Passiert auf Ubuntu Java Version 1.6.0_14
    Ich denke der exit bricht den Thread ab. Sonst wartet die JVM bis sich der Thread selbst beendet (was er nicht tut).

  10. Stefan Kiesel | 15. Dezember 2009 um 13:01 | Permalink

    Kann ich leider nicht nachvollziehen, hab auch leider keine installierte Ubuntu-Version. Nur damit es zu keinen Missverständnissen kommt: Das zuerst gestartete Programm soll bis zu einem manuellen Abbruch durchlaufen. Alle weiteren Instanzen beenden sich sofort nach dem Start und dem Austausch der Nachrichten selbst.

    Grüße
    Stefan

  11. Klaus Brokmann | 10. Februar 2011 um 17:35 | Permalink

    Hallo,
    ich benutze auch die Logik mittels ServerSocket, wie zu Beginn unter “Einen Port sperren” beschrieben!
    Seltsamerweise wird die Exception (bei mir ist es übrigens keine IOException, sondern eine BindException – ich fange aber alle ab) nicht auf allen Rechner in der Firma geworfen (auf ca. 10% nicht).
    Hat jemand eine Idee, woher das kommen kann ???
    Danke und Gruß
    Klaus

  12. Stefan Kiesel | 12. Februar 2011 um 15:59 | Permalink

    Hallo Herr Brokmann,

    vermutlich läuft unter dem gewählten Port auf bestimmten Rechnern in der Firma bereits eine andere Anwendung. Entweder müssen Sie diese Anwendung(en) identifizieren und beenden, oder – was die vermutlich leichtere Lösung ist – einen anderen Port wählen.

    Gruß
    Stefan

  13. Klaus Brokmann | 14. Februar 2011 um 08:48 | Permalink

    Guten Morgen Herr Kiesel,
    Danke für die schnelle Antwort!
    Ich bemerke gerade, dass ich mich vlt. etwas unglücklich ausgedrückt habe …
    Auch ich möchte mittels des Code prüfen, ob bereits eine Instanz der betroffenen Applikation läuft. Dazu lege ich genau so wie oben beschrieben, zu Beginn eine neue Socketvariable an und fange dann ggf. die Exception ab, um dabei dann ggf. die Applikation zu beenden!
    Dies klappt wie gesagt auf den meisten PCs sehr gut, nur auf einigen wird die Exception leider nicht geworfen, und dann wird die Anwendung ein zweites Mal gestartet!

    Hier mal der relevante Code, den ich eigentlich für fehlerfrei halte :

    static ServerSocket listenerSocket = null;
    // ...
    try
    {
        listenerSocket = new ServerSocket( nMutexServerport );
    }
    catch( Exception ex )
    {
        ex.printStackTrace( );
        JOptionPane.showMessageDialog( this,
                                        "Es ist bereits ein Worker auf diesem System aktiv.\n" +
                                        "Sollte dies nicht der Fall sein, bitte den Rechner neu starten !",
                                        "Fehler", JOptionPane.ERROR_MESSAGE, null );
        System.exit( -2 );
    }

    Freundliche Grüße
    Klaus Brokmann

  14. Stefan Kiesel | 14. Februar 2011 um 19:10 | Permalink

    Ihr Code ist soweit fehlerfrei. Sind Sie sicher, dass beide Applikationen zu der Zeile “listenerSocket = new ServerSocket(nMutexServerport);” gelangen und nicht vorher abgebrochen werden oder einen anderen Weg (if-Abfrage) wählen können? Können Sie sicherstellen, dass nMutexServerport für beide Anwendungen exakt identisch ist? Können Sie sicherstellen, dass beide Anwendungen noch laufen?

    Ansonsten versuchen Sie es doch mal primitiv mit einer einfachen Main-Klasse, die Sie zweimal hintereinander ausführen:

    public class Main {
    
      public static void main(String[] args) throws Exception {
        new ServerSocket(5892).accept();
      }
    }

    Wenn ich mich nicht vertippt habe (gerade alles aus dem Kopf und ohne Compiler und IDE) sollte dann beim zweiten Ausführen eine Fehlermeldung erscheinen. Passiert das bei Ihnen (wovon ich einmal stark ausgehe), dann ist der Fehler nicht in dem von Ihnen geposteten Codeausschnitt zu suchen.

    Grüße
    Stefan

  15. Klaus Brokmann | 15. Februar 2011 um 09:24 | Permalink

    Guten Morgen,
    ja, alle Aufrufe erreichen zwangsläufig die Stelle (ist zentral zu Beginn der main-Funktion); das habe ich auch im Debugger überprüft.

    Der Port ist ebenfalls zentral so deklariert:
    // Mutexserverport zur Instanzenkontrolle
    public static final int nMutexServerport = 62987;

    Der Aufruf mit “.accept()” klappt hier nicht, da dieser genannte Port vermutlich nicht in der Firewall resp. im Proxy freigegeben ist (die Anwendung wartet dann ‘ewig’ auf . Ich möchte ja auch nicht damit arbeiten, sondern ihn nur zu Instanzenkontrolle nutzen

    Mir fiel eben noch auf, dass mit dem von Ihnen oben beschriebene Aufruf
    new ServerSocket(nMutexServerport );
    KEINE Exception bei mir auslöst !

    Nur für den Fall
    listenerSocket = new ServerSocket( nMutexServerport );
    tritt (beim zweiten Aufruf) die Bind-Exception auf und das “listenerSocket”-Objekt ist dann null.

    Ist schon alles sehr seltsam … :-(

    Freundliche Grüße
    Klaus

  16. Stefan Kiesel | 15. Februar 2011 um 18:16 | Permalink

    Hallo Herr Brokmann,

    das accept() ist schon so beabsichtigt. So wartet Ihr Programm, bis sich jemand zu diesem ServerSocket verbindet. Da dies nicht geschehen wird, wartet das Programm ewig (bzw. bis Sie es abbrechen). Hierdurch wird wiederum gewährleistet, dass das erste Programm (die erste Ausführung) noch läuft und auch noch den ServerSocket gebunden hat, wenn Sie das Programm ein zweites Mal ausführen, so dass es zu einem Fehler kommt.

    Bitte versuchen Sie es noch einmal auf die von mir beschriebene Art und Weise.

    Grüße
    Stefan Kiesel

  17. Klaus Brokmann | 15. Februar 2011 um 18:19 | Permalink

    Hallo Herr Kiesel,
    damit wartet dann aber auch die erste Anwendung ewig – und ich komme dort nicht mal bis zum Anmeldedialog, geschweige denn, dass ich arbeiten kann !!
    Ich möchte ja nur beim zweiten Aufruf die Exception bekommen, um den zweiten Aufruf zu canceln !
    Freundliche Grüße
    Klaus Brokmann

  18. Stefan Kiesel | 15. Februar 2011 um 21:52 | Permalink

    Natürlich wartet so die erste Anwendung ewig. Sie sollen das ja auch nicht in Ihre Anwendung einbauen, sondern nur so wie es ist (ohne auch nur eine Zeile Code zu verändern) ausführen und testen ;-) . Dieses kleine Programm soll Ihnen lediglich beweisen, dass der Fehler nicht an dem von Ihnen geposteten Codeschnipsel liegt. Und diesen Beweis bringt es, wenn Sie das Programm genau in dieser Form kompilieren, zweimal ausführen und beim zweiten Mal ausführen eine Exception geworfen wird.

    Um auf mögliche Fehlerursachen Ihres eigentlichen Problems zurück zu kommen:

    Genaues kann man natürlich nur sagen, wenn man einen aussagekräftigeren Teil Ihres Codes zu Gesicht bekommt, da der Fehler (wie gesagt) in Ihrem uns zur Verfügung gestellten Teil garantiert nicht liegt. Natürlich versteh ich auch, wenn Sie nicht einfach Code Ihrer Firma hier veröffentlichen können. Deshalb ein paar allgemeine Tipps:

    1.) Könnte evtl. irgendwo eine unabgefangene Exception geworfen werden, die das schließen des Sockets bewirkt?
    2.) Sie wissen wie der GarbageCollector in Java arbeitet? Wenn Ihr Objekt nirgends mehr referenziert wird und der GarbageCollector das feststellt, wird Ihr Objekt irgendwann aufgeräumt.
    3.) Aus Ihrem letzten Kommentar schließe ich, dass Sie eine GUI verwenden. Eine Swing-GUI läuft in Java in einem separierten Thread. Nach Abarbeitung Ihrer Main-Methode wird der Thread, in welchem die Main-Methode gestartet wurde, beendet. Es läuft folglich nur noch der GUI-Thread. Könnte evtl. hier im Bezug auf die Erzeugung des ServerSockets das Problem liegen?

    Nach Ihrer Aussage

    // Zitat
    new ServerSocket(nMutexServerport );
    KEINE Exception bei mir auslöst !

    Nur für den Fall
    listenerSocket = new ServerSocket( nMutexServerport );
    tritt (beim zweiten Aufruf) die Bind-Exception auf und das “listenerSocket”-Objekt ist dann null.
    // Zitat Ende

    sollten Sie insbesondere die Punkte 2 und 3 in Betracht ziehen.

    Grüße
    Stefan

  19. Klaus Brokmann | 16. Februar 2011 um 08:46 | Permalink

    Hallo Stefan,

    ah, die Punkte 2 und 3 habe ich so noch nicht ernsthafter in Betracht bezogen …
    Ok, ich werde mal versuchen, die Anwendung dahingehend zu testen! Referenziert wird die Variable sicherlich nirgendwo mehr – das könnte in der Tat vlt. ein Knackpunkt sein …

    Ich melde mich, sobald ich weitere Ergebnisse habe!
    Zuerst nochmals vielen Dank für die Unterstützung!
    Freundliche Grüße
    Klaus

  20. Maik Jäkel | 24. Juni 2011 um 11:38 | Permalink

    Hallo Herr Kiesel,

    gibt es einen speziellen Grund dafür, dass sie das FileLock per ShutDown-Hook-Thread löschen? Ich hätte spontan einfach die deleteOnExit()-Methode des Files verwendet. Gibt es hierbei einen Unterschied, den ich noch nicht kenne?

    Viele Grüße
    Maik Jäkel

  21. Stefan Kiesel | 24. Juni 2011 um 15:13 | Permalink

    Hallo Herr Jäkel,

    ja, den gibt es. Ich zitiere die API-Doc für deleteOnExit:

    “Deletion will be attempted only for normal termination of the virtual machine, as defined by the Java Language Specification.” und “Note: this method should not be used for file-locking, as the resulting protocol cannot be made to work reliably”

    Ein Shutdown-Hook hingegen wird auch dann ausgeführt, wenn die VM auf abnormalem Wege terminiert.

    Grüße
    Stefan

Kommentar verfassen

Dein E-Mail wird nicht veröffentlicht oder weitergegeben. Pflichtfelder sind mit * markiert.
*