Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.
Auszug
hiddentrue

Nuclos API Festlegungen: Benennung, insert, update, delete, Id, UID, Exception, Dispatch Thread, Code Style.

globe with meridians Sprache: Deutsch · English

open book Festlegungen für Nuclos API Entwicklung

Konventionen für die Nuclos-API – Benennung von Methoden/Ids und Regeln für die Fehlerbehandlung.

Status
colourGrey
titleReferenz
Status
colourBlue
titleEntwickler
Status
colourGreen
titleStand: Jul 2026
Status
colourGrey
titlegilt fuer Nuclos 4.2026.x

Panel
bgColor#F4F5F7

Auf dieser Seite

Inhalt
maxLevel2
minLevel2

Verbindliche Konventionen für die Entwicklung mit der Nuclos-API – für konsistenten, wartbaren Code.

Benennung

RegelBeispiel
Collections: Suffix ...All()insert(BusinessObject) vs. insertAll(Collection<BusinessObject>)
Löschen: deletenicht remove, drop
Einfügen: insertnicht new, create
Aktualisieren: updatenicht modify
Ids: Id statt IDgetId(), Rückgabe-Methoden enden auf ...Id()
Id-Datentypimmer Long bzw. UID

Fehlerbehandlung

  • Exceptions nie still abfangen – mindestens eine Warnung ins Log schreiben.
  • Auf dem Dispatch-Thread keine RuntimeException (z.​B. CommonFatalException) werfen – das bringt die GUI zum Absturz/Einfrieren.
  • Möglichst keine allgemeinen Exception/RuntimeException fangen; wenn nötig, so minimal wie möglich.
  • Lange Methodenketten vermeiden – sie sind schlecht zu debuggen und liefern nichtssagende Stacktraces.
Info
titleBeispiele

Beispiele für sauberen Stil: Code Style sowie schlechtrichtig.

Verwandte Seiten

gear Code Style


Stil.

Öffnen →

gear Hilfsmittel


UIDGenerator.

Öffnen →