Anforderungen an eine Bibliothek für Kommandozeilenparameter (in Java)

vorhergehende Artikel in: Java Komponenten
12.12.2023

Als ich mich neulich mit einer Idee für eine Java-Anwendung beschäftigte wurde schnell klar, dass das eine Kommandozeilenanwendung werden würde, die über eine so große Flexibilität verfügen würde, dass eine robuste Möglichkeit zum Parsen von Kommandozeilenparametern eine Grundvoraussetzung für das Gelingen wäre.

Also machte ich mir zunächst einmal Gedanken darüber, welche Anforderungen ich an eine solche Bibliothek stellen würde.

Als Erstes würde ich fordern, dass jeder Parameter eine Kurz- und eine Langform hätte - also es zum Beispiel einen Parameter gäbe, der mittels -o und mittels --output anzusprechen wäre

Es müsste Parameter geben, die einfache Schalter wären und solche, die einen Wert zugewiesen bekommen könnten. Also etwa -v als Schalter für ausführliches Logging gegenüber -i input.txt als Beispiel für einen Parameter, der einen Dateinamen enthalten soll.

Schalter-Parameter sollten zusammenfassbar sein. Statt -v -a -b sollte es also möglich sein (und dasselbe Ergebnis haben), -vab zu schreiben.

Parameter sollen als obligatorisch gekennzeichnet werden können und diese Tatsache soll beim Parsen der Kommandozeile geprüft werden.

Es soll möglich sein, Parameter, die einen Wert zugewiesen bekommen auch mehrfach auf der Konnadozeile anzugeben - daraus soll dann eine Liste von Werten entstehen, die die Anwendung benutzen kann. Auf der Kommandozeile soll also zum Beispiel -c base.cnf -c user.cnf möglich sein.

Es soll möglich sein, für Parameter Default-Werte zu vereinbaren. Schalter haben prinzipiell den Default-Wert False. Dadurch ist es nicht nötig, für Schalter-Parameter etwa zwischen -v und +v zu unterscheiden.

Für Parameter sollen Beschreibungstexte angegeben werden, aus denen das Framework selbstständig einen Hilfetext generieren kann, der ausgegeben wird, wenn als Parameter -h oder --help angegeben wird.

Das Framework sorgt dafür, dass die Anwendung nach Ausgabe des Hilfetextes beendet wird, wenn es beim Parsen der Kommandozeile auf -h oder --help stößt.

Es soll möglich sein, zu spezifizieren, dass Parameter nicht nur simple Strings als Werte haben, sondern mindestens auch Ganzzahlen oder Gleitkommazahlen (Integer und Float/Double)

Für Parameter soll es möglich sein, Validierungen anzugeben, die beim Parsen der Kommandozeile sofort geprüft werden.

Schlägt die Prüfung einer solchen Validierung fehl oder fehlt ein als obligatorisch markierter Parameter ohne Default-Wert, soll das Framework nach Ausgabe einer aussagekräftigen Fehlermeldung die Anwendung ebenfalls sofort beenden.

Die Hilfetexte und Beschreibungen sollen internationalisierbar sein, die Kurz- und Langformen der Parameternamen müssen nicht internationalisierbar sein.

Die Bibliothek soll nur minimale Abhängigkeiten zu weiteren Bibliotheken / Komponenten mitbringen - idealerweise ist ihre einzige Abhängigkeit die zu einer Komponente für das Logging.

Alle Argumente, die nicht als Parameter geparst werden können, werden in einer Liste gesammelt und der Anwendung übergeben. Um auch Zeichenketten, die Kurz- oder Langformen von Parametern entsprechen an die Anwendung übergeben zu können existiert ein spezieller Parameter - zum Beispiel -- - der das Parsen beendet und alle dahinter folgenden Argumente ungeparst an die Anwendung weiterreicht.

Derzeitig ausdrücklich nicht im Fokus eines solchen Frameworks stehen komplexere Abhängigkeiten wie etwa bestimmte Parameter nur dann zu Pflichtparametern zu machen, wenn bestimmte Schalterparameter gesetzt (oder nicht gesetzt) sind. Solcherart komplexere Zusammenhänge müssen durch die jeweilige Anwendungslogik selbst beschrieben und validiert werden.

Es wäre schön, wenn ich eine bereits vorhandene Bibliothek benutzen könnte und diese unter einer (mir) angenehmen Lizenz wie etwa der MIT License oder der Apache License verfügbar wäre.

Ich werde nach einer ersten Analyse verfügbarer Libraries Picocli einer genaueren Analyse und ausführlichen Tests unterziehen (Lizenz: Apache License 2.0).

Alle Artikel rss Wochenübersicht Monatsübersicht Github Repositories Gitlab Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • Mandelbrot-Sets mittels Shadern berechnen

    17.05.2019

    Nachdem ich in den letzten verregneten Tagen auf Youtube in den Videos von Numberphile versunken bin, hat mich eines davon angestachelt, mich selbst mit dem Mandelbrotset zu beschäftigen. Als ich dann noch Code fand, der behauptete, das auf einer Graphikkarte mittels Shadern berechnen zu können, war es um mich geschehen...

    Weiterlesen...

Neueste Artikel

  • Erste Vor-Version eines Gis-Plugin für die sQLshell

    Wie bereits in einem früheren Artikel erwähnt plane ich, demnächst ein Plugin für die sQLshell anzubieten, das eine Visualisierung von Daten mit räumlichem Bezug im Stil eines Geoinformationssystems erlaubt.

    Weiterlesen...
  • bad-certificates Version 2.1.0

    Das bereits vorgestellte Projekt zur automatisierten Erzeugung von Zertifikaten mit allen möglichen Fehlern hat eine Erweiterung erfahren und verfügt über ein Partnerprojekt - beide sind nunmehr in der Version 2.1.0 freigegeben

    Weiterlesen...
  • SQLite als Geodatenbank

    Wie bereits in einem früheren Artikel beschrieben treibe ich derzeit Anstrengungen voran, die sQLshell attraktiver für Nutzer zu machen, die mit Geodatenbanken arbeiten.

    Weiterlesen...

Manche nennen es Blog, manche Web-Seite - ich schreibe hier hin und wieder über meine Erlebnisse, Rückschläge und Erleuchtungen bei meinen Hobbies.

Wer daran teilhaben und eventuell sogar davon profitieren möchte, muß damit leben, daß ich hin und wieder kleine Ausflüge in Bereiche mache, die nichts mit IT, Administration oder Softwareentwicklung zu tun haben.

Ich wünsche allen Lesern viel Spaß und hin und wieder einen kleinen AHA!-Effekt...

PS: Meine öffentlichen GitHub-Repositories findet man hier - meine öffentlichen GitLab-Repositories finden sich dagegen hier.