checkstyle.xmlに汎用検査例外のキャッチを禁止する設定を追加 (#1874)

* IllegalCatchの設定を追加 * AzureADB2CのcheckstyleにIllegalCatchを追加 * カスタマイズしている規約を追記 * テストクラスでは汎用的な例外のキャッチを許容するよう修正 * 指摘事項に対応
AlesInfiny · Jan 28, 2025 · d486bd0 · d486bd0
1 parent 6a7ecf8
commit d486bd0
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 0 deletions.
diff --git a/documents/contents/guidebooks/conventions/coding-conventions.md b/documents/contents/guidebooks/conventions/coding-conventions.md
@@ -51,3 +51,21 @@ SpotBugs を利用して、 SpotBugs が提供するバグパターンに該当
 - [SpotBugs プラグイン](../how-to-develop/java/common-project-settings.md#spotbugs-plugin)
 - [Java formatting and linting :material-open-in-new:](https://code.visualstudio.com/docs/java/java-linting){ target=_blank }
 - [静的コード分析とフォーマット(Vue.js)](../how-to-develop/vue-js/static-verification-and-format.md)
+
+## AlesInfiny Maia でカスタマイズしている規約 {#custom-conventions}
+
+AlesInfiny Maia では上記に示した基本のコーディング規約に加えて、以下に示すカスタマイズした規約を採用しています。
+
+- Java アプリケーション
+
+    - Checkstyle プラグイン
+
+        Checkstyle の規約をカスタマイズする場合、 Checkstyle プラグインが読み込むインプットファイルを編集します。具体的な方法については [こちら](../how-to-develop/java/common-project-settings.md#checkstyle-plugin) を参照ください。
+        Checkstyle プラグインでカスタマイズする規約は以下の通りです。
+
+        - [IllegalCatch :material-open-in-new:](https://checkstyle.sourceforge.io/checks/coding/illegalcatch.html){ target=_blank }
+
+            汎用検査例外を含む特定の例外のキャッチを禁止します。
+
+            汎用的な例外をキャッチしてしまうと、具体的な例外が隠蔽されてしまい、原因の特定が難しくなります。
+            汎用的な例外ではなく、具体的な例外のみをキャッチするように本規約を設けます。
diff --git a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml
@@ -283,5 +283,6 @@
       <property name="exceptionVariableName" value="expected"/>
     </module>
     <module name="CommentsIndentation"/>
+    <module name="IllegalCatch"/>
   </module>
 </module>
diff --git a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml
@@ -9,4 +9,6 @@
   <suppress checks=".*" files="com[\\/]dressca[\\/]infrastructure[\\/]repository[\\/]mybatis[\\/]generated"/>
   <!-- テストクラスのメソッド名はチェックしない（日本語を使用するため） -->
   <suppress checks="MethodName" files=".*Test.java$"/>
+  <!-- テストクラスでは汎用的な例外のキャッチを禁止しない -->
+  <suppress checks="IllegalCatch" files=".*Test.java$"/>
 </suppressions>
diff --git a/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml b/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml
@@ -283,5 +283,6 @@
       <property name="exceptionVariableName" value="expected"/>
     </module>
     <module name="CommentsIndentation"/>
+    <module name="IllegalCatch"/>
   </module>
 </module>
diff --git a/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml b/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml
@@ -11,4 +11,6 @@
   <suppress checks="MethodName" files=".*Test.java$"/>
   <!-- メッセージクラスの文字数はチェックしない -->
   <suppress checks="LineLength" files=".*MessageIdConstants.java$"/>
+  <!-- テストクラスでは汎用的な例外のキャッチを禁止しない -->
+  <suppress checks="IllegalCatch" files=".*Test.java$"/>
 </suppressions>