目次
はじめに
こちらは、個人の学習記事になります。以下の点をご承知おき下さい。
- 学習中の内容になります。必要に応じて都度加筆・修正致します。
- 出来る限り正しく記載するよう努力致しますが、間違い、ミスも御座います。コメントにてご指摘、アドバイス頂けたら幸いです。
- 二次情報としての使用は推奨致しません。ご了承ください。
前提
- Macbook Pro
- Java(17.0.5)
- IntelliJ IDEA 2022.3.3 (Community Edition)
概要
コードを書く際に、checkstyleというコード解析ツールを使っています。これにかけると「綺麗にコード書けてるかな〜？？」ってプログラムの書き方を文字通りチェックしてくれる便利ツールです。こうすると、レビュアーの方々に見てもらう時しょーもないミスとかに時間を割いてしまう…みたいな事を減らすことが出来るメリットもあります。（その内記事にしようかな）
本題です。私はIntelliJ上でそれを行なっているわけですが、今回お叱りを受けたのですがこんな内容でした。
'.*' 形式のインポートの使用は避けるべきです - org.springframework.web.bind.annotation.*。
これは要するに「インポート文まとめるのはダメですよ」って言ってます。この「*」をワイルドカードと言います。何故まとめるのがダメなのか理由は後述しますが、こんなお叱りを受けたままだと嫌なので、こいつを解決していきます。(2行目の「行が 100 文字を超えています （118 個見つかりました）。」はまた別で纏めます。)
実行したこと
早速直そうと思って、消してインポートし直しました。
勝手にまとまりやがる…。なんでやねん。
これはIntelliJが自動で纏めてくれるという機能があるので、それのせいなのです。とても親切なのですが、今回はこれがcheckstyleと相反する状態となっています。
質問
どっちが正しいのか判断出来なかったので、スクールの講師の方に質問しました。
Q：org.springframework.web.bind.annotation.*について
個別に記述したが、保存と同時に結合されてしまうのですが、アノテーションのインポートは結合したままでよいのでしょうか？cehckstyleに沿うべきでしょうか？
A:ワイルドカードインポートは避けるようなIntelliJの設定を見直すべきだと思います。
とのことでした。気になったので理由を調べたのですが、このワイルドカードでインポートしてしまうと、使う必要のないクラスまで引っ張ってきてしまっているので、他のパッケージクラスで別なインポート文を使用する時に競合してしまうという面倒くさい事態が起きかね無いので、推奨されていないらしいです。
IntelliJの設定を直してみた
ということで、ワイルドカードにならない設定をしてみます。
同じimportクラスがある程度並ぶと結合されてしまう。「(” * ”)ワイルドカード」で纏められてしまう。
JetBrainsの公式docsで確認出来たので実行してみた。
日本語での解説が少ないので敢えてプラグインは日本語にしてます。
1.「settings」を選択
2.「エディター」→「一般(General)」→「コードスタイル」→「Java」
「シングルクラスインポートを使用する」にチェック。さっきまとめられたのは同じインポート文が5行揃った時だったので、「'*'でインポートするクラス数」の設定が５となっているので納得しました。
3.「'*'でインポートするクラス数」と「'*'でstaticインポートする名前数」を変更する。
完全に無効化するという項目はないので、「999(最大値)」を入れておく。
結果
無事、全部表示されました。
おわりに
IntelliJもcheckstyleもそれぞれコードを良くしてくれる便利ツールですが、こうやって競合して「どっちなんだい？？？」ってなる事もあるんだなと思いました。こういう状況は、企業の開発環境やチームなんかでもどこをどう使うのかは変わってくると思うので、調べるよりまず聞くが大事なパターンなのかも知れません。
参考
JetBrainsの公式docs