Java APIの設計：半数値文字列を解析するメソッドのNumberFormatException？

Question

私は、文字列の日付と時刻を解析するためのいくつかのメソッドを含むライブラリを作成しています。私は、文字列引数が解析できないときにそれらのメソッドがスローするべき例外を決定するのが難しいです。 - 無効な文字列は明らかに不正な引数ですが、私には、IllegalArgumentExceptionは通常、プログラミングエラーを意味し、それがいずれかの明示的なtry catchをやりたいことはまれだ

1. java.lang.IllegalArgumentException：私はいくつかのオプションを検討しています。私は、文字列の解析はしばしば外部入力用であり、特別な扱いを受ける特別なケースであると考えています。たとえば、ユーザー入力を解析して何か他のことをした大きなコードブロックがあった場合、try catchブロックにそのコードをラップして、無効な文字列を含むユーザー入力の大文字小文字を処理することができます。しかし、IllegalArgumentExceptionをキャッチすることは、無効なユーザー入力を正確に特定するためにはあまり役に立ちません。なぜなら、ユーザー入力パースだけでなく、スローされる可能性のあるコード内に複数の場所がある可能性が高いからです。

2. java.lang.NumberFormatException - それはjava.langにInteger.parseInt(String)および他の同様の解析メソッドによってスローされます。だから、ほとんどのJava開発者は、有効であるかもしれない文字列（例えば、ユーザ入力）を解析しようとしているときに例外をキャッチすることに慣れている。しかし、それはその名前に「数字」を持っているので、ある意味では数値であるが、概念的には私の心の中では異なる日付や時刻には本当に合っているのか分からない。 "FormatException"とだけ呼ばれた場合...

3. java.text.ParseException - チェックされているため、実際にはオプションではありません。私はこれをチェックしないことを望む。

4.カスタム例外 - これはIllegalArgumentExceptionとNumberFormatExceptionの欠点を回避して、それがあまりにもIllegalArgumentExceptionを拡張することができます。しかし、本当に必要な場合を除いて、ライブラリに例外を追加することは良い考えではないと思います。ジョシュ・ブロッホを引用して、"If in doubt, leave it out"。 （また、私の場合、日付と時刻を解析するパッケージでは、「DateFormatException」、「TimeFormatException」、「CalendricalFormatException」（JSR 310など）日付、時間などを解析します。そして、解析できない文字列を特定するために使用されているのであれば、複数の例外を1つのパッケージに作成するのはばかげているでしょう）

センス？

NB java.util.DateまたはJoda Time、つまりJSR 310を使用したくないという理由があります。そのため、それらを提案する必要はありません。さらに、この質問がかなり一般的に行われていれば、APIを設計している他の人たちが苦労している問題であるため、これが良いと思います。日時には、IPアドレスやURL、または解析が必要な文字列形式の情報の他の種類の情報もあります。その他のライブラリで設定し

先例は

ほんの一例は、私が見つかりました：

java.sql.Timestamp.valueOf(String) throws IllegalArgumentException

java.util.Date.parse(String) throws IllegalArgumentException（非推奨メソッド、および例外が宣言されていませんが、あなたがそれを見ることができますソース）

java.util.UUID.fromString(String) throws IllegalArgumentException

org.apache.axis.types.Time(String) throws NumberFormatExceptionは（Apache Axisの中にも、デイクラス）

org.apache.tools.ant.util.DeweyDecimal(String) throws NumberFormatException

com.google.gdata.data.DateTime.parseDateTime(String) throws NumberFormatException

java.lang.Package.isCompatibleWith(String versionString) throws NumberFormatException（Javaの7で、これはドットで文字列のバージョン番号がとる - の種類の中に日付や時刻のような感覚）

カスタム例外を使用するパッケージがたくさんあると思いますので、それらの例を挙げることに多くの点があるのでしょうか。

Answer 1

この質問については、味の問題です。私の意見では、私は例外をスローしませんが、その代償として扱います。その理由は、入力が間違っていると、ユーザーが例外ハンドラで何もできないためです。したがって、これらのタイプのエラーは、リターンコードをチェックすることで簡単に処理できます。例外は重く、余分な価値をもたらすものではありません。

Answer 2

私はIllegalArgumentExceptionから継承され（基本クラスとしてIllegalFormatExceptionを示唆しているだろうが、残念ながら唯一のコンストラクタをパッケージで保護されているので、私はおそらくいくつかのメソッド（ 小さなAPIのため

• IllegalArgumentExceptionを使用したいですそうでない場合はIllegalArgumentExceptionから継承）
• 独自のクラス階層。

いずれにせよ、私はベースとしてIllegalArgumentException使用しますクラス。これは公式の教義ではありませんが

は、私の以前のプロジェクトの一つでは、ガイドラインは唯一

• IllegalStateException
• IllegalArgumentException
• UnsupportedOperationException

から継承RuntimeExceptionsをスローするようにしました私はそれを良い練習と呼んでいます。これらの3つはすべてシンプルで自己説明的です。

Answer 3

これは、DateFormat.parseがスローするため、ParseExceptionを選択します。したがって、2で言及する利点があります。プログラマーはそれに精通しています。しかし、チェックしたくないので、これはオプションではないと思います。チェックされていないことを余儀なくされると、私は4を選択します。

Answer 4

私は現在、NumberFormatExceptionを使用することに賛成しています。私はIllegalArgumentException昔ながらの考えていたが、それはそれは私のような少しのコードを書いたとき、理想的ではなかったことを私に明らかになった：

有効な Dayを解析すると仮定すると、

try { 
    final Day day = Day.fromString(userInputString); 
    someMethodThatCouldAlsoThrowIllegalArgumentException(day); 
} catch (IllegalArgumentException e) { 
    ui.showWarningMessage("Invalid date: " + userInputString); 
} 

を、あなたはそれで何かをしたいと思います。また、無効なパラメータ（ユーザーエラーではなくプログラミングエラー）を受け取った場合、渡すメソッドはIllegalArgumentExceptionになります。上の例のようなコードでは、無効なユーザー入力に対してプログラミングエラーを混同しないように注意したいと思うので、安全な側にするためにtry/catchブロックの前に定義されたnull変数のようなものが必要ですそれに続くnullのチェックを行います。

スワップIllegalArgumentExceptionNumberFormatExceptionまたはカスタム例外と問題がなくなります。

JDK 1.7の java.lang.Package.isCompatibleWith(String versionNo)は、バージョン番号（ "1.6.1.32"のような半数値文字列）を解析する方法のため NumberFormatExceptionを使用して、私はこれはまた、のようなものを解析する方法のための賢明な選択であるかもしれないと考えていることを見た

日時。

NumberFormatExceptionは、半数値のみの文字列を解析するのには理想的ではありませんが、実際には必要ないカスタム例外を使用してAPIを混乱させたくない場合には最適なオプションです。彼らはjava.langでそれをやっている場合は、おそらくそれは私が、私は例外が重いことについて同意