本地搭建springboot服務並實現公網遠程調試本地接口

在本文中，我們將探討如何在本地環境中建立一個Spring Boot服務，並透過網際網路實現遠端除錯的功能。這個過程可以讓開發人員在任何地方都可以對其應用程式進行除錯，而不需要實際連接到本地的計算機。以下是一個逐步指南：

準備工作

• JDK安裝：首先，確保您的電腦已經安裝了適當版本的[Java Development Kit (JDK)](https://www.oracle.com/java/technologies/downloads/#jdk17-)。這是編譯和執行Java程序的必要條件。

• Maven或Gradle：接下來，您需要選擇一個Build Tool來管理專案依賴關係和構建流程。[Apache Maven](https://maven.apache.org/)和[Gradle](https://gradle.org/)是最常見的兩個選項。

• IntelliJ IDEA（或其他IDE）: [IntelliJ IDEA](https://www.jetbrains.com/idea/)是一種流行的Java集成開發環境，它為Spring Boot提供了出色的支持。不過，任何其他支援Spring Boot的工具也可以使用。

• GitHub帳戶（或者其他版本控制系統）: 如果您不打算直接從IDE部署到生產環境，那麼使用像GitHub這樣的版本控制系統來託管您的代碼是非常有用的。這不僅方便團隊協作，還允許通過持續整合/持續交付(CI/CD)管道自動化部署過程。

創建Spring Boot項目

• 在IntelliJ IDEA中，創建一個新的`Spring Starter Project`。或者，如果您使用的是Maven以外的build tool，請按照相應的指引設置您的專案結構。

• 選擇`Spring Web`作為功能模塊，這樣您的服務才能響應HTTP請求。

• 如果需要，添加其他必要的依賴性以使您的應用程式正常運行。例如，如果您的API使用了特定的資料庫或第三方庫，則需要在pom.xml（如果是Maven）或build.gradle（如果是Gradle）文件中包含這些依賴項。

配置Spring Boot伺服器

• 在`application.properties`檔案中，配置您的Spring Boot伺服器的基本設定，比如端口號和資料庫參數。

• 為了能夠被外部訪問，您可能需要配置防火牆規則或在路由器上開啟特定埠的轉發。通常，TCP埠3000以上較少受到限制，因此您可以嘗試在那個範圍內尋找一個可用端口。

部署本地伺服器

• 一旦您的Spring Boot應用程式完成編寫並且測試過，就可以開始部署到本地伺服器。

• IntelliJ IDEA提供了一個簡單的方法來做到這一點：只需右擊專案根目錄，然後選擇“Run ‘Application’”即可。這樣會打開一個內嵌Tomcat伺服器並運行您的應用程式。

• 對於Maven使用者，可以使用`mvn spring-boot:run`命令從終端窗口啟動應用程式；而Gradle的使用者可以用`./gradlew bootRun`來代替。

配置遠端除錯

• 事先確認遠端主機會開放何種通訊埠以及如何存取。一般來說，Java虛擬機器(JVM)預設會封鎖所有遠端除錯連線，所以必須在啟動時加入額外的參數來允許這些連線。

• 在`application.properties`檔案中，您可以設定如下的屬性來啟用遠端除錯：

# Spring Boot 2.x or later
server.tomcat.remote_ip_header=client-ip
server.tomcat.protocol_header=x-forwarded-proto
management.endpoints.web.exposure.include=*
management.endpoint.shutdown.enabled=true
management.endpoint.health.show-details=always
management.endpoints.web.base-path=/actuator
management.trace.level=all

注意：上述配置僅供示例之用，實際配置可能根據不同的Spring Boot版本有所不同。務必查看最新文檔以獲取準確的配置資訊。

• 此外，您需要指定JVM參數來啟用遠端除錯監聽器：

-agentlib:jdwp=transport=dt_socket,address=<your_debugging_port>,suspend=y,server=y

其中，“應該被替換為您想要使用的具體埠號。例如，如果想使用8000埠進行遠端除錯，則該參數變為：

-agentlib:jdwp=transport=dt_socket,address=8000,suspend=y,server=y

設定遠端調試器

• 在您的開發環境中，打開您的IDE（例如IntelliJ IDEA）並創建一個新的遠程調試配置。

• 在這裡，您將指定目標主機名稱（IP地址）、要連接到的埠以及任何其他必要的連接選項。

• 保存此配置後，請嘗試從您的IDE中連接到正在運行的Spring Boot應用程式。如果一切順利，您應該能夠看到您的應用程式及其各個組件在IDE中的實時狀態。

總結

透過上述步驟，您現在可以在本地環境中輕鬆地建立和管理一個可公開訪問的Spring Boot服務，同時擁有遠端除錯的能力。這種方法不僅簡化了開發週期，而且使協作更加高效，因為團隊成員不必物理上靠近同一臺計算機就能解決問題。隨著雲計算和分散式系統的不斷發展，這些技能將變得越來越重要。