Windows 10へのSonarQubeのインストールは、一見するとかなり簡単そうに見えますが、実際にはいくつか隠れた落とし穴があります。Javaが正しくインストールまたは設定されていない場合があります。Javaは基本的に他のすべての基盤となるものです。また、パスが正しく設定されていない場合や管理者権限で実行し忘れた場合、サーバーの起動に苦労することもあります。ロケット科学ではありませんが、Windowsは単純なことを必要以上に複雑にする傾向があります。この簡単なチュートリアルでは、この優れたコード分析ツールを簡単に使いこなせるようになるため、すぐにプロジェクトを分析できるようになるでしょう。
Windows 10にSonarQubeをインストールする方法
Windows 10マシンにSonarQubeを設定する手順を詳しく説明します。これらの手順に従えば、面倒な手間をかけずにコードの品質を監視できます。ただし、Javaを正しく使用することは非常に重要です。また、Windowsは権限をロックしたり、特定のパスを認識しなかったりすることがあります。そのため、細かい点を飛ばさないでください。問題はそこに潜んでいることが多いからです。
Javaが正しくインストールされ、設定されていることを確認してください
SonarQube は Java に依存しており、どのバージョンでも良いわけではなく、Java JDK 11 以降が必要です。Java が正しくセットアップされていないと SonarQube は起動せず、その理由を調べるのに苦労します。Java が動作しているかどうかを確認するには、コマンドプロンプトを開いて と入力しますjava -version。正しいバージョンが表示されれば問題ありません。そうでない場合は、Oracle JDK サイトからダウンロードし、インストールのプロンプトに従います。JAVA_HOME 環境変数を必ず設定してください。セットアップによっては、インストール後にマシンを再起動すると Windows に認識されるので効果的です。[コントロール パネル] > [システム] > [システムの詳細設定] > [環境変数]で、JAVA_HOMEが のように Java フォルダを指しているかどうかを確認しますC:\Program Files\Java\jdk-11.0.x。これがないと、SonarQube は Java を見つけられずに異常終了する可能性があります。
SonarQubeパッケージをダウンロードして解凍します
SonarQubeのダウンロードページにアクセスしてください。最新バージョン（通常は64ビットWindows用のzipファイル）を入手してください。ダウンロード後、7-ZipやWinRARなどのソフトを使って、C:\SonarQubeのようなシンプルなディレクトリに解凍してください。スペースや特殊文字が少ないほど、Windowsがパスを気にしなくなるためです。解凍したら、フォルダを開き、bin\windows-x86-xx\を参照します。ここで起動スクリプトを実行します。
SonarQubeの設定を構成する（必要な場合）
基本的なセットアップでは必須ではありませんが、データベースを使用している場合や特定の調整が必要な場合は、confフォルダ内のsonar.propertiesを開いてください。ローカルでのテストであればデフォルト設定で問題ありませんが、より大規模なプロジェクトを計画している場合は、SonarQubeをPostgreSQLやMySQLなどの専用データベースにリンクすることを検討してください。つまり、データベースのURL、ユーザー名、パスワードなどを編集する必要があります。もちろん、Windowsでは必要以上に設定が難しくなるため、ファイアウォールの設定によってはネットワークアクセスを許可したり、特定のポートを開いたりする必要があるかもしれません。sonar.jdbc.url
SonarQubeサーバーを起動する
bin\windows-x86-64ディレクトリ内でStartSonar.bat を見つけます。右クリックして管理者として実行してください。Windows は管理者として実行しないとスクリプトの実行をブロックすることがあります。実行するとコマンドプロンプトが開き、SonarQube の起動ログが表示されます。通常、1分ほどで「SonarQube が起動しました」や「Web サーバーが実行中です」といったメッセージが表示されます。表示されない場合は、Java のインストールまたは権限を確認してください。多くの場合、これらの問題が原因で問題が発生します。
起動したら、ブラウザを開いてhttp://localhost:9000にアクセスしてください。すべてがうまくいけば、SonarQube のダッシュボードがポップアップ表示されるはずです。これで、プロジェクトを分析し、コードをクリーンでスマートに保つ準備が整いました。
一つ注意すべき点があります。サーバーが最初の起動時に起動しなかったり、Javaやポートに関する奇妙なエラーが表示されたりすることがあります。通常、サーバーを再起動するか、場合によっては再起動することでこれらの問題は解消されます。Windowsはバックグラウンドプロセスに対してかなり厳しいため、最初の数回でうまくいかなくても、それはほぼ正常な動作です。Javaのバージョンが適切であること、他のインスタンスがポート9000をブロックしていないこと、そしてスクリプトを管理者権限で実行していることを確認してください。
よりスムーズにインストールするための役立つヒント
- 実行結果を再確認し
java -version、期待どおりに表示されるか確認してください。期待どおりでない場合は、JAVA_HOMEを修正するか、Javaを再インストールしてください。 - ポート 9000 を占有している可能性のある、または Java と競合している可能性のある他のプログラムをすべて閉じます。
- より大きなデータセットや複数のプロジェクトを使用する予定の場合は、専用のデータベースをセットアップしてください。PostgreSQL は人気のある無料の選択肢です。
- Java と SonarQube を最新の状態に保ってください。セキュリティ パッチと機能は重要です。
- 言語サポートを拡張したり、統合機能を追加したりしたい場合は、SonarQubeプラグインを検討してください。SonarQubeがさらに強力になります。
よくある質問
SonarQube が起動しないのはなぜですか?
最もよくある問題は、Java の問題か権限の問題です。Java が正しくインストールされているか確認してください。また、起動スクリプトを管理者として実行してください。ポートがビジー状態の場合は、他のサービスを停止するか、 sonar.propertiesjava -versionでポートを変更してみてください。
SonarQube を別のポートで実行できますか?
はい。ポート9000が使用中の場合は、sonar.propertiesを編集して任意の空きポートに調整しsonar.web.port=9000、サーバーを再起動してください。
サーバーを停止するにはどうすればいいですか?
bin\windows-x86-64フォルダに戻り、StopSonar.batを実行します。簡単です。または、ウィンドウでコマンドプロンプトを起動した場合は、そのまま閉じてください。
まとめ
- Java がインストールされ、構成されていることを確認します
java -version。 - SonarQube をダウンロードして、単純なフォルダーに抽出します。
- 必要に応じてsonar.propertiesを編集します。
- StartSonar.bat を管理者として実行します。
- ローカルホスト経由でアクセスします。
まとめ
Windows 10でSonarQubeを動かすのは、ちょっとしたミニゲームのようなものかもしれません。Windowsのせいで、仕方ないですね。しかし、Javaを整理してサーバーを起動してしまえば、コードを正しい状態に保つための非常に頼りになるツールになります。途中で問題に遭遇しても驚かないでください。WindowsはWindowsですから。しかし、これらのヒントを活用すれば、よりスムーズに進むはずです。頑張ってください。そして、この記事が誰かの頭を悩ませる時間を少しでも軽減してくれることを願っています。