インターフェイス内に定数は持つべきではない？

Question

定数だけ定義されたインターフェイスではなく、インターフェイス内に定数は定義すべきではないのでしょうか？
インターフェイス内に定数を定義すると、SonarQubeで指摘されてしまいます。
直訳だと「"Effective Java"によると定数インターフェースパターンは、インターフェースの貧弱な使用です。」と表示されます。

ある計算を行うクラスと、そのインターフェイスがあります。
この計算クラスは、正しく計算結果を返すこともあれば、無効値を返すこともあります。
使用する側はDI注入により、インターフェイスから計算メソッドを呼び出します。

無効値を定数としてどこかに定義する必要があるのですが、インターフェイス内に定義するとSonarQubeで指摘されてしまのでenumや定数クラスを別途用意しなければなりません。
しかし、そのように修正すると、インターフェイスを使用する側は定数クラスをいちいちインポートして使用しなけれなりません。
計算クラスを使用する側はインターフェイスさえ知っていればよい状態にしたいのですが、不可能でしょうか？
もしくはそのような実装は推奨されないのでしょうか？

interface ICalculator{
  int INVALID_VALUE = -999; //Effective Javaに準拠していないと言われ怒られる
  int calculate();
}

class Calculator implements ICalculator {
  @Override
  int calculate() {
    //計算結果を返す。無効値を返すこともある。
  }
}

class Main {
  //使用する側
  
  //DI注入によりICalculatorの実体が渡ってくる
  private final ICalculator calculator;
  
  void main() {
    int result = this.calculator.calculate();
    //resultに無効値が返ってくることもあるので、無効値の定数をどこかに定義したい。
    //インターフェイスに定義すると怒られる。たかが1個の定数を定義するためにenumや定数クラスを作りたくない。
    //実体クラス側に定数を定義すると、DI注入の意味がないし、ICalculatorの実体クラスが増える度に定数を定義しなければならない。
  }
}

Answer 1

maisumakunさんの回答とコメントがかみ合ってないですが・・・
変換ってボクシングされるから、ほとんど気にしなくてよいのでは？

質問者さんがやりたいこと？

  private final ICalculator calculator;

  void main() {
    int result = this.calculator.calculate();
    if(ICalculator.INVALID_VALUE != result) {
    // 有効な値がかえってきたときの処理
    } else {
    // 無効な値がかえってきたときの処理
    }
  }

maisumakunさんの回答

  private final ICalculator calculator;

  void main() {
    try {
        int result = this.calculator.calculate();
        // 有効な値がかえってきたときの処理
    } catch (InvalidCalcuateException e) {
        // 無効な値がかえってきたときの処理
    }
  }

そもそも、無効値は無効値として格納したいのであれば、そもそも判定とかも必要ないので、

//resultに無効値が返ってくることもあるので、無効値の定数をどこかに定義したい。

の部分が意味不明ですけど・・・

個人的にはインターフェースに定数作るのはアリなのですが・・・
解決するなら、こんな感じ？

  private final ICalculator calculator;

  void main() {
    int result;
    try {
        result = this.calculator.calculate();
        // 有効な値がかえってきたときの処理
    } catch (InvalidCalcuateException e) {
        // 無効な値がかえってきたときの処理
        Logger.error("無効な値が返ってきた");
        result = 定数クラス.無効な値;
    }
    // DB格納処理
  }

Answer 2

解決済みですが・・・

インターフェースの主な目的は「機能を提供する手段としてのメソッド」を規定することで、メソッドの規定の基本はシグナチャーなので、シグナチャーだけで規定を完結する（つまり型だけによって規定する）ために、戻り値の型をintではなく次のようにするという選択もあると思います。

// (A)
interface ICalculator {
  Optional<Integer> calculate();
}

// または

// (B)
interface ICalculatorB {
  OptionalInt calculate();
}

// もっとさぼるなら

// (C)
interface ICalculatorC {
  Integer calculate();
}

intでは表現しきれない結果を無理にint型にしたためにINVALID_VALUEなんて特殊な値を定義しなくてはならないわけで、そんな値を定義しなくてもよいように「あり得る状況を全て表現できる型」を用いるわけです。

---

蛇足:
(C)は特殊状況を悪名高き(?)nullで表現するので、チェックを忘れてもコンパイル時に気づけないことも多く、実行時にNPEに遭遇なんてことにもなりますが、(A), (B)ではチェックし忘れの可能性は排除できます。ただし(A)ならmapを用いて

ICalculator calculator = ...;
String s = calculator.calculate()
           .map(v -> String.format("%,7d", v))
           .orElse("---,---");
System.out.println(s);

などと直接的なメソッドチェーンが書けますが(B)だとなぜかOptionalIntにmapが定義されてないため上記のようには書けません。個人的にはそうまで低水準な機能を設計しているのでないかぎりprimitiveにこだわらずに(A)を用いたほうが好みです。

Comments

[KSwordOfHaste]

自分の回答はmaisumakunさんがご自身の回答のコメントに書いておられることと同様の話です。わざわざ回答するまでもありませんでした。失礼しました。orz

Answer 3

//計算結果を返す。無効値を返すこともある。

そもそも論ですが、たまたま計算結果が「無効値」と一致してしまったらどうするのでしょうか。そして、このメソッドを使う側でうっかり無効値のハンドリングを忘れてしまったら、どうなるでしょうか。intの範囲内でそれを実現しようとする設計が良くないです。

異常時には、例外を投げましょう。

Comments

[maisumakun]

あとは、返り値をIntegerにしておいて、無効な場合はnullを返す、あるいはOptionalIntで返す、という方法も考えられます。

[maisumakun]

そして、インターフェースは「型」を決めるためのものですが、「この型は特定の名前と値の定数を持つ」と宣言することは、通常必要となりませんので、インターフェースに定数を入れるべきではないのです（実装したクラス全てにその定数が現れてしまいます）。

[退会済みユーザー]

計算結果の無効値は無効値として格納したいのです。
例としてintを挙げましたが、実際は計算結果として100%あり得ない数値を無効値として返却しています。（DBに計算に使用しているデータがあるが、その範囲を超えるため）
参照型を使用すると
・値を格納する際にプリミティブに変換しなければならない
・使用するメモリ領域が大きくなる
・リファクタリングの範囲が広がる
などの問題があるので、nullを返す方法は取れないです。

[yukkuri]

よこからすいません。
メモリの問題はそんな大差ないと思いますよ。よっぽどのことがない限り無視していいと思われます。
プリミティブに変換 は 、 java はボクシング というのがあり、暗黙的に変換されます。

[KSwordOfHaste]

maisumakunさん回答の１～２番目のコメント欄に書いておられることに気づけずに回答をつけてしまいました。失礼しました。ボケてました...

Answer 4

ちょうど https://code.i-harness.com/ja/q/289509 にもいい議論がありますので、参考にされても良いでしょう。

個人的には、そのインタフェース定数は、インタフェースを実装したクラスないしはサブクラスでのみ使われるよう制約を付けていれば良いかと。

なんでもかんでも定数定義用のEnumないしはパッケージに入れて、用途が直接見えにくくなるのは避けたい、という意図があります。

Answer 5

インターフェイスの本来の役割は、呼び出す側が呼び出せるメソッドの構成を呼び出される側に強制することです。参考

一方定数とは、プログラム全体に影響を及ぼすような値を1つの変数名で宣言してプログラム全体でその変数を用いることにより、外部環境の都合に合わせてその値だけを変更することでプログラムの動作を変更することがその目的だと思います。（私はそう理解しています。）
例えば日付を扱うプログラムで、「休日」の設定を定数にしている場合、休日は年度ごとに異なりますから、年度が変わるごとに定数のみを変更することでシステムを動作させたいですよね。

そう考えると、個人的にもインターフェースに定数を用いることは得策とは思いません。
「無効値」が将来的に変更されることがあるのかどうかは不明ですが、例えば「無効値」を「0」から「9」に変更したとして、過去に作成されたインターフェースを用いてコンパイルされたクラスは全て「無効値」を「0」と認識しているわけですから、全てコンパイルし直さないと呼び出し側から見て使えないことになります。

今回のようなケースでしたら、定数を保持する外部ファイルを作成してその定数用外部ファイルを都度読み込んで計算クラスを動作させるか、「無効値」が将来にわたって変わらないのであれば、固定値を返却しても良いのではないかと思います。