TV-Browser mit Eclipse bauen

Aus TV-Browser Wiki
Version vom 5. Mai 2009, 18:07 Uhr von Bananeweizen⧼word-separator⧽⧼parentheses⧽ ⧼parentheses⧽
⧼revision-nav⧽
Wechseln zu: Navigation⧼comma-separator⧽Suche

Diese Anleitung beschreibt, wie man TV-Browser in Eclipse entwickeln, compilieren und debuggen kann. Eine Alternative dazu ist das Bauen auf der Kommandozeile, das wir aber nicht empfehlen.

Benötigte Tools

Um an TV-Browser in Eclipse arbeiten zu können, braucht man folgendes:

Name Beschreibung URL
JDK 1.6 Zum Übersetzen des Java-Quellcodes und zum Ausführen von Eclipse http://java.sun.com/javase/downloads/index.jsp
Eclipse Die Entwicklungsumgebung; am besten die aktuelle Version herunterladen! http://www.eclipse.org
Subclipse SVN-Plug-in für eclipse; Anleitung zur Installation http://subclipse.tigris.org/

Empfohlene Tools

Die folgenden Tools sind nicht zum Bauen des TV-Browser notwendig, erleichtern aber die Arbeit mit dem TV-Browser-Quellcode:

Eclipse vorbereiten

  1. JDK 1.6 oder höher installieren (sofern noch nicht vorhanden)
  2. Eclipse installieren
  3. Subclipse installieren (Anleitung)

TV-Browser auschecken

Lege einen neuen Workspace an, damit du den TV-Browser nicht mit anderen Projekten durcheinander wirfst. Danach kannst du den TV-Browser-Quellcode aus dem Repository holen. Dazu geh auf "File" -> "New" -> "Other" und wähle unter "SVN" "Checkout Project from SVN".

Wenn es diesen Eintrag in der Projektauswahl bei dir nicht gibt, hast du das Subclipse-Plugin nicht installiert. Schau nochmal weiter oben nach.

Jetzt wähle "Create a new repository location". Als URL gib https://tvbrowser.svn.sourceforge.net/svnroot/tvbrowser ein. Markiere im neu angelegten Repository das Unterverzeichnis "trunk"->"tvbrowser" und beende den Dialog mit einem Klick auf "Finish".

Java-Projekt anlegen

Im neu erscheinenden Dialog zum Anlegen eines Projektes wähle "Java Project". Gib dem Projekt einen sinnvollen Namen wie "TV-Browser". Prüfe die Einstellung "JRE" in diesem Dialog. TV-Browser muss für Java 6 compiliert werden. Wenn also eine JRE mit einer Version kleiner als Java 6 ausgewählt ist, dann benutze "Use a specific execution environment" und stelle Java 6 ein. Achtung: Wenn du auch Code ändern willst, dann benutze nach Möglichkeit auch keine JRE mit einer höheren Version als Java 6. Es kann sonst passieren, dass du Methoden in deinem Quellcode verwendest, die erst in höheren Java-Versionen vorhanden sind. Beim Entwickeln führt das dann nicht zu Compilierfehlern, aber zur Laufzeit gibt es dann eine Exception.

Bei "Project layout" wähle "Create separate source and output folders" und beende den Dialog mit "Finish".

Betriebssystemspezifischen Code ausschließen

Jetzt braucht der Computer eine Weile, um alles herunterzuladen. Wenn er fertig ist, wird er sehr viele Compilerfehler anzeigen, da die Projektorganisation noch nicht vollständig ist. Markiere die *.jar-Bibliotheken im Unterverzeichnis "lib", und wähle im Kontextmenü "Add to build path".

Nach dem (automatischen) erneuten Übersetzen des Projektes sind nur noch wenige Fehlermeldungen vorhanden. Sie beziehen sich alle auf Plugins und Quellcode, die betriebssystemspezifische Anteile enthalten (z.B. für MacOS), die unter deinem eigenen Betriebssystem nicht übersetzt werden können. Falls dich die Fehlermeldungen stören, schließe einfach ein paar Plug-ins aus dem src-Verzeichnis aus. Dazu kannst du im Projektnavigator jeden Ordner (z.B. tvbrowser.ui.mainframe.macos) einzeln im Kontextmenü über "Build Path" -> "Exclude" ausschließen.

Starten und Debuggen

Aus den Quelltexten kann nun der ausführbare Code erzeugt werden. Der TV-Browser benötigt zum Starten aber noch zusätzliche Dateien wie Bilder und Icons. Am einfachsten ist es, wenn du das vorhandene Installationsverzeichnis des TV-Browsers auf der Festplatte einmal komplett kopierst (zum Beispiel unter "TV-Browser development").

Zum Starten innerhalb von Eclipse legst du eine Launch Configuration an. Benutze dazu "Run As" -> "Run..." aus dem Kontextmenü des Projektes. Lege beim Punkt "Java Application" per Klick auf den "New"-Button eine neue Konfiguration an, bei der du folgende Werte ergänzen musst:

  • Seite "Main"
    • Main class: tvbrowser.TVBrowser
  • Seite "Arguments"
    • VM arguments: -Dpropertiesfile=windows.properties
    • Workspace directory: "Other" -> "File system" -> Pfad zum vorhin kopierten Verzeichnis

Mit einem Klick auf "Run" sollte der TV-Browser jetzt starten. Zum Debuggen kann die gleiche Launch Configuration benutzt werden, es muss nur "Debug" aus dem Kontextmenü des Projektes benutzt werden.

Weitere empfohlene Plugins

Die folgenden Plugins sollten bei Arbeiten am TV-Browser ebenfalls installiert sein, da sie das Leben erleichtern:

  • FindBugs: entdeckt typische Fehlermuster im Code, die man als Entwickler immer fixen sollte.
  • PMD: eine weitere statisches Codeanalyse; findet noch mehr potentielle Probleme im Code, hat dafür aber auch viele falsch positive
  • Unnecessary code detector: kann nicht mehr verwendeten public Code entdecken. Vorsicht bei allen tool- und util- Klassen!