Sollten Methoden, die RuntimeException auslösen, dies in der Methodensignatur angeben?

Beispielsweise können viele Methoden in Frameworks / JDK ausgelöst werden

java.lang.SecurityException 

Dies wird jedoch nicht in der Methodensignatur angegeben (da dies normalerweise für geprüfte Ausnahmen reserviert ist). Ich möchte argumentieren, dass das Deklarieren von RuntimeExceptions in Methodensigs viele Vorteile hat (ähnlich wie beispielsweise die statische Typprüfung). Bin ich betrunken oder anders?

Ich würde keine ungeprüfte Ausnahme in der Signatur deklarieren, da dies für den Benutzer dieser API irreführend ist. Es ist nicht mehr ersichtlich, ob die Ausnahme explizit behandelt werden muss.

Es im Javadoc zu deklarieren ist ein besserer Ansatz, da es jemandem ermöglicht, damit umzugehen, wenn er es für notwendig hält, aber zu wissen, dass er es ignorieren kann, wenn er möchte. Dies macht die Trennung zwischen aktiviert und deaktiviert deutlich.

Aus dem Oracle Java-Tutorial :

"Wenn es so gut ist, die API einer Methode zu dokumentieren, einschließlich der Ausnahmen, die sie auslösen kann, warum nicht auch Laufzeitausnahmen angeben?" Laufzeitausnahmen stellen Probleme dar, die das Ergebnis eines Programmierproblems sind, und daher kann nicht erwartet werden, dass der API-Clientcode von ihnen wiederhergestellt oder in irgendeiner Weise behandelt wird. Solche Probleme umfassen arithmetische Ausnahmen, wie das Teilen durch Null; Zeigerausnahmen, z. B. der Versuch, über eine Nullreferenz auf ein Objekt zuzugreifen; und Indizieren von Ausnahmen, z. B. der Versuch, über einen zu großen oder zu kleinen Index auf ein Array-Element zuzugreifen.

Laufzeitausnahmen können überall in einem Programm auftreten, und in einem typischen Programm können sie sehr zahlreich sein. Das Hinzufügen von Laufzeitausnahmen in jeder Methodendeklaration würde die Klarheit eines Programms verringern.

Schauen Sie sich das Javadoc für Collection # add an

Es gibt eine ganze Reihe von ungeprüften Ausnahmen:

Throws:
UnsupportedOperationException - add is not supported by this collection.
ClassCastException - class of the specified element prevents it from being added to this collection.
NullPointerException - if the specified element is null and this collection does not support null elements.
IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

Wenn Sie die Geduld haben, würde ich empfehlen, die möglichen Ausnahmen, die Ihre Methoden auf diese Weise auslösen, gründlich zu dokumentieren. In gewisser Weise ist es sogar noch wichtiger, dies für ungeprüfte Ausnahmen zu tun, da geprüfte Ausnahmen sich selbst dokumentieren (der Compiler zwingt den aufrufenden Code, sie zu bestätigen).

Aus meiner Sicht ist es besser, Laufzeitausnahmen zumindest im Javadoc für die Methode zu deklarieren. Wenn Sie es in der Signatur deklarieren, wird noch deutlicher, was passieren kann, wenn etwas schief geht. Dies ist mein Hauptgrund für den Vorschlag, diese Informationen bereitzustellen.

Zu Ihrer Information: Mit der Zeit (jetzt im Jahr 2017) neige ich jetzt viel mehr dazu, sie nur in Javadoc zu dokumentieren und überprüfte Ausnahmen so weit wie möglich zu vermeiden.

Meiner Ansicht nach sollten ungeprüfte Ausnahmen niemals in der Methodensignatur deklariert werden, da dies ihrer Natur widerspricht.

Wenn eine Methode jedoch wahrscheinlich einige ungeprüfte Ausnahmen auslöst, die die wahrscheinlichen Umstände in @throws in Javadoc notieren, kann dies für andere hilfreich sein, die die Methode aufrufen, um zu verstehen, was schief gehen kann. Dies ist jedoch nur für Ausnahmen nützlich, die die Anrufer wahrscheinlich verarbeiten können (z. B. eine NPE aufgrund schlechter Eingaben usw.).

Wenn Sie eine API zur Verwendung durch andere schreiben, gibt es genügend Gründe für eine explizite Dokumentation Ihrer Absicht in der API, und es gibt keinen Nachteil, RuntimeExceptions in der Methodensignatur zu deklarieren.

Dies hat mit der Diskussion über geprüfte Ausnahmen zu tun . Die meisten würden zustimmen, dass Ausnahmen nicht in Methodensignaturen deklariert werden sollten.

Es gibt auch eine Diskussion darüber, wie Laufzeitausnahmen verwendet werden sollten. Ich stimme einem Poster zu, dass Laufzeitausnahmen einen Programmierfehler oder einen schwerwiegenden Zustand anzeigen sollten. Es gibt also nicht viel Verdienst, sie in der Unterschrift zu deklarieren. Jede Methode könnte möglicherweise durch eine.