Spring Bootのポート番号とコンテキストパスの変更方法!起動トラブルを防ぐ基本設定ガイド
生徒
「Spring Bootでアプリを作ってるんですけど、ポート番号を変えたいときはどうしたらいいですか?」
先生
「ポート番号やコンテキストパスは設定ファイルで簡単に変更できますよ。アプリの起動エラー対策にも関係するので、しっかり覚えておくと便利です。」
生徒
「デフォルトのままだと何か問題があるんですか?」
先生
「たとえばポートが他のアプリとバッティングしていると起動できなかったりします。それでは変更方法やトラブル対策を詳しく説明していきましょう!」
1. Spring Bootのデフォルトポートとコンテキストパス
Spring Bootでは、特別な設定を行わない場合、Webサーバーは自動的にポート番号8080で起動し、コンテキストパスは/(ルート)として扱われます。これは「最初からすぐに動かせる」ことを重視したSpring Bootの特徴でもあり、初心者でも迷わずWebアプリを起動できるようになっています。
そのため、ブラウザからは次のようなURLでアプリケーションにアクセスできます。
http://localhost:8080/
ここでのlocalhostは「自分のパソコン自身」を意味し、8080はSpring Bootが待ち受けている通信番号(ポート番号)です。まだWebの仕組みに慣れていない場合は、「住所の番号」のようなものだと考えると分かりやすいでしょう。
ただし、この8080番ポートは開発中によく使われるため、すでに他のSpring Bootアプリや別のWebサーバーが使用していることもあります。その場合、アプリ起動時にエラーが発生し、サーバーが立ち上がりません。これがいわゆるポート競合エラーです。
まずは「デフォルトでは8080番とルートパスが使われている」という点をしっかり押さえておくと、後の設定変更やトラブル対応が理解しやすくなります。
2. application.ymlでポート番号を変更する方法
ポート番号を変えたいときは、Spring Bootの設定ファイルであるapplication.ymlに書くだけでOKです。アプリを起動したまま画面をいじるのではなく、「起動時の設定」を変えるイメージなので、初心者の方でも手順が分かりやすい方法です。
たとえば、デフォルトの8080が他のアプリと重なって起動できない場合は、次のようにポート番号を8081へ変更します。
server:
port: 8081
設定を書いたら、Spring Bootアプリを再起動してください。再起動後は、アクセス先のURLが次のように変わります。
http://localhost:8081/
ここで大事なのは、ブラウザで開くURLのポート番号も同じように変えることです。よくあるつまずきとして「設定は変えたのに、いつも通り8080で開いてしまい、つながらない」というケースがあります。
また、ポート番号は基本的に1024以上の未使用番号を選ぶのが安全です。開発用なら8081や8082など、近い番号にしておくと覚えやすく、複数のSpring Bootアプリを同時に動かすときにも管理が楽になります。
将来を見据えて、+αのスキルを身につけたい方へ
JavaやLinuxを学んでいても、「このままで市場価値は上がるのか」 「キャリアの選択肢を広げたい」と感じる方は少なくありません。
AIを学ぶならアイデミープレミアム3. application.propertiesでポートを指定する場合
application.ymlではなく、application.propertiesを使っているプロジェクトでも、ポート番号の変更はとても簡単です。書き方が「キー=値」の形なので、設定ファイルに慣れていない初心者の方でも読みやすいのが特徴です。
たとえば、ポート番号を8082に変更したい場合は、次の1行を追加(または書き換え)します。
server.port=8082
保存したら、Spring Bootアプリを再起動してください。再起動後は、アクセスするURLも次のように変わります。
http://localhost:8082/
ここでのポイントは「設定を変えたら、ブラウザで開くURLのポート番号も合わせて変える」ことです。設定だけ変えてURLを変え忘れると、画面が開かずに焦りやすいので注意しましょう。
また、複数のSpring Bootアプリを同時に起動する場合は、8081、8082、8083のように番号を分けておくと管理がしやすく、ポート競合による起動エラーも避けやすくなります。
4. コンテキストパスの変更方法
コンテキストパスとは、アプリケーションのURLの基準となるパスです。デフォルトでは/ですが、以下のように設定すれば変更できます。
server:
servlet:
context-path: /myapp
この設定を行うと、WebアプリケーションのURLは以下のようになります。
http://localhost:8080/myapp/
5. ポートやパスの指定ミスによる起動エラー
Spring Bootでよくある起動エラーの一つに、「ポートがすでに使用されています」というものがあります。以下のようなエラーメッセージが出た場合は、ポート番号を別のものに変更してください。
Web server failed to start. Port 8080 was already in use.
また、コンテキストパスを/から変更した場合、ルートURLでアクセスしても404エラーになることがあるので、正しいパスでアクセスしているか確認しましょう。
6. コマンドライン引数でポートを指定する方法
一時的にポートを変更したいときは、コマンドライン引数で--server.portを指定する方法もあります。
java -jar myapp.jar --server.port=9090
この方法なら設定ファイルを編集せずに実行時だけ変更できます。
7. プロファイルごとにポートやパスを切り替える
application.ymlではプロファイルごとに設定を切り替えることもできます。
spring:
profiles: dev
server:
port: 8085
servlet:
context-path: /devapp
---
spring:
profiles: prod
server:
port: 80
servlet:
context-path: /
プロファイルの切り替えはspring.profiles.activeで指定できます。
spring:
profiles:
active: dev
8. Tomcat以外のサーバーでも同様の設定が可能
Spring BootはデフォルトでTomcatを使っていますが、JettyやUndertowに変更した場合でもserver.portやserver.servlet.context-pathの設定は同様に機能します。設定の記述は共通なので、サーバー種別によらず覚えておくと便利です。
9. ポート番号を環境変数で切り替えるテクニック
クラウド環境やCI/CDでは、環境変数からポート番号を指定することが一般的です。
たとえば、環境変数SERVER_PORTを使ってSpring Bootが起動時にポートを取得するように設定しておくと、環境に応じた柔軟な起動が可能になります。
export SERVER_PORT=8888
java -jar myapp.jar