MinecraftのMod開発にJavaを使い始めて、コードの統一化（整合性）を保つためにフォーマットを実装しようとすると少し詰まってしましました。
PythonにはRuffやTypescriptにはprettierといった主流のライブラリ等の記事が簡単に見つかるのですが、私自身がJava初心者というもとこもあると思いますが、Javaではすんなり見つからず、、、
こんな苦戦した経緯もありまので、今回はJavaのフォーマット実装の解説になります。少しでも参考になれば幸いです。
Javaのコードをフォーマットしたい
今回はフォーマットするにあたって、以下の条件は満たすようなものを探すことにします。
- git add ./する前に、できるだけ簡単にコードを整形したい
- pull requestの際にgithub actionsにてスタイルチェックをし、フォーマットされていなければ失敗としたい
これらの条件があれば、開発においてコードを最低限は整合性を保つことができると思います。
念のために以下に、私自身の動作環境を載せておきます。
| OS | Windows10 home |
| Editor | VSCode |
| Java | 22.0.2 |
| Gradle | 8.7 |
それでは、実際に実装をしていきたいと思います。
VScodeのEditorにJavaのコーディングルールの適用
はじめに
コードをフォーマットする上で、様々なスタイルのフォーマット方法があると思いますが、今回はJavaで使用するものはGoogleのgoogle checkを使用します。（というか調べたら結果的にこれになりました。）
Check for Javaのインストール
VSCodeの拡張機能にてCheckstyle for Javaと検索し、図1.1のように一番上位に表示されるCheckstyle for Javaをインストールしましょう。
図1.1 Check for Javaの検索画面
google_checksのスタイルの適用
CheckStyleのGithubにアクセスし、google_checks.xmlのファイルをダウンロードし、プロジェクトのディレクトリに保存します。
最後に保存したgoogle_checks.xmlをVSCode上で右クリックし、図1.2のようにSet the Checkstyle Configuretion Fileを押下し、ファイルを設定します。そうしますと、Javaにgoogle checkのスタイルが適用されます。
図1.2 Checkスタイルの設定
MinecraftのMod用のプロジェクトに適用すると大量にproblemが出ると思います。
以上にて、VScode上のコーディングルールの適用は完了です
Spotlessの導入
次は指摘された内容を一つ一つ手動ではとてもめんどくさいと思いますので自動で直せるようにします。これが条件1のgit add ./する前に、できるだけ簡単にコードを整形したいの内容になります。
今回は使用したものはSpotlessになります。以下がGithubになりますので詳細は以下をご覧ください。
Spotlessの設定
今回はGradleを使用してるため、build.gradleを以下のように修正します。pluginに先ほどのspotlessの追加、spotlessにgooglejavaformatを追加する設定を書きます。
plugins {
・・・
+ id "com.diffplug.spotless" version "7.0.0.BETA1"
}
・・・
+ apply plugin: "com.diffplug.spotless"
+ spotless {
+ java {
+ googleJavaFormat()
+ }
+ }
記入後、プロジェクトをリロードするとspotlessのコマンドが実行可能になっています。
一度以下のようなコマンドを実行すると、Javaのファイルがフォーマットされたと思います。
gradlew spotlessApply
以上で設定は完了です。
VScodeのタスクに追加する
追加で誰でも実行できるようにVScodeのタスクに追加しましょう。
新規に.vscodeのディレクトリとtasks.jsonを作成します。
図1.3 .vscode/tasks.jsonの作成
作成しましたら、以下の内容を書きこみましょう。ここではtasksの詳細は省きます。
{
"version": "2.0.0",
"tasks": [
{
"label": "コードの整形",
"type": "shell",
"command": "gradlew spotlessApply",
"args": [],
"problemMatcher": [],
},
]
}
記入が終わりましたら、VSCodeの上にある検索窓をクリックし、図1.4のようなセレクトが表示されますので、Run Taskをクリックします。
図1.4 VSCodeの検索窓のクリック時
次に、tasks.jsonに記入した図1.5のようにコードの整形という項目があると思いますので、クリックします。そうすると先ほどコマンドを実行したように、コードをフォーマットしたgradleのタスクが実行されると思います。
図1.5 VScodeのタスク一覧
図1.6のように成功したらOKです。
図1.6 タスク実行完了画面
以上にてSpotlessの導入は終了です。
Github Actionsにスタイルチェックを導入
最後に条件2のpull requestの際にgithub actionsにてスタイルチェックをし、フォーマットされていなければ失敗としたいを満たすものを作成していきます。
github actionsの作成
今回はnikitasavinovさんのCheckstyle GitHub Actionを使用していきましす。これはプルリク時にcheckstyleとreviewdogというものを表示してくれるものになります。
それではまずは、プロジェクトに.githubとworkflowsのディレクトリの作成をします。作成したらディレクトリにstylecheck.yamlを作成します。
作成しましたらGithub Actionsを書いていきます。(Github Actionsの詳細の解説は省きます。)
name: stylecheck
on:
pull_request:
types: [opened, synchronize, reopened]
branches:
- stg
jobs:
test:
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run check style
uses: nikitasavinov/checkstyle-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: 'github-pr-check'
tool_name: 'reviewdog'
fail_on_error: true
実際にプルリクエストしていますと、図1.7のように表示され、reviewdogが表示される際はgithub actionsが失敗しているのが分かります。
図1.7 プルリクエスト時の動作
以上にてgithub actionsの設定は完了です。
まとめ
今回はJavaのコードのフォーマットからgithub ActionsでStyleチェックする内容を実装しました。
何かあればコメントいただければと思います。
参考文献
大変お世話になりました。ありがとうございます。
Discussion