SSE
SSE（Server-Sent Events）是一種用於實現伺服器主動向客戶端推送資料的技術，它基於 HTTP 協議，利用了其長連線特性，在客戶端與伺服器之間建立一條持久化連線，並透過這條連線實現伺服器向客戶端的實時資料推送。
Server-Sent Events (SSE) 和 Sockets 都可以用於實現伺服器向客戶端推送訊息的實時通訊，差異對比：
SSE：
優點:
使用簡單，只需傳送 HTTP 流式響應。
自動處理網路中斷和重連。
支援由瀏覽器原生實現的事件，如 "error" 和 "message"。
缺點：
單向通訊，伺服器只能傳送訊息給客戶端。
每個連線需要伺服器端的一個執行緒或程序。
Socket：
優點：
雙向通訊，客戶端和伺服器都可以傳送或接收訊息。
可以處理更復雜的應用場景，如雙向對話、多人遊戲等。
伺服器可以更精細地管理連線，如使用長連線或短連線。
缺點：
需要處理網路中斷和重連，相對複雜。
需要客戶端和伺服器端的程式碼都能處理 Socket 通訊。
對開發者要求較高，需要對網路程式設計有深入瞭解。
SSE使用場景：
使用場景主要包括需要伺服器主動向客戶端推送資料的應用場景，如AI問答聊天、實時新聞、股票行情等。
案例
服務端基於springboot實現，預設支援SSE；
Android客戶端基於OkHttp實現，同樣也支SSE；
服務端介面開發
SSEController.java
package com.qxc.server.controller.sse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
@RestController
@RequestMapping("/sse")
public class SSEController {
Logger logger = LoggerFactory.getLogger(SSEController.class);
public static Map<String, SseEmitter> sseEmitters = new ConcurrentHashMap<>();
/**
* 接收sse請求，非同步處理，分批次返回結果，然後關閉SseEmitter
* @return SseEmitter
*/
@GetMapping("/stream-sse")
public SseEmitter handleSse() {
SseEmitter emitter = new SseEmitter();
// 在新執行緒中傳送訊息，以避免阻塞主執行緒
new Thread(() -> {
try {
for (int i = 0; i < 10; i++) {
Map<String, Object> event = new HashMap<>();
String mes = "Hello, SSE " + (i+1);
event.put("message", mes);
logger.debug("emitter.send: "+mes);
emitter.send(event);
Thread.sleep(200);
}
emitter.complete(); // 完成傳送
} catch (IOException | InterruptedException e) {
emitter.completeWithError(e); // 傳送錯誤
}
}).start();
return emitter;
}
/**
* 接收sse請求，非同步處理，分批次返回結果，並儲存SseEmitter，可透過外界呼叫sendMsg介面，繼續返回結果
* @param uid 客戶唯一標識
* @return SseEmitter
*/
@GetMapping("/stream-sse1")
public SseEmitter handleSse1(@RequestParam("uid") String uid) {
SseEmitter emitter = new SseEmitter();
sseEmitters.put(uid, emitter);
// 在新執行緒中傳送訊息，以避免阻塞主執行緒
new Thread(() -> {
try {
for (int i = 10; i < 15; i++) {
Map<String, Object> event = new HashMap<>();
String mes = "Hello, SSE " + (i+1);
event.put("message", mes);
logger.debug("emitter.send: "+mes);
emitter.send(event);
Thread.sleep(200); // 每2秒傳送一次
}
} catch (IOException | InterruptedException e) {
emitter.completeWithError(e); // 傳送錯誤
}
}).start();
return emitter;
}
/**
* 外界呼叫sendMsg介面，根據標識獲取快取的SseEmitter，繼續返回結果
* @param uid 客戶唯一標識
*/
@GetMapping("/sendMsg")
public void sendMsg(@RequestParam("uid") String uid) {
logger.debug("服務端傳送訊息 to " + uid);
SseEmitter emitter = sseEmitters.get(uid);
if(emitter != null){
new Thread(() -> {
try {
for (int i = 20; i < 30; i++) {
Map<String, Object> event = new HashMap<>();
String mes = "Hello, SSE " + (i+1);
event.put("message", mes);
logger.debug("emitter.send: "+mes);
emitter.send(event);
Thread.sleep(200); // 每2秒傳送一次
}
emitter.send(SseEmitter.event().name("stop").data(""));
emitter.complete(); // close connection
logger.debug("服務端主動關閉了連線 to " + uid);
} catch (IOException | InterruptedException e) {
emitter.completeWithError(e); // error finish
}
}).start();
}
}
}
程式碼定義了3個介面，主要實現了兩個功能：
stream-sse 介面
用於模擬一次請求，批次返回結果，然後結束SseEmitter；
stream-sse1介面 & sendMsg介面
用於模擬一次請求，批次返回結果，快取SseEmitter，後續還可以透過sendMsg介面，通知服務端繼續返回結果；
客戶端功能開發
Android客戶端依賴OkHttp：
implementation 'com.squareup.okhttp3:okhttp:4.9.1'
implementation("com.squareup.okhttp3:okhttp-sse:4.9.1")
佈局檔案：activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<TextView
android:id="@+id/tv"
android:layout_above="@id/btn"
android:layout_centerHorizontal="true"
android:text="--"
android:lines="15"
android:gravity="center"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_margin="20dp"/>
<Button
android:layout_width="200dp"
android:layout_height="50dp"
android:id="@+id/btn"
android:text="測試普通介面"
android:layout_centerInParent="true"/>
<Button
android:layout_width="200dp"
android:layout_height="50dp"
android:id="@+id/btn1"
android:layout_below="@id/btn"
android:text="sse連線"
android:layout_centerInParent="true"/>
<Button
android:layout_width="200dp"
android:layout_height="50dp"
android:id="@+id/btn2"
android:layout_below="@id/btn1"
android:text="sse連線，攜帶引數"
android:layout_centerInParent="true"/>
</RelativeLayout>
MainActivity.java
package com.cb.testsd;
import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import java.util.concurrent.TimeUnit;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.internal.sse.RealEventSource;
import okhttp3.sse.EventSource;
import okhttp3.sse.EventSourceListener;
public class MainActivity extends Activity {
Button btn;
Button btn1;
Button btn2;
TextView tv;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
btn = findViewById(R.id.btn);
btn1 = findViewById(R.id.btn1);
btn2 = findViewById(R.id.btn2);
tv = findViewById(R.id.tv);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
testDate();
}
}).start();
}
});
btn1.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
sse();
}
}).start();
}
});
btn2.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
sseWithParams();
}
}).start();
}
});
}
private void testDate(){
OkHttpClient client = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS) // 建立連線的超時時間
.readTimeout(10, TimeUnit.MINUTES) // 建立連線後讀取資料的超時時間
.build();
Request request = new Request.Builder()
.url("http://192.168.43.102:58888/common/getCurDate")
.build();
okhttp3.Call call = client.newCall(request);
try {
Response response = call.execute(); // 同步方法
if (response.isSuccessful()) {
String responseBody = response.body().string(); // 獲取響應體
System.out.println(responseBody);
tv.setText(responseBody);
}
} catch (Exception e) {
e.printStackTrace();
}
}
void sse(){
Request request = new Request.Builder()
.url("http://192.168.43.102:58888/sse/stream-sse")
.addHeader("Authorization", "Bearer ")
.addHeader("Accept", "text/event-stream")
.build();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS) // 建立連線的超時時間
.readTimeout(10, TimeUnit.MINUTES) // 建立連線後讀取資料的超時時間
.build();
RealEventSource realEventSource = new RealEventSource(request, new EventSourceListener() {
@Override
public void onEvent(EventSource eventSource, String id, String type, String data) {
System.out.println(data); // 請求到的資料
String text = tv.getText().toString();
tv.setText(data+"\n"+text);
if ("finish".equals(type)) { // 訊息型別，add 增量，finish 結束，error 錯誤，interrupted 中斷
}
}
});
realEventSource.connect(okHttpClient);
}
void sseWithParams(){
Request request = new Request.Builder()
.url("http://192.168.43.102:58888/sse/stream-sse1?uid=1")
.addHeader("Authorization", "Bearer ")
.addHeader("Accept", "text/event-stream")
.build();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS) // 建立連線的超時時間
.readTimeout(10, TimeUnit.MINUTES) // 建立連線後讀取資料的超時時間
.build();
RealEventSource realEventSource = new RealEventSource(request, new EventSourceListener() {
@Override
public void onEvent(EventSource eventSource, String id, String type, String data) {
System.out.println(data); // 請求到的資料
String text = tv.getText().toString();
tv.setText(data+"\n"+text);
}
});
realEventSource.connect(okHttpClient);
}
}
效果測試
呼叫stream-sse介面
伺服器分批次返回了結果：
呼叫stream-sse1介面
伺服器分批次返回了結果：
透過h5呼叫sendMsg介面，服務端繼續返回結果：
