Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

checkstyle.xmlに<module name="IllegalCatch"/>を追加したい #1387

Closed
kharada7 opened this issue Oct 15, 2024 · 1 comment · Fixed by #1874
Closed

checkstyle.xmlに<module name="IllegalCatch"/>を追加したい #1387

kharada7 opened this issue Oct 15, 2024 · 1 comment · Fixed by #1874
Assignees
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプル(コード)に関係がある target: Dressca サンプルアプリケーションDresscaに関係がある target: ガイド/規約 ドキュメントのガイド/規約に関係がある
Milestone

Comments

@kharada7
Copy link
Contributor

kharada7 commented Oct 15, 2024

概要

dressca-backendのcheckstyle設定ファイル( dressca-backend\config\checkstyle\checkstyle.xml )には現状汎用検査例外( java.lang.Exception )の catch を禁止する設定がない。
ほとんどの開発プロジェクトでは汎用検査例外を catch すべきでないと思われるので、追加してほしい。

コーディング規約に、カスタマイズしたルールに関して追記したい。

詳細 / 機能詳細(オプション)

追加する設定は以下。

<module name="Checker">
  <module name="TreeWalker">
    <module name="IllegalCatch"/>
  </module>
</module>

checkstyle – IllegalCatch

完了条件

  • 以下のファイルに IllegalCatch の設定が追加されていること。
    dressca-backend\config\checkstyle\checkstyle.xml

  • 汎用検査例外のcatchがcheckstyleの警告として検出されること。

  • コーディング規約にルールが追加されていること。

@tsuna-can-se tsuna-can-se added target: Dressca サンプルアプリケーションDresscaに関係がある target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプル(コード)に関係がある labels Oct 15, 2024
@tsuna-can-se tsuna-can-se added this to the v1.1.0 milestone Dec 20, 2024
@tsuna-can-se tsuna-can-se added the target: ガイド/規約 ドキュメントのガイド/規約に関係がある label Dec 20, 2024
@kenjiyoshid-a
Copy link
Contributor

IllegalCatchの追記によって、禁止になるデフォルトの項目

をcheckstyle.xmlに追記することによって、デフォルトで以下の例外のcatchが禁止される。

  • Error
  • Exception
  • RuntimeException
  • Throwable
  • java.lang.Error
  • java.lang.Exception
  • java.lang.RuntimeException
  • java.lang.Throwable

以上の例外以外のcatchを禁止したい場合

以上の一覧以外の例外のcatchを禁止したい場合には以下の記述を含める。
以下は、ArithmeticExceptionおよびOutOfMemoryErrorのcatchを禁止する例である。

<module name="Checker">
  <module name="TreeWalker">
    <module name="IllegalCatch">
      <property name="illegalClassNames"
           value="ArithmeticException,OutOfMemoryError"/>
    </module>
  </module>
</module>

デフォルトの設定でも、本Issueのクローズの要件を満たすことができるが、AlesInfiny Maiaとして、catchを禁止した方がいい例外を検討する必要がある。

@kenjiyoshid-a kenjiyoshid-a changed the title dressca-backendのcheckstyle.xmlに<module name="IllegalCatch"/>を追加したい checkstyle.xmlに<module name="IllegalCatch"/>を追加したい Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプル(コード)に関係がある target: Dressca サンプルアプリケーションDresscaに関係がある target: ガイド/規約 ドキュメントのガイド/規約に関係がある
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants