SpringBoot3.3 中如何實現多端口監聽
作者：編程疏影
Spring通過本文的詳細講解，我們學習了如何在 SpringBoot 中實現多端口監聽。這一功能在處理不同類型的請求或暴露多個服務接口時非常有用。我們通過配置 application.yml 文件和編寫自定義配置類，結合前端展示，實現了這一功能。
在 SpringBoot 應用中，通常情況下，我們只需要監聽一個端口來處理 HTTP 請求。但在某些情況下，我們可能需要在同一個應用中監聽多個端口，例如分別處理不同類型的請求，或者在同一個應用中暴露多個服務接口。本篇文章將詳細講解如何在 SpringBoot 中實現多端口監聽，并結合代碼示例進行深入講解。
運行效果：
圖片
若想獲取項目完整代碼以及其他文章的項目源碼，且在代碼編寫時遇到問題需要咨詢交流，歡迎加入下方的知識星球。
項目環境與依賴配置
首先，我們需要創建一個 SpringBoot 項目，并確保項目中包含必要的依賴。以下是 pom.xml的配置：
<?xml versinotallow="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.3.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.icoderoad</groupId>
<artifactId>multi-port-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>multi-port-demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<!-- Spring Boot Web Starter -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Thymeleaf 依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>配置多端口監聽
在 SpringBoot 中，通過配置 application.yml 文件可以輕松實現多端口監聽。以下是配置示例：
server:
port: 8080 # 主端口
# 額外的端口配置
additional-ports:
- 8081
- 8082編寫配置類實現多端口監聽
在配置文件中指定了額外的端口后，我們需要編寫一個配置類，使用 Spring 的 EmbeddedWebServerFactoryCustomizer 來實現多端口監聽。我們在 MultiPortConfig 類中為每個端口配置一個獨立的 Spring 上下文。
package com.icoderoad.multi_port_demo.config;
import org.apache.catalina.connector.Connector;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MultiPortConfig {
@Bean
public ServletWebServerFactory servletWebServerFactory() {
TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
factory.addAdditionalTomcatConnectors(createConnector(8081)); // Add additional port 8081
factory.addAdditionalTomcatConnectors(createConnector(8082)); // Add additional port 8082
return factory;
}
private Connector createConnector(int port) {
Connector connector = new Connector(TomcatServletWebServerFactory.DEFAULT_PROTOCOL);
connector.setPort(port);
return connector;
}
}在這個配置類中，createAndStartContext 方法為 8081 和 8082 端口創建了獨立的 Spring 上下文，每個上下文對應一個配置類（Port8081Config 和 Port8082Config），這些配置類會定義對應端口下的控制器。
為每個端口創建獨立的配置類
現在，我們為每個端口創建獨立的配置類，這些配置類將會注冊相應的控制器。
8081 端口配置類
package com.icoderoad.multi_port_demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import com.icoderoad.multi_port_demo.controller.Port8081Controller;
@Configuration
@EnableWebMvc
public class Port8081Config {
@Bean
public Port8081Controller port8081Controller() {
return new Port8081Controller();
}
}8082 端口配置類
package com.icoderoad.multi_port_demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import com.icoderoad.multi_port_demo.controller.Port8082Controller;
@Configuration
@EnableWebMvc
public class Port8082Config {
@Bean
public Port8082Controller port8082Controller() {
return new Port8082Controller();
}
}這些配置類會在相應的端口上下文中注冊對應的控制器。
控制器類定義
定義控制器類，每個控制器類對應一個端口，之前的控制器定義無需改變：
8080 端口的控制器（保持原有配置）
package com.icoderoad.multi_port_demo.controller;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class Port8080Controller {
@GetMapping("/port8080/service")
public ResponseEntity<String> service() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(org.springframework.http.MediaType.TEXT_PLAIN);
headers.set(HttpHeaders.CONTENT_TYPE, "text/plain; charset=UTF-8");
return new ResponseEntity<>("端口 8080 的服務數據", headers, HttpStatus.OK);
}
}8081 端口的控制器
package com.icoderoad.multi_port_demo.controller;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class Port8081Controller {
@CrossOrigin(origins = "http://localhost:8080") // 允許的前端地址
@GetMapping("/port8081/service")
public ResponseEntity<String> service() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(org.springframework.http.MediaType.TEXT_PLAIN);
headers.set(HttpHeaders.CONTENT_TYPE, "text/plain; charset=UTF-8");
return new ResponseEntity<>("端口 8081 的服務數據", headers, HttpStatus.OK);
}
}8082 端口的控制器
package com.icoderoad.multi_port_demo.controller;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class Port8082Controller {
@CrossOrigin(origins = "http://localhost:8080") // 允許的前端地址
@GetMapping("/port8082/service")
public ResponseEntity<String> service() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(org.springframework.http.MediaType.TEXT_PLAIN);
headers.set(HttpHeaders.CONTENT_TYPE, "text/plain; charset=UTF-8");
return new ResponseEntity<>("端口 8082 的服務數據", headers, HttpStatus.OK);
}
}編寫前端頁面
在 src/main/resources/templates 目錄下創建一個簡單的 index.html 頁面，使用 Thymeleaf 和 Bootstrap 進行前端展示。
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>SpringBoot 多端口監聽</title>
<link rel="stylesheet">
</head>
<body>
<div class="container">
<h1 class="mt-5">SpringBoot 多端口監聽示例</h1>
<p class="lead">此應用監聽多個端口，分別處理不同的請求。</p>
<p>主端口：8080</p>
<p>額外端口：8081, 8082</p>
<div class="row">
<div class="col-md-4">
<h3>端口 8080 數據</h3>
<p id="data-8080">加載中...</p>
</div>
<div class="col-md-4">
<h3>端口 8081 數據</h3>
<p id="data-8081">加載中...</p>
</div>
<div class="col-md-4">
<h3>端口 8082 數據</h3>
<p id="data-8082">加載中...</p>
</div>
</div>
</div>
<script>
fetch('http://localhost:8080/port8080/service')
.then(response => response.text())
.then(data => {
document.getElementById('data-8080').textContent = data;
});
fetch('http://localhost:8081/port8081/service')
.then(response => response.text())
.then(data => {
document.getElementById('data-8081').textContent = data;
});
fetch('http://localhost:8082/port8082/service')
.then(response => response.text())
.then(data => {
document.getElementById('data-8082').textContent = data;
});
</script>
</body>
</html>視圖控制器實現
在 src/main/java/com/icoderoad/controller 目錄下創建一個簡單的控制器，用于處理 HTTP 請求。
package com.icoderoad.multi_port_demo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class IndexController {
@GetMapping("/")
public String index() {
return "index";
}
}上述代碼中，我們創建了一個簡單的控制器類，提供了一個主頁和一個返回監聽端口信息的接口。
啟動與驗證
啟動 SpringBoot 應用后，在瀏覽器中訪問 http://localhost:8080、http://localhost:8081 和 http://localhost:8082，你會發現所有端口都可以正常響應請求，說明我們已經成功實現了多端口監聽。
總結
通過本文的詳細講解，我們學習了如何在 SpringBoot 中實現多端口監聽。這一功能在處理不同類型的請求或暴露多個服務接口時非常有用。我們通過配置 application.yml 文件和編寫自定義配置類，結合前端展示，實現了這一功能。
責任編輯：武曉燕
來源：
路條編程
