Checkstyle / Module / ClassDesign

• Prev
• Next
• Checkstyle

VisibilityModifier

フィールドに適切なアクセス制限がかかっているかをチェックします。

Rationale: カプセル化を強制させるため。

記述サンプル

• Standard Checkstyle

  <module name = "Visibility Modifier">
      <property name = "packageAllowed" value = "false" />
      <property name = "protectedAllowed" value = "false" />
      <property name = "publicMemberPattern" value = "^$" />
  </module>

• Plug-in Checkstyle

  <rule-configuration 
      classname = "com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "packageAllowed" value = "false" />
          <config-property name = "protectedAllowed" value = "false" />
          <config-property name = "publicMemberPattern" value = "^$" />
      </config-properties>
  </rule-configuration>

チェックサンプル

<module name = "Visibility Modifier">
    <property name = "packageAllowed" value = "false" />
    <property name = "protectedAllowed" value = "false" />
</module>

としたとき、以下のようになる。以下の例は、インスタンスフィールドの宣言とする。

OK!  private String name;
Boo! protected String name;
Boo! String name;
Boo! public String name; 

FinalClass

private なコンストラクタしかないクラスがfinal宣言されているかをチェックします。

これは、private なコンストラクタしかないクラスを継承したサブクラスがインスタンス化できないからです。そのため、final宣言することによって、継承できないことを明示します。

記述サンプル

• Standard Checkstyle

  <module name = "FinalClass" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.FinalClassCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

InterfaceIsType

定数インターフェイスをチェックします。

参照: Effective Java 第4章 項目17 型を定義するためだけにインタフェースを使用する

記述サンプル

• Standard Checkstyle

  <module name = "InterfaceIstype">
      <property name = "allowMarkerInterface" value = "true" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "allowMarkerInterface" value = "true" />
      </config-properties>
  </rule-configuration>

HideUtilityClassConstructor

ユーティリティクラス(スタティックメソッドしか持たないクラス)が、パブリックなコンストラクタを持っているかどうかチェックします。

Rationale: ユーティリティクラスをインスタンス化することに意味はない。そのため、コンストラクタは、private か(サブクラス化を考慮して)protected にすべきである。よくあるミスは、デフォルトコンストラクタを隠し忘れること。

記述サンプル

• Standard Checkstyle

  <module name = "HideUtilityClassConstructor" />

• Plug-in Checkstyle

  <rule-configuration 
      classname = "com.puppycrawl.tools.checkstyle.checks.HideUtilityClassConstructorCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

DesignForExtension

継承できるクラスであればそれを明示するように、継承して欲しくないクラスであればそれを明示するようにするためのチェックをします。

具体的には、以下のようなことを行います。サブクラス化できるクラスの private でもなく static でもないメソッドが以下の条件のどれかを満たしているかをチェックします。

• abstract である。
• final である。
• 実装が空である。

Rationale: この API デザインスタイルは、サブクラスによってスーパークラスが壊されるのを防ぎます。半面、サブクラスは自由度が制限されてしまいます。特に、スーパークラスの実行されるコードを防ぐことができません。しかしこれは、サブクラスがスーパーメソッドを呼ぶのを忘れることによって、スーパークラスの状態を壊すことができないことを意味します。

記述サンプル

• Standard Checkstyle

  <module name = "DesignForExtension" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.DesignForExtensionCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

ThrowsCount

メソッドからスローされる例外の数をチェックします。

Rationale: 例外はメソッドインターフェイスの一部です。あまりに多くの異なるルートをもった例外をスローするように宣言されたメソッドは、例外捕捉処理が面倒で、catch (Exception) のように悪いプログラミング習慣をもたらします。このチェックは、例外の改装内の最もシンプルなものを宣言することを開発者に強制します。これにより、メソッドの呼び出し側は、ただ1つだけ例外をチェックすればよくなるが、必要ならば特定の(宣言された例外の)サブクラスをキャッチすることもできます。

• Prev
  Checkstyle/Module/Blocks
• Next
  Checkstyle/Module/CodingProbrems
• Home
  Up?