© kabzarchyk/Shutterstock.com
Dynamische Übersetzungen mit dem Eclipse Translation Pattern

Eclipse Message Extension


Um mehrsprachige Anwendungen auf Basis von Eclipse 4 zu erstellen, gibt es unterschiedliche Mechanismen. Doch keiner ist wirklich zufriedenstellend. Vor allem die fehlende Dynamik in Bezug auf Sprachwechsel zur Laufzeit ist für heutige Frameworks nicht mehr akzeptabel. Seit Luna M3 ist ein neuer Übersetzungsmechanismus in der Eclipse-Plattform integriert, der durch die Nutzung der neuen Architektur die Stärken der vorhandenen Lösungen adaptiert und die Schwachstellen behebt.

Um zu verstehen, warum ein weiterer Mechanismus für die Internationalisierung von Eclipse-Anwendungen notwendig ist, werden die bestehenden Mechanismen kurz beleuchtet. Eine genauere Beschreibung findet sich unter [1]. Grundsätzlich gibt es drei Arten von Ressourcen in einer Anwendung basierend auf Eclipse 4, die für die Mehrsprachigkeit vorbereitet werden müssen:

  • plugin.xml

  • Application Model (*.e4xmi)

  • Quellcode

Application Model und plugin.xml nutzen beide das OSGi-ResourceBundle für die Übersetzung. Es befindet sich standardmäßig unter OSGI-INF/l10n und hat den Basisnamen bundle. Über den Bundle-Localization-Eintrag in der MANIFEST.MF kann das geändert werden. Während Übersetzungen in der plugin.xml auf das OSGi-ResourceBundle beschränkt sind, nutzt das Application Model den TranslationService. Der dafür registrierte Standardservice (BundleTranslationProvider) verwendet das OSGi-ResourceBundle, lässt sich aber austauschen, um Übersetzungen aus anderen Quellen zu beziehen. Dies wurde auf diversen Konferenzen am Beispiel von Übersetzungen durch Google Translate demonstriert. Im Quellcode lassen sich Übersetzungen bisher in drei Varianten umsetzen:

  • Stringbasierte Übersetzungen: Hierbei wird das ResourceBundle direkt referenziert und über Resource­Bundle.getString(String) die Übersetzung direkt angefragt.

  • Konstantenbasierte Übersetzungen: Hierbei wird eine von NLS abgeleitete Klasse erzeugt, die für jede Übersetzung eine entsprechende Konstante enthält. Über einen statischen Initialisierungsblock werden die Werte den Konstanten zugeordnet, die Übersetzungen können an anderen Stellen über die Konstanten direkt referenziert werden.

  • TranslationService: Hierbei handelt es sich um denselben OSGi Service, der auch für die Übersetzung des Application Models verwendet wird. Im Quellcode muss der Key wie im Application Model mit einem vorangestellten %-Zeichen versehen werden. Außerdem muss das Plug-in, das die Übersetzungen enthält, anhand des Plattform-URI angegeben werden.

Alle diese Lösungen haben diverse Nachteile. Der stringbasierte Ansatz bietet keine Unterstützung innerhalb der IDE in Bezug auf Refactoring oder Code Completion. Dasselbe gilt für den TranslationService, der ebenfalls stringbasiert ist. Dieser hat zusätzlich den Nachteil, dass bei jedem Aufruf das Plug-in mit angegeben werden muss, in dem das ResourceBundle zu finden ist. Der konstantenbasierte Ansatz hat wiederum Nachteile in Bezug auf Speichermanagement. Die Klasse, die die Übersetzungen enthält, und das zugehörige ResourceBundle müssen im gleichen Classpath vorhanden sein. Eine etwas detailliertere Beschreibung der Nachteile der bestehenden Übersetzungsmechanismen kann unter [2] gefunden werden.

New Message Extension

Bei der Programmierung bietet die konstantenbasierte Lösung im Vergleich zur stringbasierten mehrere Vorteile. Dazu gehören innerhalb der IDE die Unterstützung von Code Completion, Refactoring und das Auffinden aller Stellen im Code, an denen eine bestimmte Übersetzung verwendet wird. Aus diesem Grund ist der neue Mechanismus für Übersetzungen an den konstantenbasierten Mechanismus angelehnt. Allerdings werden keine Konstanten, sondern Instanzvariablen verwendet. Dies hat zwei große Vorteile:

  • Die Übersetzungsklassen können vom Garbage Col­lector wieder aufgeräumt werden, wenn sie nicht mehr referenziert werden.

  • Die Werte können zur Laufzeit geändert werden.

Eine weitere Verbesserung gegenüber dem bestehenden NLS-Mechanismus ist technischer Natur. Dieser ist noch auf Java 1.4 aufgebaut und beinhaltet daher diverse Work­arounds bezüglich der Auflösung von ResourceBundles im OSGi-Umfeld. Das beinhaltet sowohl die Classloader-Problematik als auch die Behandlung der Fallback Locale. Aus diesem Grund werden auch nur ResourceBundles basierend auf Properties-Dateien unterstützt.

Equinox Basis-Locale Handling

Innerhalb eines ResourceBundles wird der Wert für einen Key hierarchisch von der spezifischsten hin zur Basisdatei/-klasse gesucht:

  • bundle_de_DE.properties

  • bundle_de.properties

  • bundle.properties

Bei der Suche nach einem ResourceBundle für eine bestimmte Locale wird allerdings die Default Locale mit berücksichtigt. Die Suchreihenfolge für ein ResourceBundle für die Locale fr_CA auf einem System mit Default Locale de_DE würde wie folgt aussehen:

  • bundle_fr_CA.properties

  • bundle_fr.properties

  • bundle_de_DE.properties

  • bundle_de.properties

  • bundle.properties

Problematisch wird dieses Verhalten, wenn man z. B. die englischen Übersetzungen in der Basisklasse hinterlegt, aber kein separates bundle_­en.properties erzeugt. Fragt man die Übersetzungen für die Locale en an, erhält man auf einem System mit Default Locale de_DE allerdings die deutschen Übersetzungen aufgrund der Fallback Locale. Normalerweise umgeht man dieses Problem durch Duplizieren und Erzeugen der entsprechenden Datei/Klasse. In Equinox lässt sich dieses Verhalten umgehen, indem die System-Property equinox.root.locale auf die Locale gesetzt wird, die der Basisklasse entspricht, z.B. en.

In Java 6 wurde die Klasse ResourceBundle.Control eingeführt. Diese ermöglicht es zu kontrollieren, wie ResourceBundles geladen werden, z. B. durch Definition des für die Suche zu verwendenden ClassLoaders, der Definition...

headline from sands settings