Skip to content

Latest commit

 

History

History
202 lines (148 loc) · 5.17 KB

README.md

File metadata and controls

202 lines (148 loc) · 5.17 KB

Calculator HTTP Streaming Demo

此專案示範如何使用 Spring Boot WebFlux 透過 Server-Sent Events (SSE) 實現 HTTP 串流。專案包含兩個應用程式：

  • Calculator Server：一個反應式的網路服務，用於計算並透過 SSE 傳送串流結果
  • Calculator Client：一個客戶端應用程式，用來接收串流端點的資料

前置需求

  • Java 17 或以上版本
  • Maven 3.6 或以上版本

專案結構

java/
├── calculator-server/     # Spring Boot server with SSE endpoint
│   ├── src/main/java/com/example/calculatorserver/
│   │   ├── CalculatorServerApplication.java
│   │   └── CalculatorController.java
│   └── pom.xml
├── calculator-client/     # Spring Boot client application
│   ├── src/main/java/com/example/calculatorclient/
│   │   └── CalculatorClientApplication.java
│   └── pom.xml
└── README.md

運作原理

  1. Calculator Server 開放 /calculate endpoint that:

    • Accepts query parameters: a (number), b (number), op (operation)
    • Supported operations: add, sub, mul, div
    • Returns Server-Sent Events with calculation progress and result

  2. The Calculator Client connects to the server and:

    • Makes a request to calculate 7 * 5
    • 接收串流回應
    • 將每個事件印出至主控台

執行應用程式

選項一：使用 Maven（推薦）

1. 啟動 Calculator Server

開啟終端機並切換到 server 目錄：

cd calculator-server
mvn clean package
mvn spring-boot:run

伺服器會啟動於 http://localhost:8080

你會看到類似以下的輸出：

Started CalculatorServerApplication in X.XXX seconds
Netty started on port 8080 (http)

2. 執行 Calculator Client

開啟另一個終端機並切換到 client 目錄：

cd calculator-client
mvn clean package
mvn spring-boot:run

客戶端會連接到伺服器，執行計算並顯示串流結果。

選項二：直接使用 Java

1. 編譯並執行伺服器：

cd calculator-server
mvn clean package
java -jar target/calculator-server-0.0.1-SNAPSHOT.jar

2. 編譯並執行客戶端：

cd calculator-client
mvn clean package
java -jar target/calculator-client-0.0.1-SNAPSHOT.jar

手動測試伺服器

你也可以使用瀏覽器或 curl 來測試伺服器：

使用瀏覽器：

造訪：http://localhost:8080/calculate?a=10&b=5&op=add

使用 curl：

curl "http://localhost:8080/calculate?a=10&b=5&op=add" -H "Accept: text/event-stream"

預期輸出

執行客戶端時，你應該會看到類似以下的串流輸出：

event:info
data:Calculating: 7.0 mul 5.0

event:result
data:35.0

支援的運算

  • add - Addition (a + b)
  • sub - Subtraction (a - b)
  • mul - Multiplication (a * b)
  • div - Division (a / b, returns NaN if b = 0)

API Reference

GET /calculate

Parameters:

  • a (required): First number (double)
  • b (required): Second number (double)
  • op (required): Operation (add, sub, mul, div)

Response:

  • Content-Type: text/event-stream
  • 回傳包含計算進度與結果的 Server-Sent Events

範例請求：

GET /calculate?a=7&b=5&op=mul HTTP/1.1
Host: localhost:8080
Accept: text/event-stream

範例回應：

event: info
data: Calculating: 7.0 mul 5.0

event: result
data: 35.0

疑難排解

常見問題

  1. 8080 埠口已被佔用

    • 停止其他佔用 8080 埠口的應用程式
    • 或修改 calculator-server/src/main/resources/application.yml

  2. Connection refused

    • Make sure the server is running before starting the client
    • Check that the server started successfully on port 8080

  3. Parameter name issues

    • This project includes Maven compiler configuration with -parameters flag
    • If you encounter parameter binding issues, ensure the project is built with this configuration

Stopping the Applications

  • Press Ctrl+C in the terminal where each application is running
  • Or use mvn spring-boot:stop 中的伺服器埠號（如果是以背景程序執行）

技術棧

  • Spring Boot 3.3.1 - 應用框架
  • Spring WebFlux - 反應式網路框架
  • Project Reactor - 反應式串流函式庫
  • Netty - 非阻塞 I/O 伺服器
  • Maven - 建置工具
  • Java 17+ - 程式語言

下一步

嘗試修改程式碼來：

  • 新增更多數學運算
  • 加入無效運算的錯誤處理
  • 增加請求/回應的日誌紀錄
  • 實作身份驗證
  • 新增單元測試

免責聲明：
本文件係使用 AI 翻譯服務 Co-op Translator 進行翻譯。雖然我們力求準確，但請注意，自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應視為權威來源。對於重要資訊，建議採用專業人工翻譯。我們不對因使用本翻譯所產生的任何誤解或誤譯負責。