Software Factories WS 2016/17. Prof. Dr. Dirk Müller. 4 Eclipse und Plug-ins

Transkript

1 Software Factories 4 Eclipse und Plug-ins Prof. Dr. Dirk Müller

2 Übersicht Eclipse als besondere IDE und als Programmplattform Geschichte RCP-Anwendungen Plug-ins in Eclipse Kommunikation zwischen Plug-ins Entwicklung einer RCP-Anwendung 2/65

3 Entwicklungsplattform Eclipse keine IDE im herkömmlichen Sinn: Plug-in-Technologie Eclipse besteht selbst (weitgehend) aus Plug-ins erweiterbar und dynamisch anpassbar mittels Plug-ins aktuelle Version: (Neon) Eclipse ist ein Java-Programm, keine JRE Workbench: Desktop-Entwicklungsumgebung Perspektiven enthalten jeweils Editoren, Sichten, Menüs Workspace als Ablageort für Projektdaten 3/65

4 Geschichte der Rich Client Platform IDE Eclipse RCP 3 Eclipse RCP Quelle: [1], S Neon 4.5 Mars 4.4 Luna 4.3 Kepler 3.8/4.2 Juno 3.7/4.1 Indigo 3.6/4.0 Helios 3.5 Galileo 3.4 Ganymede Command-Framework 3.3 Europa 3.2 Callisto Action-Framework /65

5 Besonderheiten von Eclipse Komponentenmodell seit Eclipse 3.0 (2004) komponentenbasierte SW-Entwicklung => Plug-ins OSGi (Open Services Gateway initiative) ausgewählt Equinox als Referenzimplementierung meistens genutzt Service Bundles deklarativ definiert dynamisches (De-)Installieren, Aktualisieren von Bundles Extraktion des Kerns jeder Entwicklungsumgebung nahtlose Erweiterbarkeit Anpassbarkeit an Domäne, domänenspezifische Sprache (DSL) verteiltes Arbeiten im Team gut unterstützt Release jährlich im Juni (simultan seit 3.2) Open-Source-SW, aber Beteiligung von IBM, Borland, Intel Auszeichnung: ACM Software System Award /65

6 Architektur von Eclipse Eclipse besteht aus Subsystemen, die auf einer Runtime-Maschine arbeiten (= Eclipse-Kern) SWT ist das Standard Widget Toolkit (quelloffen) für Java JFace ist ein UI-Framework und enthält Klassen, die von UI-Plug-ins benötigt werden Team ist ein Subsystem zur Unterstützung der Versionsverwaltung 6/65

7 Komponente und Plug-in Komponente: Softwarebaustein mit semantisch zusammengehörender Funktionalität, die nach außen über Schnittstellen genutzt werden kann Plug-in [..] der od. das; -s, -s <engl.;»das Anschließen«>: (EDV) kleines Softwareprogramm, das in eine größere Anwendung integriert werden kann Quelle: Duden - Das Fremdwörterbuch, 8. Aufl. Mannheim 2005 [CD-ROM] Synonyme: Modul, Service Bundle Rich Client Platform (RCP) Teil der Eclipse-Plattform, mit dem sich ClientAnwendungen beliebiger Art entwickeln lassen [1], S. 454 Plug-in Development Environment (PDE) Teile der Eclipse-IDE zur komfortablen Entwicklung von RCP-Anwendungen [1], S /65

8 Lebenszyklus eines Plug-ins install update Installed Starting start update Resolved uninstall activate Active stop uninstall resolve stop resolve Uninstalled Stopping Quelle: [1], S. 20 8/65

9 Steuerung des Lebenszyklus 9/65

10 Thin, Fat, Rich Client Thin Client Webseiten im Browser als Nutzerschnittstelle, somit plattformunabhängig, aber geringe Nutzerfreundlichkeit Anwendungslogik beim Server einfache Verteilung und Installation Fat Client Präsentation und Anwendungslogik beim Client, somit nutzerfreundlich komplizierte Verteilung und Installation häufig plattformabhängig monolithische Strukturen Rich Client: Delta zum Fat Client einheitliches Komponentenmodell integrierte Update-Fähigkeit Quelle: [2] bessere Erweiterbarkeit 10/65

11 Client-Server-Architektur: Verteilungsarten Netzwerk permanent nötig Hardware für Client billiger Grundlage für WebArchitektur, die über HTTP und Browser läuft Anwendungen müssen an alle Clients in verschiedenen Versionen (OS) verteilt werden Netzwerk nicht permanent nötig Quelle: [Bal11], S. 194 ff. 11/65

12 Rich Client Platform (RCP) RCP-Anwendungen (fast) nur aus Plug-ins aufgebaut z.b.: Eclipse-IDE sehr mächtig, auch für Geschäftsanwendungen universelle Java-Plattform für Desktop-Anwendungen jetzt auch für Webanwendungen Remote Application Platform (RAP), früher: Rich Ajax Platform Feature Gruppierung von Plug ins (wie auch bei Plug ins) mit Versionsnummer Product Anwendung mit Branding Update Site Verzeichnis (lokal oder auf Server) zum Installieren oder Verwalten von Features 12/65

13 Alles ist ein Plug-in Plug-ins ketten sich an Plug-ins, an die sich wiederum Plug-ins ketten... Die Wurzel eines Geflechts von Plug-ins ist selbst an kein weiteres Plug-in gekettet. Wurzeln sind: org.eclipse.core.resources org.eclipse.core.runtime Erweiterungspunkte: Haken, die Plug-ins publizieren Erweiterungen: Ösen, die sich dort einhängen können Java-Klasse, die ein bestimmtes Interface implementiert Die Java-Klasse, die den Extension Point bereitstellt, ruft Methoden der Extension-Klasse über das Interface auf. Wann und wo das Plug-in in seine Extension Points eingehängte Extensions aufruft, bestimmt es selbst. 13/65

14 Eclipse: Extension-Mechanismus 14/65

15 Nutzen von Eclipse-Plug-ins Erweiterung und Anpassung von Eclipse als IDE reichhaltige Editoren (Code-Formatierung, -Vervollständigung, Templates, Korrektur-Assistent, etc.) Perspektiven, Sichten, Menüs Programmplattform RCP für Geschäftsanwendungen Entwicklung von eigenen Anwendungen auf der Basis einer minimalen Eclipse-Umgebung Eclipse als Rich Client Platform (RCP) minimale Menge org.eclipse.ui org.eclipse.core.runtime 15/65

16 Beschreibung von Eclipse-Plug-ins Verhalten wird in Java-Quellcode beschrieben Konfiguration in speziellen Dateien, aber konsistente Änderungen über speziellen IDE-Editor sinnvoll Abhängigkeiten und Dienste Laufzeitverhalten Build-Eigenschaften META-INF\MANIFEST.MF OSGi-Manifest-Datei, u.a. Meta-Verhalten zur Laufzeit plugin.xml primäre Konfigurationsdatei einer Eclipse-RCP-3-Anwendung Erweiterungen und Erweiterungspunkte deklariert build.properties durch Registerkarte Build gesteuert Bibliotheken 16/65

17 Abhängigkeiten zwischen Plug-ins Quelle: [ClR2009] 17/65

18 Beispiel für MANIFEST.MF Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: OneTwoThree Bundle-SymbolicName: OneTwoThree;singleton:=true Bundle-Version: qualifier Bundle-Activator: onetwothree.activator Require-Bundle: org.eclipse.ui, org.eclipse.core.runtime, org.eclipse.ui, org.eclipse.core.runtime Bundle-RequiredExecutionEnvironment: JavaSE-1.8 Bundle-ActivationPolicy: lazy 18/65

19 Beispiel für plugin.xml <?xml version="1.0" encoding="utf-8"?> <?eclipse version="3.4"?> <plugin> <extension point="org.eclipse.ui.views"> <category name="sample Category" id="onetwothree"> </category> <view name="sample View" icon="icons/sample.gif" category="onetwothree" class="onetwothree.views.sampleview" id="onetwothree.views.sampleview"> </view> </extension> 19/65

20 Beispiel für build.properties source.. = src/ output.. = bin/ bin.includes = plugin.xml,\ plugin.properties,\ META-INF/,\.,\ constraints/,\ about.html src.includes = about.html javacsource = 1.5 javactarget = /65

21 Entwicklung eines Plug-ins (1/2) Rezept mit 4 Schritten Erzeugen eines Plug-in-Projektes Review des generierten Codes (optional) Build des Plug-ins Installation und Ausführung des Plug-ins Beispiel: Erzeugen einer neuen View 1. Erzeugen eines Plug-in-Projektes (5 Schritte) 1. Starten des Wizards» New Project... Auswahl: Plug-in Project 2. Plug-in-Identifier (Projekt-Name) festlegen, Java project markieren, Zielplattform festlegen 3. Versionsnummer und Provider festlegen, Generierung einer Activator-Klasse fordern, Festlegen: Plug-in soll sich auf grafische Oberfläche beziehen, Plug-in soll IDE erweitern (keine Rich Client Application) 21/65

22 Entwicklung eines Plug-ins (2/2) 4. vorgefertigte Codestücke verwenden Plug-in with a view 5. Klassennamen und View-Namen für View festlegen 2. Review des generierten Codes (optional) nach Erzeugen des Projektes ist der Plug-in-Manifest-Editor geöffnet 3.Build erfolgt manuell (oder mittels Ant-Script) Exportieren (Export Wizard) als JAR-Archiv 4.Installieren und Ausführen Eclipse beenden, JAR ins Plug-in-Verzeichnis kopieren, Neustart alternativ: Run as->eclipse Application, 2. Instanz von Eclipse öffnet ->Window->Show View->Other->Sample Category->Sample View Ergebnis: die View wird angezeigt, es gibt eine Funktionalität für einen Doppelklick und für das Kontextmenü 22/65

23 Beispiel-View Doppelklick Auswahl im Kontextmenü 23/65

24 Action-Framework Ursache Vermittlung Menübefehl Wirkung ApplicationActionBarAdvisor Symbolbefehl Action Tastaturbefehl Java-Code hoher Programmieraufwand langsamer Programmstart (Laden aller Klassen) bis 2007 Standard Quelle: [1], S /65

25 Command-Framework Ursache Vermittlung Wirkung Menübefehl Symbolbefehl Command Handler Tastaturbefehl plugin.xml deklarativer Ansatz, weniger Aufwand schneller Programmstart seit 2007, erster Schritt Richtung RCP 4 Java-Code Quelle: [1], S /65

26 Ziel: Kommunikation zwischen Plug-ins 26/65

27 Beispiel: Kommunikation zwischen Plug-ins Ziel: Fernsteuerung eines Hello-World-Plugins, Entwicklung von 2 Plug-ins, die Funktionen ausführen Plug-in A ruft über einen Erweiterungspunkt eine Funktion in Plug-in B, welche einen Text anzeigen soll Rezept 1. Plug-in-Projekt erzeugt ein Plug-in, das einen Erweiterungspunkt bereitstellt: Provider 2. Plug-in-Projekt erzeugt ein 2. Plug-in, das eine Erweiterung zum Erweiterungspunkt definiert und vom 1. Plug-in aufgerufen wird: Usage 27/65

28 Provider erstellen (1/9) Plug-in-Projekt de.htwdd.sf.provider erzeugen Nutzung der Vorlage Hello, World für Plug-in, das Menüpunkt enthält baut auf org.eclipse.ui, org.eclipse.core.runtime sowie org.eclipse.core.commands auf Methode execute der Klasse SampleHandler: public Object execute(executionevent event) throws ExecutionException { IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindowChecked(event); MessageDialog.openInformation( window.getshell(), "Provider", "Hello, Eclipse world"); } 28/65

29 Provider erstellen (2/9), Hello, World läuft 29/65

30 Provider erstellen (3/9), Erweiterungspunkt Extension Point Aufruf wird deklariert Manifest-Editor: Extension Points Add... 30/65

31 Provider erstellen (4/9), Schema erstellen Open extension point schema, um neues Element zu erstellen Neues Element: Name client Attribut class ( Element wählen New Attribute ) Typ java New Choice 1..* beliebig viele client -Extensions können die Schnittstelle nutzen Attribut class implementiert die Schnittstelle de.htwdd.sf.provider.iaufruf (nach Anlegen des Interfaces eintragen) 31/65

32 Provider erstellen (5/9), Aufruf-Definition 32/65

33 Provider erstellen (6/9), IAufruf 33/65

34 Provider erstellen (7/9), Export des Pakets 34/65

35 Provider erstellen (8/9) Aufruf der Extension anderer Plug-ins, die den Extension Point nutzen in SampleHandler.java programmieren sucht in allen Plug-ins nach der Extension de.htwdd.sf.extensionpoint.aufruf und ruft Aufruf() auf 35/65

36 Provider erstellen (9/9), execute public Object execute(executionevent event) throws ExecutionException { IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindowChecked(event); MessageDialog.openInformation( window.getshell(), "Provider", "Hello, Eclipse world"); try { IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor("de.htwdd.sf.extensionpoint.aufruf"); System.out.println("In execute des Providers..."); for (IConfigurationElement e: config) { final Object o = e.createexecutableextension("class"); if (o instanceof IAufruf) { ISafeRunnable runnable = new ISafeRunnable() public void handleexception(throwable exception) { System.out.println("Exception in client"); public void run() throws Exception { ((IAufruf)o).Aufruf(); } }; SafeRunner.run(runnable); }} } catch (Exception ex) { System.out.println(ex.getMessage()); } return null;} 36/65

37 Usage erstellen (1/4) Plug-in-Projekt de.htwdd.sf.usage erzeugen im Manifest-Editor unter Dependencies hinzufügen: de.htwdd.sf.provider unter Extensions hinzufügen: de.htwdd.sf.extensionpoint.aufruf mittels New den Client unterordnen, der durch de.htwdd.sf.usage.externeraufruf repräsentiert wird 37/65

38 Usage erstellen (2/4), Abhängigkeiten 38/65

39 Usage erstellen (3/4), Erweiterungen 39/65

40 Usage erstellen (4/4), Klasse ExternerAufruf package de.htwdd.sf.usage; import de.htwdd.sf.provider.iaufruf; public class ExternerAufruf implements IAufruf { public void Aufruf() { System.out.println("Aufruf des Plug-ins de.htwdd.sf.usage"); } } Run as Eclipse Application 2. Instanz von Eclipse öffnet sich Klicken und Beobachten der Meldungen 40/65

41 Features, Branding, Updates Feature Fea ture [': ] das; -s, -s, (auch:) die; -, -s <lat.-fr.-engl.;»aufmachung«>: [..] 3. (Jargon) typisches Merkmal, charakteristische Eigenschaft (bes. eines technischen Gerätes) Quelle: Duden - Das Fremdwörterbuch, 8. Aufl. Mannheim 2005 [CD-ROM] hier: Gruppe von zusammengehörigen Plug-ins, zur besseren Übersicht und zur einfacheren Verteilung/Aktualisierung (s.u.) Branding Fenstersymbole, About-Dialog, Copyright-Text Updates erstmalige Verteilung später Updates (Aktualisierungen) Cloud-Updates vs. Website-Updates 41/65

42 Feature-Projekt-Beispiel, Eigenschaften 42/65

43 Feature-Projekt-Beispiel, Auswahl der Plug-ins 43/65

44 Feature-Projekt-Beispiel, Auswahl der Plug-ins 44/65

45 Features und Branding hierarchische Gruppierung unterstützt: Included Features SWT greift über JNI direkt auf Betriebssystem zu identische Java-Archive für jede Ziel-JVM nicht möglich Zielbetriebssystem, -fenstersystem, Sprachen, Rechnerarchitektur sind anzugeben, da plattformspezifischer Code feature.xml Konfigurationsdatei, manuelle Änderung: Gefahr der Inkonsistenz build.properties bzw. Reiter Build evtl. zusätzliche benötigte Dateien, z.b. PDF-Dateien Reiter Information Beschreibung, Copyright- und Lizenzbedingungen, Website Quelle: [1], S. 307ff. 45/65

46 Erstellung einer Eclipse-Update-Site Eclipse unterstützt die Web-basierte Verteilung und Installation von Features und Plug-ins Eclipse-Update-Site speziell konstruierte Web-Site, um Features und Plug-ins zu hosten site.xml spezielle Beschreibung in Form einer Manifest-Datei Eclipse-Update-Manager kann die site.xml lesen und daraufhin Updates automatisch laden und installieren 46/65

47 Update-Site-Beispiel Wichtig! 47/65

48 Update-Site-Beispiel 48/65

49 Update-Site-Beispiel abschließend unter Reiter Archives URL eintragen Build All komplettes Verzeichnis incl. Unterverzeichnissen in das URL-Verzeichnis kopieren bzw. ins Web hochladen Feature mit gewöhnlichem Eclipse-Mechanismus installieren/deinstallieren Help Install New Software... unter Work with obige URL eintragen 49/65

50 Entwicklung von RCP-Anwendungen Rich Client Platform (RCP): minimale Menge von Plug-ins zum Bau einer Rich Client Application mit grafischer Benutzeroberfläche org.eclipse.ui org.eclipse.core.runtime Eine RCP-Anwendung nutzt nur die benötigten Teile (Plug-ins) der Eclipse-IDE. 50/65

51 Architektur einer RCP-Anwendung Beispiel: Eclipse-IDE IDE User Interface Workspace/ Resources Compare/ Search Workspace based Document Editors Java Development Tools (JDT) Rich Client Platform Workbench JFace Plug-in Development Environment (PDE) eigene Plug-ins Team Help SWT Workspace OSGi-Runtime (Equinox) Quelle: [1], S /65

52 RCP-Anwendung und -Produkt benötigte Plug-ins org.eclipse.ui org.eclipse.core.runtime Eine Eclipse-RCP-Anwendung muss folgende Elemente definieren: eine Hauptklasse, die IApplication implementiert (Erweiterunspunkt org.eclipse.core.runtime.application) eine Perspektive ApplicationWorkbenchAdvisor, unsichtbare technische ApplicationWorkbenchWindowAdvisor und Komponenten ApplicationActionBarAdvisor Ein Produkt (von Eclipse unabhängige Anwendung) enthält alle Plug-ins, von denen es abhängt einen native launcher (Kommando) Branding (Icons etc.) 52/65

53 Entwicklung eines RCP-Plug-in-Projektes (1/5) 53/65

54 Entwicklung eines RCP-Plug-in-Projektes (2/5) Etwas Zeit vergeht... 54/65

55 Entwicklung eines RCP-Plug-in-Projektes (3/5) 55/65

56 Entwicklung eines RCP-Plug-in-Projektes (4/5) Steuerung des Lebenszyklus (start, stop, etc.)) Festlegung der Actions der Anwendung Erzeugung des WindowAdvisor, Festlegung der Standardperspektive Erzeugung des ActionBarAdvsior, Konfiguration des Workbench-Fensters Icons für verschiedene Betriebssysteme, z.b. XPM für Linux, ICNS für Mac OS X und ICO für Windows Begrüßungsbild beim Start der Anwendung 56/65

57 Entwicklung eines RCP-Plug-in-Projektes (5/5) Eclipse Runtime wertet aus, welche Klasse über den Erweiterungspunkt org.eclipse.core.runtime.application definiert ist Begrüßungsbild für kurze Zeit gezeigt 57/65

58 Produkt und Anwendung Ein Produkt definiert alle Ressourcen, die mit der Applikation geliefert werden. Ein Produkt ist ein Entwicklungsartefakt, das das Abarbeiten der Anwendung außerhalb von Eclipse erleichtert. Die Eclipse-Anwendung entspricht der Klasse, die normalerweise die Java-Methode main enthält. Anwendungen werden über den Erweiterungspunkt org.eclipse.core.runtime.applications definiert und müssen IApplication implementieren. Einem Produkt ist immer eine Anwendung zugeordnet. Die Produkt-Konfiguration wird in der Datei <name>.product definiert. 58/65